Prevent v2 batches from being resumed before all items have been created #1614

ericallam · 2025-01-14T14:08:24Z

Summary by CodeRabbit

New Features
- Enhanced batch run processing for version "v2" with additional validation checks
- Implemented live run subscription for batch tasks to monitor real-time run status
Bug Fixes
- Improved error handling and logging for batch run scenarios

changeset-bot · 2025-01-14T14:08:30Z

⚠️ No Changeset found

Latest commit: 4622437

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 · 2025-01-14T14:08:33Z

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/v3/services/resumeBatchRun.server.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces modifications to batch run processing, specifically adding a new conditional check for version "v2" batch runs. In the resumeBatchRun.server.ts file, a validation is implemented to ensure that the number of batch run items matches the expected run count for version "v2" runs. Additionally, the batch.ts file now includes enhanced logic for subscribing to live run updates, allowing real-time monitoring of batch task runs.

Changes

File	Change Summary
`apps/webapp/app/v3/services/resumeBatchRun.server.ts`	Added version "v2" specific validation check for batch runs, ensuring item count matches run count
`references/v3-catalog/src/trigger/batch.ts`	Implemented subscription to live run updates for batch tasks, monitoring run completion status

Sequence Diagram

sequenceDiagram
    participant BatchService as Batch Run Service
    participant RunManager as Run Manager
    
    BatchService->>RunManager: Check Batch Run Version
    alt Batch Version is V2
        RunManager->>BatchService: Validate Item Count
        alt Items Count < Run Count
            BatchService-->>RunManager: Return PENDING
            BatchService->>RunManager: Log Debug Message
        else Items Count >= Run Count
            RunManager->>BatchService: Process Batch Run
        end
    else Batch Version is Not V2
        RunManager->>BatchService: Continue Normal Processing
    end

Possibly related PRs

Fix: Prevent failed resumes for very large batches #1598: Handles batch processes, directly related to the new conditional check for batch runs with version "v2"

Poem

🐰 Batch runs dancing, version two in sight,
Counting items with algorithmic might,
Logs that whisper, runs that gleam,
Validation's magic in our coding dream!
Hop along, little tasks, your journey's bright! 🚀

📜 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 b3aa87e and 4622437.

📒 Files selected for processing (2)

apps/webapp/app/v3/services/resumeBatchRun.server.ts (1 hunks)
references/v3-catalog/src/trigger/batch.ts (1 hunks)

⏰ 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 (buildjet-8vcpu-ubuntu-2204 - pnpm)
GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - npm)
GitHub Check: units / 🧪 Unit Tests
GitHub Check: typecheck / typecheck
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (3)

apps/webapp/app/v3/services/resumeBatchRun.server.ts (2)

54-69: LGTM! The v2 batch validation logic is well implemented.

The validation correctly ensures that v2 batches have all their items created before being resumed, with appropriate debug logging and version-specific handling.

72-72: LGTM! The version indicator in the log message improves clarity.

Adding the "[v1]" indicator helps distinguish between v1 and v2 batch processing in logs.

references/v3-catalog/src/trigger/batch.ts (1)

379-382: LGTM! The subscription logic for live run updates is well implemented.

The implementation correctly monitors batch run completion by checking the finishedAt property and includes appropriate loop termination conditions.

Also applies to: 387-390

Finishing Touches

📝 Generate Docstrings (Beta)

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

🪧 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. (Beta)
@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.

pkg-pr-new · 2025-01-14T14:16:25Z

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1614

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1614

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1614

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1614

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1614

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1614

commit: 4622437

Prevent v2 batches from being resumed before all items have been created

4622437

matt-aitken approved these changes Jan 14, 2025

View reviewed changes

ericallam merged commit 7eda228 into main Jan 14, 2025
12 checks passed

ericallam deleted the ea-branch-4 branch January 14, 2025 14:37

coderabbitai bot mentioned this pull request Jan 23, 2025

engine v1 improved dequeue selection algorithm #1632

Merged

coderabbitai bot mentioned this pull request Feb 19, 2025

Run Engine 2.0 (alpha) #1575

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Prevent v2 batches from being resumed before all items have been created #1614

Prevent v2 batches from being resumed before all items have been created #1614

Uh oh!

ericallam commented Jan 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Jan 14, 2025

Uh oh!

coderabbitai bot commented Jan 14, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jan 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Prevent v2 batches from being resumed before all items have been created #1614

Prevent v2 batches from being resumed before all items have been created #1614

Uh oh!

Conversation

ericallam commented Jan 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Jan 14, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Poem

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jan 14, 2025

Uh oh!

Uh oh!

Uh oh!

ericallam commented Jan 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)