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

Jobber API version update #15610

Merged
merged 3 commits into from
Feb 19, 2025
Merged

Jobber API version update #15610

merged 3 commits into from
Feb 19, 2025

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Feb 13, 2025

Resolves #15599

Summary by CodeRabbit

  • Chores
    • Updated module versions for client, quote, and request actions.
    • Upgraded the application’s integration with a new GraphQL API version.
    • Refreshed the package release with updated version and dependency requirements.
  • Documentation
    • Updated descriptions for the quote generation action.

Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

This pull request updates multiple version numbers across the Jobber components. The action modules (create-client, create-quote, and create-request) have their version bumped from "0.0.1" to "0.0.2". Additionally, the description of the create-quote action is modified, and a new function is added to its propertyId prop definition. The GraphQL API header in jobber.app.mjs is updated from "2023-11-15" to "2025-01-20". Finally, the package.json file reflects a package version update from "0.1.0" to "0.1.1" along with a dependency update for @pipedream/platform from ^1.6.0 to ^3.0.3.

Changes

File(s) Change Summary
`components/jobber/actions/.../create-[client request].mjs`
components/jobber/actions/create-quote/create-quote.mjs Version updated from "0.0.1" to "0.0.2", description modified, and new function added to propertyId prop definition.
components/jobber/…/jobber.app.mjs Updated X-JOBBER-GRAPHQL-VERSION header from "2023-11-15" to "2025-01-20" and modified propertyId method signature to accept clientId.
components/jobber/package.json Package version bumped from "0.1.0" to "0.1.1" and dependency @pipedream/platform updated from ^1.6.0 to ^3.0.3.

Possibly related PRs

  • Gmail - bump action versions #13089: The changes in the main PR, which involve updating version numbers of exported modules, are related to the changes in the retrieved PR that also focus on version updates for Gmail actions, indicating a similar type of modification at the code level.

Suggested labels

dependencies, User submitted

Suggested reviewers

  • lcaresia

Poem

I'm a little bunny hopping by,
Celebrating updates that catch the eye,
Versions jump from old to new,
In each file, a change so true,
Carrots crunching with each line of code,
🐇 Here's to a smooth and merry road!

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/jobber/actions/create-quote/create-quote.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 packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

components/jobber/jobber.app.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 packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


📜 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 e93f176 and 1f9331f.

📒 Files selected for processing (2)
  • components/jobber/actions/create-quote/create-quote.mjs (2 hunks)
  • components/jobber/jobber.app.mjs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/jobber/actions/create-quote/create-quote.mjs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Verify TypeScript components
  • GitHub Check: pnpm publish
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (1)
components/jobber/jobber.app.mjs (1)

38-41: LGTM! Clean implementation of client-based property filtering.

The changes effectively implement conditional filtering of properties based on the client ID, with clean template literal usage and proper null handling.

Also applies to: 45-45

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

Copy link

vercel bot commented Feb 13, 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 Feb 18, 2025 6:37pm
pipedream-docs ⬜️ Ignored (Inspect) Feb 18, 2025 6:37pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Feb 18, 2025 6:37pm

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7e0a32b and e93f176.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (5)
  • components/jobber/actions/create-client/create-client.mjs (1 hunks)
  • components/jobber/actions/create-quote/create-quote.mjs (1 hunks)
  • components/jobber/actions/create-request/create-request.mjs (1 hunks)
  • components/jobber/jobber.app.mjs (1 hunks)
  • components/jobber/package.json (2 hunks)
✅ Files skipped from review due to trivial changes (3)
  • components/jobber/actions/create-client/create-client.mjs
  • components/jobber/actions/create-quote/create-quote.mjs
  • components/jobber/actions/create-request/create-request.mjs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: pnpm publish
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (2)
components/jobber/package.json (2)

3-3: LGTM!

The minor version bump (0.1.0 → 0.1.1) is appropriate for backward-compatible changes like updating the API version.


16-16:

❓ Verification inconclusive

Verify compatibility with @pipedream/platform v3.

The major version bump (1.x → 3.x) of @pipedream/platform suggests breaking changes. Please verify:

  1. Compatibility with the new version
  2. Required migration steps
  3. Impact on existing functionality

🌐 Web query:

What are the breaking changes in @pipedream/platform v3.0.3?

💡 Result:

The provided search results do not explicitly mention breaking changes in @pipedream/platform v3.0.3. However, based on general patterns observed in Pipedream's migration guides and version updates:

  1. Code Scaffolding Changes

    • In v2 workflows, code steps are wrapped in defineComponent, replacing the previous inline function syntax[2]. For example:
      // Old (v1)
      async (event, steps) => { ... }
      
      // New (v2)
      defineComponent({
        async run({ steps, $ }) { ... }
      });
    • Access to trigger events now requires steps.trigger.event instead of direct event parameter[2].
  2. Deprecated Features

    • $checkpoint functionality was replaced by Data Stores[2].
    • Special variables like $end were remapped (e.g., $.flow.exit)[2].
  3. Parameter Handling

    • Props must now be explicitly defined within components using a structured schema[2]:
      props: {
        firstName: { type: "string", label: "First Name" }
      }

For specifics about @pipedream/platform v3.0.3, consult the official npm changelog or Pipedream's documentation[7][10].

Citations:


Action Required: Confirm Compatibility with @pipedream/platform v3

Based on the available migration resources, while there isn’t explicit documentation calling out unique breaking changes for v3.0.3, typical updates in Pipedream’s platform indicate several areas to verify:

  • Code Scaffolding: Ensure that any workflow or component implementations now follow the new pattern (e.g., using defineComponent rather than inline function signatures, and referencing trigger events via steps.trigger.event).
  • Deprecated Features: Check if your code still relies on features like $checkpoint or legacy special variables (e.g., $end) that might have been replaced.
  • Parameter Handling: Confirm that component properties are defined using the updated structured schema.

Please review your implementation, test the related functionality, and update your migration steps if necessary using the guides available on Pipedream's documentation and the npm changelog.

lcaresia
lcaresia previously approved these changes Feb 17, 2025
@michelle0927
Copy link
Collaborator Author

/approve

@michelle0927 michelle0927 merged commit 961cbf6 into master Feb 19, 2025
11 checks passed
@michelle0927 michelle0927 deleted the issue-15599 branch February 19, 2025 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Jobber API version update
2 participants