Skip to content

chore: Nats duplicated messages notice #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

shellphy
Copy link
Contributor

@shellphy shellphy commented Nov 21, 2024

refer to: https://github.com/orgs/roadrunner-server/discussions/2049#discussioncomment-11334380

Summary by CodeRabbit

  • Documentation
    • Updated NATS driver documentation to include a note emphasizing the importance of configuring unique streams for each pipeline to prevent duplicate message consumption.

Copy link

coderabbitai bot commented Nov 21, 2024

Walkthrough

The documentation for the NATS driver in queues/nats.md has been updated to include a new informational note regarding the configuration of unique streams in NATS-driven pipelines. This note emphasizes that to prevent duplicate message consumption, each pipeline must be assigned a distinct NATS stream. The existing configuration options and their descriptions remain unchanged.

Changes

File Change Summary
queues/nats.md Added a notice emphasizing the use of unique streams in NATS-driven pipelines to avoid duplicates.

Poem

In the land of queues where messages flow,
Unique streams are the way to go!
No duplicates here, just a clear path,
For happy pipelines, let's do the math!
So heed this notice, dear friends of the code,
And let your message journey be a joyful ode! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 909f333 and bacfdd9.

📒 Files selected for processing (1)
  • queues/nats.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • queues/nats.md

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
🪧 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 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

@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

🧹 Outside diff range and nitpick comments (1)
queues/nats.md (1)

79-80: LGTM! Consider adding a warning emoji for better visibility.

The notice about unique streams is well-placed and provides valuable guidance to prevent duplicate message consumption. To make this important notice even more visible to users, consider adding a warning emoji at the start.

-> Notice: To avoid duplicate message consumption in NATS-driven pipelines, use unique streams for each pipeline. Sharing streams can lead to repeated processing of the same messages.
+> ⚠️ Notice: To avoid duplicate message consumption in NATS-driven pipelines, use unique streams for each pipeline. Sharing streams can lead to repeated processing of the same messages.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5b64bd6 and 1f60068.

📒 Files selected for processing (1)
  • queues/nats.md (1 hunks)

@rustatian rustatian changed the title add nats notice chore: Nats duplicated messages notice Nov 21, 2024
@rustatian rustatian changed the base branch from master to release/v2024.3 November 21, 2024 13:40
@rustatian rustatian merged commit 33fb9f0 into roadrunner-server:release/v2024.3 Nov 21, 2024
1 check passed
@rustatian
Copy link
Member

Thank you, @shellphy 👍

@coderabbitai coderabbitai bot mentioned this pull request Dec 5, 2024
@coderabbitai coderabbitai bot mentioned this pull request Jan 24, 2025
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.

7 participants