Skip to content

[Components] parsehub #13329 #16948

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[Components] parsehub #13329 #16948

wants to merge 3 commits into from

Conversation

lcaresia
Copy link
Collaborator

@lcaresia lcaresia commented Jun 3, 2025

WHY

Summary by CodeRabbit

  • New Features
    • Added the ability to cancel a specific ParseHub run using its run token.
    • Introduced a feature to delete a ParseHub run and its associated data.
    • Enabled listing all projects in a ParseHub account, with optional pagination support (offset and limit).

@lcaresia lcaresia self-assigned this Jun 3, 2025
Copy link

vercel bot commented Jun 3, 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 3, 2025 7:03pm
pipedream-docs ⬜️ Ignored (Inspect) Jun 3, 2025 7:03pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 3, 2025 7:03pm

Copy link
Contributor

coderabbitai bot commented Jun 3, 2025

Walkthrough

Three new action modules were introduced for the ParseHub integration: "Cancel Run," "Delete Run," and "Get Projects." The ParseHub app definition was updated to support these actions by adding pagination properties and new methods for canceling and deleting runs. Each action interacts with the ParseHub API to perform its respective function.

Changes

File(s) Change Summary
components/parsehub/actions/cancel-run/cancel-run.mjs Added new "Cancel Run" action module to cancel a specific run by run token.
components/parsehub/actions/delete-run/delete-run.mjs Added new "Delete Run" action module to cancel and delete a run by run token.
components/parsehub/actions/get-projects/get-projects.mjs Added new "Get Projects" action module to list all projects with optional pagination.
components/parsehub/parsehub.app.mjs Added offset and limit prop definitions; implemented cancelRun and deleteRun async methods.
components/parsehub/package.json Updated package version from 0.1.1 to 0.2.0.
components/parsehub/actions/get-data-run/get-data-run.mjs, Updated version numbers from 0.0.2 to 0.0.3 in "Get Data for a Run," "Get Project," and "Run Project" actions.
components/parsehub/actions/get-project/get-project.mjs,
components/parsehub/actions/run-project/run-project.mjs

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ActionModule
    participant ParseHubApp
    participant ParseHubAPI

    User->>ActionModule: Trigger "Cancel Run" or "Delete Run"
    ActionModule->>ParseHubApp: Call cancelRun/deleteRun(runToken)
    ParseHubApp->>ParseHubAPI: POST/DELETE /runs/{runToken}/cancel or /runs/{runToken}
    ParseHubAPI-->>ParseHubApp: API Response
    ParseHubApp-->>ActionModule: Return response
    ActionModule-->>User: Output summary and API response
Loading
sequenceDiagram
    participant User
    participant GetProjectsAction
    participant ParseHubApp
    participant ParseHubAPI

    User->>GetProjectsAction: Trigger "Get Projects" (with optional offset/limit)
    GetProjectsAction->>ParseHubApp: listProjects(offset, limit)
    ParseHubApp->>ParseHubAPI: GET /projects?offset=&limit=
    ParseHubAPI-->>ParseHubApp: Projects list
    ParseHubApp-->>GetProjectsAction: Return projects
    GetProjectsAction-->>User: Output summary and projects list
Loading

Poem

In burrows deep, new actions grow,
Cancel, delete, or fetch—off we go!
ParseHub’s powers now expand,
With tokens and lists at your command.
The rabbit hops with cheerful pride,
For API magic, code supplied!
🐇✨

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/parsehub/actions/get-data-run/get-data-run.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:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:170:49)

components/parsehub/actions/get-project/get-project.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:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:170:49)

components/parsehub/actions/run-project/run-project.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:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:170: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 e70edd9 and 6599f4b.

📒 Files selected for processing (3)
  • components/parsehub/actions/get-data-run/get-data-run.mjs (1 hunks)
  • components/parsehub/actions/get-project/get-project.mjs (1 hunks)
  • components/parsehub/actions/run-project/run-project.mjs (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • components/parsehub/actions/run-project/run-project.mjs
  • components/parsehub/actions/get-data-run/get-data-run.mjs
  • components/parsehub/actions/get-project/get-project.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
✨ 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.

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

🧹 Nitpick comments (2)
components/parsehub/parsehub.app.mjs (2)

32-43: Consider using integer types for pagination parameters.

The offset and limit props are defined as strings, but pagination parameters are typically numeric values. Consider changing these to integer type for better type safety and API consistency.

-    offset: {
-      type: "string",
+    offset: {
+      type: "integer",
       label: "Offset",
       description: "Specifies the offset from which to start listing the projects",
       optional: true,
     },
-    limit: {
-      type: "string",
+    limit: {
+      type: "integer",
       label: "Limit",
       description: "Specifies how many entries will be returned in the list",
       optional: true,
     },

96-113: Consider using uppercase HTTP method names for consistency.

While axios accepts both cases, it's conventional to use uppercase HTTP method names for better readability and consistency with HTTP standards.

     async cancelRun({
       runToken, ...args
     }) {
       return this._makeRequest({
         path: `/runs/${runToken}/cancel`,
-        method: "post",
+        method: "POST",
         ...args,
       });
     },
     async deleteRun({
       runToken, ...args
     }) {
       return this._makeRequest({
         path: `/runs/${runToken}`,
-        method: "delete",
+        method: "DELETE",
         ...args,
       });
     },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a7211d1 and 0d24898.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • components/parsehub/actions/cancel-run/cancel-run.mjs (1 hunks)
  • components/parsehub/actions/delete-run/delete-run.mjs (1 hunks)
  • components/parsehub/actions/get-projects/get-projects.mjs (1 hunks)
  • components/parsehub/parsehub.app.mjs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Verify TypeScript components
  • GitHub Check: pnpm publish
  • GitHub Check: Lint Code Base
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (3)
components/parsehub/actions/cancel-run/cancel-run.mjs (1)

1-26: LGTM! Well-structured action implementation.

The action follows Pipedream conventions correctly:

  • Proper import and prop definitions
  • Clear documentation with API reference link
  • Appropriate error handling delegation to the app method
  • Informative summary message
components/parsehub/actions/get-projects/get-projects.mjs (1)

1-35: LGTM! Pagination implementation is correct.

The action properly:

  • Uses optional pagination parameters from prop definitions
  • Passes parameters correctly in the params object to the API call
  • Includes appropriate documentation reference
  • Follows standard Pipedream action patterns
components/parsehub/actions/delete-run/delete-run.mjs (1)

1-26: LGTM! Consistent implementation with other actions.

The delete run action is well-implemented:

  • Consistent structure with the cancel run action
  • Proper use of prop definitions and app methods
  • Clear documentation with API reference
  • Appropriate summary message for the destructive operation

@lcaresia lcaresia linked an issue Jun 3, 2025 that may be closed by this pull request
Copy link
Collaborator

@luancazarine luancazarine left a comment

Choose a reason for hiding this comment

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

Hi @lcaresia, LGTM! Ready for QA!

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.

[Components] parsehub
2 participants