Skip to content

Increase v4 visibility timeouts & don't try continue finished runs #1978

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 4 commits into from
Apr 24, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented Apr 24, 2025

This pull request introduces new functionality to handle specific task run statuses, improves error handling in the WaitpointSystem, and adjusts visibility timeouts in the workerCatalog. These changes aim to enhance the reliability and maintainability of the run engine.

New functionality for task run statuses:

  • Added a new function, isFinishedOrPendingFinished, to determine if a task run status is either "FINISHED" or "PENDING_CANCEL". This function is now used in the WaitpointSystem to prevent unnecessary processing of completed runs. (internal-packages/run-engine/src/engine/statuses.ts, internal-packages/run-engine/src/engine/statuses.tsR34-R38)

Improvements to the WaitpointSystem:

Adjustments to visibility timeouts:

  • Increased the visibility timeout for several worker operations in the workerCatalog to reduce the likelihood of premature task retries. Most timeouts were adjusted from 5,000ms or 10,000ms to 30,000ms, with queueRunsPendingVersion updated to 60,000ms. (internal-packages/run-engine/src/engine/workerCatalog.ts, internal-packages/run-engine/src/engine/workerCatalog.tsL9-R54)

Summary by CodeRabbit

  • New Features

    • Improved handling to prevent further processing of runs that are already finished or pending finish.
  • Bug Fixes

    • Enhanced error logging for runs missing checkpoints.
  • Chores

    • Increased visibility timeout values for several background tasks to improve reliability.

Copy link

changeset-bot bot commented Apr 24, 2025

⚠️ No Changeset found

Latest commit: 1db5a6b

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.

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 Apr 24, 2025

Walkthrough

The changes introduce a new utility function to check if a task run execution status is either "FINISHED" or "PENDING_CANCEL". This function is integrated into the waitpoint system to add an early exit condition, preventing unnecessary processing for runs that are already finished or pending cancellation. Additionally, error logging is improved for missing checkpoints. Separately, the visibility timeout values for several worker tasks in the worker catalog are increased to allow more time for task completion, with no changes to public APIs or logic beyond these configuration updates.

Changes

File(s) Change Summary
internal-packages/run-engine/src/engine/statuses.ts Added isFinishedOrPendingFinished function to check for "FINISHED" or "PENDING_CANCEL" statuses.
internal-packages/run-engine/src/engine/systems/waitpointSystem.ts Imported and used the new function to add an early exit for finished/pending-finished runs; improved error logging for missing checkpoints.
internal-packages/run-engine/src/engine/workerCatalog.ts Increased visibilityTimeoutMs values for all worker tasks; no changes to logic or exported APIs.

Sequence Diagram(s)

sequenceDiagram
    participant System as WaitpointSystem
    participant Statuses as statuses.ts

    System->>Statuses: isFinishedOrPendingFinished(status)
    alt Status is finished or pending finished
        System-->>System: Log debug message
        System-->>System: Return early, skip processing
    else Status is not finished/pending finished
        System-->>System: Continue normal processing
    end
Loading

Poem

In the warren where code does hop,
A new check says, "Finished? Stop!"
Timeouts stretch, giving tasks more grace,
And logs now show a clearer face.
With every tweak, the system's tight—
Rabbits code through day and night!
🐇✨


📜 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 32ff569 and 1db5a6b.

📒 Files selected for processing (3)
  • internal-packages/run-engine/src/engine/statuses.ts (1 hunks)
  • internal-packages/run-engine/src/engine/systems/waitpointSystem.ts (3 hunks)
  • internal-packages/run-engine/src/engine/workerCatalog.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
internal-packages/run-engine/src/engine/statuses.ts (1)
packages/core/src/v3/schemas/runEngine.ts (2)
  • TaskRunExecutionStatus (6-16)
  • TaskRunExecutionStatus (18-19)
internal-packages/run-engine/src/engine/systems/waitpointSystem.ts (1)
internal-packages/run-engine/src/engine/statuses.ts (1)
  • isFinishedOrPendingFinished (34-37)
⏰ 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: units / 🧪 Unit Tests
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
internal-packages/run-engine/src/engine/statuses.ts (1)

34-37: Clean implementation of the new status check function.

This new utility function follows the established pattern of other status check functions in the file, providing a clear way to identify runs that are either finished or pending cancellation.

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

9-9: Good adjustment of visibility timeouts to reduce premature task retries.

Increasing the visibility timeouts from 5,000/10,000ms to 30,000ms (and 60,000ms for queueRunsPendingVersion) should effectively reduce premature retries and provide sufficient time for tasks to complete normally. This aligns well with the PR objective of improving reliability.

Also applies to: 16-16, 22-22, 30-30, 36-36, 42-42, 48-48, 54-54

internal-packages/run-engine/src/engine/systems/waitpointSystem.ts (3)

13-13: LGTM: Updated imports to include the new function.

Correctly imports the newly added isFinishedOrPendingFinished function.


515-521: Efficient early exit for already finished runs.

Good implementation of the guard clause to skip processing for runs that are already finished or pending cancellation. This prevents unnecessary work and potential issues that might arise from trying to continue runs that are already complete.


584-588: Enhanced error logging for better debugging.

The improved error logging now includes the run ID, snapshot details, and blocking waitpoints information, which will make it easier to diagnose issues when a run lacks a checkpoint.

✨ 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 generate sequence diagram to generate a sequence diagram of the changes in 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 aa10279 into main Apr 24, 2025
12 checks passed
@matt-aitken matt-aitken deleted the increase-v4-worker-visibility-timeouts branch April 24, 2025 12:36
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