Fix for queue indexing not updating concurrencyLimit/removing it

[matt-aitken]

When updating a queue the concurrencyLimit wasn't getting updated/removed. Made sure that releaseConcurrencyOnWaitpoint is set correctly to false if it's omitted (in an update)

Summary by CodeRabbit

• Refactor
  • Enhanced background processing to ensure more predictable and reliable task execution.
  • Updated internal parameter handling to improve overall system stability and performance.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4a3f93f

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]

Walkthrough

This change refines parameter handling in background worker queue functions. Specifically, the type of concurrencyLimit is updated from number | undefined to number | null, and its default value is changed from undefined to null. Additionally, the releaseConcurrencyOnWaitpoint parameter is now strictly a boolean (defaulting to false if not provided). These modifications ensure clearer type expectations and predictable behavior for both the createWorkerQueue and upsertWorkerQueueRecord functions.

Changes

File	Change Summary
apps/webapp/app/v3/services/createBackgroundWorker.server.ts	- Updated concurrencyLimit parameter from `number

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant createWorkerQueue
    participant upsertWorkerQueueRecord

    Caller->>createWorkerQueue: Call with parameters
    alt Concurrency limit provided
        createWorkerQueue->>upsertWorkerQueueRecord: Pass provided concurrencyLimit
    else Not provided
        createWorkerQueue->>upsertWorkerQueueRecord: Pass null as concurrencyLimit
    end
    alt releaseConcurrencyOnWaitpoint is valid boolean
        createWorkerQueue->>upsertWorkerQueueRecord: Pass provided releaseConcurrencyOnWaitpoint
    else Not a boolean or missing
        createWorkerQueue->>upsertWorkerQueueRecord: Pass false as releaseConcurrencyOnWaitpoint
    end

Loading

Possibly related PRs

• Task queues weren’t setting concurrencyLimit or releaseConcurrencyOnWaitpoint #1844: Introduced parameter handling for concurrencyLimit and releaseConcurrencyOnWaitpoint in the createWorkerQueue function.
• Fix: custom queue releaseConcurrencyOnWaitpoint. #1896: Adjusted the handling of releaseConcurrencyOnWaitpoint in both createWorkerQueue and upsertWorkerQueueRecord functions.
• Fix issue with heavy contention on TaskQueue updating concurrency limit #1653: Modified the default behavior of the concurrencyLimit parameter by enabling null to indicate no limit.

Suggested reviewers

• ericallam
• samejr

Poem

I'm a crafty rabbit with a twitch in my nose,
Hopping through the code where the pure logic flows.
With null for no limit and booleans so right,
The worker queues now dance in the bright daylight.
Happy hops and code leaps—let's celebrate tonight! 🐰

---

📜 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 8382274 and 4a3f93f.

📒 Files selected for processing (1)

• apps/webapp/app/v3/services/createBackgroundWorker.server.ts (4 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 (ubuntu-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: typecheck / typecheck
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (4)

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

368-373: Improved handling of concurrencyLimit and releaseConcurrencyOnWaitpoint.

The changes correctly ensure that:

1. concurrencyLimit defaults to null rather than undefined when not provided
2. releaseConcurrencyOnWaitpoint explicitly defaults to false when not provided as a boolean

These changes fix the issue described in the PR where queue indexing wasn't properly updating or removing the concurrencyLimit during updates.

---

405-408: Type definitions aligned with implementation.

Great improvement to the type definitions:

• Changing concurrencyLimit from number | undefined to number | null makes it clear that null is the expected "no value" state
• Changing releaseConcurrencyOnWaitpoint from boolean | undefined to boolean enforces that this value must always be explicitly provided

This makes the function signature more accurate and prevents potential errors.

---

433-434: Direct usage of parameters matches updated type definitions.

The parameter is now used directly in the data object without additional null checks, which aligns with the updated type definition ensuring it's always a boolean.

---

453-454: Consistent parameter usage in update operation.

Both concurrencyLimit and releaseConcurrencyOnWaitpoint are now used consistently in updates, ensuring that the queue indexing correctly updates or removes these values as needed.

✨ 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.

[nicktrn]

Who doesn't like nulls?