fix: safe upserting of task queues during worker indexing

[ericallam]

Summary by CodeRabbit

• Refactor

  • Streamlined background task processing by modularizing and improving the logic for managing task queues, resulting in more efficient and resilient operations.

• New Features

  • Introduced a shared task queue with multiple new tasks that enhance concurrency management and scheduling, ensuring that concurrent operations adhere to specified execution limits.

[changeset-bot]

⚠️ No Changeset found

Latest commit: d5227bc

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]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes modularize the task queue management logic and introduce new shared queue tasks. In createBackgroundWorker.server.ts, the existing createWorkerQueue logic is refactored to delegate finding or creating a task queue to a new helper, upsertWorkerQueueRecord, which includes retry logic for unique constraint errors. In queues.ts, a new shared queue named myQueue with a concurrency limit of 2 is added along with several tasks and a test task to validate concurrent task execution.

Changes

File(s) Changed	Change Summary
apps/webapp/.../createBackgroundWorker.server.ts	Refactored createWorkerQueue to invoke the new helper upsertWorkerQueueRecord for encapsulating queue lookup, creation, update, and error handling (including retries for Prisma error P2002).
references/hello-world/.../queues.ts	Added a new shared queue myQueue with a concurrency limit of 2, defined a new Payload type, and introduced five shared tasks (sharedQueueTask1–sharedQueueTask5) along with a test task (sharedQueueTestTask) to enforce and verify concurrency.

Sequence Diagram(s)

sequenceDiagram
    participant Worker as createWorkerQueue
    participant Helper as upsertWorkerQueueRecord
    participant Prisma as Prisma Client

    Worker ->> Helper: Request upsert of task queue
    Helper ->> Prisma: Query existing task queue (findFirst)
    alt Queue found
      Prisma -->> Helper: Return existing queue record
      Helper ->> Prisma: Update queue record (add/update worker connections)
    else Queue not found
      Prisma -->> Helper: No queue found
      Helper ->> Prisma: Create new task queue record
    end
    alt Unique constraint error (P2002)
      Helper ->> Helper: Retry up to three attempts
    end
    Helper -->> Worker: Return task queue record

Loading

sequenceDiagram
    participant Test as sharedQueueTestTask
    participant Queue as myQueue
    participant Task as SharedTask

    Test ->> Queue: Trigger batch of tasks
    Queue -->> Task: Dequeue a task for execution
    Task ->> Queue: Log start, process (waitSeconds), and complete task
    Queue -->> Test: Return task execution result

Loading

Possibly related PRs

• Fix issue with heavy contention on TaskQueue updating concurrency limit #1653: Refactors the createWorkerQueue function using a helper for task queue management, sharing similarities with the current queue logic enhancements.
• Task queues weren’t setting concurrencyLimit or releaseConcurrencyOnWaitpoint #1844: Alters the queue creation function to include concurrency settings, reflecting similar code-level modifications in task queue management.

Suggested reviewers

• matt-aitken

Poem

Hoppity hops through lines of code,
I nibble on changes in every node.
With new queues and tasks in a row,
My carrot dreams of clean code grow.
In modular fields, my whiskers twitch in delight,
Celebrating each fix from morning till 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 4d5080d and d5227bc.

📒 Files selected for processing (2)

• apps/webapp/app/v3/services/createBackgroundWorker.server.ts (2 hunks)
• references/hello-world/src/trigger/queues.ts (2 hunks)

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.