Fix: custom queue releaseConcurrencyOnWaitpoint.

[matt-aitken]

There was an issue with releaseConcurrencyOnWaitpoint being set when indexing. It was registered twice, once for the custom queue and again where it was being used on any tasks. On the task registrations it didn't pass through releaseConcurrencyOnWaitpoint and this was "winning".

• Now we allow setting releaseConcurrencyOnWaitpoint directly on a task queue.
• Fixed custom queues not working with releaseConcurrencyOnWaitpoint
• We show an error if you register the same queue twice but with different settings (but continue).

Summary by CodeRabbit

• New Features

  • Introduced a new configuration option that allows tasks to conditionally release concurrency during waitpoints, enhancing overall queue management.
  • Improved queue metadata registration to detect and log discrepancies in configuration settings, ensuring integrity.

• Tests

  • Added a testing module that simulates different concurrency behaviors to validate the updated task execution order.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a6a4359

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

This change updates the queue creation and metadata registration logic across multiple files to support a new parameter, releaseConcurrencyOnWaitpoint. The parameter now flows from task creation to metadata registration and into the task queue records. A new file has been added to test concurrency behavior by enqueuing tasks with differing waitpoint behaviors. These modifications adjust function signatures, data objects, and logging to ensure the new option is handled consistently across the system.

Changes

File(s)	Change Summary
apps/webapp/app/v3/services/…/createBackgroundWorker.server.ts	Updated createWorkerQueue and upsertWorkerQueueRecord functions to accept and propagate the releaseConcurrencyOnWaitpoint parameter in the function signatures and internal calls.
packages/core/src/v3/resource-catalog/standardResourceCatalog.ts	Modified registerQueueMetadata to check for mismatches in concurrencyLimit and the new releaseConcurrencyOnWaitpoint property, logging warnings and preventing conflicting queue registrations.
packages/core/src/v3/types/tasks.ts	Added an optional property releaseConcurrencyOnWaitpoint?: boolean to the CommonTaskOptions type to allow configuration of concurrency behavior at waitpoints.
packages/trigger-sdk/src/v3/shared.ts	Updated createTask and createSchemaTask functions to include the releaseConcurrencyOnWaitpoint property when registering the queue metadata with the resource catalog.
references/hello-world/src/trigger/release-concurrency.ts	Added a new file that implements concurrency testing. It defines two tasks (one with concurrency release enabled and one disabled) and validates task execution order based on the configured release behavior during waitpoints.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client Request
    participant WG as Worker Service
    participant DB as Task Queue Database

    Client->>WG: Request worker queue creation (with releaseConcurrencyOnWaitpoint flag)
    WG->>WG: Process createWorkerQueue (include flag)
    WG->>DB: Call upsertWorkerQueueRecord (with releaseConcurrencyOnWaitpoint)
    DB-->>WG: Return confirmation
    WG-->>Client: Worker queue created

Loading

sequenceDiagram
    participant Tester as waitReleaseConcurrencyTestTask
    participant Q1 as Release-Enabled Queue
    participant Q2 as Release-Disabled Queue

    Tester->>Q1: Trigger releaseEnabledTask
    Tester->>Q2: Trigger releaseDisabledTask
    Q1-->>Tester: Task starts immediately (concurrency released)
    Q2-->>Tester: Task waits for previous to complete
    Tester-->>Tester: Validate execution order & concurrency behavior

Loading

Possibly related PRs

• fix: safe upserting of task queues during worker indexing #1858: Addresses similar modifications in createBackgroundWorker.server.ts regarding the handling of the releaseConcurrencyOnWaitpoint parameter.
• fix: cleanup ttl expire run graphile jobs #1373: Involves the addition and management of the releaseConcurrencyOnWaitpoint parameter within task queue configuration.
• re2: add ability to selectively disable release concurrency queue consumers via env var #1881: Introduces enhancements to concurrency management that align with the adjustments made for releasing concurrency at waitpoints in this PR.

Suggested reviewers

• samejr
• nicktrn

Poem

I'm a hopping rabbit, light on my feet,
Coding queues and waitpoints, oh so neat!
I pass a flag for concurrency release,
Ensuring tasks and records find their peace.
With ASCII hops and joyful cheer, I code on without a fear!

---

📜 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 9d261f4 and a6a4359.

📒 Files selected for processing (5)

• apps/webapp/app/v3/services/createBackgroundWorker.server.ts (5 hunks)
• packages/core/src/v3/resource-catalog/standardResourceCatalog.ts (1 hunks)
• packages/core/src/v3/types/tasks.ts (1 hunks)
• packages/trigger-sdk/src/v3/shared.ts (2 hunks)
• references/hello-world/src/trigger/release-concurrency.ts (1 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.