@upstash/workflow 0.2.21 → 0.2.22

package/index.d.mts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter } from './types-Q3dM0UlR.mjs';
-export { A as AsyncStepFunction, C as CallResponse, w as CallSettings, D as DetailedFinishCondition, t as Duration, o as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, y as InvokableWorkflow, x as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, z as LogLevel, s as NotifyStepResponse, P as ParallelCallState, n as PublicServeOptions, p as RequiredExceptFields, k as Step, m as StepFunction, j as StepTypes, v as StringifyBody, l as SyncStepFunction, u as WaitEventOptions, q as WaitRequest, r as WaitStepResponse, d as WorkflowAbort, h as WorkflowClient, g as WorkflowContext, c as WorkflowError, G as WorkflowLogger, B as WorkflowLoggerOptions, e as WorkflowNonRetryableError, i as WorkflowReceiver, f as WorkflowTool } from './types-Q3dM0UlR.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter } from './types-9nCq6bRP.mjs';
+export { A as AsyncStepFunction, C as CallResponse, x as CallSettings, D as DetailedFinishCondition, u as Duration, p as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, z as InvokableWorkflow, y as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, B as LogLevel, t as NotifyStepResponse, P as ParallelCallState, o as PublicServeOptions, q as RequiredExceptFields, l as Step, n as StepFunction, k as StepTypes, w as StringifyBody, m as SyncStepFunction, v as WaitEventOptions, r as WaitRequest, s as WaitStepResponse, d as WorkflowAbort, i as WorkflowClient, h as WorkflowContext, c as WorkflowError, J as WorkflowLogger, G as WorkflowLoggerOptions, e as WorkflowNonRetryableError, j as WorkflowReceiver, f as WorkflowRetryAfterError, g as WorkflowTool } from './types-9nCq6bRP.mjs';
 import { FlowControl, PublishRequest, HTTPMethods, State, Client as Client$1 } from '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -439,6 +439,14 @@ type TriggerOptions = {
      * @default false
      */
     keepTriggerConfig?: boolean;
