Canny - new components #19474

michelle0927 · 2025-12-12T17:04:33Z

Resolves #13310

Summary by CodeRabbit

New Features
- Added Canny integration with four new actions: Create Post, Create Comment, Change Post Status, and Get Post
- Added three new event sources: New Comment Created, New Vote Created, and Post Status Changed for automated workflows
- Enabled dynamic filtering and pagination across Canny resources (boards, posts, users, categories, tags, etc.)

_{✏️ Tip: You can customize this high-level summary in your review settings.}

vercel · 2025-12-12T17:04:39Z

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			Dec 12, 2025 5:04pm

coderabbitai · 2025-12-12T17:04:59Z

Walkthrough

Introduces a comprehensive Canny integration including four action modules for post and comment management, three polling-based event sources, a core app component with API methods and pagination, and a utility function for JSON parsing. Version bumped to 0.7.0.

Changes

Cohort / File(s)	Summary
Action Modules `components/canny/actions/change-post-status/change-post-status.mjs`, `components/canny/actions/create-comment/create-comment.mjs`, `components/canny/actions/create-post/create-post.mjs`, `components/canny/actions/get-post/get-post.mjs`	New action modules exporting default configuration objects. Change Post Status updates post status with notifications. Create Comment requires value or imageUrls with validation. Create Post maps inputs to API fields including custom fields parsing. Get Post retrieves post by ID or URL.
Core App Integration `components/canny/canny.app.mjs`	Introduces base HTTP layer with `_baseUrl()` and `_makeRequest()` using axios. Adds 12 public API methods (get, list, create, update operations) and async generator `paginate()` for handling paged results. Expands propDefinitions with dynamic options for boardId, postId, userId, companyId, tagId, categoryId, and commentId with server-side paging support.
Polling Source Base `components/canny/sources/common/base-polling.mjs`	New reusable base component implementing polling workflow. Tracks last-processed timestamp in database, filters items by timestamp, emits events with generated metadata. Provides abstract methods (getResourceFn, getResourceKey, generateMeta) for subclass implementation.
Event Source Modules `components/canny/sources/new-comment-created/new-comment-created.mjs`, `components/canny/sources/new-vote-created/new-vote-created.mjs`, `components/canny/sources/post-status-changed/post-status-changed.mjs`	Three polling-based sources extending base component. New Comment Created and New Vote Created support optional filtering by board, author/user, company, and post. Post Status Changed supports optional board filtering. Each generates event metadata with id, summary, and timestamp.
Utilities & Version `components/canny/common/utils.mjs`, `components/canny/package.json`	New `parseObject()` export providing recursive JSON parsing for strings, arrays, and objects. Version bumped from 0.6.0 to 0.7.0.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

canny.app.mjs: Pagination logic with async generators, dynamic prop resolution, and centralized request handling require careful review for edge cases and error propagation
sources/common/base-polling.mjs: Base class design with abstract methods and timestamp tracking logic; verify ConfigurationError handling and state persistence
Action validation logic: Confirm required field validation (e.g., value/imageUrls in create-comment) and configuration error flows
Data mapping: Review field transformations across all modules (camelCase ↔ PascalCase for API params) for consistency

Suggested labels

action, trigger / source

Suggested reviewers

GTFalcao

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description only contains 'Resolves #13310' and is missing the WHY section from the required template that explains the business context, rationale, and motivation for the changes.	Add a 'WHY' section to the description explaining the purpose and context of implementing these new Canny components.
Linked Issues check	⚠️ Warning	The PR implements only 4 of 7 required features from #13310: missing 'new-comment-instant' and 'new-vote-instant' sources with post id requirement, and 'find-post' action with post_id/title requirement.	Implement the missing sources (new-comment-instant, new-vote-instant) and action (find-post) with their required props as specified in #13310.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title 'Canny - new components' accurately summarizes the main change: introducing new Canny integration components for actions and sources.
Out of Scope Changes check	✅ Passed	All code changes are in scope: new Canny actions (change-post-status, create-comment, create-post, get-post), sources (polling base, new-comment-created, new-vote-created, post-status-changed), utilities, and supporting infrastructure align with the objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch issue-13310

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.}

coderabbitai

Actionable comments posted: 9

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 080d445 and 3eb1cba.

📒 Files selected for processing (11)

