Skip to content

Use idempotency key index when finding existing runs by idempotency key in batch #1677

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

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Feb 7, 2025

Summary by CodeRabbit

  • New Features
    • Introduced context-aware task handling with idempotency support to ensure consistent, reliable batch operations.
  • Refactor
    • Optimized batch processing by grouping tasks and executing related queries in parallel, resulting in faster performance and improved error management for duplicate operations.

Copy link

changeset-bot bot commented Feb 7, 2025

⚠️ No Changeset found

Latest commit: ca17fe9

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

Walkthrough

This update refactors the batch processing logic in two modules. In the BatchTriggerV3Service, the #prepareRunData method now groups items by their taskIdentifier and performs parallel database queries using Promise.all, while also enhancing error handling for unique constraint violations. In the allV2TestTask function, an additional context parameter has been added and payloads now include an options property with an idempotencyKey generated via randomUUID to strengthen idempotency during task triggers.

Changes

File Change Summary
apps/webapp/.../batchTriggerV3.server.ts Refactored #prepareRunData to group items by taskIdentifier using reduce; replaced flat idempotencyKeys with parallel findMany queries; improved error checking/logging.
references/v3-catalog/.../batch.ts Updated allV2TestTask run method by adding a { ctx } parameter and modifying payloads to include an options property with an idempotencyKey generated by randomUUID.

Sequence Diagram(s)

sequenceDiagram
    participant Service as BatchTriggerV3Service
    participant Group as Item Grouper
    participant DB as Database
    participant Logger as Error Logger

    Service->>Group: Group items by taskIdentifier
    Group-->>Service: Grouped items
    par Parallel Queries
        Service->>DB: findMany(query for taskIdentifier 1)
        Service->>DB: findMany(query for taskIdentifier 2)
    end
    DB-->>Service: Return cached runs
    alt Unique constraint violation detected
        Service->>Logger: Log debug message (item exists)
    end
Loading
sequenceDiagram
    participant Caller as Task Initiator
    participant Task as allV2TestTask
    participant Batch as Batch Trigger

    Caller->>Task: Call run({ triggerSequentially? }, { ctx })
    Task->>Task: Generate payload with options { idempotencyKey: randomUUID() }
    Task->>Batch: Trigger batch with payload
    Batch-->>Task: Return result
    Task-->>Caller: Return execution outcome
Loading

Possibly related PRs

Suggested reviewers

  • matt-aitken

Poem

In the realm of code I hop along,
Grouping tasks to make the system strong.
Parallel queries race with grace,
Ensuring errors find their place.
With each neat change, I cheer with glee —
A bunny’s code is wild and free!
Happy hops to all in the dev spree!

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.

references/v3-catalog/src/trigger/batch.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.

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.

✨ 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 (1)
apps/webapp/app/v3/services/batchTriggerV3.server.ts (1)

343-365: Excellent optimization of database queries.

The changes improve performance by:

  1. Fetching cached runs for each task identifier separately
  2. Using Promise.all for parallel execution
  3. Leveraging database indexes effectively through the taskIdentifier

This approach significantly reduces database load by:

  • Making better use of indexes
  • Reducing the number of database roundtrips
  • Enabling parallel query execution
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b555fa and ca17fe9.

📒 Files selected for processing (2)
  • apps/webapp/app/v3/services/batchTriggerV3.server.ts (1 hunks)
  • references/v3-catalog/src/trigger/batch.ts (1 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: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
references/v3-catalog/src/trigger/batch.ts (2)

129-129: LGTM: Added context parameter to run method.

The addition of the ctx parameter allows access to the execution context, which is a good practice for better context management.


132-146: LGTM: Added idempotency keys for batch items.

The addition of unique idempotency keys using randomUUID() for each batch item is a good practice that ensures:

  1. Each batch item has a unique identifier
  2. Prevents duplicate processing
  3. Enables proper caching and retrieval
apps/webapp/app/v3/services/batchTriggerV3.server.ts (1)

332-341: LGTM: Optimized item grouping by taskIdentifier.

The implementation efficiently groups items by their taskIdentifier using reduce, which helps in optimizing subsequent database queries.

@ericallam ericallam merged commit b586762 into main Feb 7, 2025
11 checks passed
@ericallam ericallam deleted the ea-branch-17 branch February 7, 2025 13:36
@coderabbitai coderabbitai bot mentioned this pull request Feb 17, 2025
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