fix(run-engine): stop a '*' concurrency key stranding its whole base queue - #4628
fix(run-engine): stop a '*' concurrency key stranding its whole base queue#46281stvamp wants to merge 1 commit into
Conversation
…queue A concurrency key is an unrestricted client string, so '*' reaches the queue unescaped, and queueKey renders it as a variant name byte-identical to the wildcard member the CK scripts keep in the master queue for that base queue. Each CK script rebalances the master queue with that wildcard member and then removes the 'old-format' entry for the variant it just touched. Where the variant IS the wildcard those two calls name the same member, so the cleanup undid the rebalance and took the base queue's only master-queue entry with it. Nothing then pointed at the queue, so every concurrency key on it silently stopped being dequeued until some later write happened to re-add the member. Guards the cleanup in all 10 CK scripts (4 enqueue, 6 ack/nack/dead-letter). No key-format change, so state already in Redis is repaired by the next write rather than needing a migration. Tests cover the enqueue, ack and nack paths, and fail without the guard.
|
WalkthroughThe run queue now preserves the master-queue wildcard entry when the concurrency key is Merge Risk: ⚪ Minimal · up to The change prevents wildcard concurrency keys from stranding their base queues, and no actionable merge-blocking risk remains; the remaining test import cleanup is minor and localized. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 34739a5b-f23e-4bde-83f2-6c153541a78a
📒 Files selected for processing (3)
.server-changes/ck-wildcard-queue-strand.mdinternal-packages/run-engine/src/run-queue/index.tsinternal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.ts
📜 Review details
⏰ Context from checks skipped due to timeout. (19)
- GitHub Check: fk-cascade-guard / fk-cascade-guard
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (11, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (12, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (3, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (1, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (7, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (10, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (4, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (9, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (5, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (8, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (2, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (6, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal
- GitHub Check: e2e-webapp / 🧪 E2E Tests: Webapp
- GitHub Check: runops-guard / runops-guard
- GitHub Check: typecheck / typecheck
- GitHub Check: code-quality / code-quality
- GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/*.{ts,tsx}: Use types over interfaces for TypeScript
Avoid using enums; prefer string unions or const objects instead
**/*.{ts,tsx}: Prefer static imports over dynamicimport(); use dynamic imports only for unresolvable circular dependencies, genuine performance code splitting, or conditional runtime loading.
Import Trigger.dev tasks from@trigger.dev/sdk; never use@trigger.dev/sdk/v3or deprecatedclient.defineJob.
Add agentcrumbs while writing code using approved namespaces; mark lines with//@Crumbsor blocks with `// `#region` `@crumbs, and strip them before merging.
Files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use function declarations instead of default exports
Files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
**/*.{test,spec}.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use vitest for all tests in the Trigger.dev repository
**/*.{test,spec}.{ts,tsx}: Use Vitest exclusively and never mock dependencies; use Testcontainers for integration dependencies.
Place test files next to the source files they test.
Files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.ts
**/*.ts
📄 CodeRabbit inference engine (.cursor/rules/otel-metrics.mdc)
**/*.ts: When creating or editing OTEL metrics (counters, histograms, gauges), ensure metric attributes have low cardinality by using only enums, booleans, bounded error codes, or bounded shard IDs
Do not use high-cardinality attributes in OTEL metrics such as UUIDs/IDs (envId, userId, runId, projectId, organizationId), unbounded integers (itemCount, batchSize, retryCount), timestamps (createdAt, startTime), or free-form strings (errorMessage, taskName, queueName)
When exporting OTEL metrics via OTLP to Prometheus, be aware that the exporter automatically adds unit suffixes to metric names (e.g., 'my_duration_ms' becomes 'my_duration_ms_milliseconds', 'my_counter' becomes 'my_counter_total'). Account for these transformations when writing Grafana dashboards or Prometheus queries
Files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
internal-packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
For internal packages, use
typecheckfor verification and never usebuildas the correctness check.
Files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
🧠 Learnings (13)
📚 Learning: 2026-07-26T13:14:02.968Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 4378
File: .server-changes/realtime-run-reads-from-primary.md:0-0
Timestamp: 2026-07-26T13:14:02.968Z
Learning: For files in the .server-changes directory, the body text is published verbatim as dashboard-facing user release notes. Write entries in terms of user-visible behavior (what users can do/see), and avoid implementation-oriented details such as environment-variable names, internal mechanisms, or configuration knobs. If you need to include operational/configuration specifics, put those details in the PR description instead of the .server-changes entry.
Applied to files:
.server-changes/ck-wildcard-queue-strand.md
📚 Learning: 2026-05-14T14:54:39.095Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3545
File: .server-changes/agent-view-sessions.md:10-10
Timestamp: 2026-05-14T14:54:39.095Z
Learning: In the `trigger.dev` repository, do not flag inconsistent dot vs slash notation in route/path strings inside `.server-changes/*.md` files. These markdown files are consumed verbatim into the changelog, so the mixed notation (e.g., `resources.orgs.../runs.$runParam/...`) is intentional and should be preserved as-is.
Applied to files:
.server-changes/ck-wildcard-queue-strand.md
📚 Learning: 2026-03-22T13:26:12.060Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3244
File: apps/webapp/app/components/code/TextEditor.tsx:81-86
Timestamp: 2026-03-22T13:26:12.060Z
Learning: In the triggerdotdev/trigger.dev codebase, do not flag `navigator.clipboard.writeText(...)` calls for `missing-await`/`unhandled-promise` issues. These clipboard writes are intentionally invoked without `await` and without `catch` handlers across the project; keep that behavior consistent when reviewing TypeScript/TSX files (e.g., usages like in `apps/webapp/app/components/code/TextEditor.tsx`).
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-03-22T19:24:14.403Z
Learnt from: matt-aitken
Repo: triggerdotdev/trigger.dev PR: 3187
File: apps/webapp/app/v3/services/alerts/deliverErrorGroupAlert.server.ts:200-204
Timestamp: 2026-03-22T19:24:14.403Z
Learning: In the triggerdotdev/trigger.dev codebase, webhook URLs are not expected to contain embedded credentials/secrets (e.g., fields like `ProjectAlertWebhookProperties` should only hold credential-free webhook endpoints). During code review, if you see logging or inclusion of raw webhook URLs in error messages, do not automatically treat it as a credential-leak/secrets-in-logs issue by default—first verify the URL does not contain embedded credentials (for example, no username/password in the URL, no obvious secret/token query params or fragments). If the URL is credential-free per this project’s conventions, allow the logging.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-05-18T08:21:27.694Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3632
File: apps/webapp/sentry.server.ts:4-21
Timestamp: 2026-05-18T08:21:27.694Z
Learning: When handling Prisma error P1001 ("Can't reach database server") in TypeScript, don’t assume a single error shape. Prisma can surface P1001 via two different error classes/fields: `PrismaClientKnownRequestError` exposes it as `err.code === "P1001"` (common during mid-query connection drops), while `PrismaClientInitializationError` exposes it as `err.errorCode === "P1001"` (common on client startup failure). Therefore, predicates should use `err.code === "P1001" || err.errorCode === "P1001"`. Do not flag `err.code === "P1001"` as “unreachable/never matches,” as it is expected in production.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-05-18T08:21:27.694Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3632
File: apps/webapp/sentry.server.ts:4-21
Timestamp: 2026-05-18T08:21:27.694Z
Learning: When handling Prisma errors for P1001 ("Can't reach database server"), do not assume it only appears under a single property name. Prisma may surface P1001 via either `PrismaClientKnownRequestError` (`err.code === "P1001"`, e.g., mid-query connection drops) or `PrismaClientInitializationError` (`err.errorCode === "P1001"`, e.g., client startup connection failure). To reliably detect the condition, check `err.code === "P1001" || err.errorCode === "P1001"`, and avoid review rules that would incorrectly flag `err.code === "P1001"` as unreachable/never-matching.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-06-13T19:53:13.759Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3937
File: packages/trigger-sdk/skills/realtime-and-frontend/SKILL.md:258-260
Timestamp: 2026-06-13T19:53:13.759Z
Learning: When reviewing code that uses `trigger.dev/react-hooks`’s `useRealtimeRun`, preserve the call signature where the first argument is the full realtime handle object (not `handle.id`). This is intentional to maintain type-safety and is consistent with the official docs; do not suggest changing the first argument from the handle object to `handle.id`.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-06-17T17:13:49.929Z
Learnt from: matt-aitken
Repo: triggerdotdev/trigger.dev PR: 3948
File: apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.bulk-actions.$bulkActionParam/route.tsx:48-62
Timestamp: 2026-06-17T17:13:49.929Z
Learning: In triggerdotdev/trigger.dev, within `dashboardLoader`/`dashboardAction` (or similar context resolver code) whenever you resolve an organization ID from an organization slug for RBAC/enterprise authorization scope, always read from the primary Prisma client (`prisma`), not `$replica`. Using `$replica` can hit replica-lag and cause the RBAC lookup/authorization to run without the correct org scope (bypassing intended role enforcement). Implement the slug→org lookup with `prisma.organization.findFirst(...)` (or equivalent primary-client query) and add an inline comment documenting why the primary client is required (replica lag could lead to unscoped RBAC checks).
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-06-23T13:04:21.413Z
Learnt from: carderne
Repo: triggerdotdev/trigger.dev PR: 4023
File: apps/webapp/app/services/upsertBranch.server.ts:14-18
Timestamp: 2026-06-23T13:04:21.413Z
Learning: In TypeScript, it’s valid to `import { type X }` and then use `typeof X` in a type-only position, e.g. `type Alias = z.infer<typeof X>`. The `type` modifier suppresses the runtime import, but the type checker still has the full exported type so `z.infer<typeof X>` can resolve correctly. In code reviews, don’t flag this as a TypeScript compile error as long as `typeof X` is used in a type context (e.g., with `z.infer`, `type` aliases, generics), not as a runtime value.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-05-18T14:40:02.173Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3658
File: packages/core/src/v3/realtimeStreams/manager.test.ts:1-147
Timestamp: 2026-05-18T14:40:02.173Z
Learning: In the triggerdotdev/trigger.dev repo, the policy “Never mock anything — use testcontainers instead” should only be enforced for integration tests that interact with real external services (e.g., Redis, Postgres) via actual infrastructure. For unit tests that exercise pure in-memory logic (e.g., cache semantics) it is OK to stub collaborators such as `ApiClient` using Vitest (`vi.fn()`) to assert call counts or control behavior. Do not flag `vi.fn()`-based `ApiClient` stubs in unit tests as violations of the testcontainers policy.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.ts
📚 Learning: 2026-06-04T18:16:35.386Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3836
File: apps/supervisor/src/backpressure/backpressureMonitor.ts:3-5
Timestamp: 2026-06-04T18:16:35.386Z
Learning: When reviewing TypeScript in this repo, apply the rule “prefer type aliases over interfaces” only to data/object shapes and union/intersection type modeling. If an interface is being used as a behavioral contract for collaborators to implement (e.g., method-shape interfaces that define required behavior, such as `BackpressureLogger` / `BackpressureSignalSource` in `apps/supervisor/src/backpressure/backpressureMonitor.ts`), keep it as an `interface` and do not flag it as a type-alias-vs-interface violation.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-06-09T17:58:04.699Z
Learnt from: 0ski
Repo: triggerdotdev/trigger.dev PR: 3879
File: apps/webapp/app/models/vercelIntegration.server.ts:619-630
Timestamp: 2026-06-09T17:58:04.699Z
Learning: In this codebase, outbound raw `fetch` calls should typically rely on Node/undici’s default request timeout (about ~300s) rather than adding a per-call `AbortController` + `setTimeout` wrapper inside individual functions (e.g. in files like `apps/webapp/app/models/vercelIntegration.server.ts`). During code review, do not flag the absence of a per-call timeout on a single `fetch` as an issue; if per-call timeouts are needed, they should be implemented via a codebase-wide convention (e.g., a shared fetch wrapper or documented pattern) rather than ad-hoc per-function changes.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsinternal-packages/run-engine/src/run-queue/index.ts
📚 Learning: 2026-06-16T09:19:47.637Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3960
File: apps/webapp/test/prismaInfrastructureErrorCapture.test.ts:0-0
Timestamp: 2026-06-16T09:19:47.637Z
Learning: In this repo’s Vitest setup, `vitest.config.ts` uses `globals: true`, so identifiers like `vi`, `describe`, `it`, and `expect` are available as globals in Vitest test files. During code review, do not flag missing `vi`/`describe`/`it`/`expect` imports as a runtime error or correctness issue when they’re used in `*.test.ts/tsx` or `*.spec.ts/tsx` files. Explicit imports are still preferred for consistency, but they’re not required for runtime behavior.
Applied to files:
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.ts
🔇 Additional comments (3)
internal-packages/run-engine/src/run-queue/index.ts (1)
3606-3612: LGTM!Also applies to: 3716-3722, 3851-3857, 3974-3980, 4931-4937, 5001-5007, 5052-5058, 5133-5139, 5244-5250, 5309-5315
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.ts (1)
1-4: LGTM!Also applies to: 6-191
.server-changes/ck-wildcard-queue-strand.md (1)
1-6: LGTM!
| import { trace } from "@internal/tracing"; | ||
| import { Logger } from "@trigger.dev/core/logger"; | ||
| import { Decimal } from "@trigger.dev/database"; | ||
| import { describe } from "node:test"; |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -eu
target='internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.ts'
printf '%s\n' '--- target file ---'
cat -n "$target"
printf '%s\n' '--- nearby package/config files ---'
find internal-packages/run-engine -maxdepth 2 -type f \
\( -name 'package.json' -o -name '*vitest*' -o -name 'vite.config.*' -o -name 'tsconfig*.json' \) \
-print
printf '%s\n' '--- test-framework references ---'
rg -n --glob 'package.json' --glob '*vitest*' --glob 'vite.config.*' --glob 'tsconfig*.json' \
'vitest|node:test|include|test' internal-packages/run-engine .github 2>/dev/null | head -200Repository: triggerdotdev/trigger.dev
Length of output: 10921
🏁 Script executed:
#!/bin/bash
set -eu
printf '%s\n' '--- Vitest config ---'
cat -n internal-packages/run-engine/vitest.config.ts
printf '%s\n' '--- package scripts ---'
sed -n '35,55p' internal-packages/run-engine/package.json
printf '%s\n' '--- test imports in run-engine ---'
rg -n --glob '*.test.ts' 'from "(vitest|node:test)"|from "(vitest|node:test)/' \
internal-packages/run-engine/src | head -120
printf '%s\n' '--- test API usage in target ---'
rg -n '^(import|export)|\b(describe|it|test|expect|vi)\b' \
internal-packages/run-engine/src/run-queue/tests/ckWildcardKey.test.tsRepository: triggerdotdev/trigger.dev
Length of output: 11898
Import describe from Vitest.
This file runs under Vitest. Importing describe from node:test mixes test frameworks.
Proposed fix
-import { describe } from "node:test";
+import { describe } from "vitest";📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| import { describe } from "node:test"; | |
| import { describe } from "vitest"; |
Source: Coding guidelines
1 participant
The bug
A concurrency key is an unrestricted client string (
ConcurrencyKeySchemaisz.union([z.string(), z.number()]).transform(String)), andconcurrencyKeySectiondoes no escaping, so*reaches the queue raw.queueKeythen renders it as...:queue:<q>:ck:*, which is byte-identical to the wildcard member the CK scripts keep in the master queue to mean "this base queue has concurrency-key work".Every CK script ends with the same pair:
ckWildcardNameistoCkWildcard(message.queue), and for a*-keyed run that returns the identical string, so the cleanup on the second line deletes what the rebalance on the first line just wrote.The master queue then has no entry for that base queue, while
ckIndexand the variant queues still hold the work. Every concurrency key on the queue stops being dequeued, not just the*one. It is silent, and it only recovers if some later write happens to re-add the member.Reproduced before the fix:
Blast radius is bounded to the environment that triggers it, so it is self-inflicted rather than cross-tenant, but a single trigger stalls the queue for everything on it.
The fix
Guard the cleanup so it never removes the wildcard member:
Applied to all 10 CK scripts (4 enqueue, 6 ack/nack/dead-letter). No key-format change and no migration: a queue already stranded in Redis is repaired by its next write.
I considered rejecting
*at the API boundary instead and rejected it. Existing Redis state andTaskRun.concurrencyKeyrows already hold raw:-bearing and*keys, so changing key construction would orphan in-flight messages and split concurrency accounting mid-deploy. Boundary validation would still be reasonable as belt-and-braces later, but the Lua guard alone fixes it including for state already out there.Testing
ckWildcardKey.test.tscovers the enqueue, ack and nack paths. All three pass with the guard and all three fail without it, verified by reverting. Fullsrc/run-queue/suite is green (166 tests).Note for #4367
The virtual-time branch adds three more CK scripts with the same pattern (
enqueueMessageCkVtimeTracked,enqueueMessageWithTtlCkVtimeTracked,nackMessageCkVtimeTracked). They do not exist on main so they are not in this PR; the same guard needs applying there, and I will do that on that branch.