Skip to content

Quickbooks Sandbox - new components #17078

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

Merged
merged 5 commits into from
Jun 16, 2025

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Jun 11, 2025

Followup PR to this issue

Summary by CodeRabbit

  • New Features

    • Introduced sandbox-specific actions for QuickBooks: create estimate, create purchase order, send estimate, send invoice, update estimate, update invoice, and void invoice. These actions provide tailored functionality for the QuickBooks Sandbox environment.
  • Chores

    • Updated the QuickBooks Sandbox package version to 0.2.0 and upgraded the QuickBooks integration dependency.

@michelle0927 michelle0927 self-assigned this Jun 11, 2025
Copy link

vercel bot commented Jun 11, 2025

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

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Jun 16, 2025 3:24pm
pipedream-docs ⬜️ Ignored (Inspect) Jun 16, 2025 3:24pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 16, 2025 3:24pm

Copy link
Contributor

coderabbitai bot commented Jun 11, 2025

Walkthrough

New action modules have been added to the QuickBooks Sandbox integration, each adapting corresponding actions from the main QuickBooks integration for sandbox use. These modules import the base action, adjust property definitions for the sandbox environment, and export customized action objects. The package version and dependency on the main QuickBooks package were also updated.

Changes

File(s) Change Summary
components/quickbooks_sandbox/actions/create-estimate/create-estimate.mjs Added a sandbox-specific create-estimate action by adapting the common action and adjusting its properties.
components/quickbooks_sandbox/actions/create-purchase-order/create-purchase-order.mjs Introduced a sandbox-specific create-purchase-order action with tailored property definitions.
components/quickbooks_sandbox/actions/send-estimate/send-estimate.mjs Added a sandbox-specific send-estimate action by customizing the base action for sandbox use.
components/quickbooks_sandbox/actions/send-invoice/send-invoice.mjs Added a sandbox-specific send-invoice action with adjusted properties and sandbox app reference.
components/quickbooks_sandbox/actions/update-estimate/update-estimate.mjs Introduced a sandbox-specific update-estimate action with customized props and metadata.
components/quickbooks_sandbox/actions/update-invoice/update-invoice.mjs Added a sandbox-specific update-invoice action, reusing and adapting the common action for sandbox context.
components/quickbooks_sandbox/actions/void-invoice/void-invoice.mjs Added a sandbox-specific void-invoice action with adjusted property definitions and sandbox app instance.
components/quickbooks_sandbox/package.json Updated package version to 0.2.0 and upgraded dependency on @pipedream/quickbooks to 0.6.1.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SandboxAction
    participant SandboxApp
    participant CommonAction

    User->>SandboxAction: Invoke action (e.g., create-estimate)
    SandboxAction->>CommonAction: Use base action logic
    SandboxAction->>SandboxApp: Use sandbox app instance
    CommonAction-->>SandboxAction: Return result
    SandboxAction-->>User: Return sandbox-adapted result
Loading

Poem

In the sandbox, rabbits hop with glee,
New actions sprout for QuickBooks, wild and free.
Estimates, invoices, all in a row,
Purchase orders and voids, ready to go!
With version bumps and code anew,
The sandbox garden grows for you.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/quickbooks_sandbox/actions/create-estimate/create-estimate.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:201:49)

components/quickbooks_sandbox/actions/create-purchase-order/create-purchase-order.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:201:49)

