Skip to content

Reduce contention on batchTaskRun when setting expected count #1662

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
Feb 4, 2025

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Feb 4, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved batch task processing for more accurate tracking and completion of operations.
  • Chores
    • Enhanced underlying error handling and retry logic to boost overall system stability and resilience.

Copy link

changeset-bot bot commented Feb 4, 2025

⚠️ No Changeset found

Latest commit: 65b91a9

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 Feb 4, 2025

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/batchTriggerV3.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.

internal-packages/database/src/transaction.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 changes update the batch processing and database transaction logic. In the batch service, an expectedCount variable is introduced to track the successful processing of items. The method for item processing now returns a boolean and the logic to mark a batch as completed is refined with an explicit check and timeout. In the transaction module, a new maxRetries option was added and the $transaction function now supports retrying transactions on encountering a specific error code.

Changes

File(s) Change Summary
apps/webapp/app/v3/services/batchTriggerV3.server.ts Introduced expectedCount in batch item processing; modified #processBatchTaskRunItem to return a boolean; streamlined unique constraint error handling; updated completeBatchTaskRunItemV3 to check batch status and completed count with a 10-second transaction timeout.
internal-packages/database/src/transaction.ts Added an optional maxRetries property to PrismaTransactionOptions; updated $transaction function by adding an attempt parameter and introducing a retry mechanism for Prisma error code "P2034".

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant B as BatchTriggerV3Service
    participant DB as Database

    C->>B: Initiate batch processing
    B->>B: Call #processBatchTaskRunItems
    loop Process Each Item
        B->>B: Call #processBatchTaskRunItem
        B-->>B: Returns Boolean (success/failure)
        B->>B: Increment expectedCount if successful
    end
    B->>B: Check if completed count == expectedCount
    B->>DB: Update batch status to COMPLETED (with 10s timeout)
    DB-->>B: Confirmation update
Loading
sequenceDiagram
    participant App as Application
    participant TX as $transaction Function
    participant DB as Database

    App->>TX: Execute transaction
    TX->>DB: Run database operations
    alt Serialization failure ("P2034")
        TX->>TX: Check maxRetries and attempt count
        TX->>DB: Retry transaction call (recursive)
    else Successful operation
        DB-->>TX: Return results
    end
    TX-->>App: Transaction result
Loading

Possibly related PRs

Poem

I'm a clever little rabbit 🐰,
Hoping through the code with glee,
Expected counts are now our guide,
Transactions retry, errors subside,
Batch processes dance, bugs flee,
Celebrating changes so merrily!
^(>^.^<)^

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
apps/webapp/app/v3/services/batchTriggerV3.server.ts (2)

763-763: Name alignment.

expectedCount here tracks how many new items are “expected” to complete based on creation. Consider a name like newlyCreatedItems or similar to distinguish it from the expectedCount column on the batch more explicitly.


990-992: Timeout choice.

A 10-second transaction timeout may be sufficient for typical load, but under heavy database contention it could lead to frequent retries or partial updates. Validate this value in load testing.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 53e6d47 and 65b91a9.

📒 Files selected for processing (2)
  • apps/webapp/app/v3/services/batchTriggerV3.server.ts (5 hunks)
  • internal-packages/database/src/transaction.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (7)
internal-packages/database/src/transaction.ts (3)

33-39: Well-documented addition of maxRetries.

The inline references to the Prisma docs provide clarity on when to adjust maxRetries. This is a straightforward and helpful enhancement.


46-47: Consider clarifying recursion boundaries.

Using attempt = 0 is fine as a default, but ensure large values of maxRetries won't inadvertently create very deep recursion if an error persists. You could potentially mitigate this by adding an upper bound check or considering an iterative retry approach for extreme edge cases.


57-63: Good handling of Prisma "P2034" retry logic.

The condition ensures retries happen only for serialization failures, and the recursion is guarded by the attempt < options.maxRetries check. This is a clean and robust solution.

apps/webapp/app/v3/services/batchTriggerV3.server.ts (4)

767-776: Incrementing the batch’s “expected count.”

Your approach of incrementing expectedCount only if an item is newly created avoids double counting, which is good. Ensure concurrency is handled if multiple chunks process in parallel; the final persisted value should accurately sum all newly created items across chunks.


794-803: Piecing together the “expectedCount.”

Wrapping the single update in a separate logic block reduces the number of writes to the database, which helps avoid repeated row locks. This looks aligned with the PR’s goal of minimizing contention.


928-948: Use minimal update for changing item status.

Marking the item as "COMPLETED" only if it was previously "PENDING" is straightforward and prevents redundant updates. This helps keep the transaction light and reduces possible contention on high-traffic tables.


950-987: Batch finalization logic.

Incrementing the completedCount and checking completedCount === expectedCount && sealed to mark the batch COMPLETED is clear. Note that race conditions can occur if multiple items complete simultaneously. Your check on the batch’s status being "PENDING" mitigates the risk of double-completing the same batch.

Copy link

pkg-pr-new bot commented Feb 4, 2025

@trigger.dev/build

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

trigger.dev

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

@trigger.dev/react-hooks

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

@trigger.dev/core

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

@trigger.dev/rsc

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

@trigger.dev/sdk

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

commit: 65b91a9

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.

1 participant