Skip to content

Conversation

@luancazarine
Copy link
Collaborator

@luancazarine luancazarine commented Jun 27, 2025

Resolves #17253

Summary by CodeRabbit

  • New Features

    • Added a new source to emit events when new Reddit private messages are received.
  • New Methods

    • Introduced a method for retrieving private messages from Reddit.
  • Chores

    • Updated component and action versions for improved consistency.
    • Upgraded package dependencies for enhanced compatibility.

…rce, and increment action versions to 0.1.2 and 0.1.3 for various actions. Refactor imports for consistency.
@vercel
Copy link

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 27, 2025

Walkthrough

A new source for detecting new Reddit private messages was added, along with a supporting method in the Reddit app module. Several components and sources had their version numbers incremented, and some import statements were reordered. No other functional or logic changes were introduced outside the new private message detection feature.

Changes

File(s) Change Summary
components/reddit/sources/new-private-message/new-private-message.mjs Added new source to emit events for new Reddit private messages.
components/reddit/reddit.app.mjs Added getPrivateMessages method to fetch private messages.
components/reddit/actions/list-comments-in-a-post.mjs
components/reddit/actions/list-subreddits-by-query.mjs
components/reddit/actions/search-post.mjs
components/reddit/actions/submit-a-comment.mjs
components/reddit/actions/submit-a-post.mjs
components/reddit/sources/new-comments-by-user.mjs
components/reddit/sources/new-comments-on-a-post.mjs
components/reddit/sources/new-hot-posts-on-a-subreddit.mjs
components/reddit/sources/new-links-by-user.mjs
components/reddit/sources/new-links-on-a-subreddit.mjs
components/reddit/sources/new-saved-post-by-user.mjs
Incremented version numbers and reordered some import statements.
components/reddit/package.json Updated package version and upgraded @pipedream/platform dependency.

Sequence Diagram(s)

