Skip to content
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

Don't expire enqueued runs if they have lockedAt set #1571

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Dec 16, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling for expiring enqueued runs to prevent locked runs from being expired.

Copy link

changeset-bot bot commented Dec 16, 2024

⚠️ No Changeset found

Latest commit: f967cc4

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Dec 16, 2024

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.

apps/webapp/app/v3/services/expireEnqueuedRun.server.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The changes focus on improving the ExpireEnqueuedRunService by adding a new conditional check in the call method. The modification prevents expiring runs that are currently locked, introducing an additional layer of error handling and ensuring that only non-locked, pending runs can be expired. This change enhances the robustness of the run expiration process by avoiding potential conflicts with locked runs.

Changes

File Change Summary
apps/webapp/app/v3/services/expireEnqueuedRun.server.ts Added a conditional check to prevent expiring locked runs, with a debug log for locked run scenarios

Poem

🐰 A Rabbit's Ode to Run Expiration 🕰️

Locked runs, stay still, don't you dare move!
Our service now knows just what to prove
A check so clever, precise and neat
Preventing conflicts with a bunny's beat
Expiration logic, now safe and sound
No locked run shall slip through our ground! 🚫

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 (1)
apps/webapp/app/v3/services/expireEnqueuedRun.server.ts (1)

52-58: Consider enhancing the debug log with timing information.

To aid in debugging potential race conditions, consider including the lockedAt timestamp in the debug log.

     if (run.lockedAt) {
       logger.debug("Run cannot be expired because it's locked", {
-        run,
+        run,
+        lockedAt: run.lockedAt,
+        timeSinceLock: Date.now() - run.lockedAt.getTime()
       });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 88a0754 and f967cc4.

📒 Files selected for processing (1)
  • apps/webapp/app/v3/services/expireEnqueuedRun.server.ts (1 hunks)
🔇 Additional comments (2)
apps/webapp/app/v3/services/expireEnqueuedRun.server.ts (2)

52-58: LGTM! The implementation correctly prevents expiring locked runs.

The added check aligns with the PR objective and follows the established pattern of guard clauses in the service.


52-58: Verify concurrent processing behavior.

The new lock check introduces a potential race condition window between checking lockedAt and performing expiration. Let's verify the atomicity of operations and usage patterns.

✅ Verification successful

Based on the shell script results, I can now generate the final response:

Lock handling is safe due to database-level transaction isolation

The code shows that all lock operations are performed through Prisma's transactional updates:

  • Lock acquisition is done via atomic database updates in both dev and shared queue consumers
  • Lock checks and status updates are performed within database transactions
  • The lockedAt field is only modified through proper update operations with where clauses

The race condition window is effectively handled by the database's transaction isolation level, making the lock check and subsequent operations atomic.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential race conditions in lock handling

# Look for other services that might modify lockedAt
rg -A 5 "lockedAt.*=" 

# Check for transaction usage patterns
ast-grep --pattern 'transaction|$tx'

# Look for other expire or lock operations
rg -A 5 '\b(lock|expire|unlock).*Run'

Length of output: 22765

Copy link

pkg-pr-new bot commented Dec 16, 2024

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1571

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1571

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1571

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1571

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1571

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1571

commit: f967cc4

@ericallam ericallam merged commit 3418aa6 into main Dec 16, 2024
9 checks passed
@ericallam ericallam deleted the fix-dequeued-expired-runs branch December 16, 2024 19:00
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.

1 participant