Fix dequeue snapshot batch ids

[matt-aitken]

When dequeuing a run, the batch id wasn't being copied to the new snapshot. Same for creating a run attempt

Summary by CodeRabbit

• New Features

  • Enhanced run tracking by capturing additional contextual data during execution, including batchId and completedWaitpoints, improving monitoring and diagnostics of run processes.

• Tests

  • Added a new test case to verify the behavior of the RunEngine with checkpoints and the execution of child tasks, ensuring proper handling of task states and waitpoints.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a05a9fe

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

This pull request introduces a new batchId property to the execution snapshots in multiple components of the run engine. In the dequeueFromMasterQueue method of the DequeueSystem, batchId is added to the snapshot. In the startRunAttempt method of the RunAttemptSystem, both batchId and a new completedWaitpoints property are included. Additionally, the CheckpointSystem class methods createCheckpoint and continueRunExecution are updated to incorporate batchId. These changes enhance the contextual data captured during execution without altering existing control flow.

Changes

File(s)	Change Summary
internal-packages/run-engine/src/engine/systems/dequeueSystem.ts	Added batchId property to the execution snapshot in the dequeueFromMasterQueue method.
internal-packages/run-engine/src/engine/systems/runAttemptSystem.ts	Added batchId and completedWaitpoints properties to the execution snapshot in the startRunAttempt method.
internal-packages/run-engine/src/engine/systems/checkpointSystem.ts	Added batchId property in the createCheckpoint and continueRunExecution methods.
internal-packages/run-engine/src/engine/tests/checkpoints.test.ts	Added a new test case for "batchTriggerAndWait resume after checkpoint" to validate behavior with batch processing.

Sequence Diagram(s)

(No sequence diagram available as the changes only enhance data capture without modifying control flow.)

Possibly related PRs

• Add support for deferred checkpoints #1721: Related changes to the handling of checkpoints and the inclusion of batchId in execution snapshots.
• Fix: Prevent failed resumes for very large batches #1598: Modifications that also introduce a batchId property in the context of run attempts.
• Set taskRunAttemptId on batch task run items on completion #1658: Introduces a batchId property in a related context, enhancing batch processing data structures.

Suggested reviewers

• ericallam
• nicktrn

Poem

I'm a rabbit in the code, so spry,
Adding batch IDs as we hop by.
With waitpoints in a joyful parade,
Our snapshots now are finely remade.
Hop on, dear coders, let brilliance apply!

---

📜 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 2e575a7 and a05a9fe.

📒 Files selected for processing (2)

• internal-packages/run-engine/src/engine/systems/checkpointSystem.ts (1 hunks)
• internal-packages/run-engine/src/engine/tests/checkpoints.test.ts (2 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

internal-packages/run-engine/src/engine/tests/checkpoints.test.ts (4)

internal-packages/testcontainers/src/index.ts (1)

• containerTest (145-151)

internal-packages/run-engine/src/engine/tests/setup.ts (2)

• setupAuthenticatedEnvironment (20-66)
• setupBackgroundWorker (68-272)

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

• RunEngine (56-1336)

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

• RunEngine (1-1)

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

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

🔇 Additional comments (2)

internal-packages/run-engine/src/engine/systems/checkpointSystem.ts (1)

286-286: Good addition of batchId propagation.

This addition ensures that the batch ID is correctly passed to the new snapshot when a run is continued after being suspended, which aligns with the PR objective to fix batch ID propagation during dequeuing.

internal-packages/run-engine/src/engine/tests/checkpoints.test.ts (1)

987-1387: Comprehensive batch ID propagation test - LGTM!

This test thoroughly verifies that batch IDs are correctly maintained when a run is checkpointed and resumed, which is exactly what the PR aims to fix. The test covers:

1. Creating a parent run with a batch
2. Triggering child runs connected to the batch
3. Creating a checkpoint
4. Completing child runs
5. Resuming the parent run and verifying its batch ID and completed waitpoints are preserved

The assertions at lines 1269-1270, 1330-1331, and 1354-1355 particularly validate that the batch ID and completed waitpoints are correctly maintained across snapshots.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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