Skip to content

Multiple queue consumers per supervisor #1947

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
merged 4 commits into from
Apr 18, 2025
Merged

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Apr 18, 2025

Consumer count can now be tweaked via env vars in addition to replica count.

Summary by CodeRabbit

  • New Features
    • Added support for configuring multiple consumers for dequeue operations, allowing parallel processing of tasks.
    • Introduced a new environment variable to control the maximum number of consumers.
  • Improvements
    • Enhanced session management to start and stop multiple consumers concurrently for improved performance.

Copy link

changeset-bot bot commented Apr 18, 2025

⚠️ No Changeset found

Latest commit: dabd542

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Apr 18, 2025

Walkthrough

The changes introduce support for configuring multiple queue consumers in the supervisor session. A new environment variable, TRIGGER_DEQUEUE_MAX_CONSUMER_COUNT, is added to control the maximum number of consumers. This value is passed through the supervisor's configuration and used to instantiate multiple RunQueueConsumer instances within the SupervisorSession class. The session's start and stop methods are updated to handle all consumers concurrently, enabling parallel dequeue operations.

Changes

File(s) Change Summary
apps/supervisor/src/env.ts Added TRIGGER_DEQUEUE_MAX_CONSUMER_COUNT environment variable to the Env schema.
apps/supervisor/src/index.ts Passed new maxConsumerCount config from environment to SupervisorSession constructor.
packages/core/src/v3/runEngineWorker/supervisor/session.ts Updated SupervisorSession to support multiple consumers: new option, array of consumers, and concurrent start/stop logic.

Sequence Diagram(s)

sequenceDiagram
    participant Env
    participant ManagedSupervisor
    participant SupervisorSession
    participant RunQueueConsumer

    Env->>ManagedSupervisor: Provide TRIGGER_DEQUEUE_MAX_CONSUMER_COUNT
    ManagedSupervisor->>SupervisorSession: Pass maxConsumerCount option
    loop maxConsumerCount times
        SupervisorSession->>RunQueueConsumer: Instantiate consumer
    end
    SupervisorSession->>RunQueueConsumer: start() all consumers concurrently
    SupervisorSession->>RunQueueConsumer: stop() all consumers concurrently
Loading

Poem

In the warren of code, new tunnels appear,
More consumers awake, their purpose is clear.
With a hop and a jump, they dequeue in stride,
No longer alone, now many abide.
The supervisor smiles, the queues move with grace—
A parallel dance in the rabbit-run race!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ 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.
    • 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 generate docstrings to generate docstrings for 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: 0

🧹 Nitpick comments (2)
packages/core/src/v3/runEngineWorker/supervisor/session.ts (2)

187-187: Consider adding error handling for consumer start failures.

Using Promise.allSettled is a good choice to ensure all consumers attempt to start. Consider adding some logging if any individual consumer fails to start.

-      await Promise.allSettled(this.queueConsumers.map(async (q) => q.start()));
+      const startResults = await Promise.allSettled(this.queueConsumers.map(async (q, index) => q.start()));
+      startResults.forEach((result, index) => {
+        if (result.status === 'rejected') {
+          console.error(`[SupervisorSession] Failed to start queue consumer ${index}`, { error: result.reason });
+        }
+      });

202-202: Consider adding error handling for consumer stop failures.

Similarly to the start method, consider adding error handling for consumers that fail to stop properly.

-    await Promise.allSettled(this.queueConsumers.map(async (q) => q.stop()));
+    const stopResults = await Promise.allSettled(this.queueConsumers.map(async (q, index) => q.stop()));
+    stopResults.forEach((result, index) => {
+      if (result.status === 'rejected') {
+        console.error(`[SupervisorSession] Failed to stop queue consumer ${index}`, { error: result.reason });
+      }
+    });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 863ecf4 and dabd542.

📒 Files selected for processing (3)
  • apps/supervisor/src/env.ts (1 hunks)
  • apps/supervisor/src/index.ts (1 hunks)
  • packages/core/src/v3/runEngineWorker/supervisor/session.ts (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
apps/supervisor/src/env.ts (1)

36-36: LGTM: Environment variable definition is well-structured.

The new environment variable TRIGGER_DEQUEUE_MAX_CONSUMER_COUNT is properly defined with appropriate type coercion to integer and a sensible default value of 1, which maintains backward compatibility.

apps/supervisor/src/index.ts (1)

121-121: LGTM: Parameter correctly passed to SupervisorSession.

The environment variable is appropriately passed to the SupervisorSession constructor, enabling dynamic configuration of the number of queue consumers.

packages/core/src/v3/runEngineWorker/supervisor/session.ts (3)

21-21: LGTM: Well-defined option type extension.

The SupervisorSessionOptions type is correctly extended with the optional maxConsumerCount parameter.


31-31: LGTM: Appropriate type change for multiple consumers.

Good change from a single consumer instance to an array of consumers, matching the new functionality.


43-52: LGTM: Clean implementation of multiple consumers initialization.

The constructor efficiently creates the specified number of queue consumers using Array.from, with a sensible default of 1 if no count is specified.

@nicktrn nicktrn merged commit f683fe8 into main Apr 18, 2025
12 checks passed
@nicktrn nicktrn deleted the feat/improved-queue-consumers branch April 18, 2025 10:07
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.

2 participants