Skip to content

Run Engine 2: reschedule heartbeats and added a test to check it works #1765

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
Mar 6, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented Mar 6, 2025

This pull request includes changes to improve the heartbeat mechanism in the RunEngine class and adds a new test to ensure the functionality of the heartbeat system. The most important changes include refactoring the heartbeat scheduling logic and adding a comprehensive test case.

Improvements to heartbeat mechanism:

Addition of new test:

Summary by CodeRabbit

  • Refactor
    • Streamlined the process for scheduling periodic signals to maintain continuous task execution.
  • Tests
    • Added a new test validating that ongoing signals correctly keep tasks active and that execution status transitions as expected.

Copy link

changeset-bot bot commented Mar 6, 2025

⚠️ No Changeset found

Latest commit: 8b7c697

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 Mar 6, 2025

Walkthrough

The changes update the heartbeat management in the RunEngine. The intermediary method #setHeartbeatDeadline is removed and replaced with direct use of #getHeartbeatIntervalMs to determine the heartbeat interval. This adjustment modifies the heartbeat scheduling logic in both the heartbeatRun and #createExecutionSnapshot methods. Additionally, a new test case is added to simulate and verify that a run remains executing with periodic heartbeats and transitions to a queued state when heartbeats cease.

Changes

File(s) Summary
internal-packages/run-engine/.../engine/index.ts Removed the private method #setHeartbeatDeadline and updated heartbeatRun and #createExecutionSnapshot to directly use #getHeartbeatIntervalMs for heartbeat scheduling.
internal-packages/run-engine/.../engine/tests/heartbeats.test.ts Added a new test case "Heartbeat keeps run alive" to verify that continuous heartbeats maintain the run’s executing status and that absence of heartbeats leads to a queued state.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Suite
    participant RE as RunEngine
    participant W as Worker

    Test->>RE: Start run with heartbeat configuration
    RE->>W: Reschedule heartbeat (using getHeartbeatIntervalMs)
    alt Heartbeat active
        W-->>RE: Heartbeat callback received
        RE->>W: Enqueue next heartbeat job
    else Heartbeat stops
        Note over RE: Run eventually times out
    end
Loading

Suggested reviewers

  • ericallam

Poem

I'm a rabbit in a field of code, hopping with delight,
Heartbeats guiding every run in rhythmic flight.
No intermediary hops, just a direct, steady beat,
Rescheduling with flair, making our system neat.
With every pulse, our engine comes alive – oh what a sight!
🐇💻 Hop on, my friend, code dreams take flight!


📜 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 983bb41 and 8b7c697.

📒 Files selected for processing (2)
  • internal-packages/run-engine/src/engine/index.ts (2 hunks)
  • internal-packages/run-engine/src/engine/tests/heartbeats.test.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • 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: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
internal-packages/run-engine/src/engine/index.ts (2)

2434-2438: Simplified heartbeat scheduling logic.

This change replaces the previous call to #setHeartbeatDeadline with direct heartbeat rescheduling. The code now checks for a valid interval and reschedules the heartbeat job directly using the worker.


3642-3650: Streamlined heartbeat initialization in execution snapshot creation.

The code now directly enqueues a heartbeat job when creating an execution snapshot that requires heartbeats, rather than going through an intermediary method. This is a cleaner approach that makes the heartbeat scheduling more explicit.

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

494-611: Good test coverage for heartbeat functionality.

This new test validates that:

  1. Regular heartbeats keep a run alive in "EXECUTING" state
  2. When heartbeats stop, the run properly times out and transitions to "QUEUED" state

The test effectively verifies the behavior of the modified heartbeat scheduling mechanism.

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

@matt-aitken matt-aitken merged commit 722fae5 into main Mar 6, 2025
11 of 13 checks passed
@matt-aitken matt-aitken deleted the heartbeat-rescheduling branch March 6, 2025 10:44
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