@upstash/workflow 1.3.0 → 1.3.2-rc

package/express.d.mts

@@ -1,7 +1,7 @@
 import * as express_serve_static_core from 'express-serve-static-core';
-import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.mjs';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.mjs';
 import { Router } from 'express';
-import { s as serveManyBase } from './serve-many-D3D9uE4u.mjs';
+import { s as serveManyBase } from './serve-many-CG3BFvO3.mjs';
 import '@upstash/qstash';
 import 'zod';
 

package/express.d.ts

@@ -1,7 +1,7 @@
 import * as express_serve_static_core from 'express-serve-static-core';
-import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.js';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.js';
 import { Router } from 'express';
-import { s as serveManyBase } from './serve-many-kPOasiyb.js';
+import { s as serveManyBase } from './serve-many-iJF1IUXk.js';
 import '@upstash/qstash';
 import 'zod';
 

package/express.js

@@ -39,12 +39,13 @@ var WORKFLOW_RETRIED_HEADER = "Upstash-Retried";
 var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 var WORKFLOW_UNKOWN_SDK_VERSION_HEADER = "Upstash-Workflow-Unknown-Sdk";
 var WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER = "upstash-workflow-trigger-by-sdk";
+var WORKFLOW_ERROR_STEP_NAME_HEADER = "Upstash-Error-Step-Name";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
 var NO_CONCURRENCY = 1;
 var DEFAULT_RETRIES = 3;
-var VERSION = "v1.2.1";
+var VERSION = "v1.3.2";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -127,6 +128,22 @@ var formatWorkflowError = (error) => {
     message: `An error occured while executing workflow: '${typeof error === "string" ? error : JSON.stringify(error)}'`
   };
 };
