Skip to content

Commit c828724

Browse files
committed
refactor(sdk,core,webapp): combined concurrency override API names
The override and reset endpoints, client methods and SDK functions now say combinedConcurrencyLimit, matching the queue option.
1 parent 3a2b871 commit c828724

5 files changed

Lines changed: 17 additions & 17 deletions

File tree

‎.changeset/queue-concurrency-overrides.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
"@trigger.dev/core": patch
44
---
55

6-
Adjust queue concurrency at runtime, per key and in total. `queues.overrideConcurrencyLimit` accepts a `concurrencyKey` to raise or lower one key's limit without touching the rest of the queue, and the new `queues.overrideTotalConcurrencyLimit` and `queues.resetTotalConcurrencyLimit` adjust the cap across all keys.
6+
Adjust queue concurrency at runtime, per key and combined. `queues.overrideConcurrencyLimit` accepts a `concurrencyKey` to raise or lower one key's limit without touching the rest of the queue, and the new `queues.overrideCombinedConcurrencyLimit` and `queues.resetCombinedConcurrencyLimit` adjust the cap across all keys.
77

88
```ts
99
import { queues } from "@trigger.dev/sdk";
1010

1111
await queues.overrideConcurrencyLimit("my-queue", 20, { concurrencyKey: "tenant-123" });
1212
await queues.resetConcurrencyLimit("my-queue", { concurrencyKey: "tenant-123" });
1313

14-
await queues.overrideTotalConcurrencyLimit("my-queue", 100);
15-
await queues.resetTotalConcurrencyLimit("my-queue");
14+
await queues.overrideCombinedConcurrencyLimit("my-queue", 100);
15+
await queues.resetCombinedConcurrencyLimit("my-queue");
1616
```
1717

18-
Overrides survive deploys and reset back to the declared configuration. Enforcement happens server-side on servers with total concurrency limits enabled.
18+
Overrides survive deploys and reset back to the declared configuration. Enforcement happens server-side on servers with combined concurrency limits enabled.

apps/webapp/app/routes/api.v1.queues.$queueParam.concurrency.total.override.ts renamed to apps/webapp/app/routes/api.v1.queues.$queueParam.concurrency.combined.override.ts

File renamed without changes.

apps/webapp/app/routes/api.v1.queues.$queueParam.concurrency.total.reset.ts renamed to apps/webapp/app/routes/api.v1.queues.$queueParam.concurrency.combined.reset.ts

File renamed without changes.

‎packages/core/src/v3/apiClient/index.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1765,7 +1765,7 @@ export class ApiClient {
17651765
);
17661766
}
17671767

1768-
overrideQueueTotalConcurrencyLimit(
1768+
overrideQueueCombinedConcurrencyLimit(
17691769
queue: RetrieveQueueParam,
17701770
concurrencyLimit: number,
17711771
requestOptions?: ZodFetchOptions
@@ -1777,7 +1777,7 @@ export class ApiClient {
17771777

17781778
return zodfetch(
17791779
QueueItem,
1780-
`${this.baseUrl}/api/v1/queues/${encodedValue}/concurrency/total/override`,
1780+
`${this.baseUrl}/api/v1/queues/${encodedValue}/concurrency/combined/override`,
17811781
{
17821782
method: "POST",
17831783
headers: this.#getHeaders(false),
@@ -1790,15 +1790,15 @@ export class ApiClient {
17901790
);
17911791
}
17921792

1793-
resetQueueTotalConcurrencyLimit(queue: RetrieveQueueParam, requestOptions?: ZodFetchOptions) {
1793+
resetQueueCombinedConcurrencyLimit(queue: RetrieveQueueParam, requestOptions?: ZodFetchOptions) {
17941794
const type = typeof queue === "string" ? "id" : queue.type;
17951795
const value = typeof queue === "string" ? queue : queue.name;
17961796

17971797
const encodedValue = encodeURIComponent(value.replace(/\//g, "%2F"));
17981798

17991799
return zodfetch(
18001800
QueueItem,
1801-
`${this.baseUrl}/api/v1/queues/${encodedValue}/concurrency/total/reset`,
1801+
`${this.baseUrl}/api/v1/queues/${encodedValue}/concurrency/combined/reset`,
18021802
{
18031803
method: "POST",
18041804
headers: this.#getHeaders(false),

‎packages/trigger-sdk/src/v3/queues.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -183,14 +183,14 @@ export function overrideConcurrencyLimit(
183183
}
184184

185185
/**
186-
* Overrides the total concurrency limit of a queue: the cap on concurrent runs across
186+
* Overrides the combined concurrency limit of a queue: the cap on concurrent runs across
187187
* all of its `concurrencyKey` values.
188188
*
189189
* @param queue - The ID of the queue, or the type and name
190-
* @param concurrencyLimit - The total concurrency limit to apply
190+
* @param concurrencyLimit - The combined concurrency limit to apply
191191
* @returns The updated queue state
192192
*/
193-
export function overrideTotalConcurrencyLimit(
193+
export function overrideCombinedConcurrencyLimit(
194194
queue: RetrieveQueueParam,
195195
concurrencyLimit: number,
196196
requestOptions?: ApiRequestOptions
@@ -200,7 +200,7 @@ export function overrideTotalConcurrencyLimit(
200200
const $requestOptions = mergeRequestOptions(
201201
{
202202
tracer,
203-
name: "queues.overrideTotalConcurrencyLimit()",
203+
name: "queues.overrideCombinedConcurrencyLimit()",
204204
icon: "queue",
205205
attributes: {
206206
...flattenAttributes({ queue }),
@@ -218,16 +218,16 @@ export function overrideTotalConcurrencyLimit(
218218
requestOptions
219219
);
220220

221-
return apiClient.overrideQueueTotalConcurrencyLimit(queue, concurrencyLimit, $requestOptions);
221+
return apiClient.overrideQueueCombinedConcurrencyLimit(queue, concurrencyLimit, $requestOptions);
222222
}
223223

224224
/**
225-
* Resets the total concurrency limit of a queue back to its declared value.
225+
* Resets the combined concurrency limit of a queue back to its declared value.
226226
*
227227
* @param queue - The ID of the queue, or the type and name
228228
* @returns The updated queue state
229229
*/
230-
export function resetTotalConcurrencyLimit(
230+
export function resetCombinedConcurrencyLimit(
231231
queue: RetrieveQueueParam,
232232
requestOptions?: ApiRequestOptions
233233
): ApiPromise<QueueItem> {
@@ -236,7 +236,7 @@ export function resetTotalConcurrencyLimit(
236236
const $requestOptions = mergeRequestOptions(
237237
{
238238
tracer,
239-
name: "queues.resetTotalConcurrencyLimit()",
239+
name: "queues.resetCombinedConcurrencyLimit()",
240240
icon: "queue",
241241
attributes: {
242242
...flattenAttributes({ queue }),
@@ -254,7 +254,7 @@ export function resetTotalConcurrencyLimit(
254254
requestOptions
255255
);
256256

257-
return apiClient.resetQueueTotalConcurrencyLimit(queue, $requestOptions);
257+
return apiClient.resetQueueCombinedConcurrencyLimit(queue, $requestOptions);
258258
}
259259

260260
/**

0 commit comments

Comments
 (0)