+    /**
+     * By default, Workflow SDK sends telemetry about SDK version, framework or runtime.
+     *
+     * Set `disableTelemetry` to disable this behavior.
+     *
+     * @default false
+     */
+    disableTelemetry?: boolean;
 } & ({
     /**
      * URL to call if the first request to the workflow endpoint fails

package/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter } from './types-Q3dM0UlR.js';
-export { A as AsyncStepFunction, C as CallResponse, w as CallSettings, D as DetailedFinishCondition, t as Duration, o as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, y as InvokableWorkflow, x as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, z as LogLevel, s as NotifyStepResponse, P as ParallelCallState, n as PublicServeOptions, p as RequiredExceptFields, k as Step, m as StepFunction, j as StepTypes, v as StringifyBody, l as SyncStepFunction, u as WaitEventOptions, q as WaitRequest, r as WaitStepResponse, d as WorkflowAbort, h as WorkflowClient, g as WorkflowContext, c as WorkflowError, G as WorkflowLogger, B as WorkflowLoggerOptions, e as WorkflowNonRetryableError, i as WorkflowReceiver, f as WorkflowTool } from './types-Q3dM0UlR.js';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter } from './types-9nCq6bRP.js';
+export { A as AsyncStepFunction, C as CallResponse, x as CallSettings, D as DetailedFinishCondition, u as Duration, p as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, z as InvokableWorkflow, y as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, B as LogLevel, t as NotifyStepResponse, P as ParallelCallState, o as PublicServeOptions, q as RequiredExceptFields, l as Step, n as StepFunction, k as StepTypes, w as StringifyBody, m as SyncStepFunction, v as WaitEventOptions, r as WaitRequest, s as WaitStepResponse, d as WorkflowAbort, i as WorkflowClient, h as WorkflowContext, c as WorkflowError, J as WorkflowLogger, G as WorkflowLoggerOptions, e as WorkflowNonRetryableError, j as WorkflowReceiver, f as WorkflowRetryAfterError, g as WorkflowTool } from './types-9nCq6bRP.js';
 import { FlowControl, PublishRequest, HTTPMethods, State, Client as Client$1 } from '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -439,6 +439,14 @@ type TriggerOptions = {
      * @default false
      */
     keepTriggerConfig?: boolean;
+    /**
+     * By default, Workflow SDK sends telemetry about SDK version, framework or runtime.
+     *
+     * Set `disableTelemetry` to disable this behavior.
+     *
+     * @default false
+     */
+    disableTelemetry?: boolean;
 } & ({
     /**
      * URL to call if the first request to the workflow endpoint fails

package/index.js

@@ -27,13 +27,102 @@ __export(src_exports, {
   WorkflowError: () => WorkflowError,
   WorkflowLogger: () => WorkflowLogger,
   WorkflowNonRetryableError: () => WorkflowNonRetryableError,
+  WorkflowRetryAfterError: () => WorkflowRetryAfterError,
   WorkflowTool: () => WorkflowTool,
   serve: () => serve
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/client/utils.ts
+var import_qstash2 = require("@upstash/qstash");
+
+// src/error.ts
 var import_qstash = require("@upstash/qstash");
+var WorkflowError = class extends import_qstash.QstashError {
+  constructor(message) {
+    super(message);
+    this.name = "WorkflowError";
+  }
+};
+var WorkflowAbort = class extends Error {
+  stepInfo;
+  stepName;
+  /**
+   * whether workflow is to be canceled on abort
+   */
+  cancelWorkflow;
+  /**
+   *
+   * @param stepName name of the aborting step
+   * @param stepInfo step information
+   * @param cancelWorkflow
+   */
+  constructor(stepName, stepInfo, cancelWorkflow = false) {
+    super(
+      `This is an Upstash Workflow error thrown after a step executes. It is expected to be raised. Make sure that you await for each step. Also, if you are using try/catch blocks, you should not wrap context.run/sleep/sleepUntil/call methods with try/catch. Aborting workflow after executing step '${stepName}'.`
+    );
+    this.name = "WorkflowAbort";
+    this.stepName = stepName;
+    this.stepInfo = stepInfo;
+    this.cancelWorkflow = cancelWorkflow;
+  }
+};
+var WorkflowNonRetryableError = class extends WorkflowAbort {
+  /**
+   * @param message error message to be displayed
+   */
+  constructor(message) {
+    super("fail", void 0, false);
+    this.name = "WorkflowNonRetryableError";
+    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,
+    message: error.message,
+    stack: error.stack
+  } : {
+    error: "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],
@@ -80,7 +169,7 @@ var getSteps = async (requester, workflowRunId, messageId, debug) => {
       return { steps: filteredSteps, workflowRunEnded: false };
     }
   } catch (error) {
-    if (error instanceof import_qstash.QstashError && error.status === 404) {
+    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
@@ -105,65 +194,13 @@ 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";
 var TELEMETRY_HEADER_RUNTIME = "Upstash-Telemetry-Runtime";
 var TELEMETRY_HEADER_AGENT = "Upstash-Telemetry-Agent";
 
-// src/error.ts
-var import_qstash2 = require("@upstash/qstash");
-var WorkflowError = class extends import_qstash2.QstashError {
-  constructor(message) {
-    super(message);
-    this.name = "WorkflowError";
-  }
-};
-var WorkflowAbort = class extends Error {
-  stepInfo;
-  stepName;
-  /**
-   * whether workflow is to be canceled on abort
-   */
-  cancelWorkflow;
-  /**
-   *
-   * @param stepName name of the aborting step
-   * @param stepInfo step information
-   * @param cancelWorkflow
-   */
-  constructor(stepName, stepInfo, cancelWorkflow = false) {
-    super(
-      `This is an Upstash Workflow error thrown after a step executes. It is expected to be raised. Make sure that you await for each step. Also, if you are using try/catch blocks, you should not wrap context.run/sleep/sleepUntil/call methods with try/catch. Aborting workflow after executing step '${stepName}'.`
-    );
-    this.name = "WorkflowAbort";
-    this.stepName = stepName;
-    this.stepInfo = stepInfo;
-    this.cancelWorkflow = cancelWorkflow;
-  }
-};
-var WorkflowNonRetryableError = class extends WorkflowAbort {
-  /**
-   * @param message error message to be displayed
-   */
-  constructor(message) {
-    super("fail", void 0, false);
-    this.name = "WorkflowNonRetryableError";
-    if (message) this.message = message;
-  }
-};
-var formatWorkflowError = (error) => {
-  return error instanceof Error ? {
-    error: error.name,
-    message: error.message,
-    stack: error.stack
-  } : {
-    error: "Error",
-    message: `An error occured while executing workflow: '${typeof error === "string" ? error : JSON.stringify(error)}'`
-  };
-};
-
 // src/context/auto-executor.ts
 var import_qstash5 = require("@upstash/qstash");
 
@@ -723,17 +760,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");
@@ -2040,7 +2077,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(
@@ -2147,7 +2184,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);
@@ -2328,7 +2365,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);
@@ -2461,10 +2498,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;
@@ -3146,7 +3183,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(
@@ -3399,13 +3436,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,
@@ -3615,12 +3663,18 @@ var serveBase = (routeFunction, telemetry, 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;
@@ -3651,7 +3705,7 @@ var serveBase = (routeFunction, telemetry, 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
@@ -3920,14 +3974,14 @@ var Client4 = class {
         workflowRunId: finalWorkflowRunId,
         retries: option.retries,
         retryDelay: option.retryDelay,
-        telemetry: { sdk: SDK_TELEMETRY },
+        telemetry: option.disableTelemetry ? void 0 : { sdk: SDK_TELEMETRY },
         flowControl: option.flowControl,
         failureUrl,
         label: option.label
       });
       return {
         workflowContext: context,
-        telemetry: { sdk: SDK_TELEMETRY },
+        telemetry: option.disableTelemetry ? void 0 : { sdk: SDK_TELEMETRY },
         delay: option.delay,
         notBefore: option.notBefore,
         keepTriggerConfig: option.keepTriggerConfig
@@ -4012,6 +4066,7 @@ var Client4 = class {
   WorkflowError,
   WorkflowLogger,
   WorkflowNonRetryableError,
+  WorkflowRetryAfterError,
   WorkflowTool,
   serve
 });

package/index.mjs

@@ -7,6 +7,7 @@ import {
   WorkflowError,
   WorkflowLogger,
   WorkflowNonRetryableError,
+  WorkflowRetryAfterError,
   WorkflowTool,
   getWorkflowRunId,
   makeGetWaitersRequest,
@@ -14,7 +15,7 @@ import {
   prepareFlowControl,
   serve,
   triggerFirstInvocation
-} from "./chunk-NQDNC5P4.mjs";
+} from "./chunk-BON2RKOR.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -257,14 +258,14 @@ var Client = class {
         workflowRunId: finalWorkflowRunId,
         retries: option.retries,
         retryDelay: option.retryDelay,
-        telemetry: { sdk: SDK_TELEMETRY },
+        telemetry: option.disableTelemetry ? void 0 : { sdk: SDK_TELEMETRY },
         flowControl: option.flowControl,
         failureUrl,
         label: option.label
       });
       return {
         workflowContext: context,
-        telemetry: { sdk: SDK_TELEMETRY },
+        telemetry: option.disableTelemetry ? void 0 : { sdk: SDK_TELEMETRY },
         delay: option.delay,
         notBefore: option.notBefore,
         keepTriggerConfig: option.keepTriggerConfig
@@ -348,6 +349,7 @@ export {
   WorkflowError,
   WorkflowLogger,
   WorkflowNonRetryableError,
+  WorkflowRetryAfterError,
   WorkflowTool,
   serve
 };

package/nextjs.d.mts

@@ -1,6 +1,6 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, n as PublicServeOptions, y as InvokableWorkflow } from './types-Q3dM0UlR.mjs';
-import { s as serveManyBase } from './serve-many-BNusWYgt.mjs';
+import { R as RouteFunction, o as PublicServeOptions, z as InvokableWorkflow } from './types-9nCq6bRP.mjs';
+import { s as serveManyBase } from './serve-many-CctdYIfB.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/nextjs.d.ts

@@ -1,6 +1,6 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, n as PublicServeOptions, y as InvokableWorkflow } from './types-Q3dM0UlR.js';
-import { s as serveManyBase } from './serve-many-CXqQP3RI.js';
+import { R as RouteFunction, o as PublicServeOptions, z as InvokableWorkflow } from './types-9nCq6bRP.js';
+import { s as serveManyBase } from './serve-many-BXDr30rl.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';