+var attachStepNameToError = (error, stepName) => {
+  if (typeof error !== "object" || error === null) return;
+  if ("errorStepName" in error) return;
+  if (!Object.isExtensible(error)) return;
+  try {
+    error.errorStepName = stepName;
+  } catch {
+  }
+};
+var getStepNameFromError = (error) => {
+  if (typeof error === "object" && error !== null) {
+    const stepName = error.errorStepName;
+    return typeof stepName === "string" ? stepName : void 0;
+  }
+  return void 0;
+};
 function getConstructorName(obj) {
   if (obj === null || obj === void 0) {
     return null;
@@ -216,6 +233,31 @@ var import_qstash4 = require("@upstash/qstash");
 // src/utils.ts
 var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
 var NANOID_LENGTH = 21;
+var RESOURCE_NAME_PATTERN = /^[a-zA-Z0-9\-_.]+$/;
+function validateLabel(label) {
+  if (label === void 0) return;
+  const labels = Array.isArray(label) ? label : [label];
+  if (labels.length === 0) {
+    throw new WorkflowNonRetryableError("Invalid label: label array must not be empty.");
+  }
+  for (const value of labels) {
+    if (!RESOURCE_NAME_PATTERN.test(value)) {
+      throw new WorkflowNonRetryableError(
+        `Invalid label "${value}": must be alphanumeric, hyphen, underscore, or period.`
+      );
+    }
+  }
+}
+function serializeLabel(label) {
+  return Array.isArray(label) ? label.join(",") : label;
+}
+function validateFlowControl(flowControl) {
+  if (flowControl?.key !== void 0 && !RESOURCE_NAME_PATTERN.test(flowControl.key)) {
+    throw new WorkflowNonRetryableError(
+      `Invalid flow control key "${flowControl.key}": must be alphanumeric, hyphen, underscore, or period.`
+    );
+  }
+}
 function getRandomInt() {
   return Math.floor(Math.random() * NANOID_CHARS.length);
 }
@@ -751,8 +793,8 @@ var triggerFirstInvocation = async (params) => {
       if (unknownSdk) {
         headers[WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER] = "true";
       }
-      if (workflowContext.label) {
-        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      if (workflowContext.labels.length > 0) {
+        headers[WORKFLOW_LABEL_HEADER] = serializeLabel(workflowContext.labels);
       }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
@@ -1554,8 +1596,9 @@ var LazyInvokeStep = class extends BaseLazyStep {
     });
     triggerHeaders["Upstash-Workflow-Invoke"] = "true";
     if (label) {
-      triggerHeaders[WORKFLOW_LABEL_HEADER] = label;
-      triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = label;
+      const labelHeader = serializeLabel(label);
+      triggerHeaders[WORKFLOW_LABEL_HEADER] = labelHeader;
+      triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = labelHeader;
     }
     return { headers: triggerHeaders, contentType };
   }
@@ -1898,7 +1941,13 @@ var submitSingleStep = async ({
   await dispatchLifecycle("beforeExecution", {
     stepName: lazyStep.stepName
   });
-  const resultStep = await lazyStep.getResultStep(concurrency, stepId);
+  let resultStep;
+  try {
+    resultStep = await lazyStep.getResultStep(concurrency, stepId);
+  } catch (error) {
+    attachStepNameToError(error, lazyStep.stepName);
+    throw error;
+  }
   const { headers } = lazyStep.getHeaders({
     context,
     step: resultStep,
@@ -2121,9 +2170,11 @@ var AutoExecutor = class _AutoExecutor {
           if (isInstanceOf(error, WorkflowAbort) || isInstanceOf(error, import_qstash5.QstashError) && error.status === 400 || isInstanceOf(error, import_qstash5.QstashError) && error.status === 412) {
             throw error;
           }
-          throw new WorkflowError(
+          const wrappedError = new WorkflowError(
             `Error submitting steps to QStash in partial parallel step execution: ${error}`
           );
+          attachStepNameToError(wrappedError, parallelSteps[stepIndex].stepName);
+          throw wrappedError;
         }
         break;
       }
@@ -2696,9 +2747,10 @@ var WorkflowContext = class {
    */
   env;
   /**
-   * Label to apply to the workflow run.
+   * Labels attached to the workflow run.
    *
-   * Can be used to filter the workflow run logs.
+   * Can be used to filter the workflow run logs. A run can have multiple
+   * labels when triggered with `label: string[]`.
    *
    * Can be set by passing a `label` parameter when triggering the workflow
    * with `client.trigger`:
@@ -2706,11 +2758,20 @@ var WorkflowContext = class {
    * ```ts
    * await client.trigger({
    *   url: "https://workflow-endpoint.com",
-   *   label: "my-label"
+   *   label: ["label-1", "label-2"]
    * });
    * ```
    */
-  label;
+  labels;
+  /**
+   * Label of the workflow run.
+   *
+   * @deprecated Use `labels` instead. When a run has multiple labels, this
+   *   only returns the first one.
+   */
+  get label() {
+    return this.labels[0];
+  }
   /**
    * Number of times QStash has retried delivering the current request.
    *
@@ -2741,7 +2802,7 @@ var WorkflowContext = class {
     this.headers = headers;
     this.requestPayload = initialPayload;
     this.env = env ?? {};
-    this.label = label;
+    this.labels = label === void 0 ? [] : Array.isArray(label) ? label : label ? label.split(",") : [];
     this.retried = retried ?? 0;
     const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
     middlewareManagerInstance.assignContext(this);
@@ -2822,8 +2883,10 @@ var WorkflowContext = class {
     await this.addStep(new LazySleepUntilStep(this, stepName, time));
   }
   async call(stepName, settings) {
+    validateFlowControl(settings.flowControl);
     let callStep;
     if ("workflow" in settings) {
+      validateLabel(settings.label);
       const url = getNewUrlFromWorkflowId(this.url, settings.workflow.workflowId);
       const stringBody = typeof settings.body === "string" ? settings.body : settings.body === void 0 ? void 0 : JSON.stringify(settings.body);
       callStep = new LazyCallStep({
@@ -2931,6 +2994,8 @@ var WorkflowContext = class {
     );
   }
   async invoke(stepName, settings) {
+    validateLabel(settings.label);
+    validateFlowControl(settings.flowControl);
     return await this.addStep(
       new LazyInvokeStep(this, stepName, settings)
     );
@@ -3016,7 +3081,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       url: context.url,
       initialPayload: context.requestPayload,
       env: context.env,
-      label: context.label,
+      label: context.labels,
       retried: context.retried
     });
     try {
@@ -3854,10 +3919,12 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       await middlewareManager.dispatchDebug("onError", {
         error: isInstanceOf(error, Error) ? error : new Error(formattedError.message)
       });
+      const stepName = getStepNameFromError(error)?.replace(/[\u0000-\u001F\u007F]+/g, " ").trim();
       return new Response(JSON.stringify(formattedError), {
         status: 500,
         headers: {
-          [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION
+          [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION,
+          ...stepName ? { [WORKFLOW_ERROR_STEP_NAME_HEADER]: stepName } : {}
         }
       });
     }

package/express.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-G24J5PCC.mjs";
+} from "./chunk-ICDNN4UW.mjs";
 
 // platforms/express.ts
 import {

package/h3.d.mts

@@ -1,6 +1,6 @@
 import * as h3 from 'h3';
-import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.mjs';
-import { s as serveManyBase } from './serve-many-D3D9uE4u.mjs';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.mjs';
+import { s as serveManyBase } from './serve-many-CG3BFvO3.mjs';
 import '@upstash/qstash';
 import 'zod';
 

package/h3.d.ts

@@ -1,6 +1,6 @@
 import * as h3 from 'h3';
-import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.js';
-import { s as serveManyBase } from './serve-many-kPOasiyb.js';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.js';
+import { s as serveManyBase } from './serve-many-iJF1IUXk.js';
 import '@upstash/qstash';
 import 'zod';
 

package/h3.js

@@ -412,6 +412,22 @@ var formatWorkflowError = (error) => {
     message: `An error occured while executing workflow: '${typeof error === "string" ? error : JSON.stringify(error)}'`
   };
 };
+var attachStepNameToError = (error, stepName) => {
+  if (typeof error !== "object" || error === null) return;
+  if ("errorStepName" in error) return;
+  if (!Object.isExtensible(error)) return;
+  try {
+    error.errorStepName = stepName;
+  } catch {
+  }
+};
+var getStepNameFromError = (error) => {
+  if (typeof error === "object" && error !== null) {
+    const stepName = error.errorStepName;
+    return typeof stepName === "string" ? stepName : void 0;
+  }
+  return void 0;
+};
 function getConstructorName(obj) {
   if (obj === null || obj === void 0) {
     return null;
@@ -505,12 +521,13 @@ var WORKFLOW_RETRIED_HEADER = "Upstash-Retried";
 var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 var WORKFLOW_UNKOWN_SDK_VERSION_HEADER = "Upstash-Workflow-Unknown-Sdk";
 var WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER = "upstash-workflow-trigger-by-sdk";
+var WORKFLOW_ERROR_STEP_NAME_HEADER = "Upstash-Error-Step-Name";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
 var NO_CONCURRENCY = 1;
 var DEFAULT_RETRIES = 3;
-var VERSION = "v1.2.1";
+var VERSION = "v1.3.2";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -525,6 +542,31 @@ var import_qstash4 = require("@upstash/qstash");
 // src/utils.ts
 var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
 var NANOID_LENGTH = 21;
+var RESOURCE_NAME_PATTERN = /^[a-zA-Z0-9\-_.]+$/;
+function validateLabel(label) {
+  if (label === void 0) return;
+  const labels = Array.isArray(label) ? label : [label];
+  if (labels.length === 0) {
+    throw new WorkflowNonRetryableError("Invalid label: label array must not be empty.");
+  }
+  for (const value of labels) {
+    if (!RESOURCE_NAME_PATTERN.test(value)) {
+      throw new WorkflowNonRetryableError(
+        `Invalid label "${value}": must be alphanumeric, hyphen, underscore, or period.`
+      );
+    }
+  }
+}
+function serializeLabel(label) {
+  return Array.isArray(label) ? label.join(",") : label;
+}
+function validateFlowControl(flowControl) {
+  if (flowControl?.key !== void 0 && !RESOURCE_NAME_PATTERN.test(flowControl.key)) {
+    throw new WorkflowNonRetryableError(
+      `Invalid flow control key "${flowControl.key}": must be alphanumeric, hyphen, underscore, or period.`
+    );
+  }
+}
 function getRandomInt() {
   return Math.floor(Math.random() * NANOID_CHARS.length);
 }
@@ -1060,8 +1102,8 @@ var triggerFirstInvocation = async (params) => {
       if (unknownSdk) {
         headers[WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER] = "true";
       }
-      if (workflowContext.label) {
-        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      if (workflowContext.labels.length > 0) {
+        headers[WORKFLOW_LABEL_HEADER] = serializeLabel(workflowContext.labels);
       }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
@@ -1863,8 +1905,9 @@ var LazyInvokeStep = class extends BaseLazyStep {
     });
     triggerHeaders["Upstash-Workflow-Invoke"] = "true";
     if (label) {
-      triggerHeaders[WORKFLOW_LABEL_HEADER] = label;
-      triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = label;
+      const labelHeader = serializeLabel(label);
+      triggerHeaders[WORKFLOW_LABEL_HEADER] = labelHeader;
+      triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = labelHeader;
     }
     return { headers: triggerHeaders, contentType };
   }
@@ -2207,7 +2250,13 @@ var submitSingleStep = async ({
   await dispatchLifecycle("beforeExecution", {
     stepName: lazyStep.stepName
   });
-  const resultStep = await lazyStep.getResultStep(concurrency, stepId);
+  let resultStep;
+  try {
+    resultStep = await lazyStep.getResultStep(concurrency, stepId);
+  } catch (error) {
+    attachStepNameToError(error, lazyStep.stepName);
+    throw error;
+  }
   const { headers } = lazyStep.getHeaders({
     context,
     step: resultStep,
@@ -2430,9 +2479,11 @@ var AutoExecutor = class _AutoExecutor {
           if (isInstanceOf(error, WorkflowAbort) || isInstanceOf(error, import_qstash5.QstashError) && error.status === 400 || isInstanceOf(error, import_qstash5.QstashError) && error.status === 412) {
             throw error;
           }
-          throw new WorkflowError(
+          const wrappedError = new WorkflowError(
             `Error submitting steps to QStash in partial parallel step execution: ${error}`
           );
+          attachStepNameToError(wrappedError, parallelSteps[stepIndex].stepName);
+          throw wrappedError;
         }
         break;
       }
@@ -3005,9 +3056,10 @@ var WorkflowContext = class {
    */
   env;
   /**
-   * Label to apply to the workflow run.
+   * Labels attached to the workflow run.
    *
-   * Can be used to filter the workflow run logs.
+   * Can be used to filter the workflow run logs. A run can have multiple
+   * labels when triggered with `label: string[]`.
    *
    * Can be set by passing a `label` parameter when triggering the workflow
    * with `client.trigger`:
@@ -3015,11 +3067,20 @@ var WorkflowContext = class {
    * ```ts
    * await client.trigger({
    *   url: "https://workflow-endpoint.com",
-   *   label: "my-label"
+   *   label: ["label-1", "label-2"]
    * });
    * ```
    */
-  label;
+  labels;
+  /**
+   * Label of the workflow run.
+   *
+   * @deprecated Use `labels` instead. When a run has multiple labels, this
+   *   only returns the first one.
+   */
+  get label() {
+    return this.labels[0];
+  }
   /**
    * Number of times QStash has retried delivering the current request.
    *
@@ -3050,7 +3111,7 @@ var WorkflowContext = class {
     this.headers = headers;
     this.requestPayload = initialPayload;
     this.env = env ?? {};
-    this.label = label;
+    this.labels = label === void 0 ? [] : Array.isArray(label) ? label : label ? label.split(",") : [];
     this.retried = retried ?? 0;
     const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
     middlewareManagerInstance.assignContext(this);
@@ -3131,8 +3192,10 @@ var WorkflowContext = class {
     await this.addStep(new LazySleepUntilStep(this, stepName, time));
   }
   async call(stepName, settings) {
+    validateFlowControl(settings.flowControl);
     let callStep;
     if ("workflow" in settings) {
+      validateLabel(settings.label);
       const url = getNewUrlFromWorkflowId(this.url, settings.workflow.workflowId);
       const stringBody = typeof settings.body === "string" ? settings.body : settings.body === void 0 ? void 0 : JSON.stringify(settings.body);
       callStep = new LazyCallStep({
@@ -3240,6 +3303,8 @@ var WorkflowContext = class {
     );
   }
   async invoke(stepName, settings) {
+    validateLabel(settings.label);
+    validateFlowControl(settings.flowControl);
     return await this.addStep(
       new LazyInvokeStep(this, stepName, settings)
     );
@@ -3325,7 +3390,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       url: context.url,
       initialPayload: context.requestPayload,
       env: context.env,
-      label: context.label,
+      label: context.labels,
       retried: context.retried
     });
     try {
@@ -4163,10 +4228,12 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       await middlewareManager.dispatchDebug("onError", {
         error: isInstanceOf(error, Error) ? error : new Error(formattedError.message)
       });
+      const stepName = getStepNameFromError(error)?.replace(/[\u0000-\u001F\u007F]+/g, " ").trim();
       return new Response(JSON.stringify(formattedError), {
         status: 500,
         headers: {
-          [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION
+          [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION,
+          ...stepName ? { [WORKFLOW_ERROR_STEP_NAME_HEADER]: stepName } : {}
         }
       });
     }

package/h3.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-G24J5PCC.mjs";
+} from "./chunk-ICDNN4UW.mjs";
 
 // node_modules/defu/dist/defu.mjs
 function isPlainObject(value) {

package/hono.d.mts

@@ -1,7 +1,7 @@
 import { Context } from 'hono';
-import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.mjs';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.mjs';
 import { Variables } from 'hono/types';
-import { s as serveManyBase } from './serve-many-D3D9uE4u.mjs';
+import { s as serveManyBase } from './serve-many-CG3BFvO3.mjs';
 import '@upstash/qstash';
 import 'zod';
 

package/hono.d.ts

@@ -1,7 +1,7 @@
 import { Context } from 'hono';
-import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.js';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-CekOpKvz.js';
 import { Variables } from 'hono/types';
-import { s as serveManyBase } from './serve-many-kPOasiyb.js';
+import { s as serveManyBase } from './serve-many-iJF1IUXk.js';
 import '@upstash/qstash';
 import 'zod';