Skip to content

Conversation

@PrajwalLokhande2003
Copy link
Contributor

@PrajwalLokhande2003 PrajwalLokhande2003 commented Nov 3, 2025

WHY

Summary by CodeRabbit

  • New Features

    • Lead Stage Support: specify a lead stage when creating leads to have the stage applied automatically.
  • Chores

    • App/actions package updated: action versions and package version bumped; platform dependency updated.

@vercel
Copy link

vercel bot commented Nov 3, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
pipedream-docs-redirect-do-not-edit Ignored Ignored Nov 4, 2025 6:43pm

@adolfo-pd adolfo-pd added the User submitted Submitted by a user label Nov 3, 2025
@pipedream-component-development
Copy link
Collaborator

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2025

Walkthrough

Added a new optional leadStage/stage property to the Hyros app and the Create Lead action; action version bumps and a package.json version/dependency update were also included. The stage value is passed through into the lead creation payload when provided.

Changes

Cohort / File(s) Summary
Hyros app manifest
components/hyros/hyros.app.mjs
Added new public prop definition leadStage (type: string, label: "Lead Stage", description: "The name of a stage to be applied to the lead").
Create Lead action
components/hyros/actions/create-lead/create-lead.mjs
Bumped action version to 0.0.3; added optional public prop stage (propDefinition referencing hyros, "leadStage") and included stage in the data payload passed to the API when provided.
Create Call action
components/hyros/actions/create-call/create-call.mjs
Bumped action version from 0.0.2 to 0.0.3 (no functional changes).
Package manifest
components/hyros/package.json
Bumped package version 0.1.00.1.1 and updated dependency @pipedream/platform ^1.5.1^3.1.0.

Sequence Diagram(s)

sequenceDiagram
  participant UI as User / Workflow
  participant Action as Create Lead Action
  participant App as Hyros App (manifest)
  participant API as Hyros API

  rect rgb(220,235,255)
    UI->>Action: invoke action (props + optional stage)
    Action->>App: read propDefinition leadStage (if not supplied)
    Action->>Action: build data payload {..., stage: stage?}
  end

  rect rgb(220,255,235)
    Action->>API: POST /leads with payload (includes stage when present)
    API-->>Action: 200 / lead created
    Action-->>UI: return result
  end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Attention points:
    • Verify the stage prop name mapping between leadStage (app prop) and action prop (stage) is consistent.
    • Confirm payload schema accepted by Hyros API includes stage and no validation changes are needed.
    • Review package.json dependency bump for any required code adjustments or build changes.

Poem

🐰 I hopped through code with nimble feet,
A stage added where lead and data meet.
Versions nudged, a gentle tweak — hooray!
New fields pass through to brighten the day. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete and contains only a placeholder comment with no substantive content provided by the author. Complete the WHY section with a clear explanation of why this change is needed, what problem it solves, and the context for adding the stage field to the create lead action.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly describes the main change: adding a stage field to the hyros create lead action, which aligns with the changeset.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@pipedream-component-development
Copy link
Collaborator

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:

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 (1)
components/hyros/hyros.app.mjs (1)

32-36: Add trailing period for consistency.

The description should end with a period to match the style of other propDefinitions in this file (see lines 10, 15, 20, 25, 30).

Apply this diff:

     leadStage: {
       type: "string",
       label: "Lead Stage",
-      description: "The name of a stage to be applied to the lead",
+      description: "The name of a stage to be applied to the lead.",
     },
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f7145f and ce13bd3.

📒 Files selected for processing (2)
  • components/hyros/actions/create-lead/create-lead.mjs (1 hunks)
  • components/hyros/hyros.app.mjs (1 hunks)
🔇 Additional comments (1)
components/hyros/actions/create-lead/create-lead.mjs (1)

58-64: API support for leadStage parameter confirmed.

The Hyros Create Lead endpoint supports a lead stage (the "Lead Stage" / stage field), and the implementation correctly includes leadStage in the API payload through the spread operator.

@michelle0927 michelle0927 linked an issue Nov 4, 2025 that may be closed by this pull request
@michelle0927 michelle0927 self-requested a review November 4, 2025 18:16
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 (1)
components/hyros/package.json (1)

3-3: Reconsider the version bump strategy.

Adding a new optional field is a feature addition, which typically warrants a minor version bump (0.1.0 → 0.2.0), not a patch bump (0.1.0 → 0.1.1). Per semantic versioning, patch bumps are reserved for backward-compatible bug fixes.

If this is intentional (e.g., the field is considered internal), then please clarify the versioning strategy. Otherwise, consider bumping to 0.2.0:

-  "version": "0.1.1",
+  "version": "0.2.0",
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce13bd3 and 35979c5.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • components/hyros/actions/create-call/create-call.mjs (1 hunks)
  • components/hyros/actions/create-lead/create-lead.mjs (2 hunks)
  • components/hyros/package.json (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/hyros/actions/create-call/create-call.mjs
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/hyros/actions/create-lead/create-lead.mjs
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-12-12T19:23:09.039Z
Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.

Applied to files:

  • components/hyros/package.json
🔇 Additional comments (1)
components/hyros/package.json (1)

16-16: Compatibility with v3.1.0 confirmed; no changes required.

The upgrade from @pipedream/platform@^1.5.1 to ^3.1.0 is safe for this codebase. The implementation uses only stable platform exports:

  • axios: Low-level HTTP utility wrapper—remains stable across major versions
  • ConfigurationError: Simple exception class—compatible across versions
  • propDefinition pattern: Standard SDK feature used with basic types; no advanced typing affected by v3 breaking changes

The code avoids areas with breaking changes in v3 (client initialization, pagination metadata, complex ConfigurableProp typing), making the version bump compatible. Action versions at 0.0.3 are appropriate for this migration.

Copy link
Collaborator

@michelle0927 michelle0927 left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution! LGTM! Ready for QA

@vunguyenhung
Copy link
Collaborator

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

Test reports

@michelle0927 michelle0927 merged commit 76a26f6 into PipedreamHQ:master Nov 5, 2025
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

User submitted Submitted by a user

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add new Field for Hyros Create Lead Action

5 participants