New Components - opnform

[luancazarine]

Resolves #15639.

Summary by CodeRabbit

• New Features

  • Enabled dynamic selection of workspaces and forms for a more seamless submission experience.
  • Integrated webhook support for real-time notifications and automated event handling.
  • Launched an instant event trigger that captures and processes form submissions as they occur.

• Chores

  • Upgraded the platform version and updated dependencies for improved performance.
  • Added a sample event structure to assist with testing and demonstration.

[vercel]

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 26, 2025 2:52pm
pipedream-docs	⬜️ Ignored (Inspect)			Feb 26, 2025 2:52pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Feb 26, 2025 2:52pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request enhances the opnform component functionality by introducing new properties (workspaceId and formId) with dynamic options methods that fetch workspaces and forms. Several helper methods for constructing API requests and managing authorization have been added, including _baseUrl, _headers, and _makeRequest. Additionally, webhook management methods (createWebhook and deleteWebhook) have been introduced. A new module for instant form submission events has been created with lifecycle hooks to activate and deactivate webhooks, as well as a test event module.

Changes

File(s)	Change Summary
components/opnform/opnform.app.mjs	Added new propDefinitions properties (workspaceId, formId) with asynchronous options; introduced helper methods (_baseUrl, _headers, _makeRequest, listForms, listWorkspaces, createWebhook, and deleteWebhook).
components/opnform/package.json	Updated version from 0.0.1 to 0.1.0; added a dependency for @pipedream/platform and adjusted the publishConfig section.
components/opnform/sources/.../new-submission-instant.mjs components/opnform/sources/.../test-event.mjs	Introduced a new source module to handle form submission events with lifecycle hooks for webhook management and a test event module defining a sample submission structure with deprecation details.

Sequence Diagram(s)

sequenceDiagram
    participant NSI as New Submission Module
    participant Opn as Opnform Module
    participant API as API Service

    NSI->>Opn: Activate hook (createWebhook with hookUrl & formId)
    Opn->>API: POST request to create webhook
    API-->>Opn: Webhook created response
    Note over NSI,Opn: Waiting for form submission event
    NSI->>NSI: Process submission event (run)
    NSI->>Opn: Deactivate hook (deleteWebhook with hookUrl & formId)
    Opn->>API: POST request to delete webhook
    API-->>Opn: Webhook deleted response

Loading

Possibly related PRs

• New Components - waitlist #12846: Involves modifications to propDefinitions and API interaction methods similar to the current changes.
• New Components - formcarry #14277: Introduces similar properties (formId, workspaceId) and webhook-related methods for handling form submissions.
• New Components - highergov #14066: Implements webhook management via API requests, paralleling the newly added createWebhook and deleteWebhook methods.

Suggested reviewers

• michelle0927

Poem

Hopping through code with a joyful heart,
I discovered new paths where webhooks start.
With forms and workspaces put in a neat row,
My API adventures begin to glow.
CodeRabbit leaps with every clever part!
🐇💻

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/opnform/opnform.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)

components/opnform/sources/new-submission-instant/test-event.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/opnform/sources/new-submission-instant/new-submission-instant.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 1427969 and b1aeb77.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (4)

• components/opnform/opnform.app.mjs (1 hunks)
• components/opnform/package.json (2 hunks)
• components/opnform/sources/new-submission-instant/new-submission-instant.mjs (1 hunks)
• components/opnform/sources/new-submission-instant/test-event.mjs (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[jcortes]

Hi @luancazarine lgtm! Ready for QA!