New Components - stiply #17551
New Components - stiply #17551
Conversation
WalkthroughThe changes introduce a new Stiply integration, adding an action to send sign requests and a polling source to emit events when sign requests are completed. Supporting utility functions, API client methods, and test event data are implemented. Minor formatting changes (newlines) are also applied to unrelated component files. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant SendSignRequestAction
participant StiplyApp
participant StiplyAPI
User->>SendSignRequestAction: Provide sign request details
SendSignRequestAction->>StiplyApp: sendSignRequest(details)
StiplyApp->>StiplyAPI: POST /sign_requests
StiplyAPI-->>StiplyApp: Sign request created (ID)
StiplyApp-->>SendSignRequestAction: API response
SendSignRequestAction-->>User: Summary & response
sequenceDiagram
participant PollingSource
participant StiplyApp
participant StiplyAPI
participant EventStream
PollingSource->>StiplyApp: listSignRequests(status="completed")
StiplyApp->>StiplyAPI: GET /sign_requests?status=completed
StiplyAPI-->>StiplyApp: List of completed sign requests
StiplyApp-->>PollingSource: Completed sign requests
PollingSource->>EventStream: Emit event for each completed request
Assessment against linked issues
Poem
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
components/stiply/actions/send-sign-request/send-sign-request.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/stiply/sources/new-sign-request-completed/new-sign-request-completed.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
components/stiply/actions/send-sign-request/send-sign-request.mjs (1)
90-90: Fix summary message formatting.The summary message uses a semicolon instead of a colon, which affects readability.
Apply this diff to fix the formatting:
- $.export("$summary", `Sign request with ID; ${response.data.id} sent successfully`); + $.export("$summary", `Sign request with ID ${response.data.id} sent successfully`);components/stiply/stiply.app.mjs (1)
36-61: Consider renamingtotalvariable for clarity.The variable
totalactually represents the current page's item count, not the total items across all pages. This naming could be confusing.- let total, count = 0; + let pageItemCount, count = 0; do { const { data } = await fn({ params, }); - total = data?.length; - if (!total) { + pageItemCount = data?.length; + if (!pageItemCount) { return; } for (const item of data) { yield item; if (max && ++count >= max) { return; } } params["$page"]++; - } while (total === params["$page_size"]); + } while (pageItemCount === params["$page_size"]);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (10)
components/qr_api/qr_api.app.mjs(1 hunks)components/stiply/actions/send-sign-request/send-sign-request.mjs(1 hunks)components/stiply/common/utils.mjs(1 hunks)components/stiply/package.json(1 hunks)components/stiply/sources/new-sign-request-completed/new-sign-request-completed.mjs(1 hunks)components/stiply/sources/new-sign-request-completed/test-event.mjs(1 hunks)components/stiply/stiply.app.mjs(1 hunks)components/sylius/sylius.app.mjs(1 hunks)components/the_official_board/the_official_board.app.mjs(1 hunks)components/walletap/walletap.app.mjs(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
components/stiply/sources/new-sign-request-completed/new-sign-request-completed.mjs (3)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common.mjs:97-98
Timestamp: 2024-07-24T02:05:59.531Z
Learning: The `processTimerEvent` method in the `components/salesforce_rest_api/sources/common.mjs` file is intentionally left unimplemented to enforce that subclasses must implement this method, similar to an abstract class in object-oriented programming.
components/stiply/sources/new-sign-request-completed/test-event.mjs (3)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-10-08T15:33:38.240Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-07-24T02:06:47.016Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
components/stiply/package.json (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#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.
components/stiply/actions/send-sign-request/send-sign-request.mjs (2)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
components/stiply/stiply.app.mjs (1)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#16954
File: components/salesloft/salesloft.app.mjs:14-23
Timestamp: 2025-06-04T17:52:05.780Z
Learning: In the Salesloft API integration (components/salesloft/salesloft.app.mjs), the _makeRequest method returns response.data which directly contains arrays for list endpoints like listPeople, listCadences, listUsers, and listAccounts. The propDefinitions correctly call .map() directly on these responses without needing to destructure a nested data property.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: pnpm publish
- GitHub Check: Verify TypeScript components
- GitHub Check: Publish TypeScript components
- GitHub Check: Lint Code Base
🔇 Additional comments (13)
components/the_official_board/the_official_board.app.mjs (1)
11-12: Trailing newline addition looks goodPOSIX-style trailing newline prevents potential EOF issues and satisfies common linters. No further action required.
components/walletap/walletap.app.mjs (1)
11-12: Trailing newline addition looks goodConsistent with code-style guidelines and avoids diffs on future edits.
components/qr_api/qr_api.app.mjs (1)
11-12: Trailing newline addition looks goodMaintains consistency and satisfies linters.
components/sylius/sylius.app.mjs (1)
11-12: Trailing newline addition looks goodNo functional impact; keeps file POSIX-compliant.
components/stiply/package.json (1)
15-17: LGTM! Dependency addition is correct.The
@pipedream/platformdependency is properly added and needed for theDEFAULT_POLLING_SOURCE_TIMER_INTERVALconstant used in the source component.components/stiply/common/utils.mjs (1)
1-25: LGTM! Well-implemented utility function.The
parseObjectfunction correctly handles all data types with proper error handling for JSON parsing and recursive processing for nested structures. The implementation is robust and follows good functional programming practices.components/stiply/sources/new-sign-request-completed/test-event.mjs (1)
1-22: LGTM! Comprehensive test event data.The test event object provides a realistic and complete representation of a completed sign request with all necessary fields for testing the source component.
components/stiply/sources/new-sign-request-completed/new-sign-request-completed.mjs (1)
1-45: LGTM! Well-structured source component.The polling source correctly implements the timer interface, properly filters for completed sign requests, handles pagination, and emits events with appropriate metadata. The "unique" dedupe strategy is suitable for this use case.
components/stiply/actions/send-sign-request/send-sign-request.mjs (1)
1-93: LGTM! Comprehensive action implementation.The action component is well-structured with thorough property definitions, proper use of the parseObject utility, and correct API integration. The component follows Pipedream patterns and provides good user experience with detailed descriptions.
components/stiply/stiply.app.mjs (4)
1-7: LGTM! Standard Pipedream app structure.The import and basic app configuration follow the expected pattern.
8-22: Well-structured API client implementation.The base URL and request method are properly implemented with OAuth authentication and appropriate headers.
23-35: RESTful API methods implemented correctly.Both methods properly delegate to
_makeRequestwith the appropriate HTTP methods for listing (GET) and creating (POST) sign requests.
62-68: Clean implementation of pagination helper.The method correctly collects all paginated results using the async generator pattern.
components/stiply/actions/send-sign-request/send-sign-request.mjs
Outdated
Show resolved
Hide resolved
|
/approve |
|
/approve |
Resolves #17280
Note to QA (@vunguyenhung) - I haven't been able to test
send-sign-requestbecause I haven't been able to successfully create a file URL that has "signature fields for all signers".Summary by CodeRabbit
New Features
Chores