sequenceDiagram
    participant RedditSource as New Private Message Source
    participant RedditApp as Reddit App
    participant RedditAPI as Reddit API

    RedditSource->>RedditApp: getPrivateMessages({ before, limit })
    RedditApp->>RedditAPI: GET /message/inbox with params
    RedditAPI-->>RedditApp: List of private messages
    RedditApp-->>RedditSource: Private messages data
    loop For each new message
        RedditSource->>RedditSource: Emit event with message metadata
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement new trigger "New Reddit Private Message" (#17253)
Add method to fetch private messages from Reddit API (#17253)
Add action to "Reply Reddit Private Message" (#17253) No action to reply to private messages is present in the changes.

Assessment against linked issues: Out-of-scope changes

Code Change Explanation
Version bumps and import reordering in unrelated actions and sources (various files) These changes are not related to the "New Reddit Private Message" trigger or reply action.
Upgrade of @pipedream/platform dependency in package.json Not directly related to the objectives of the linked issue.

Poem

In the burrows of Reddit, a message hops in,
Now a trigger detects it, let the fun begin!
With versions all tidy and imports in line,
The inbox is watched—oh, isn’t that fine?
A bunny with code, with ears held up high,
Celebrates new features as messages fly!
🐇💌

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/reddit/reddit.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 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:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

components/reddit/sources/new-private-message/new-private-message.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:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202: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 490c66a and 1127634.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • components/reddit/reddit.app.mjs (2 hunks)
  • components/reddit/sources/new-private-message/new-private-message.mjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • components/reddit/reddit.app.mjs
  • components/reddit/sources/new-private-message/new-private-message.mjs
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Lint Code Base
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
  • GitHub Check: pnpm publish
✨ 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: 2

🧹 Nitpick comments (2)
components/reddit/actions/submit-a-post/submit-a-post.mjs (1)

8-8: Reminder on semantic version

Action moves from 0.1.10.1.2. Since behaviour is unchanged, patch bump is correct. Make sure any downstream workflows pinning exact versions are updated.

components/reddit/sources/new-links-on-a-subreddit/new-links-on-a-subreddit.mjs (1)

11-11: Patch version bump check

Confirm changelog & package registry carry 0.1.2.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2db2518 and 490c66a.

📒 Files selected for processing (14)
  • components/reddit/actions/list-comments-in-a-post/list-comments-in-a-post.mjs (1 hunks)
  • components/reddit/actions/list-subreddits-by-query/list-subreddits-by-query.mjs (1 hunks)
  • components/reddit/actions/search-post/search-post.mjs (1 hunks)
  • components/reddit/actions/submit-a-comment/submit-a-comment.mjs (1 hunks)
  • components/reddit/actions/submit-a-post/submit-a-post.mjs (1 hunks)
  • components/reddit/package.json (2 hunks)
  • components/reddit/reddit.app.mjs (2 hunks)
  • components/reddit/sources/new-comments-by-user/new-comments-by-user.mjs (1 hunks)
  • components/reddit/sources/new-comments-on-a-post/new-comments-on-a-post.mjs (2 hunks)
  • components/reddit/sources/new-hot-posts-on-a-subreddit/new-hot-posts-on-a-subreddit.mjs (2 hunks)
  • components/reddit/sources/new-links-by-user/new-links-by-user.mjs (1 hunks)
  • components/reddit/sources/new-links-on-a-subreddit/new-links-on-a-subreddit.mjs (2 hunks)
  • components/reddit/sources/new-private-message/new-private-message.mjs (1 hunks)
  • components/reddit/sources/new-saved-post-by-user/new-saved-post-by-user.mjs (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
components/reddit/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/reddit/sources/new-saved-post-by-user/new-saved-post-by-user.mjs (1)
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.
components/reddit/sources/new-comments-on-a-post/new-comments-on-a-post.mjs (1)
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.
components/reddit/reddit.app.mjs (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/reddit/sources/new-private-message/new-private-message.mjs (4)
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-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.
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#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.
components/reddit/sources/new-hot-posts-on-a-subreddit/new-hot-posts-on-a-subreddit.mjs (1)
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.
🪛 GitHub Actions: Components Checks
components/reddit/package.json

[error] 1-1: pnpm install failed due to outdated lockfile. The pnpm-lock.yaml is not up to date with package.json dependencies. Specifiers in lockfile do not match package.json (e.g., '@pipedream/platform' version mismatch). Use 'pnpm install --no-frozen-lockfile' to bypass.

🪛 GitHub Actions: Pull Request Checks
components/reddit/package.json

[error] 1-1: pnpm install failed due to outdated lockfile. The pnpm-lock.yaml is not up to date with package.json dependencies. Specifically, '@pipedream/platform' version mismatch (^1.4.0 in lockfile vs ^3.1.0 in package.json). Use 'pnpm install --no-frozen-lockfile' to bypass.

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: pnpm publish
🔇 Additional comments (21)
components/reddit/sources/new-comments-by-user/new-comments-by-user.mjs (1)

10-10: Version bump is fine

No logic changed here; the minor patch bump is appropriate and keeps parity with sibling sources.

components/reddit/sources/new-saved-post-by-user/new-saved-post-by-user.mjs (1)

10-10: Patch bump acknowledged

The 0.1.3 increment is consistent with the coordinated component release. Nothing else to flag.

components/reddit/actions/search-post/search-post.mjs (1)

6-6: Minor version tick LGTM

No functional code touched; the bump keeps action versions in sync.

components/reddit/actions/submit-a-comment/submit-a-comment.mjs (1)

7-7: Version alignment acknowledged

Patch bump only; implementation unchanged.

components/reddit/sources/new-comments-on-a-post/new-comments-on-a-post.mjs (2)

2-2: Import order looks good

lodash/get.js (external) now precedes the local common.mjs, matching the usual “external-before-internal” convention.
No action needed.


12-12: Ensure version bump is reflected everywhere

Bumped to 0.1.2. Double-check that:

  1. components/reddit/package.json lists "version": "1.2.0" (already in diff) and
  2. any documentation / CHANGELOG has the same number.

Prevents mismatched releases.

components/reddit/sources/new-links-by-user/new-links-by-user.mjs (2)

10-10: Version bump only – looks fine

Nothing else changed; ✅


10-10: Cross-file consistency

Please confirm every consumer (e.g. Marketplace metadata) now references 0.1.2; otherwise older cache may still surface 0.1.1.

components/reddit/actions/submit-a-post/submit-a-post.mjs (1)

3-3: Import grouping

tzs (internal util) is now above reddit (app). Grouping remains “external -> internal helpers -> app instances”, so order is acceptable.

components/reddit/actions/list-subreddits-by-query/list-subreddits-by-query.mjs (2)

2-2: Import location change acknowledged

No functional impact; ok to merge.


7-7: Propagate version bump

Same note as other files—sync docs/examples to 0.1.2.

components/reddit/sources/new-links-on-a-subreddit/new-links-on-a-subreddit.mjs (1)

2-2: Import order compliant

External first, then local – accepted.

components/reddit/sources/new-hot-posts-on-a-subreddit/new-hot-posts-on-a-subreddit.mjs (2)

1-1: LGTM: Import reordering for consistency.

The import statements have been reordered to improve consistency across the codebase, with no functional impact.

Also applies to: 4-4


14-14: LGTM: Version bump aligns with package update.

The version increment is consistent with the broader Reddit component update mentioned in the PR.

components/reddit/actions/list-comments-in-a-post/list-comments-in-a-post.mjs (2)

2-2: LGTM: Import reordering for consistency.

The reddit app import has been moved below the axios import, improving consistency without functional impact.


7-7: LGTM: Version bump aligns with package update.

The version increment is consistent with the coordinated Reddit component update.

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

4-5: LGTM: Import reordering for consistency.

The import order swap between isNil and qs improves consistency without affecting functionality.


493-499: LGTM: Well-implemented API method following established patterns.

The new getPrivateMessages method correctly:

  • Uses the _withRetries wrapper for error handling
  • Targets the appropriate Reddit API endpoint (/message/inbox)
  • Accepts optional parameters through the opts parameter
  • Follows the same pattern as other methods in this module
components/reddit/sources/new-private-message/new-private-message.mjs (3)

1-11: LGTM: Well-structured source component setup.

The component properly extends the common base, defines appropriate metadata, and uses unique deduplication strategy for private messages.


12-30: LGTM: Proper initialization in deploy hook.

The deploy hook correctly:

  • Fetches initial sample messages with appropriate limit
  • Handles empty response gracefully
  • Sets up cursor tracking using the newest message ID
  • Emits events in chronological order (reversed)

32-40: LGTM: Appropriate event metadata generation.

The generateEventMetadata method correctly extracts the message ID, body as summary, and creation timestamp for event tracking.

@luancazarine luancazarine merged commit c888690 into master Jul 1, 2025
11 checks passed
@luancazarine luancazarine deleted the 17253-action-new-trigger-new-reddit-private-message-and-action-reply-reddit-private-message branch July 1, 2025 18:30
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.

[ACTION] New trigger "New Reddit Private Message" and Action "Reply Reddit Private Message"

3 participants