Skip to content

fix: moved dequeuing from a worker queue out of lua to be able to use blpop #2151

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 1 commit into from
Jun 4, 2025

Conversation

ericallam
Copy link
Member

No description provided.

Copy link

changeset-bot bot commented Jun 4, 2025

⚠️ No Changeset found

Latest commit: 2acf276

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 Jun 4, 2025

Walkthrough

The changes introduce a new public asynchronous method, readMessageFromKey, to the RunQueue class, which retrieves and parses a message from Redis by its key. The dequeueMessageFromWorkerQueue method is refactored to use Redis’s native BLPOP command for dequeuing messages, replacing the previous Lua script-based approach. This method now calls readMessageFromKey to parse dequeued messages. Additionally, test files are updated to remove explicit timeout options from redisTest calls, relying on default timeout behavior instead. No changes are made to the logic or flow of the tests themselves.

✨ 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e7795a0 and 2acf276.

📒 Files selected for processing (2)
  • internal-packages/run-engine/src/run-queue/index.test.ts (3 hunks)
  • internal-packages/run-engine/src/run-queue/index.ts (3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
internal-packages/run-engine/src/run-queue/index.test.ts (1)
internal-packages/testcontainers/src/index.ts (1)
  • redisTest (167-167)
internal-packages/run-engine/src/run-queue/index.ts (3)
internal-packages/run-engine/src/run-queue/keyProducer.ts (2)
  • messageKey (184-188)
  • workerQueueKey (40-42)
apps/webapp/app/v3/marqs/index.server.ts (6)
  • message (453-459)
  • message (461-467)
  • message (843-847)
  • message (1057-1257)
  • message (1321-1389)
  • message (1391-1450)
internal-packages/run-engine/src/run-queue/types.ts (2)
  • OutputPayload (31-31)
  • OutputPayload (33-33)
⏰ Context from checks skipped due to timeout of 90000ms (25)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
internal-packages/run-engine/src/run-queue/index.ts (3)

441-472: LGTM! Clean implementation of message retrieval by key.

The new readMessageFromKey method follows the existing patterns and properly handles parsing errors with appropriate logging.


1445-1448: Good refactoring to use native Redis BLPOP.

The switch from a custom Lua script to Redis's native BLPOP command simplifies the implementation and leverages Redis's built-in blocking behavior. The configurable timeout is a nice touch.


1648-1652: Clean simplification after removing Lua commands.

The method is now focused solely on creating a duplicate Redis client, which aligns perfectly with the refactored approach using native Redis commands.

internal-packages/run-engine/src/run-queue/index.test.ts (1)

581-581: LGTM! Test cleanup aligns with the refactored implementation.

Removing explicit timeout options from the redisTest calls is appropriate since the blocking behavior is now handled by the native Redis BLPOP command with its own timeout configuration.

Also applies to: 662-662, 809-809

Comment on lines +1452 to +1456
cleanup().then(() => {
this.logger.debug("dequeueMessageFromWorkerQueue cleanup", {
service: this.name,
});
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Consider awaiting the cleanup or handling potential errors.

The async cleanup of the blocking client doesn't await the promise. If cleanup() fails, the error won't be caught and could lead to unhandled promise rejections.

Consider either awaiting the cleanup:

-    cleanup().then(() => {
-      this.logger.debug("dequeueMessageFromWorkerQueue cleanup", {
-        service: this.name,
-      });
-    });
+    await cleanup().then(() => {
+      this.logger.debug("dequeueMessageFromWorkerQueue cleanup", {
+        service: this.name,
+      });
+    }).catch((error) => {
+      this.logger.error("dequeueMessageFromWorkerQueue cleanup failed", {
+        error,
+        service: this.name,
+      });
+    });

Or at least add error handling:

     cleanup().then(() => {
       this.logger.debug("dequeueMessageFromWorkerQueue cleanup", {
         service: this.name,
       });
+    }).catch((error) => {
+      this.logger.error("dequeueMessageFromWorkerQueue cleanup failed", {
+        error,
+        service: this.name,
+      });
     });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cleanup().then(() => {
this.logger.debug("dequeueMessageFromWorkerQueue cleanup", {
service: this.name,
});
});
await cleanup().then(() => {
this.logger.debug("dequeueMessageFromWorkerQueue cleanup", {
service: this.name,
});
}).catch((error) => {
this.logger.error("dequeueMessageFromWorkerQueue cleanup failed", {
error,
service: this.name,
});
});
🤖 Prompt for AI Agents
In internal-packages/run-engine/src/run-queue/index.ts around lines 1452 to
1456, the cleanup() async call is not awaited, which risks unhandled promise
rejections if cleanup fails. Modify the code to either await the cleanup() call
to ensure it completes before proceeding or add a .catch() handler to log or
handle any errors from cleanup(). This will properly handle potential errors and
avoid unhandled promise rejections.

@ericallam ericallam merged commit 575413c into main Jun 4, 2025
33 checks passed
@ericallam ericallam deleted the fix-redis-blocking-in-lua-script branch June 4, 2025 21:04
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