components/canny/actions/change-post-status/change-post-status.mjs (1 hunks)
components/canny/actions/create-comment/create-comment.mjs (1 hunks)
components/canny/actions/create-post/create-post.mjs (1 hunks)
components/canny/actions/get-post/get-post.mjs (1 hunks)
components/canny/canny.app.mjs (1 hunks)
components/canny/common/utils.mjs (1 hunks)
components/canny/package.json (1 hunks)
components/canny/sources/common/base-polling.mjs (1 hunks)
components/canny/sources/new-comment-created/new-comment-created.mjs (1 hunks)
components/canny/sources/new-vote-created/new-vote-created.mjs (1 hunks)
components/canny/sources/post-status-changed/post-status-changed.mjs (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📚 Learning: 2024-10-10T19:18:27.998Z

Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 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.

Applied to files:

components/canny/sources/common/base-polling.mjs

📚 Learning: 2025-06-04T17:52:05.780Z

Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 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.

Applied to files:

components/canny/canny.app.mjs

📚 Learning: 2025-09-15T22:01:11.472Z

Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 18362
File: components/leonardo_ai/actions/generate-image/generate-image.mjs:103-105
Timestamp: 2025-09-15T22:01:11.472Z
Learning: In Pipedream components, pipedream/platform's axios implementation automatically excludes undefined values from HTTP requests, so there's no need to manually check for truthiness before including properties in request payloads.

Applied to files:

components/canny/canny.app.mjs

🧬 Code graph analysis (6)

components/canny/actions/get-post/get-post.mjs (3)

components/canny/actions/change-post-status/change-post-status.mjs (1)

response (60-68)

components/canny/actions/create-comment/create-comment.mjs (1)

response (65-75)

components/canny/actions/create-post/create-post.mjs (1)

response (83-97)

components/canny/actions/create-comment/create-comment.mjs (3)

components/canny/actions/change-post-status/change-post-status.mjs (1)

response (60-68)

components/canny/actions/create-post/create-post.mjs (1)

response (83-97)

components/canny/actions/get-post/get-post.mjs (1)

response (41-48)

components/canny/sources/common/base-polling.mjs (2)

components/zep/actions/get-threads/get-threads.mjs (1)

max (39-39)

components/canny/canny.app.mjs (1)

items (243-243)

components/canny/actions/create-post/create-post.mjs (1)

components/canny/common/utils.mjs (2)

parseObject (1-27)

parseObject (1-27)

components/canny/actions/change-post-status/change-post-status.mjs (3)

components/canny/actions/create-comment/create-comment.mjs (1)

response (65-75)

components/canny/actions/create-post/create-post.mjs (1)

response (83-97)

components/canny/actions/get-post/get-post.mjs (1)

response (41-48)

components/canny/canny.app.mjs (2)

components/canny/sources/common/base-polling.mjs (3)

data (33-33)

items (43-43)

resourceKey (34-34)

components/zep/actions/get-threads/get-threads.mjs (1)

max (39-39)

⏰ 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: Lint Code Base
GitHub Check: pnpm publish
GitHub Check: Publish TypeScript components
GitHub Check: Verify TypeScript components

🔇 Additional comments (8)

components/canny/package.json (1)

1-18: Version bump looks consistent with new surface area.
No concerns in this file.

components/canny/actions/get-post/get-post.mjs (1)

14-51: [rewritten comment]
[classification tag]

components/canny/actions/create-comment/create-comment.mjs (1)

17-59: [rewritten comment]
[classification tag]

components/canny/canny.app.mjs (1)

136-151: LGTM!

The centralized _makeRequest method correctly injects apiKey into all requests and uses POST method as required by Canny's API.

components/canny/common/utils.mjs (1)

12-27: LGTM!

The recursive handling for arrays and objects is correctly implemented, and the null check on line 16 properly guards against typeof null === "object".
components/canny/actions/create-post/create-post.mjs (3)
4-14: LGTM!

Action metadata and annotations are properly configured with appropriate hints for the action's behavior (non-destructive, open-world, read-write).

82-100: LGTM!

The run method correctly maps prop names to Canny's API field naming convention (e.g., authorId → authorID) and provides a clear summary on success.

69-74: Consider parsing imageUrls like customFields for consistency.

If users provide imageUrls as a JSON string (e.g., from a previous step), it won't be parsed. For consistency with customFields handling, consider using parseObject.
-        imageURLs: this.imageUrls,
+        imageURLs: parseObject(this.imageUrls),
Also applies to: 94-94
⛔ Skipped due to learnings
Learnt from: js07
Repo: PipedreamHQ/pipedream PR: 18744
File: components/slack_v2/actions/send-large-message/send-large-message.mjs:49-64
Timestamp: 2025-10-20T01:01:02.970Z
Learning: In components/slack_v2/actions/send-large-message/send-large-message.mjs, the metadata_event_payload prop is typed as string, so the code only needs to handle string-to-JSON parsing and does not need to handle object inputs.

components/canny/actions/change-post-status/change-post-status.mjs

components/canny/canny.app.mjs

components/canny/common/utils.mjs

components/canny/sources/common/base-polling.mjs

components/canny/sources/new-comment-created/new-comment-created.mjs

components/canny/sources/new-vote-created/new-vote-created.mjs

components/canny/sources/post-status-changed/post-status-changed.mjs

michelle0927 added 2 commits December 12, 2025 10:09

wip

23f1a77

new components

3eb1cba

coderabbitai bot reviewed Dec 12, 2025

View reviewed changes

pipedream-component-development requested a review from lcaresia December 12, 2025 17:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Canny - new components #19474

Canny - new components #19474

Uh oh!

michelle0927 commented Dec 12, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Dec 12, 2025

Uh oh!

coderabbitai bot commented Dec 12, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Canny - new components #19474

Are you sure you want to change the base?

Canny - new components #19474

Uh oh!

Conversation

michelle0927 commented Dec 12, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Dec 12, 2025

Uh oh!

coderabbitai bot commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

michelle0927 commented Dec 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 12, 2025 •

edited

Loading