components/quickbooks_sandbox/actions/send-estimate/send-estimate.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:201:49)

  • 4 others

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9772c8 and 1295b66.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (8)
  • components/quickbooks_sandbox/actions/create-estimate/create-estimate.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/create-purchase-order/create-purchase-order.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/send-estimate/send-estimate.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/send-invoice/send-invoice.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/update-estimate/update-estimate.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/update-invoice/update-invoice.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/void-invoice/void-invoice.mjs (1 hunks)
  • components/quickbooks_sandbox/package.json (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/quickbooks_sandbox/actions/create-estimate/create-estimate.mjs
🚧 Files skipped from review as they are similar to previous changes (7)
  • components/quickbooks_sandbox/package.json
  • components/quickbooks_sandbox/actions/send-invoice/send-invoice.mjs
  • components/quickbooks_sandbox/actions/update-estimate/update-estimate.mjs
  • components/quickbooks_sandbox/actions/update-invoice/update-invoice.mjs
  • components/quickbooks_sandbox/actions/send-estimate/send-estimate.mjs
  • components/quickbooks_sandbox/actions/void-invoice/void-invoice.mjs
  • components/quickbooks_sandbox/actions/create-purchase-order/create-purchase-order.mjs
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: pnpm publish
  • GitHub Check: Lint Code Base
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Publish TypeScript components
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@michelle0927
Copy link
Collaborator Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jun 11, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

♻️ Duplicate comments (2)
components/quickbooks_sandbox/actions/create-purchase-order/create-purchase-order.mjs (1)

18-21: Same quickbooks-prop overwrite risk as noted in void-invoice.mjs
See earlier comment – apply the same ordering fix.

components/quickbooks_sandbox/actions/send-estimate/send-estimate.mjs (1)

18-21: Same quickbooks-prop overwrite risk as noted in void-invoice.mjs
See earlier comment – apply the same ordering fix.

🧹 Nitpick comments (2)
components/quickbooks_sandbox/actions/send-invoice/send-invoice.mjs (1)

11-17: Minor duplication – keep metadata single-sourced

You extract name, description, type only to re-assign them unchanged.
Since they’re already present inside ...others, removing them from the destructuring would cut a few lines and the chance of drift:

-const {
-  name, description, type, ...others
-} = common;
+const { ...others } = common;

…and drop the explicit name, description, type when exporting.
Optional, but keeps the shim ultra-thin.

components/quickbooks_sandbox/actions/void-invoice/void-invoice.mjs (1)

1-22: Seven nearly-identical sandbox action wrappers – extract a helper to kill duplication

The exact same scaffold (import app, import common, adjust props, export) is now repeated across every sandbox action module.
A tiny factory such as buildSandboxAction(commonAction, key) inside components/quickbooks_sandbox/common/utils.mjs would:

  • remove boilerplate,
  • guarantee consistent ordering (preventing bugs like the one above),
  • centralise version & naming logic.

This keeps each action file to a two-liner and future additions virtually free.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a956e30 and 3dd81fd.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (8)
  • components/quickbooks_sandbox/actions/create-estimate/create-estimate.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/create-purchase-order/create-purchase-order.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/send-estimate/send-estimate.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/send-invoice/send-invoice.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/update-estimate/update-estimate.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/update-invoice/update-invoice.mjs (1 hunks)
  • components/quickbooks_sandbox/actions/void-invoice/void-invoice.mjs (1 hunks)
  • components/quickbooks_sandbox/package.json (2 hunks)
🔇 Additional comments (1)
components/quickbooks_sandbox/package.json (1)

3-3: Ensure the action-level versioning story is clear

The package version is bumped to 0.2.0, but every new action introduced in this PR keeps an internal version: "0.0.1".
That is fine if the action version is intended to indicate per-action semver that starts from zero, but please double-check that:

  1. The publishing pipeline does not assume action version == package version.
  2. Down-stream services (catalog, docs generator, etc.) do not surface the mixed numbering in a confusing way.

If either tool expects the two to march in lock-step, align the numbers before merge.

@michelle0927 michelle0927 moved this from Doing to Ready for PR Review in Component (Source and Action) Backlog Jun 11, 2025
jcortes
jcortes previously approved these changes Jun 11, 2025
Copy link
Collaborator

@jcortes jcortes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @michelle0927 lgtm! Ready for QA!

@jcortes jcortes moved this from Ready for PR Review to Ready for QA in Component (Source and Action) Backlog Jun 11, 2025
@vunguyenhung vunguyenhung moved this from Ready for QA to In QA in Component (Source and Action) Backlog Jun 12, 2025
@vunguyenhung vunguyenhung moved this from In QA to Changes Required in Component (Source and Action) Backlog Jun 12, 2025
@vunguyenhung
Copy link
Collaborator

Hello everyone, I have tested this PR and there're some test cases failed or needed improvement.

Please check the test report below for more information
https://vunguyenhung.notion.site/Quickbooks-Sandbox-new-components-20fbf548bb5e818d84f7e5f9b287a42e

@vunguyenhung
Copy link
Collaborator

Hi everyone, all test cases are passed! Ready for release!

Test report
https://vunguyenhung.notion.site/Quickbooks-Sandbox-new-components-20fbf548bb5e818d84f7e5f9b287a42e

@michelle0927
Copy link
Collaborator Author

/approve

@jcortes jcortes force-pushed the quickbooks-sandbox-new-components branch from f9772c8 to 1295b66 Compare June 16, 2025 15:24
@michelle0927 michelle0927 merged commit 65ebf61 into master Jun 16, 2025
11 checks passed
@michelle0927 michelle0927 deleted the quickbooks-sandbox-new-components branch June 16, 2025 15:39
@github-project-automation github-project-automation bot moved this from Ready for Release to Done in Component (Source and Action) Backlog Jun 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants