Skip to content

[ACTION] Figure out action required for Intuit Quickbooks API version changes #15369

New issue

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

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

Already on GitHub? # to your account

Merged
merged 3 commits into from
Jan 23, 2025

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Jan 22, 2025

  • Pinned requests to new base minorversion = 75
  • Tested all components
  • Made updates where needed
  • Will create follow PR to update quickbooks_sandbox components after this is published (quickbox_sandbox imports from @pipedream/quickbooks package)

Resolves #15362

Summary by CodeRabbit

  • Chores

    • Updated version numbers across multiple QuickBooks components and actions
    • Incremented package version from 0.5.0 to 0.5.1
    • Minor updates to various QuickBooks integration modules
  • Enhancements

    • Improved QuickBooks API request handling by adding support for additional parameters
    • Added minorversion parameter to API requests for more precise version control

The updates appear to be routine maintenance and version synchronization across the QuickBooks integration, with no significant functional changes to the core components.

Copy link

vercel bot commented Jan 22, 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 Jan 22, 2025 9:31pm
pipedream-docs ⬜️ Ignored (Inspect) Jan 22, 2025 9:31pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jan 22, 2025 9:31pm

Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

This pull request involves version updates across multiple QuickBooks integration components. The changes primarily consist of incrementing version numbers for various actions, sources, and the main package, with most version increments being minor (e.g., from 0.1.7 to 0.1.8 or 0.0.4 to 0.0.5). Additionally, there's a notable modification in the quickbooks.app.mjs file, which now allows passing additional parameters to the _makeRequest method, specifically introducing a minorversion parameter set to 75.

Changes

File Path Change Summary
components/quickbooks/actions/* Version updates across multiple actions (create, get, search, update) from various versions like 0.0.1, 0.1.7 to next incremental version
components/quickbooks/sources/* Version updates for source components from 0.0.2, 0.0.4 to next incremental version
components/quickbooks/package.json Package version updated from 0.5.0 to 0.5.1
components/quickbooks/quickbooks.app.mjs Updated _makeRequest method to support additional parameters and minorversion

Assessment against linked issues

Objective Addressed Explanation
Investigate Intuit QuickBooks API version changes [#15362] Partial investigation evident, but full context of API changes not fully clear from the PR

Possibly related PRs

Suggested labels

quickbooks, version-update, api-integration, user submitted

Suggested reviewers

  • GTFalcao
  • QuickBooks integration maintainer

Poem

🐰 Hop, hop, version update time!
QuickBooks actions, looking so fine
Numbers climbing, one step higher
Integration's version fire!
Rabbit's code dance continues to shine 🚀


📜 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 73fdd00 and 2cc2c70.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (41)
  • components/quickbooks/actions/create-ap-aging-report/create-ap-aging-report.mjs (1 hunks)
  • components/quickbooks/actions/create-bill/create-bill.mjs (1 hunks)
  • components/quickbooks/actions/create-customer/create-customer.mjs (1 hunks)
  • components/quickbooks/actions/create-invoice/create-invoice.mjs (1 hunks)
  • components/quickbooks/actions/create-payment/create-payment.mjs (1 hunks)
  • components/quickbooks/actions/create-pl-report/create-pl-report.mjs (1 hunks)
  • components/quickbooks/actions/create-purchase/create-purchase.mjs (1 hunks)
  • components/quickbooks/actions/create-sales-receipt/create-sales-receipt.mjs (1 hunks)
  • components/quickbooks/actions/delete-purchase/delete-purchase.mjs (2 hunks)
  • components/quickbooks/actions/get-bill/get-bill.mjs (1 hunks)
  • components/quickbooks/actions/get-customer/get-customer.mjs (1 hunks)
  • components/quickbooks/actions/get-invoice/get-invoice.mjs (1 hunks)
  • components/quickbooks/actions/get-my-company/get-my-company.mjs (1 hunks)
  • components/quickbooks/actions/get-payment/get-payment.mjs (1 hunks)
  • components/quickbooks/actions/get-purchase-order/get-purchase-order.mjs (1 hunks)
  • components/quickbooks/actions/get-purchase/get-purchase.mjs (1 hunks)
  • components/quickbooks/actions/get-sales-receipt/get-sales-receipt.mjs (1 hunks)
  • components/quickbooks/actions/get-time-activity/get-time-activity.mjs (1 hunks)
  • components/quickbooks/actions/search-accounts/search-accounts.mjs (1 hunks)
  • components/quickbooks/actions/search-customers/search-customers.mjs (1 hunks)
  • components/quickbooks/actions/search-invoices/search-invoices.mjs (1 hunks)
  • components/quickbooks/actions/search-items/search-items.mjs (1 hunks)
  • components/quickbooks/actions/search-products/search-products.mjs (1 hunks)
  • components/quickbooks/actions/search-purchases/search-purchases.mjs (1 hunks)
  • components/quickbooks/actions/search-query/search-query.mjs (1 hunks)
  • components/quickbooks/actions/search-services/search-services.mjs (1 hunks)
  • components/quickbooks/actions/search-time-activities/search-time-activities.mjs (1 hunks)
  • components/quickbooks/actions/search-vendors/search-vendors.mjs (1 hunks)
  • components/quickbooks/actions/sparse-update-invoice/sparse-update-invoice.mjs (2 hunks)
  • components/quickbooks/actions/update-customer/update-customer.mjs (1 hunks)
  • components/quickbooks/actions/update-item/update-item.mjs (1 hunks)
  • components/quickbooks/package.json (1 hunks)
  • components/quickbooks/quickbooks.app.mjs (2 hunks)
  • components/quickbooks/sources/new-customer-created/new-customer-created.mjs (1 hunks)
  • components/quickbooks/sources/new-customer-updated/new-customer-updated.mjs (1 hunks)
  • components/quickbooks/sources/new-employee-created/new-employee-created.mjs (1 hunks)
  • components/quickbooks/sources/new-employee-updated/new-employee-updated.mjs (1 hunks)
  • components/quickbooks/sources/new-invoice-created/new-invoice-created.mjs (1 hunks)
  • components/quickbooks/sources/new-invoice-updated/new-invoice-updated.mjs (1 hunks)
  • components/quickbooks/sources/new-item-created/new-item-created.mjs (1 hunks)
  • components/quickbooks/sources/new-item-updated/new-item-updated.mjs (1 hunks)
✅ Files skipped from review due to trivial changes (38)
  • components/quickbooks/actions/search-time-activities/search-time-activities.mjs
  • components/quickbooks/actions/search-products/search-products.mjs
  • components/quickbooks/actions/search-accounts/search-accounts.mjs
  • components/quickbooks/sources/new-employee-updated/new-employee-updated.mjs
  • components/quickbooks/actions/get-time-activity/get-time-activity.mjs
  • components/quickbooks/actions/create-ap-aging-report/create-ap-aging-report.mjs
  • components/quickbooks/sources/new-invoice-updated/new-invoice-updated.mjs
  • components/quickbooks/actions/get-purchase-order/get-purchase-order.mjs
  • components/quickbooks/actions/search-vendors/search-vendors.mjs
  • components/quickbooks/actions/get-invoice/get-invoice.mjs
  • components/quickbooks/actions/update-item/update-item.mjs
  • components/quickbooks/actions/search-invoices/search-invoices.mjs
  • components/quickbooks/actions/get-bill/get-bill.mjs
  • components/quickbooks/actions/search-query/search-query.mjs
  • components/quickbooks/actions/create-bill/create-bill.mjs
  • components/quickbooks/actions/update-customer/update-customer.mjs
  • components/quickbooks/actions/get-sales-receipt/get-sales-receipt.mjs
  • components/quickbooks/actions/create-sales-receipt/create-sales-receipt.mjs
  • components/quickbooks/actions/create-invoice/create-invoice.mjs
  • components/quickbooks/actions/create-customer/create-customer.mjs
  • components/quickbooks/package.json
  • components/quickbooks/actions/search-services/search-services.mjs
  • components/quickbooks/actions/get-my-company/get-my-company.mjs
  • components/quickbooks/actions/search-customers/search-customers.mjs
  • components/quickbooks/sources/new-invoice-created/new-invoice-created.mjs
  • components/quickbooks/actions/get-payment/get-payment.mjs
  • components/quickbooks/actions/create-purchase/create-purchase.mjs
  • components/quickbooks/actions/get-customer/get-customer.mjs
  • components/quickbooks/sources/new-customer-created/new-customer-created.mjs
  • components/quickbooks/actions/get-purchase/get-purchase.mjs
  • components/quickbooks/actions/create-pl-report/create-pl-report.mjs
  • components/quickbooks/actions/create-payment/create-payment.mjs
  • components/quickbooks/sources/new-item-created/new-item-created.mjs
  • components/quickbooks/actions/search-items/search-items.mjs
  • components/quickbooks/actions/search-purchases/search-purchases.mjs
  • components/quickbooks/sources/new-employee-created/new-employee-created.mjs
  • components/quickbooks/sources/new-customer-updated/new-customer-updated.mjs
  • components/quickbooks/sources/new-item-updated/new-item-updated.mjs
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: pnpm publish
🔇 Additional comments (5)
components/quickbooks/quickbooks.app.mjs (1)

Line range hint 454-467: LGTM! API version pinning implemented correctly.

The changes properly implement the PR objective by pinning all API requests to minorversion 75. The implementation:

  • Correctly adds the params parameter to allow for additional query parameters
  • Properly merges custom params with the minorversion parameter
  • Maintains backward compatibility with existing calls

Let's verify that no API calls bypass the _makeRequest method:

✅ Verification successful

Version pinning implementation verified - all API calls use _makeRequest

The codebase analysis confirms that all QuickBooks API requests are made through the _makeRequest method, ensuring the minorversion parameter is consistently applied across all API calls. No direct axios calls bypassing _makeRequest were found in the QuickBooks component.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for direct axios calls that might bypass _makeRequest
rg -l "axios\(" --type js --type mjs . | grep -v "quickbooks\.app\.mjs"

Length of output: 101


Script:

#!/bin/bash
# Search for direct axios calls using AST pattern matching
ast-grep --pattern 'axios($$$)'

# Also search with ripgrep without file type filtering
rg "axios\(" -l

Length of output: 65946

components/quickbooks/actions/delete-purchase/delete-purchase.mjs (2)

7-7: Version bump aligns with API changes.

Version increment from 0.0.5 to 0.0.6 appropriately reflects the underlying API version changes.


19-24: LGTM! Improved purchase ID handling.

The changes improve robustness by:

  • Properly handling both purchaseId.value and direct purchaseId
  • Safely retrieving SyncToken through getPurchase instead of direct extraction
components/quickbooks/actions/sparse-update-invoice/sparse-update-invoice.mjs (2)

9-9: Version bump aligns with API changes.

Version increment from 0.1.5 to 0.1.6 appropriately reflects the underlying API version changes.


115-115: LGTM! Fixed array handling with spread operator.

The change from push(lines) to push(...lines) fixes a potential nested array issue by properly spreading the line items into the invoice lines array.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 michelle0927 marked this pull request as ready for review January 22, 2025 21:40
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!

@michelle0927 michelle0927 merged commit 2c1ae19 into master Jan 23, 2025
11 checks passed
@michelle0927 michelle0927 deleted the issue-15362 branch January 23, 2025 15:33
michelle0927 added a commit that referenced this pull request Jan 27, 2025
* update package.json & component versions

* pnpm-lock.yaml
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ACTION] Figure out action required for Intuit Quickbooks API version changes
2 participants