@upstash/workflow 1.2.1 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -0
- package/astro.d.mts +2 -2
- package/astro.d.ts +2 -2
- package/astro.js +80 -14
- package/astro.mjs +1 -1
- package/{chunk-THS5AX2D.mjs → chunk-CWCCIOXR.mjs} +83 -14
- package/cloudflare.d.mts +2 -2
- package/cloudflare.d.ts +2 -2
- package/cloudflare.js +80 -14
- package/cloudflare.mjs +1 -1
- package/express.d.mts +2 -2
- package/express.d.ts +2 -2
- package/express.js +80 -14
- package/express.mjs +1 -1
- package/h3.d.mts +2 -2
- package/h3.d.ts +2 -2
- package/h3.js +80 -14
- package/h3.mjs +1 -1
- package/hono.d.mts +2 -2
- package/hono.d.ts +2 -2
- package/hono.js +80 -14
- package/hono.mjs +1 -1
- package/index.d.mts +24 -5
- package/index.d.ts +24 -5
- package/index.js +83 -15
- package/index.mjs +8 -3
- package/nextjs.d.mts +2 -2
- package/nextjs.d.ts +2 -2
- package/nextjs.js +80 -14
- package/nextjs.mjs +1 -1
- package/package.json +1 -1
- package/react-router.d.mts +2 -2
- package/react-router.d.ts +2 -2
- package/react-router.js +80 -14
- package/react-router.mjs +1 -1
- package/{serve-many-C6sa_DxN.d.mts → serve-many-CG3BFvO3.d.mts} +1 -1
- package/{serve-many-B-fe7bh7.d.ts → serve-many-iJF1IUXk.d.ts} +1 -1
- package/solidjs.d.mts +1 -1
- package/solidjs.d.ts +1 -1
- package/solidjs.js +80 -14
- package/solidjs.mjs +1 -1
- package/svelte.d.mts +2 -2
- package/svelte.d.ts +2 -2
- package/svelte.js +80 -14
- package/svelte.mjs +1 -1
- package/tanstack.d.mts +2 -2
- package/tanstack.d.ts +2 -2
- package/tanstack.js +80 -14
- package/tanstack.mjs +1 -1
- package/{types-B2S08hRU.d.ts → types-CekOpKvz.d.mts} +23 -7
- package/{types-B2S08hRU.d.mts → types-CekOpKvz.d.ts} +23 -7
package/cloudflare.js
CHANGED
|
@@ -35,6 +35,7 @@ var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
|
|
|
35
35
|
var WORKFLOW_FAILURE_CALLBACK_HEADER = "Upstash-Workflow-Failure-Callback";
|
|
36
36
|
var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
|
|
37
37
|
var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
|
|
38
|
+
var WORKFLOW_RETRIED_HEADER = "Upstash-Retried";
|
|
38
39
|
var WORKFLOW_LABEL_HEADER = "Upstash-Label";
|
|
39
40
|
var WORKFLOW_UNKOWN_SDK_VERSION_HEADER = "Upstash-Workflow-Unknown-Sdk";
|
|
40
41
|
var WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER = "upstash-workflow-trigger-by-sdk";
|
|
@@ -43,7 +44,7 @@ var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
|
|
|
43
44
|
var DEFAULT_CONTENT_TYPE = "application/json";
|
|
44
45
|
var NO_CONCURRENCY = 1;
|
|
45
46
|
var DEFAULT_RETRIES = 3;
|
|
46
|
-
var VERSION = "v1.
|
|
47
|
+
var VERSION = "v1.2.1";
|
|
47
48
|
var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
|
|
48
49
|
var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
|
|
49
50
|
var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
|
|
@@ -215,6 +216,31 @@ var import_qstash4 = require("@upstash/qstash");
|
|
|
215
216
|
// src/utils.ts
|
|
216
217
|
var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
|
|
217
218
|
var NANOID_LENGTH = 21;
|
|
219
|
+
var RESOURCE_NAME_PATTERN = /^[a-zA-Z0-9\-_.]+$/;
|
|
220
|
+
function validateLabel(label) {
|
|
221
|
+
if (label === void 0) return;
|
|
222
|
+
const labels = Array.isArray(label) ? label : [label];
|
|
223
|
+
if (labels.length === 0) {
|
|
224
|
+
throw new WorkflowNonRetryableError("Invalid label: label array must not be empty.");
|
|
225
|
+
}
|
|
226
|
+
for (const value of labels) {
|
|
227
|
+
if (!RESOURCE_NAME_PATTERN.test(value)) {
|
|
228
|
+
throw new WorkflowNonRetryableError(
|
|
229
|
+
`Invalid label "${value}": must be alphanumeric, hyphen, underscore, or period.`
|
|
230
|
+
);
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
function serializeLabel(label) {
|
|
235
|
+
return Array.isArray(label) ? label.join(",") : label;
|
|
236
|
+
}
|
|
237
|
+
function validateFlowControl(flowControl) {
|
|
238
|
+
if (flowControl?.key !== void 0 && !RESOURCE_NAME_PATTERN.test(flowControl.key)) {
|
|
239
|
+
throw new WorkflowNonRetryableError(
|
|
240
|
+
`Invalid flow control key "${flowControl.key}": must be alphanumeric, hyphen, underscore, or period.`
|
|
241
|
+
);
|
|
242
|
+
}
|
|
243
|
+
}
|
|
218
244
|
function getRandomInt() {
|
|
219
245
|
return Math.floor(Math.random() * NANOID_CHARS.length);
|
|
220
246
|
}
|
|
@@ -750,8 +776,8 @@ var triggerFirstInvocation = async (params) => {
|
|
|
750
776
|
if (unknownSdk) {
|
|
751
777
|
headers[WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER] = "true";
|
|
752
778
|
}
|
|
753
|
-
if (workflowContext.
|
|
754
|
-
headers[WORKFLOW_LABEL_HEADER] = workflowContext.
|
|
779
|
+
if (workflowContext.labels.length > 0) {
|
|
780
|
+
headers[WORKFLOW_LABEL_HEADER] = serializeLabel(workflowContext.labels);
|
|
755
781
|
}
|
|
756
782
|
const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
|
|
757
783
|
return {
|
|
@@ -855,6 +881,9 @@ var recreateUserHeaders = (headers) => {
|
|
|
855
881
|
}
|
|
856
882
|
return filteredHeaders;
|
|
857
883
|
};
|
|
884
|
+
var isThirdPartyCallResult = (request) => {
|
|
885
|
+
return request.headers.get("Upstash-Workflow-Callback") !== null;
|
|
886
|
+
};
|
|
858
887
|
var handleThirdPartyCallResult = async ({
|
|
859
888
|
request,
|
|
860
889
|
requestPayload,
|
|
@@ -864,7 +893,7 @@ var handleThirdPartyCallResult = async ({
|
|
|
864
893
|
middlewareManager
|
|
865
894
|
}) => {
|
|
866
895
|
try {
|
|
867
|
-
if (request
|
|
896
|
+
if (isThirdPartyCallResult(request)) {
|
|
868
897
|
let callbackPayload;
|
|
869
898
|
if (requestPayload) {
|
|
870
899
|
callbackPayload = requestPayload;
|
|
@@ -1550,8 +1579,9 @@ var LazyInvokeStep = class extends BaseLazyStep {
|
|
|
1550
1579
|
});
|
|
1551
1580
|
triggerHeaders["Upstash-Workflow-Invoke"] = "true";
|
|
1552
1581
|
if (label) {
|
|
1553
|
-
|
|
1554
|
-
triggerHeaders[
|
|
1582
|
+
const labelHeader = serializeLabel(label);
|
|
1583
|
+
triggerHeaders[WORKFLOW_LABEL_HEADER] = labelHeader;
|
|
1584
|
+
triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = labelHeader;
|
|
1555
1585
|
}
|
|
1556
1586
|
return { headers: triggerHeaders, contentType };
|
|
1557
1587
|
}
|
|
@@ -2692,9 +2722,10 @@ var WorkflowContext = class {
|
|
|
2692
2722
|
*/
|
|
2693
2723
|
env;
|
|
2694
2724
|
/**
|
|
2695
|
-
*
|
|
2725
|
+
* Labels attached to the workflow run.
|
|
2696
2726
|
*
|
|
2697
|
-
* Can be used to filter the workflow run logs.
|
|
2727
|
+
* Can be used to filter the workflow run logs. A run can have multiple
|
|
2728
|
+
* labels when triggered with `label: string[]`.
|
|
2698
2729
|
*
|
|
2699
2730
|
* Can be set by passing a `label` parameter when triggering the workflow
|
|
2700
2731
|
* with `client.trigger`:
|
|
@@ -2702,11 +2733,27 @@ var WorkflowContext = class {
|
|
|
2702
2733
|
* ```ts
|
|
2703
2734
|
* await client.trigger({
|
|
2704
2735
|
* url: "https://workflow-endpoint.com",
|
|
2705
|
-
* label: "
|
|
2736
|
+
* label: ["label-1", "label-2"]
|
|
2706
2737
|
* });
|
|
2707
2738
|
* ```
|
|
2708
2739
|
*/
|
|
2709
|
-
|
|
2740
|
+
labels;
|
|
2741
|
+
/**
|
|
2742
|
+
* Label of the workflow run.
|
|
2743
|
+
*
|
|
2744
|
+
* @deprecated Use `labels` instead. When a run has multiple labels, this
|
|
2745
|
+
* only returns the first one.
|
|
2746
|
+
*/
|
|
2747
|
+
get label() {
|
|
2748
|
+
return this.labels[0];
|
|
2749
|
+
}
|
|
2750
|
+
/**
|
|
2751
|
+
* Number of times QStash has retried delivering the current request.
|
|
2752
|
+
*
|
|
2753
|
+
* Sourced from the `Upstash-Retried` header. `0` on the first delivery,
|
|
2754
|
+
* `1` on the first retry, `2` on the second, and so on.
|
|
2755
|
+
*/
|
|
2756
|
+
retried;
|
|
2710
2757
|
constructor({
|
|
2711
2758
|
qstashClient,
|
|
2712
2759
|
workflowRunId,
|
|
@@ -2719,6 +2766,7 @@ var WorkflowContext = class {
|
|
|
2719
2766
|
telemetry: telemetry2,
|
|
2720
2767
|
invokeCount,
|
|
2721
2768
|
label,
|
|
2769
|
+
retried,
|
|
2722
2770
|
middlewareManager
|
|
2723
2771
|
}) {
|
|
2724
2772
|
this.qstashClient = qstashClient;
|
|
@@ -2729,7 +2777,8 @@ var WorkflowContext = class {
|
|
|
2729
2777
|
this.headers = headers;
|
|
2730
2778
|
this.requestPayload = initialPayload;
|
|
2731
2779
|
this.env = env ?? {};
|
|
2732
|
-
this.
|
|
2780
|
+
this.labels = label === void 0 ? [] : Array.isArray(label) ? label : label ? label.split(",") : [];
|
|
2781
|
+
this.retried = retried ?? 0;
|
|
2733
2782
|
const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
|
|
2734
2783
|
middlewareManagerInstance.assignContext(this);
|
|
2735
2784
|
this.executor = new AutoExecutor(
|
|
@@ -2809,8 +2858,10 @@ var WorkflowContext = class {
|
|
|
2809
2858
|
await this.addStep(new LazySleepUntilStep(this, stepName, time));
|
|
2810
2859
|
}
|
|
2811
2860
|
async call(stepName, settings) {
|
|
2861
|
+
validateFlowControl(settings.flowControl);
|
|
2812
2862
|
let callStep;
|
|
2813
2863
|
if ("workflow" in settings) {
|
|
2864
|
+
validateLabel(settings.label);
|
|
2814
2865
|
const url = getNewUrlFromWorkflowId(this.url, settings.workflow.workflowId);
|
|
2815
2866
|
const stringBody = typeof settings.body === "string" ? settings.body : settings.body === void 0 ? void 0 : JSON.stringify(settings.body);
|
|
2816
2867
|
callStep = new LazyCallStep({
|
|
@@ -2918,6 +2969,8 @@ var WorkflowContext = class {
|
|
|
2918
2969
|
);
|
|
2919
2970
|
}
|
|
2920
2971
|
async invoke(stepName, settings) {
|
|
2972
|
+
validateLabel(settings.label);
|
|
2973
|
+
validateFlowControl(settings.flowControl);
|
|
2921
2974
|
return await this.addStep(
|
|
2922
2975
|
new LazyInvokeStep(this, stepName, settings)
|
|
2923
2976
|
);
|
|
@@ -2993,7 +3046,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
|
|
|
2993
3046
|
const disabledContext = new _DisabledWorkflowContext({
|
|
2994
3047
|
qstashClient: new import_qstash10.Client({
|
|
2995
3048
|
baseUrl: "disabled-client",
|
|
2996
|
-
token: "disabled-client"
|
|
3049
|
+
token: "disabled-client",
|
|
3050
|
+
devMode: false
|
|
2997
3051
|
}),
|
|
2998
3052
|
workflowRunId: context.workflowRunId,
|
|
2999
3053
|
workflowRunCreatedAt: context.workflowRunCreatedAt,
|
|
@@ -3002,7 +3056,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
|
|
|
3002
3056
|
url: context.url,
|
|
3003
3057
|
initialPayload: context.requestPayload,
|
|
3004
3058
|
env: context.env,
|
|
3005
|
-
label: context.
|
|
3059
|
+
label: context.labels,
|
|
3060
|
+
retried: context.retried
|
|
3006
3061
|
});
|
|
3007
3062
|
try {
|
|
3008
3063
|
await routeFunction(disabledContext);
|
|
@@ -3218,6 +3273,7 @@ var handleFailure = async ({
|
|
|
3218
3273
|
errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
|
|
3219
3274
|
}
|
|
3220
3275
|
const userHeaders = recreateUserHeaders(request.headers);
|
|
3276
|
+
const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
|
|
3221
3277
|
const workflowContext = new WorkflowContext({
|
|
3222
3278
|
qstashClient,
|
|
3223
3279
|
workflowRunId,
|
|
@@ -3229,6 +3285,7 @@ var handleFailure = async ({
|
|
|
3229
3285
|
telemetry: void 0,
|
|
3230
3286
|
// not going to make requests in authentication check
|
|
3231
3287
|
label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0,
|
|
3288
|
+
retried,
|
|
3232
3289
|
workflowRunCreatedAt: workflowCreatedAt,
|
|
3233
3290
|
middlewareManager: void 0
|
|
3234
3291
|
});
|
|
@@ -3388,6 +3445,9 @@ var getReceiver = (environment, receiverConfig, region) => {
|
|
|
3388
3445
|
if (receiverConfig === "set-to-undefined") {
|
|
3389
3446
|
return void 0;
|
|
3390
3447
|
}
|
|
3448
|
+
if (isQStashDevModeEnabled(environment)) {
|
|
3449
|
+
return new import_qstash11.Receiver({ devMode: true });
|
|
3450
|
+
}
|
|
3391
3451
|
const receiverEnv = readReceiverEnvironmentVariables(environment, region);
|
|
3392
3452
|
return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash11.Receiver({
|
|
3393
3453
|
currentSigningKey: receiverEnv.QSTASH_CURRENT_SIGNING_KEY,
|
|
@@ -3397,6 +3457,10 @@ var getReceiver = (environment, receiverConfig, region) => {
|
|
|
3397
3457
|
return receiverConfig;
|
|
3398
3458
|
}
|
|
3399
3459
|
};
|
|
3460
|
+
var isQStashDevModeEnabled = (env) => {
|
|
3461
|
+
const value = env.QSTASH_DEV;
|
|
3462
|
+
return value === "true" || value === "1";
|
|
3463
|
+
};
|
|
3400
3464
|
var getQStashHandlerOptions = (...params) => {
|
|
3401
3465
|
const handlers = getQStashHandlers(...params);
|
|
3402
3466
|
return {
|
|
@@ -3706,12 +3770,13 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
|
|
|
3706
3770
|
);
|
|
3707
3771
|
}
|
|
3708
3772
|
const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
|
|
3773
|
+
const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
|
|
3709
3774
|
const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
|
|
3710
3775
|
const workflowRunCreatedAt = request.headers.get(WORKFLOW_CREATED_AT_HEADER);
|
|
3711
3776
|
const workflowContext = new WorkflowContext({
|
|
3712
3777
|
qstashClient: regionalClient,
|
|
3713
3778
|
workflowRunId,
|
|
3714
|
-
initialPayload: initialPayloadParser(rawInitialPayload),
|
|
3779
|
+
initialPayload: isThirdPartyCallResult(request) ? JSON.parse(rawInitialPayload) : initialPayloadParser(rawInitialPayload),
|
|
3715
3780
|
headers: recreateUserHeaders(request.headers),
|
|
3716
3781
|
steps,
|
|
3717
3782
|
url: workflowUrl,
|
|
@@ -3719,6 +3784,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
|
|
|
3719
3784
|
telemetry: telemetry2,
|
|
3720
3785
|
invokeCount,
|
|
3721
3786
|
label,
|
|
3787
|
+
retried,
|
|
3722
3788
|
workflowRunCreatedAt: Number(workflowRunCreatedAt),
|
|
3723
3789
|
middlewareManager
|
|
3724
3790
|
});
|
package/cloudflare.mjs
CHANGED
package/express.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as express_serve_static_core from 'express-serve-static-core';
|
|
2
|
-
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-
|
|
2
|
+
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.mjs';
|
|
3
3
|
import { Router } from 'express';
|
|
4
|
-
import { s as serveManyBase } from './serve-many-
|
|
4
|
+
import { s as serveManyBase } from './serve-many-CG3BFvO3.mjs';
|
|
5
5
|
import '@upstash/qstash';
|
|
6
6
|
import 'zod';
|
|
7
7
|
|
package/express.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as express_serve_static_core from 'express-serve-static-core';
|
|
2
|
-
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-
|
|
2
|
+
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.js';
|
|
3
3
|
import { Router } from 'express';
|
|
4
|
-
import { s as serveManyBase } from './serve-many-
|
|
4
|
+
import { s as serveManyBase } from './serve-many-iJF1IUXk.js';
|
|
5
5
|
import '@upstash/qstash';
|
|
6
6
|
import 'zod';
|
|
7
7
|
|
package/express.js
CHANGED
|
@@ -35,6 +35,7 @@ var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
|
|
|
35
35
|
var WORKFLOW_FAILURE_CALLBACK_HEADER = "Upstash-Workflow-Failure-Callback";
|
|
36
36
|
var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
|
|
37
37
|
var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
|
|
38
|
+
var WORKFLOW_RETRIED_HEADER = "Upstash-Retried";
|
|
38
39
|
var WORKFLOW_LABEL_HEADER = "Upstash-Label";
|
|
39
40
|
var WORKFLOW_UNKOWN_SDK_VERSION_HEADER = "Upstash-Workflow-Unknown-Sdk";
|
|
40
41
|
var WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER = "upstash-workflow-trigger-by-sdk";
|
|
@@ -43,7 +44,7 @@ var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
|
|
|
43
44
|
var DEFAULT_CONTENT_TYPE = "application/json";
|
|
44
45
|
var NO_CONCURRENCY = 1;
|
|
45
46
|
var DEFAULT_RETRIES = 3;
|
|
46
|
-
var VERSION = "v1.
|
|
47
|
+
var VERSION = "v1.2.1";
|
|
47
48
|
var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
|
|
48
49
|
var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
|
|
49
50
|
var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
|
|
@@ -215,6 +216,31 @@ var import_qstash4 = require("@upstash/qstash");
|
|
|
215
216
|
// src/utils.ts
|
|
216
217
|
var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
|
|
217
218
|
var NANOID_LENGTH = 21;
|
|
219
|
+
var RESOURCE_NAME_PATTERN = /^[a-zA-Z0-9\-_.]+$/;
|
|
220
|
+
function validateLabel(label) {
|
|
221
|
+
if (label === void 0) return;
|
|
222
|
+
const labels = Array.isArray(label) ? label : [label];
|
|
223
|
+
if (labels.length === 0) {
|
|
224
|
+
throw new WorkflowNonRetryableError("Invalid label: label array must not be empty.");
|
|
225
|
+
}
|
|
226
|
+
for (const value of labels) {
|
|
227
|
+
if (!RESOURCE_NAME_PATTERN.test(value)) {
|
|
228
|
+
throw new WorkflowNonRetryableError(
|
|
229
|
+
`Invalid label "${value}": must be alphanumeric, hyphen, underscore, or period.`
|
|
230
|
+
);
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
function serializeLabel(label) {
|
|
235
|
+
return Array.isArray(label) ? label.join(",") : label;
|
|
236
|
+
}
|
|
237
|
+
function validateFlowControl(flowControl) {
|
|
238
|
+
if (flowControl?.key !== void 0 && !RESOURCE_NAME_PATTERN.test(flowControl.key)) {
|
|
239
|
+
throw new WorkflowNonRetryableError(
|
|
240
|
+
`Invalid flow control key "${flowControl.key}": must be alphanumeric, hyphen, underscore, or period.`
|
|
241
|
+
);
|
|
242
|
+
}
|
|
243
|
+
}
|
|
218
244
|
function getRandomInt() {
|
|
219
245
|
return Math.floor(Math.random() * NANOID_CHARS.length);
|
|
220
246
|
}
|
|
@@ -750,8 +776,8 @@ var triggerFirstInvocation = async (params) => {
|
|
|
750
776
|
if (unknownSdk) {
|
|
751
777
|
headers[WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER] = "true";
|
|
752
778
|
}
|
|
753
|
-
if (workflowContext.
|
|
754
|
-
headers[WORKFLOW_LABEL_HEADER] = workflowContext.
|
|
779
|
+
if (workflowContext.labels.length > 0) {
|
|
780
|
+
headers[WORKFLOW_LABEL_HEADER] = serializeLabel(workflowContext.labels);
|
|
755
781
|
}
|
|
756
782
|
const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
|
|
757
783
|
return {
|
|
@@ -855,6 +881,9 @@ var recreateUserHeaders = (headers) => {
|
|
|
855
881
|
}
|
|
856
882
|
return filteredHeaders;
|
|
857
883
|
};
|
|
884
|
+
var isThirdPartyCallResult = (request) => {
|
|
885
|
+
return request.headers.get("Upstash-Workflow-Callback") !== null;
|
|
886
|
+
};
|
|
858
887
|
var handleThirdPartyCallResult = async ({
|
|
859
888
|
request,
|
|
860
889
|
requestPayload,
|
|
@@ -864,7 +893,7 @@ var handleThirdPartyCallResult = async ({
|
|
|
864
893
|
middlewareManager
|
|
865
894
|
}) => {
|
|
866
895
|
try {
|
|
867
|
-
if (request
|
|
896
|
+
if (isThirdPartyCallResult(request)) {
|
|
868
897
|
let callbackPayload;
|
|
869
898
|
if (requestPayload) {
|
|
870
899
|
callbackPayload = requestPayload;
|
|
@@ -1550,8 +1579,9 @@ var LazyInvokeStep = class extends BaseLazyStep {
|
|
|
1550
1579
|
});
|
|
1551
1580
|
triggerHeaders["Upstash-Workflow-Invoke"] = "true";
|
|
1552
1581
|
if (label) {
|
|
1553
|
-
|
|
1554
|
-
triggerHeaders[
|
|
1582
|
+
const labelHeader = serializeLabel(label);
|
|
1583
|
+
triggerHeaders[WORKFLOW_LABEL_HEADER] = labelHeader;
|
|
1584
|
+
triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = labelHeader;
|
|
1555
1585
|
}
|
|
1556
1586
|
return { headers: triggerHeaders, contentType };
|
|
1557
1587
|
}
|
|
@@ -2692,9 +2722,10 @@ var WorkflowContext = class {
|
|
|
2692
2722
|
*/
|
|
2693
2723
|
env;
|
|
2694
2724
|
/**
|
|
2695
|
-
*
|
|
2725
|
+
* Labels attached to the workflow run.
|
|
2696
2726
|
*
|
|
2697
|
-
* Can be used to filter the workflow run logs.
|
|
2727
|
+
* Can be used to filter the workflow run logs. A run can have multiple
|
|
2728
|
+
* labels when triggered with `label: string[]`.
|
|
2698
2729
|
*
|
|
2699
2730
|
* Can be set by passing a `label` parameter when triggering the workflow
|
|
2700
2731
|
* with `client.trigger`:
|
|
@@ -2702,11 +2733,27 @@ var WorkflowContext = class {
|
|
|
2702
2733
|
* ```ts
|
|
2703
2734
|
* await client.trigger({
|
|
2704
2735
|
* url: "https://workflow-endpoint.com",
|
|
2705
|
-
* label: "
|
|
2736
|
+
* label: ["label-1", "label-2"]
|
|
2706
2737
|
* });
|
|
2707
2738
|
* ```
|
|
2708
2739
|
*/
|
|
2709
|
-
|
|
2740
|
+
labels;
|
|
2741
|
+
/**
|
|
2742
|
+
* Label of the workflow run.
|
|
2743
|
+
*
|
|
2744
|
+
* @deprecated Use `labels` instead. When a run has multiple labels, this
|
|
2745
|
+
* only returns the first one.
|
|
2746
|
+
*/
|
|
2747
|
+
get label() {
|
|
2748
|
+
return this.labels[0];
|
|
2749
|
+
}
|
|
2750
|
+
/**
|
|
2751
|
+
* Number of times QStash has retried delivering the current request.
|
|
2752
|
+
*
|
|
2753
|
+
* Sourced from the `Upstash-Retried` header. `0` on the first delivery,
|
|
2754
|
+
* `1` on the first retry, `2` on the second, and so on.
|
|
2755
|
+
*/
|
|
2756
|
+
retried;
|
|
2710
2757
|
constructor({
|
|
2711
2758
|
qstashClient,
|
|
2712
2759
|
workflowRunId,
|
|
@@ -2719,6 +2766,7 @@ var WorkflowContext = class {
|
|
|
2719
2766
|
telemetry: telemetry2,
|
|
2720
2767
|
invokeCount,
|
|
2721
2768
|
label,
|
|
2769
|
+
retried,
|
|
2722
2770
|
middlewareManager
|
|
2723
2771
|
}) {
|
|
2724
2772
|
this.qstashClient = qstashClient;
|
|
@@ -2729,7 +2777,8 @@ var WorkflowContext = class {
|
|
|
2729
2777
|
this.headers = headers;
|
|
2730
2778
|
this.requestPayload = initialPayload;
|
|
2731
2779
|
this.env = env ?? {};
|
|
2732
|
-
this.
|
|
2780
|
+
this.labels = label === void 0 ? [] : Array.isArray(label) ? label : label ? label.split(",") : [];
|
|
2781
|
+
this.retried = retried ?? 0;
|
|
2733
2782
|
const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
|
|
2734
2783
|
middlewareManagerInstance.assignContext(this);
|
|
2735
2784
|
this.executor = new AutoExecutor(
|
|
@@ -2809,8 +2858,10 @@ var WorkflowContext = class {
|
|
|
2809
2858
|
await this.addStep(new LazySleepUntilStep(this, stepName, time));
|
|
2810
2859
|
}
|
|
2811
2860
|
async call(stepName, settings) {
|
|
2861
|
+
validateFlowControl(settings.flowControl);
|
|
2812
2862
|
let callStep;
|
|
2813
2863
|
if ("workflow" in settings) {
|
|
2864
|
+
validateLabel(settings.label);
|
|
2814
2865
|
const url = getNewUrlFromWorkflowId(this.url, settings.workflow.workflowId);
|
|
2815
2866
|
const stringBody = typeof settings.body === "string" ? settings.body : settings.body === void 0 ? void 0 : JSON.stringify(settings.body);
|
|
2816
2867
|
callStep = new LazyCallStep({
|
|
@@ -2918,6 +2969,8 @@ var WorkflowContext = class {
|
|
|
2918
2969
|
);
|
|
2919
2970
|
}
|
|
2920
2971
|
async invoke(stepName, settings) {
|
|
2972
|
+
validateLabel(settings.label);
|
|
2973
|
+
validateFlowControl(settings.flowControl);
|
|
2921
2974
|
return await this.addStep(
|
|
2922
2975
|
new LazyInvokeStep(this, stepName, settings)
|
|
2923
2976
|
);
|
|
@@ -2993,7 +3046,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
|
|
|
2993
3046
|
const disabledContext = new _DisabledWorkflowContext({
|
|
2994
3047
|
qstashClient: new import_qstash10.Client({
|
|
2995
3048
|
baseUrl: "disabled-client",
|
|
2996
|
-
token: "disabled-client"
|
|
3049
|
+
token: "disabled-client",
|
|
3050
|
+
devMode: false
|
|
2997
3051
|
}),
|
|
2998
3052
|
workflowRunId: context.workflowRunId,
|
|
2999
3053
|
workflowRunCreatedAt: context.workflowRunCreatedAt,
|
|
@@ -3002,7 +3056,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
|
|
|
3002
3056
|
url: context.url,
|
|
3003
3057
|
initialPayload: context.requestPayload,
|
|
3004
3058
|
env: context.env,
|
|
3005
|
-
label: context.
|
|
3059
|
+
label: context.labels,
|
|
3060
|
+
retried: context.retried
|
|
3006
3061
|
});
|
|
3007
3062
|
try {
|
|
3008
3063
|
await routeFunction(disabledContext);
|
|
@@ -3218,6 +3273,7 @@ var handleFailure = async ({
|
|
|
3218
3273
|
errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
|
|
3219
3274
|
}
|
|
3220
3275
|
const userHeaders = recreateUserHeaders(request.headers);
|
|
3276
|
+
const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
|
|
3221
3277
|
const workflowContext = new WorkflowContext({
|
|
3222
3278
|
qstashClient,
|
|
3223
3279
|
workflowRunId,
|
|
@@ -3229,6 +3285,7 @@ var handleFailure = async ({
|
|
|
3229
3285
|
telemetry: void 0,
|
|
3230
3286
|
// not going to make requests in authentication check
|
|
3231
3287
|
label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0,
|
|
3288
|
+
retried,
|
|
3232
3289
|
workflowRunCreatedAt: workflowCreatedAt,
|
|
3233
3290
|
middlewareManager: void 0
|
|
3234
3291
|
});
|
|
@@ -3388,6 +3445,9 @@ var getReceiver = (environment, receiverConfig, region) => {
|
|
|
3388
3445
|
if (receiverConfig === "set-to-undefined") {
|
|
3389
3446
|
return void 0;
|
|
3390
3447
|
}
|
|
3448
|
+
if (isQStashDevModeEnabled(environment)) {
|
|
3449
|
+
return new import_qstash11.Receiver({ devMode: true });
|
|
3450
|
+
}
|
|
3391
3451
|
const receiverEnv = readReceiverEnvironmentVariables(environment, region);
|
|
3392
3452
|
return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash11.Receiver({
|
|
3393
3453
|
currentSigningKey: receiverEnv.QSTASH_CURRENT_SIGNING_KEY,
|
|
@@ -3397,6 +3457,10 @@ var getReceiver = (environment, receiverConfig, region) => {
|
|
|
3397
3457
|
return receiverConfig;
|
|
3398
3458
|
}
|
|
3399
3459
|
};
|
|
3460
|
+
var isQStashDevModeEnabled = (env) => {
|
|
3461
|
+
const value = env.QSTASH_DEV;
|
|
3462
|
+
return value === "true" || value === "1";
|
|
3463
|
+
};
|
|
3400
3464
|
var getQStashHandlerOptions = (...params) => {
|
|
3401
3465
|
const handlers = getQStashHandlers(...params);
|
|
3402
3466
|
return {
|
|
@@ -3706,12 +3770,13 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
|
|
|
3706
3770
|
);
|
|
3707
3771
|
}
|
|
3708
3772
|
const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
|
|
3773
|
+
const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
|
|
3709
3774
|
const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
|
|
3710
3775
|
const workflowRunCreatedAt = request.headers.get(WORKFLOW_CREATED_AT_HEADER);
|
|
3711
3776
|
const workflowContext = new WorkflowContext({
|
|
3712
3777
|
qstashClient: regionalClient,
|
|
3713
3778
|
workflowRunId,
|
|
3714
|
-
initialPayload: initialPayloadParser(rawInitialPayload),
|
|
3779
|
+
initialPayload: isThirdPartyCallResult(request) ? JSON.parse(rawInitialPayload) : initialPayloadParser(rawInitialPayload),
|
|
3715
3780
|
headers: recreateUserHeaders(request.headers),
|
|
3716
3781
|
steps,
|
|
3717
3782
|
url: workflowUrl,
|
|
@@ -3719,6 +3784,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
|
|
|
3719
3784
|
telemetry: telemetry2,
|
|
3720
3785
|
invokeCount,
|
|
3721
3786
|
label,
|
|
3787
|
+
retried,
|
|
3722
3788
|
workflowRunCreatedAt: Number(workflowRunCreatedAt),
|
|
3723
3789
|
middlewareManager
|
|
3724
3790
|
});
|
package/express.mjs
CHANGED
package/h3.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as h3 from 'h3';
|
|
2
|
-
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-
|
|
3
|
-
import { s as serveManyBase } from './serve-many-
|
|
2
|
+
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.mjs';
|
|
3
|
+
import { s as serveManyBase } from './serve-many-CG3BFvO3.mjs';
|
|
4
4
|
import '@upstash/qstash';
|
|
5
5
|
import 'zod';
|
|
6
6
|
|
package/h3.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as h3 from 'h3';
|
|
2
|
-
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-
|
|
3
|
-
import { s as serveManyBase } from './serve-many-
|
|
2
|
+
import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.js';
|
|
3
|
+
import { s as serveManyBase } from './serve-many-iJF1IUXk.js';
|
|
4
4
|
import '@upstash/qstash';
|
|
5
5
|
import 'zod';
|
|
6
6
|
|