Fix v4 restore race condition

[nicktrn]

There was a race condition that could cause a suspended run to have a brief delay before shutting down. If it's alerted of a snapshot change in this time, it's possible for it to finish the run, even though there was a restore queued. If worker notifications fail and we fall back to polling, the SUSPENDED and QUEUED statuses may be skipped due to timing, so it goes straight to PENDING_EXECUTING again.

This is all fine, but the restored run will come up and its next snapshot change will be FINISHED. We didn't handle that case. Now we do.

Summary by CodeRabbit

• New Features
  • Updated the system behavior so that after a task completes, it now automatically enters a waiting mode for the next operation. This change enhances responsiveness by transitioning seamlessly from completion to readiness, providing clearer feedback on the process flow for end users.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 52e0b5b

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

[coderabbitai]

Walkthrough

The changes update the ManagedRunController within the CLI package. The handling of the "FINISHED" execution status in the handleSnapshotChange method is modified. Instead of simply logging that nothing needs to be done, the controller now logs a message indicating it will wait for the next run and calls this.waitForNextRun(). No changes were made to any public or exported entities.

Changes

File Path	Change Summary
packages/cli-v3/src/entryPoints/managed-run-controller.ts	Modified the log message for "FINISHED" status and added a call to waitForNextRun() immediately after logging the message.

Sequence Diagram(s)

sequenceDiagram
    participant M as ManagedRunController
    participant Log as Logger
    participant Wait as waitForNextRun Method

    M->>M: handleSnapshotChange(snapshot)
    alt Execution status == FINISHED
        M->>Log: Log "Run is finished, will wait for next run."
        M->>M: Call waitForNextRun()
    else Other Status
        M->>M: Handle status accordingly
    end

Loading

Poem

I'm a rabbit in the code garden, so spry,
Watching the runs with a keen rabbit's eye.
"Run is finished," now cues a wait so neat,
For the next adventure where our processes meet.
Hop along with joy as we refactor and play,
Coding carrots and bunnies all the way!
🐰✨

---

📜 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 dcacc3a and 52e0b5b.

📒 Files selected for processing (1)

• packages/cli-v3/src/entryPoints/managed-run-controller.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: typecheck / typecheck

🔇 Additional comments (1)

packages/cli-v3/src/entryPoints/managed-run-controller.ts (1)

488-489: Good fix for the race condition!

This change addresses the race condition described in the PR by ensuring the controller properly transitions to a waiting state when a run is finished. Previously, it likely just logged the message without calling waitForNextRun(), which could leave the controller in a state where it might erroneously process a restored run that was marked as FINISHED.

The waitForNextRun() method (defined at line 817) handles the cleanup of the current process and prepares the controller to handle the next run correctly, preventing the race condition where a suspended container could complete its run despite a restore being queued.

✨ 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 plan to trigger planning for file edits and PR creation.
• @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.