Prevent crashes on expected checkpoint cancellations

[nicktrn]

In some cases, expected checkpoint cancellations, e.g. when a dependency finishes before the parent checkpoint has been created, could cause the run to crash. This has been fixed by adding custom errors for all readiness interruptions. We now correctly distinguish between them and only crash on timeouts. If a run doesn't become ready to checkpoint within 20s, it's likely stuck forever and will be unable to resume in all scenarios.

Summary by CodeRabbit

• New Features

  • Introduced two new error classes for improved error handling: CheckpointReadinessTimeoutError and CheckpointCancelError.
  • Enhanced clarity in error responses for timeout and cancellation scenarios during checkpoint operations.

• Bug Fixes

  • Improved robustness of the checkpointing mechanism by distinguishing between different failure modes.

[changeset-bot]

⚠️ No Changeset found

Latest commit: be20f92

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]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce two new error classes, CheckpointReadinessTimeoutError and CheckpointCancelError, to improve error handling within the TaskCoordinator class. The isCheckpointable promise now rejects with a CheckpointReadinessTimeoutError if it exceeds a 20-second timeout. The updated error handling logic allows for distinct responses to timeout and cancellation scenarios, enhancing the robustness of the checkpointing mechanism and improving overall error management.

Changes

Files	Change Summary
apps/coordinator/src/index.ts	Added two new error classes: CheckpointReadinessTimeoutError and CheckpointCancelError.

Poem

In the land of tasks where errors play,
A timeout hops and jumps away.
With clear new signals, we now can see,
When checkpoints cancel or timeout with glee.
Hooray for changes, let’s cheer and prance,
For better handling, let’s take a chance! 🐇✨

---

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

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