@upstash/workflow 0.2.21 → 0.2.22

package/cloudflare.js

@@ -39,7 +39,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 = "v0.2.21";
+var VERSION = "v0.2.22";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -47,61 +47,11 @@ var TELEMETRY_HEADER_RUNTIME = "Upstash-Telemetry-Runtime";
 var TELEMETRY_HEADER_AGENT = "Upstash-Telemetry-Agent";
 
 // src/client/utils.ts
-var import_qstash = require("@upstash/qstash");
-var makeNotifyRequest = async (requester, eventId, eventData) => {
-  const result = await requester.request({
-    path: ["v2", "notify", eventId],
-    method: "POST",
-    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
-  });
-  return result;
-};
-var makeCancelRequest = async (requester, workflowRunId) => {
-  await requester.request({
-    path: ["v2", "workflows", "runs", `${workflowRunId}?cancel=true`],
-    method: "DELETE",
-    parseResponseAsJson: false
-  });
-  return true;
-};
-var getSteps = async (requester, workflowRunId, messageId, debug) => {
-  try {
-    const steps = await requester.request({
-      path: ["v2", "workflows", "runs", workflowRunId],
-      parseResponseAsJson: true
-    });
-    if (!messageId) {
-      await debug?.log("INFO", "ENDPOINT_START", {
-        message: `Pulled ${steps.length} steps from QStashand returned them without filtering with messageId.`
-      });
-      return { steps, workflowRunEnded: false };
-    } else {
-      const index = steps.findIndex((item) => item.messageId === messageId);
-      if (index === -1) {
-        return { steps: [], workflowRunEnded: false };
-      }
-      const filteredSteps = steps.slice(0, index + 1);
-      await debug?.log("INFO", "ENDPOINT_START", {
-        message: `Pulled ${steps.length} steps from QStash and filtered them to ${filteredSteps.length} using messageId.`
-      });
-      return { steps: filteredSteps, workflowRunEnded: false };
-    }
-  } catch (error) {
-    if (error instanceof import_qstash.QstashError && error.status === 404) {
-      await debug?.log("WARN", "ENDPOINT_START", {
-        message: "Couldn't fetch workflow run steps. This can happen if the workflow run succesfully ends before some callback is executed.",
-        error
-      });
-      return { steps: void 0, workflowRunEnded: true };
-    } else {
-      throw error;
-    }
-  }
-};
+var import_qstash2 = require("@upstash/qstash");
 
 // src/error.ts
