Set a maximum number of times the dequeue loop can run

[ericallam]

Summary by CodeRabbit

• New Features

  • Introduced a configurable limit for dequeue loop attempts in the run engine, with a default value of 10.

• Bug Fixes

  • Improved handling to prevent potential infinite loops during message dequeue operations.

• Tests

  • Removed a test case related to early exit behavior when no messages can be dequeued due to concurrency limits.

[changeset-bot]

⚠️ No Changeset found

Latest commit: cbe8d81

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This change introduces a new configuration parameter, maxDequeueLoopAttempts, which sets a limit on the number of iterations allowed in the dequeue loop of the run engine's queue system. The parameter is added as an environment variable, passed through configuration objects, and used to control the dequeue logic. The previous mechanism, which relied on detecting a successful dequeue to break the loop early, is removed. Corresponding test coverage for the old early exit logic is also deleted.

Changes

Files/Paths	Change Summary
apps/webapp/app/env.server.ts	Added RUN_ENGINE_MAX_DEQUEUE_LOOP_ATTEMPTS to the environment schema as an integer with a default of 10.
apps/webapp/app/v3/runEngine.server.ts	Passed the new environment variable as maxDequeueLoopAttempts in the queue configuration to the RunEngine constructor.
internal-packages/run-engine/src/engine/types.ts	Added optional maxDequeueLoopAttempts?: number to the queue options in RunEngineOptions type.
internal-packages/run-engine/src/engine/index.ts	Updated RunEngine to pass maxDequeueLoopAttempts to RunQueue from options or default to 10.
internal-packages/run-engine/src/run-queue/index.ts	Added maxDequeueLoopAttempts to RunQueueOptions and RunQueue, defaulting to 10; refactored dequeue loop to use this limit and removed old logic.
internal-packages/run-engine/src/run-queue/tests/dequeueMessageFromMasterQueue.test.ts	Removed the test case for early exit when no messages can be dequeued in a full cycle.

Sequence Diagram(s)

sequenceDiagram
    participant Env as Environment
    participant WebApp as WebApp Config
    participant RunEngine as RunEngine
    participant RunQueue as RunQueue

    Env->>WebApp: Provide RUN_ENGINE_MAX_DEQUEUE_LOOP_ATTEMPTS
    WebApp->>RunEngine: Pass maxDequeueLoopAttempts in queue config
    RunEngine->>RunQueue: Initialize with maxDequeueLoopAttempts
    RunQueue->>RunQueue: Dequeue loop (max attempts = maxDequeueLoopAttempts)

Loading

Possibly related PRs

• triggerdotdev/trigger.dev#1946: Removes the early exit logic based on a successful dequeue flag and replaces it with a maximum dequeue loop attempts limit, which directly relates to the core dequeue loop control change in this PR.

Suggested reviewers

• matt-aitken

Poem

In the warren where queues abound,
A rabbit set a limit, so loops are sound.
No more endless hops, just ten at a time,
Messages await, in orderly line.
Old flags are gone, the logic is neat—
With max attempts set, the cycle’s complete!
🐇✨

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.

---

📜 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 0ebecbe and cbe8d81.

📒 Files selected for processing (6)

• apps/webapp/app/env.server.ts (1 hunks)
• apps/webapp/app/v3/runEngine.server.ts (1 hunks)
• internal-packages/run-engine/src/engine/index.ts (1 hunks)
• internal-packages/run-engine/src/engine/types.ts (1 hunks)
• internal-packages/run-engine/src/run-queue/index.ts (5 hunks)
• internal-packages/run-engine/src/run-queue/tests/dequeueMessageFromMasterQueue.test.ts (0 hunks)

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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