Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] develop from medusajs:develop #5

Merged
merged 3 commits into from
Dec 18, 2024
Merged

Conversation

pull[bot]
Copy link

@pull pull bot commented Dec 18, 2024

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Refactor the core workflows to replace useQueryStep with useQueryGraphStep for better query management and update type definitions to enhance IntelliSense while providing more flexibility.

Enhancements:

  • Refactor workflows to use useQueryGraphStep instead of useQueryStep for improved query handling.

Chores:

  • Update types to maintain IntelliSense while allowing more flexibility.

adrien2p and others added 3 commits December 18, 2024 17:12
**What**
Keep the autocompletion for the fields API in Query APIs while being more flexible in order to prevent limitation from our depth limit but also to be more flexible when assigning string[] coming from the API for example.
Replace usage of `useQueryStep` with `useGraphQueryStep` and remove `useQueryStep`, as it's not exported by the package and seems to be a duplicate of `useGraphQueryStep`
* fix: cart data passed to context, from location in validation

* refactor: extract common fields to a const
@pull pull bot added the ⤵️ pull label Dec 18, 2024
@pull pull bot merged commit 3dba551 into Stars1233:develop Dec 18, 2024
Copy link

sourcery-ai bot commented Dec 18, 2024

Reviewer's Guide by Sourcery

This PR primarily focuses on improving the shipping options calculation workflow and query handling in the Medusa core. The changes include refactoring field definitions, updating query step usage, and enhancing type definitions for remote queries.

Class diagram for updated cart field utilities

classDiagram
    class CartFields {
        +cartFieldsForRefreshSteps: string[]
        +cartFieldsForCalculateShippingOptionsPrices: string[]
    }
    note for CartFields "Updated to include new fields for calculating shipping options prices"
Loading

Class diagram for updated query step usage

classDiagram
    class QuerySteps {
        -useQueryStep
        +useQueryGraphStep
    }
    note for QuerySteps "Replaced useQueryStep with useQueryGraphStep in workflows"
Loading

Class diagram for RemoteQueryObjectConfig type

classDiagram
    class RemoteQueryObjectConfig {
        +TEntry: string
        +RemoteQueryEntryPoints: Object
        +ObjectToRemoteQueryFields: Object[] | string[]
    }
    note for RemoteQueryObjectConfig "Enhanced type definitions to support string arrays"
Loading

File-Level Changes

Change Details Files
Refactored cart fields for shipping options calculation into a dedicated constant
  • Created new cartFieldsForCalculateShippingOptionsPrices constant with required fields
  • Updated existing workflows to use the new fields constant
  • Added additional variant-related fields to cart refresh steps
packages/core/core-flows/src/cart/utils/fields.ts
packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart-with-pricing.ts
packages/core/core-flows/src/fulfillment/workflows/calculate-shipping-options-prices.ts
Migrated from useQueryStep to useQueryGraphStep across multiple workflows
  • Updated process-payment workflow to use useQueryGraphStep
  • Updated complete-cart workflow to use useQueryGraphStep
  • Removed deprecated use-query.ts file
packages/core/core-flows/src/payment/workflows/process-payment.ts
packages/core/core-flows/src/cart/workflows/complete-cart.ts
packages/core/core-flows/src/common/steps/use-query.ts
Enhanced type definitions for remote queries
  • Modified RemoteQueryObjectConfig to support string arrays
  • Updated type tests to reflect new type definitions
  • Added more flexible type constraints for query fields
packages/core/types/src/modules-sdk/remote-query-object-from-string.ts
packages/core/types/src/modules-sdk/__tests__/remote-query.spec.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

coderabbitai bot commented Dec 18, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants