|
| 1 | +import type { CreateWorkflowRunParams } from "./backend.js"; |
| 2 | + |
| 3 | +const INVALID_CONCURRENCY_KEY_TYPE_ERROR = |
| 4 | + 'Invalid workflow concurrency metadata: "concurrencyKey" must be a string or null.'; |
| 5 | +export const INVALID_CONCURRENCY_KEY_VALUE_ERROR = |
| 6 | + 'Invalid workflow concurrency metadata: "concurrencyKey" must be a non-empty string when provided.'; |
| 7 | +const INVALID_CONCURRENCY_LIMIT_TYPE_ERROR = |
| 8 | + 'Invalid workflow concurrency metadata: "concurrencyLimit" must be a number or null.'; |
| 9 | +export const INVALID_CONCURRENCY_LIMIT_VALUE_ERROR = |
| 10 | + 'Invalid workflow concurrency metadata: "concurrencyLimit" must be a positive integer or null.'; |
| 11 | +const INVALID_CONCURRENCY_PAIR_ERROR = |
| 12 | + 'Invalid workflow concurrency metadata: "concurrencyKey" and "concurrencyLimit" must both be null or both be set.'; |
| 13 | +export const CONCURRENCY_LIMIT_MISMATCH_ERROR = |
| 14 | + 'Invalid workflow concurrency metadata: active runs in the same bucket must use the same "concurrencyLimit".'; |
| 15 | + |
| 16 | +/** |
| 17 | + * Bucket identity for workflow-level concurrency. |
| 18 | + */ |
| 19 | +export interface ConcurrencyBucket { |
| 20 | + workflowName: string; |
| 21 | + version: string | null; |
| 22 | + key: string; |
| 23 | + limit: number; |
| 24 | +} |
| 25 | + |
| 26 | +/** |
| 27 | + * Normalize and validate workflow concurrency metadata passed to create calls. |
| 28 | + * This protects direct backend callers that bypass client-side validation. |
| 29 | + * @param params - Workflow run creation params |
| 30 | + * @returns Params with normalized concurrency fields |
| 31 | + * @throws {Error} When concurrency metadata has invalid shape or values |
| 32 | + */ |
| 33 | +export function normalizeCreateWorkflowRunParams( |
| 34 | + params: CreateWorkflowRunParams, |
| 35 | +): CreateWorkflowRunParams { |
| 36 | + const rawParams = params as unknown as Record<string, unknown>; |
| 37 | + const rawConcurrencyKey = rawParams["concurrencyKey"]; |
| 38 | + const rawConcurrencyLimit = rawParams["concurrencyLimit"]; |
| 39 | + |
| 40 | + if (rawConcurrencyKey === undefined && rawConcurrencyLimit === undefined) { |
| 41 | + return { |
| 42 | + ...params, |
| 43 | + concurrencyKey: null, |
| 44 | + concurrencyLimit: null, |
| 45 | + }; |
| 46 | + } |
| 47 | + |
| 48 | + if ( |
| 49 | + rawConcurrencyKey !== undefined && |
| 50 | + rawConcurrencyKey !== null && |
| 51 | + typeof rawConcurrencyKey !== "string" |
| 52 | + ) { |
| 53 | + throw new Error(INVALID_CONCURRENCY_KEY_TYPE_ERROR); |
| 54 | + } |
| 55 | + |
| 56 | + if ( |
| 57 | + rawConcurrencyLimit !== undefined && |
| 58 | + rawConcurrencyLimit !== null && |
| 59 | + typeof rawConcurrencyLimit !== "number" |
| 60 | + ) { |
| 61 | + throw new Error(INVALID_CONCURRENCY_LIMIT_TYPE_ERROR); |
| 62 | + } |
| 63 | + |
| 64 | + const concurrencyKey = |
| 65 | + rawConcurrencyKey === undefined ? null : rawConcurrencyKey; |
| 66 | + const concurrencyLimit = |
| 67 | + rawConcurrencyLimit === undefined ? null : rawConcurrencyLimit; |
| 68 | + |
| 69 | + if ((concurrencyKey === null) !== (concurrencyLimit === null)) { |
| 70 | + throw new Error(INVALID_CONCURRENCY_PAIR_ERROR); |
| 71 | + } |
| 72 | + |
| 73 | + if ( |
| 74 | + typeof concurrencyKey === "string" && |
| 75 | + concurrencyKey.trim().length === 0 |
| 76 | + ) { |
| 77 | + throw new Error(INVALID_CONCURRENCY_KEY_VALUE_ERROR); |
| 78 | + } |
| 79 | + |
| 80 | + if ( |
| 81 | + typeof concurrencyLimit === "number" && |
| 82 | + (!Number.isFinite(concurrencyLimit) || |
| 83 | + !Number.isInteger(concurrencyLimit) || |
| 84 | + concurrencyLimit <= 0) |
| 85 | + ) { |
| 86 | + throw new Error(INVALID_CONCURRENCY_LIMIT_VALUE_ERROR); |
| 87 | + } |
| 88 | + |
| 89 | + return { |
| 90 | + ...params, |
| 91 | + concurrencyKey, |
| 92 | + concurrencyLimit, |
| 93 | + }; |
| 94 | +} |
| 95 | + |
| 96 | +/** |
| 97 | + * Return bucket identity for constrained runs, otherwise null. |
| 98 | + * @param params - Normalized workflow run creation params |
| 99 | + * @returns Concurrency bucket or null for unconstrained runs |
| 100 | + */ |
| 101 | +export function toConcurrencyBucket( |
| 102 | + params: CreateWorkflowRunParams, |
| 103 | +): ConcurrencyBucket | null { |
| 104 | + if (params.concurrencyKey === null || params.concurrencyLimit === null) { |
| 105 | + return null; |
| 106 | + } |
| 107 | + |
| 108 | + return { |
| 109 | + workflowName: params.workflowName, |
| 110 | + version: params.version, |
| 111 | + key: params.concurrencyKey, |
| 112 | + limit: params.concurrencyLimit, |
| 113 | + }; |
| 114 | +} |
0 commit comments