-var import_qstash2 = require("@upstash/qstash");
-var WorkflowError = class extends import_qstash2.QstashError {
+var import_qstash = require("@upstash/qstash");
+var WorkflowError = class extends import_qstash.QstashError {
   constructor(message) {
     super(message);
     this.name = "WorkflowError";
@@ -140,6 +90,19 @@ var WorkflowNonRetryableError = class extends WorkflowAbort {
     if (message) this.message = message;
   }
 };
+var WorkflowRetryAfterError = class extends WorkflowAbort {
+  retryAfter;
+  /**
+   * @param retryAfter time in seconds after which the workflow should be retried
+   * @param message error message to be displayed
+   */
+  constructor(message, retryAfter) {
+    super("retry", void 0, false);
+    this.name = "WorkflowRetryAfterError";
+    this.retryAfter = retryAfter;
+    if (message) this.message = message;
+  }
+};
 var formatWorkflowError = (error) => {
   return error instanceof Error ? {
     error: error.name,
@@ -150,6 +113,79 @@ var formatWorkflowError = (error) => {
     message: `An error occured while executing workflow: '${typeof error === "string" ? error : JSON.stringify(error)}'`
   };
 };
+function getConstructorName(obj) {
+  if (obj === null || obj === void 0) {
+    return null;
+  }
+  const ctor = obj.constructor;
+  if (!ctor || ctor.name === "Object") {
+    return null;
+  }
+  return ctor.name;
+}
+function getConstructorNames(obj) {
+  const proto = Object.getPrototypeOf(obj);
+  const name = getConstructorName(proto);
+  if (name === null) {
+    return [];
+  }
+  return [name, ...getConstructorNames(proto)];
+}
+function isInstanceOf(v, ctor) {
+  return getConstructorNames(v).includes(ctor.name);
+}
+
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+var makeCancelRequest = async (requester, workflowRunId) => {
+  await requester.request({
+    path: ["v2", "workflows", "runs", `${workflowRunId}?cancel=true`],
+    method: "DELETE",
+    parseResponseAsJson: false
+  });
+  return true;
+};
+var getSteps = async (requester, workflowRunId, messageId, debug) => {
+  try {
+    const steps = await requester.request({
+      path: ["v2", "workflows", "runs", workflowRunId],
+      parseResponseAsJson: true
+    });
+    if (!messageId) {
+      await debug?.log("INFO", "ENDPOINT_START", {
+        message: `Pulled ${steps.length} steps from QStashand returned them without filtering with messageId.`
+      });
+      return { steps, workflowRunEnded: false };
+    } else {
+      const index = steps.findIndex((item) => item.messageId === messageId);
+      if (index === -1) {
+        return { steps: [], workflowRunEnded: false };
+      }
+      const filteredSteps = steps.slice(0, index + 1);
+      await debug?.log("INFO", "ENDPOINT_START", {
+        message: `Pulled ${steps.length} steps from QStash and filtered them to ${filteredSteps.length} using messageId.`
+      });
+      return { steps: filteredSteps, workflowRunEnded: false };
+    }
+  } catch (error) {
+    if (isInstanceOf(error, import_qstash2.QstashError) && error.status === 404) {
+      await debug?.log("WARN", "ENDPOINT_START", {
+        message: "Couldn't fetch workflow run steps. This can happen if the workflow run succesfully ends before some callback is executed.",
+        error
+      });
+      return { steps: void 0, workflowRunEnded: true };
+    } else {
+      throw error;
+    }
+  }
+};
 
 // src/context/auto-executor.ts
 var import_qstash5 = require("@upstash/qstash");
@@ -710,17 +746,17 @@ var triggerRouteFunction = async ({
     return ok("workflow-finished");
   } catch (error) {
     const error_ = error;
-    if (error instanceof import_qstash3.QstashError && error.status === 400) {
+    if (isInstanceOf(error, import_qstash3.QstashError) && error.status === 400) {
       await debug?.log("WARN", "RESPONSE_WORKFLOW", {
         message: `tried to append to a cancelled workflow. exiting without publishing.`,
         name: error.name,
         errorMessage: error.message
       });
       return ok("workflow-was-finished");
-    } else if (!(error_ instanceof WorkflowAbort)) {
-      return err(error_);
-    } else if (error_ instanceof WorkflowNonRetryableError) {
+    } else if (isInstanceOf(error_, WorkflowNonRetryableError) || isInstanceOf(error_, WorkflowRetryAfterError)) {
       return ok(error_);
+    } else if (!isInstanceOf(error_, WorkflowAbort)) {
+      return err(error_);
     } else if (error_.cancelWorkflow) {
       await onCancel();
       return ok("workflow-finished");
@@ -2027,7 +2063,7 @@ var AutoExecutor = class _AutoExecutor {
           });
           throw new WorkflowAbort(parallelStep.stepName, resultStep);
         } catch (error) {
-          if (error instanceof WorkflowAbort || error instanceof import_qstash5.QstashError && error.status === 400) {
+          if (isInstanceOf(error, WorkflowAbort) || isInstanceOf(error, import_qstash5.QstashError) && error.status === 400) {
             throw error;
           }
           throw new WorkflowError(
@@ -2134,7 +2170,7 @@ var validateParallelSteps = (lazySteps, stepsFromRequest) => {
       validateStep(lazySteps[index], stepFromRequest);
     }
   } catch (error) {
-    if (error instanceof WorkflowError) {
+    if (isInstanceOf(error, WorkflowError)) {
       const lazyStepNames = lazySteps.map((lazyStep) => lazyStep.stepName);
       const lazyStepTypes = lazySteps.map((lazyStep) => lazyStep.stepType);
       const requestStepNames = stepsFromRequest.map((step) => step.stepName);
@@ -2315,7 +2351,7 @@ var fetchWithContextCall = async (context, agentCallParams, ...params) => {
       headers: responseHeaders
     });
   } catch (error) {
-    if (error instanceof Error && error.name === "WorkflowAbort") {
+    if (error instanceof Error && isInstanceOf(error, WorkflowAbort)) {
       throw error;
     } else {
       console.error("Error in fetch implementation:", error);
@@ -2417,10 +2453,10 @@ var Agent = class {
       });
       return { text: result.text };
     } catch (error) {
-      if (error instanceof import_ai2.ToolExecutionError) {
-        if (error.cause instanceof Error && error.cause.name === "WorkflowAbort") {
+      if (isInstanceOf(error, import_ai2.ToolExecutionError)) {
+        if (error.cause instanceof Error && isInstanceOf(error.cause, WorkflowAbort)) {
           throw error.cause;
-        } else if (error.cause instanceof import_ai2.ToolExecutionError && error.cause.cause instanceof Error && error.cause.cause.name === "WorkflowAbort") {
+        } else if (isInstanceOf(error.cause, import_ai2.ToolExecutionError) && isInstanceOf(error.cause.cause, WorkflowAbort)) {
           throw error.cause.cause;
         } else {
           throw error;
@@ -3169,7 +3205,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     try {
       await routeFunction(disabledContext);
     } catch (error) {
-      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage || error instanceof WorkflowNonRetryableError) {
+      if (isInstanceOf(error, WorkflowAbort) && error.stepName === this.disabledMessage || isInstanceOf(error, WorkflowNonRetryableError) || isInstanceOf(error, WorkflowRetryAfterError)) {
         return ok("step-found");
       }
       console.warn(
@@ -3422,13 +3458,24 @@ var processOptions = (options) => {
           },
           status: 489
         });
-      } else if (detailedFinishCondition?.condition === "failure-callback") {
-        return new Response(detailedFinishCondition.result ?? void 0, {
-          status: 200,
+      } else if (detailedFinishCondition?.condition === "retry-after-error") {
+        return new Response(JSON.stringify(formatWorkflowError(detailedFinishCondition.result)), {
           headers: {
+            "Retry-After": detailedFinishCondition.result.retryAfter.toString(),
             [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION
-          }
+          },
+          status: 429
         });
+      } else if (detailedFinishCondition?.condition === "failure-callback") {
+        return new Response(
+          JSON.stringify({ result: detailedFinishCondition.result ?? void 0 }),
+          {
+            status: 200,
+            headers: {
+              [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION
+            }
+          }
+        );
       }
       return new Response(JSON.stringify({ workflowRunId }), {
         status: 200,
@@ -3638,12 +3685,18 @@ var serveBase = (routeFunction, telemetry2, options) => {
         },
         debug
       });
-      if (result.isOk() && result.value instanceof WorkflowNonRetryableError) {
+      if (result.isOk() && isInstanceOf(result.value, WorkflowNonRetryableError)) {
         return onStepFinish(workflowRunId, result.value, {
           condition: "non-retryable-error",
           result: result.value
         });
       }
+      if (result.isOk() && isInstanceOf(result.value, WorkflowRetryAfterError)) {
+        return onStepFinish(workflowRunId, result.value, {
+          condition: "retry-after-error",
+          result: result.value
+        });
+      }
       if (result.isErr()) {
         await debug?.log("ERROR", "ERROR", { error: result.error.message });
         throw result.error;
@@ -3674,7 +3727,7 @@ var serveBase = (routeFunction, telemetry2, options) => {
         const errorMessage = `Error while running onError callback: '${formattedOnErrorError.message}'.
 Original error: '${formattedError.message}'`;
         console.error(errorMessage);
-        return new Response(errorMessage, {
+        return new Response(JSON.stringify({ error: errorMessage }), {
           status: 500,
           headers: {
             [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION

package/cloudflare.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-NQDNC5P4.mjs";
+} from "./chunk-BON2RKOR.mjs";
 
 // platforms/cloudflare.ts
 var getArgs = (args) => {

package/express.d.mts

@@ -1,7 +1,7 @@
 import * as express_serve_static_core from 'express-serve-static-core';
-import { R as RouteFunction, W as WorkflowServeOptions, y as InvokableWorkflow } from './types-Q3dM0UlR.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions, z as InvokableWorkflow } from './types-9nCq6bRP.mjs';
 import { Router } from 'express';
-import { s as serveManyBase } from './serve-many-BNusWYgt.mjs';
+import { s as serveManyBase } from './serve-many-CctdYIfB.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/express.d.ts

@@ -1,7 +1,7 @@
 import * as express_serve_static_core from 'express-serve-static-core';
-import { R as RouteFunction, W as WorkflowServeOptions, y as InvokableWorkflow } from './types-Q3dM0UlR.js';
+import { R as RouteFunction, W as WorkflowServeOptions, z as InvokableWorkflow } from './types-9nCq6bRP.js';
 import { Router } from 'express';
-import { s as serveManyBase } from './serve-many-CXqQP3RI.js';
+import { s as serveManyBase } from './serve-many-BXDr30rl.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';