feat: Add Shopify Get Order action #14858

GovardhaneNitin · 2024-12-05T18:32:56Z

Description

Added new Shopify Get Order action to retrieve order details using the Admin GraphQL API.

Changes

Added new action shopify-get-order
Implements order retrieval using Shopify's GraphQL API
Added documentation and examples

Testing

Tested locally with sample order IDs
Verified response format matches Shopify API documentation

Summary by CodeRabbit

New Features
- Introduced a new module for retrieving and formatting order data from Shopify.
- Added customizable options for including specific fields, metafields, and customer details in the order response.
Bug Fixes
- Enhanced order retrieval process to ensure accurate data formatting and response output.

vercel · 2024-12-05T18:33:01Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Dec 5, 2024 7:32pm

vercel · 2024-12-05T18:33:02Z

@GovardhaneNitin is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-12-05T18:33:04Z

Walkthrough

The pull request introduces two new modules for handling Shopify order data. The first module, common.mjs, provides a method formatOrderData(order) for formatting order details, along with customizable properties for field selection and inclusion of metafields and customer information. The second module, get-order.mjs, defines a method to retrieve a specific order, utilizing the formatting method to structure the response. Together, these changes enhance the functionality for retrieving and formatting Shopify order data.

Changes

File Path	Change Summary
components/shopify/actions/get-order/common.mjs	- Added method: `formatOrderData(order)` - Added props: `orderFields`, `includeMetafields`, `includeCustomer`, `includeLineItems`
components/shopify/actions/get-order/get-order.mjs	- New module exported with properties: `key`, `name`, `description`, `version`, `type`, `props` - Added property: `orderId` in `props`

Possibly related PRs

Shopify (OAuth) - Update Metafield action #14076: This PR involves changes to the Shopify actions, specifically related to metafields, which may interact with the order data formatting introduced in the main PR, particularly in how order data might include metafields.

Suggested reviewers

luancazarine

Poem

🐰 In the land of Shopify, orders do play,
With fields and formats, they brighten the day.
A method to gather, a structure to share,
Order data dances, with love and with care.
So hop along, friends, let’s fetch and delight,
In the world of commerce, everything feels right! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 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.

pipedream-component-development · 2024-12-05T18:33:16Z

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

pipedream-component-development · 2024-12-05T18:33:17Z

coderabbitai

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (2)

components/shopify/actions/get-order/common.mjs (1)
27-37: Add validation for orderFields

The orderFields prop accepts any string array without validating if the fields actually exist in the Shopify API.

Consider adding an enum of valid fields or validation logic:
 orderFields: {
   type: "string[]",
   label: "Order Fields",
+  options: [
+    "id",
+    "order_number",
+    "total_price",
+    "created_at",
+    "updated_at",
+    "fulfillment_status",
+    "financial_status",
+    "customer",
+    "line_items",
+    "shipping_address",
+    "billing_address",
+  ],
   description: toSingleLineString(`
     Select which fields to include in the response. 
     If none selected, returns all available fields.
     See Shopify Order API documentation for available fields:
     https://shopify.dev/api/admin-graphql/2024-10/queries/order
   `),
   optional: true,
 },
components/shopify/actions/get-order/get-order.mjs (1)
20-38: Consider rate limiting and sensitive data handling

When dealing with order data through Shopify's API:

Consider implementing rate limiting to avoid API throttling

Be mindful of handling sensitive customer information in logs

Consider adding rate limiting middleware or using a rate limiter from the app instance. Also, ensure sensitive data is not logged in the $summary.
 async run({ $ }) {
   try {
+    // Redact orderId in logs
+    const redactedOrderId = this.orderId.substring(0, 4) + '...';
     const response = await this.app.resourceAction(
       "order",
       "get",
       params,
       this.orderId,
     );

     const formattedOrder = this.formatOrderData(response.result);
-    $.export("$summary", `Retrieved order ${this.orderId}`);
+    $.export("$summary", `Retrieved order ${redactedOrderId}`);
     return formattedOrder;
   }
 },
🧰 Tools

🪛 eslint

[error] 32-33: Missing trailing comma.

(comma-dangle)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a8245f7 and 281233b.

📒 Files selected for processing (2)

components/shopify/actions/get-order/common.mjs (1 hunks)
components/shopify/actions/get-order/get-order.mjs (1 hunks)

🧰 Additional context used

🪛 eslint

components/shopify/actions/get-order/get-order.mjs

[error] 32-33: Missing trailing comma.

(comma-dangle)

🔇 Additional comments (1)

components/shopify/actions/get-order/get-order.mjs (1)

1-19: LGTM! Well-structured component setup

Good use of common configuration spreading and proper prop definitions.

components/shopify/actions/get-order/common.mjs

components/shopify/actions/get-order/get-order.mjs

feat: Add Shopify Get Order action

281233b

dylburger added the User submitted Submitted by a user label Dec 5, 2024

pipedream-component-development requested a review from lcaresia December 5, 2024 18:33

coderabbitai bot reviewed Dec 5, 2024

View reviewed changes

components/shopify/actions/get-order/common.mjs Show resolved Hide resolved

components/shopify/actions/get-order/common.mjs Show resolved Hide resolved

components/shopify/actions/get-order/get-order.mjs Show resolved Hide resolved

Merge branch 'master' into feature/shopify-get-order

0b551e5

GovardhaneNitin closed this Dec 7, 2024

GovardhaneNitin deleted the feature/shopify-get-order branch December 7, 2024 20:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add Shopify Get Order action #14858

feat: Add Shopify Get Order action #14858

Uh oh!

GovardhaneNitin commented Dec 5, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Dec 5, 2024 •

edited

Loading

Uh oh!

vercel bot commented Dec 5, 2024

Uh oh!

coderabbitai bot commented Dec 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pipedream-component-development commented Dec 5, 2024

Uh oh!

pipedream-component-development commented Dec 5, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: Add Shopify Get Order action #14858

feat: Add Shopify Get Order action #14858

Uh oh!

Conversation

GovardhaneNitin commented Dec 5, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Testing

Summary by CodeRabbit

Uh oh!

vercel bot commented Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Dec 5, 2024

Uh oh!

coderabbitai bot commented Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pipedream-component-development commented Dec 5, 2024

Uh oh!

pipedream-component-development commented Dec 5, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

GovardhaneNitin commented Dec 5, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Dec 5, 2024 •

edited

Loading

coderabbitai bot commented Dec 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)