@upstash/workflow 1.2.0 → 1.3.0

package/express.js

@@ -35,6 +35,7 @@ var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FAILURE_CALLBACK_HEADER = "Upstash-Workflow-Failure-Callback";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+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";
@@ -43,7 +44,7 @@ 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.0.0";
+var VERSION = "v1.2.1";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -855,6 +856,9 @@ var recreateUserHeaders = (headers) => {
   }
   return filteredHeaders;
 };
+var isThirdPartyCallResult = (request) => {
+  return request.headers.get("Upstash-Workflow-Callback") !== null;
+};
 var handleThirdPartyCallResult = async ({
   request,
   requestPayload,
@@ -864,7 +868,7 @@ var handleThirdPartyCallResult = async ({
   middlewareManager
 }) => {
   try {
-    if (request.headers.get("Upstash-Workflow-Callback")) {
+    if (isThirdPartyCallResult(request)) {
       let callbackPayload;
       if (requestPayload) {
         callbackPayload = requestPayload;
@@ -2707,6 +2711,13 @@ var WorkflowContext = class {
    * ```
    */
   label;
+  /**
+   * Number of times QStash has retried delivering the current request.
+   *
+   * Sourced from the `Upstash-Retried` header. `0` on the first delivery,
+   * `1` on the first retry, `2` on the second, and so on.
+   */
+  retried;
   constructor({
     qstashClient,
     workflowRunId,
@@ -2719,6 +2730,7 @@ var WorkflowContext = class {
     telemetry: telemetry2,
     invokeCount,
     label,
+    retried,
     middlewareManager
   }) {
     this.qstashClient = qstashClient;
@@ -2730,6 +2742,7 @@ var WorkflowContext = class {
     this.requestPayload = initialPayload;
     this.env = env ?? {};
     this.label = label;
+    this.retried = retried ?? 0;
     const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
     middlewareManagerInstance.assignContext(this);
     this.executor = new AutoExecutor(
@@ -2993,7 +3006,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     const disabledContext = new _DisabledWorkflowContext({
       qstashClient: new import_qstash10.Client({
         baseUrl: "disabled-client",
-        token: "disabled-client"
+        token: "disabled-client",
+        devMode: false
       }),
       workflowRunId: context.workflowRunId,
       workflowRunCreatedAt: context.workflowRunCreatedAt,
@@ -3002,7 +3016,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       url: context.url,
       initialPayload: context.requestPayload,
       env: context.env,
-      label: context.label
+      label: context.label,
+      retried: context.retried
     });
     try {
       await routeFunction(disabledContext);
@@ -3218,6 +3233,7 @@ var handleFailure = async ({
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
     const userHeaders = recreateUserHeaders(request.headers);
+    const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3229,6 +3245,7 @@ var handleFailure = async ({
       telemetry: void 0,
       // not going to make requests in authentication check
       label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0,
+      retried,
       workflowRunCreatedAt: workflowCreatedAt,
       middlewareManager: void 0
     });
@@ -3388,6 +3405,9 @@ var getReceiver = (environment, receiverConfig, region) => {
     if (receiverConfig === "set-to-undefined") {
       return void 0;
     }
+    if (isQStashDevModeEnabled(environment)) {
+      return new import_qstash11.Receiver({ devMode: true });
+    }
     const receiverEnv = readReceiverEnvironmentVariables(environment, region);
     return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash11.Receiver({
       currentSigningKey: receiverEnv.QSTASH_CURRENT_SIGNING_KEY,
@@ -3397,6 +3417,10 @@ var getReceiver = (environment, receiverConfig, region) => {
     return receiverConfig;
   }
 };
+var isQStashDevModeEnabled = (env) => {
+  const value = env.QSTASH_DEV;
+  return value === "true" || value === "1";
+};
 var getQStashHandlerOptions = (...params) => {
   const handlers = getQStashHandlers(...params);
   return {
@@ -3706,12 +3730,13 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       );
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
     const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowRunCreatedAt = request.headers.get(WORKFLOW_CREATED_AT_HEADER);
     const workflowContext = new WorkflowContext({
       qstashClient: regionalClient,
       workflowRunId,
-      initialPayload: initialPayloadParser(rawInitialPayload),
+      initialPayload: isThirdPartyCallResult(request) ? JSON.parse(rawInitialPayload) : initialPayloadParser(rawInitialPayload),
       headers: recreateUserHeaders(request.headers),
       steps,
       url: workflowUrl,
@@ -3719,6 +3744,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       telemetry: telemetry2,
       invokeCount,
       label,
+      retried,
       workflowRunCreatedAt: Number(workflowRunCreatedAt),
       middlewareManager
     });

package/express.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-V5ZUHMAF.mjs";
+} from "./chunk-G24J5PCC.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-B2S08hRU.mjs';
-import { s as serveManyBase } from './serve-many-C6sa_DxN.mjs';
+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 '@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-B2S08hRU.js';
-import { s as serveManyBase } from './serve-many-B-fe7bh7.js';
+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 '@upstash/qstash';
 import 'zod';
 

package/h3.js

@@ -501,6 +501,7 @@ var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FAILURE_CALLBACK_HEADER = "Upstash-Workflow-Failure-Callback";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+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";
@@ -509,7 +510,7 @@ 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.0.0";
+var VERSION = "v1.2.1";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -1164,6 +1165,9 @@ var recreateUserHeaders = (headers) => {
   }
   return filteredHeaders;
 };
+var isThirdPartyCallResult = (request) => {
+  return request.headers.get("Upstash-Workflow-Callback") !== null;
+};
 var handleThirdPartyCallResult = async ({
   request,
   requestPayload,
@@ -1173,7 +1177,7 @@ var handleThirdPartyCallResult = async ({
   middlewareManager
 }) => {
   try {
-    if (request.headers.get("Upstash-Workflow-Callback")) {
+    if (isThirdPartyCallResult(request)) {
       let callbackPayload;
       if (requestPayload) {
         callbackPayload = requestPayload;
@@ -3016,6 +3020,13 @@ var WorkflowContext = class {
    * ```
    */
   label;
+  /**
+   * Number of times QStash has retried delivering the current request.
+   *
+   * Sourced from the `Upstash-Retried` header. `0` on the first delivery,
+   * `1` on the first retry, `2` on the second, and so on.
+   */
+  retried;
   constructor({
     qstashClient,
     workflowRunId,
@@ -3028,6 +3039,7 @@ var WorkflowContext = class {
     telemetry: telemetry2,
     invokeCount,
     label,
+    retried,
     middlewareManager
   }) {
     this.qstashClient = qstashClient;
@@ -3039,6 +3051,7 @@ var WorkflowContext = class {
     this.requestPayload = initialPayload;
     this.env = env ?? {};
     this.label = label;
+    this.retried = retried ?? 0;
     const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
     middlewareManagerInstance.assignContext(this);
     this.executor = new AutoExecutor(
@@ -3302,7 +3315,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     const disabledContext = new _DisabledWorkflowContext({
       qstashClient: new import_qstash10.Client({
         baseUrl: "disabled-client",
-        token: "disabled-client"
+        token: "disabled-client",
+        devMode: false
       }),
       workflowRunId: context.workflowRunId,
       workflowRunCreatedAt: context.workflowRunCreatedAt,
@@ -3311,7 +3325,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       url: context.url,
       initialPayload: context.requestPayload,
       env: context.env,
-      label: context.label
+      label: context.label,
+      retried: context.retried
     });
     try {
       await routeFunction(disabledContext);
@@ -3527,6 +3542,7 @@ var handleFailure = async ({
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
     const userHeaders = recreateUserHeaders(request.headers);
+    const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3538,6 +3554,7 @@ var handleFailure = async ({
       telemetry: void 0,
       // not going to make requests in authentication check
       label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0,
+      retried,
       workflowRunCreatedAt: workflowCreatedAt,
       middlewareManager: void 0
     });
@@ -3697,6 +3714,9 @@ var getReceiver = (environment, receiverConfig, region) => {
     if (receiverConfig === "set-to-undefined") {
       return void 0;
     }
+    if (isQStashDevModeEnabled(environment)) {
+      return new import_qstash11.Receiver({ devMode: true });
+    }
     const receiverEnv = readReceiverEnvironmentVariables(environment, region);
     return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash11.Receiver({
       currentSigningKey: receiverEnv.QSTASH_CURRENT_SIGNING_KEY,
@@ -3706,6 +3726,10 @@ var getReceiver = (environment, receiverConfig, region) => {
     return receiverConfig;
   }
 };
+var isQStashDevModeEnabled = (env) => {
+  const value = env.QSTASH_DEV;
+  return value === "true" || value === "1";
+};
 var getQStashHandlerOptions = (...params) => {
   const handlers = getQStashHandlers(...params);
   return {
@@ -4015,12 +4039,13 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       );
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
     const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowRunCreatedAt = request.headers.get(WORKFLOW_CREATED_AT_HEADER);
     const workflowContext = new WorkflowContext({
       qstashClient: regionalClient,
       workflowRunId,
-      initialPayload: initialPayloadParser(rawInitialPayload),
+      initialPayload: isThirdPartyCallResult(request) ? JSON.parse(rawInitialPayload) : initialPayloadParser(rawInitialPayload),
       headers: recreateUserHeaders(request.headers),
       steps,
       url: workflowUrl,
@@ -4028,6 +4053,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       telemetry: telemetry2,
       invokeCount,
       label,
+      retried,
       workflowRunCreatedAt: Number(workflowRunCreatedAt),
       middlewareManager
     });

package/h3.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-V5ZUHMAF.mjs";
+} from "./chunk-G24J5PCC.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-B2S08hRU.mjs';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.mjs';
 import { Variables } from 'hono/types';
-import { s as serveManyBase } from './serve-many-C6sa_DxN.mjs';
+import { s as serveManyBase } from './serve-many-D3D9uE4u.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-B2S08hRU.js';
+import { c as RouteFunction, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B_E1VAK6.js';
 import { Variables } from 'hono/types';
-import { s as serveManyBase } from './serve-many-B-fe7bh7.js';
+import { s as serveManyBase } from './serve-many-kPOasiyb.js';
 import '@upstash/qstash';
 import 'zod';
 

package/hono.js

@@ -192,6 +192,7 @@ var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FAILURE_CALLBACK_HEADER = "Upstash-Workflow-Failure-Callback";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+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";
@@ -200,7 +201,7 @@ 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.0.0";
+var VERSION = "v1.2.1";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -855,6 +856,9 @@ var recreateUserHeaders = (headers) => {
   }
   return filteredHeaders;
 };
+var isThirdPartyCallResult = (request) => {
+  return request.headers.get("Upstash-Workflow-Callback") !== null;
+};
 var handleThirdPartyCallResult = async ({
   request,
   requestPayload,
@@ -864,7 +868,7 @@ var handleThirdPartyCallResult = async ({
   middlewareManager
 }) => {
   try {
-    if (request.headers.get("Upstash-Workflow-Callback")) {
+    if (isThirdPartyCallResult(request)) {
       let callbackPayload;
       if (requestPayload) {
         callbackPayload = requestPayload;
@@ -2707,6 +2711,13 @@ var WorkflowContext = class {
    * ```
    */
   label;
+  /**
+   * Number of times QStash has retried delivering the current request.
+   *
+   * Sourced from the `Upstash-Retried` header. `0` on the first delivery,
+   * `1` on the first retry, `2` on the second, and so on.
+   */
+  retried;
   constructor({
     qstashClient,
     workflowRunId,
@@ -2719,6 +2730,7 @@ var WorkflowContext = class {
     telemetry: telemetry2,
     invokeCount,
     label,
+    retried,
     middlewareManager
   }) {
     this.qstashClient = qstashClient;
@@ -2730,6 +2742,7 @@ var WorkflowContext = class {
     this.requestPayload = initialPayload;
     this.env = env ?? {};
     this.label = label;
+    this.retried = retried ?? 0;
     const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
     middlewareManagerInstance.assignContext(this);
     this.executor = new AutoExecutor(
@@ -2993,7 +3006,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     const disabledContext = new _DisabledWorkflowContext({
       qstashClient: new import_qstash10.Client({
         baseUrl: "disabled-client",
-        token: "disabled-client"
+        token: "disabled-client",
+        devMode: false
       }),
       workflowRunId: context.workflowRunId,
       workflowRunCreatedAt: context.workflowRunCreatedAt,
@@ -3002,7 +3016,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       url: context.url,
       initialPayload: context.requestPayload,
       env: context.env,
-      label: context.label
+      label: context.label,
+      retried: context.retried
     });
     try {
       await routeFunction(disabledContext);
@@ -3218,6 +3233,7 @@ var handleFailure = async ({
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
     const userHeaders = recreateUserHeaders(request.headers);
+    const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3229,6 +3245,7 @@ var handleFailure = async ({
       telemetry: void 0,
       // not going to make requests in authentication check
       label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0,
+      retried,
       workflowRunCreatedAt: workflowCreatedAt,
       middlewareManager: void 0
     });
@@ -3388,6 +3405,9 @@ var getReceiver = (environment, receiverConfig, region) => {
     if (receiverConfig === "set-to-undefined") {
       return void 0;
     }
+    if (isQStashDevModeEnabled(environment)) {
+      return new import_qstash11.Receiver({ devMode: true });
+    }
     const receiverEnv = readReceiverEnvironmentVariables(environment, region);
     return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash11.Receiver({
       currentSigningKey: receiverEnv.QSTASH_CURRENT_SIGNING_KEY,
@@ -3397,6 +3417,10 @@ var getReceiver = (environment, receiverConfig, region) => {
     return receiverConfig;
   }
 };
+var isQStashDevModeEnabled = (env) => {
+  const value = env.QSTASH_DEV;
+  return value === "true" || value === "1";
+};
 var getQStashHandlerOptions = (...params) => {
   const handlers = getQStashHandlers(...params);
   return {
@@ -3706,12 +3730,13 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       );
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const retried = Number(request.headers.get(WORKFLOW_RETRIED_HEADER) ?? "0");
     const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowRunCreatedAt = request.headers.get(WORKFLOW_CREATED_AT_HEADER);
     const workflowContext = new WorkflowContext({
       qstashClient: regionalClient,
       workflowRunId,
-      initialPayload: initialPayloadParser(rawInitialPayload),
+      initialPayload: isThirdPartyCallResult(request) ? JSON.parse(rawInitialPayload) : initialPayloadParser(rawInitialPayload),
       headers: recreateUserHeaders(request.headers),
       steps,
       url: workflowUrl,
@@ -3719,6 +3744,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       telemetry: telemetry2,
       invokeCount,
       label,
+      retried,
       workflowRunCreatedAt: Number(workflowRunCreatedAt),
       middlewareManager
     });

package/hono.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-V5ZUHMAF.mjs";
+} from "./chunk-G24J5PCC.mjs";
 
 // platforms/hono.ts
 var telemetry = {