@upstash/workflow 0.2.13 → 0.2.15

package/astro.d.mts

@@ -1,6 +1,6 @@
 import { APIContext, APIRoute } from 'astro';
-import { e as WorkflowContext, k as PublicServeOptions, t as InvokableWorkflow } from './types-C1WIgVLA.mjs';
-import { s as serveManyBase } from './serve-many-BF71QZHQ.mjs';
+import { g as WorkflowContext, n as PublicServeOptions, w as InvokableWorkflow } from './types-Dd-3bPoU.mjs';
+import { s as serveManyBase } from './serve-many-AFwJPR3S.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/astro.d.ts

@@ -1,6 +1,6 @@
 import { APIContext, APIRoute } from 'astro';
-import { e as WorkflowContext, k as PublicServeOptions, t as InvokableWorkflow } from './types-C1WIgVLA.js';
-import { s as serveManyBase } from './serve-many-BMlN2PAB.js';
+import { g as WorkflowContext, n as PublicServeOptions, w as InvokableWorkflow } from './types-Dd-3bPoU.js';
+import { s as serveManyBase } from './serve-many-AaKSQyi7.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/astro.js

@@ -91,7 +91,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.13";
+var VERSION = "v0.2.15";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -129,6 +129,16 @@ var WorkflowAbort = class extends Error {
     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,
@@ -599,59 +609,72 @@ var StepTypes = [
 
 // src/workflow-requests.ts
 var import_qstash3 = require("@upstash/qstash");
-var triggerFirstInvocation = async ({
-  workflowContext,
-  useJSONContent,
-  telemetry: telemetry2,
-  debug,
-  invokeCount,
-  delay
-}) => {
-  const { headers } = getHeaders({
-    initHeaderValue: "true",
-    workflowConfig: {
-      workflowRunId: workflowContext.workflowRunId,
-      workflowUrl: workflowContext.url,
-      failureUrl: workflowContext.failureUrl,
-      retries: workflowContext.retries,
-      telemetry: telemetry2,
-      flowControl: workflowContext.flowControl,
-      useJSONContent: useJSONContent ?? false
-    },
-    invokeCount: invokeCount ?? 0,
-    userHeaders: workflowContext.headers
-  });
-  if (workflowContext.headers.get("content-type")) {
-    headers["content-type"] = workflowContext.headers.get("content-type");
-  }
-  if (useJSONContent) {
-    headers["content-type"] = "application/json";
-  }
-  try {
-    const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
-    const result = await workflowContext.qstashClient.publish({
-      headers,
-      method: "POST",
-      body,
-      url: workflowContext.url,
-      delay
-    });
-    if (result.deduplicated) {
-      await debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
-        message: `Workflow run ${workflowContext.workflowRunId} already exists. A new one isn't created.`,
+var triggerFirstInvocation = async (params) => {
+  const firstInvocationParams = Array.isArray(params) ? params : [params];
+  const workflowContextClient = firstInvocationParams[0].workflowContext.qstashClient;
+  const invocationBatch = firstInvocationParams.map(
+    ({ workflowContext, useJSONContent, telemetry: telemetry2, invokeCount, delay }) => {
+      const { headers } = getHeaders({
+        initHeaderValue: "true",
+        workflowConfig: {
+          workflowRunId: workflowContext.workflowRunId,
+          workflowUrl: workflowContext.url,
+          failureUrl: workflowContext.failureUrl,
+          retries: workflowContext.retries,
+          telemetry: telemetry2,
+          flowControl: workflowContext.flowControl,
+          useJSONContent: useJSONContent ?? false
+        },
+        invokeCount: invokeCount ?? 0,
+        userHeaders: workflowContext.headers
+      });
+      if (workflowContext.headers.get("content-type")) {
+        headers["content-type"] = workflowContext.headers.get("content-type");
+      }
+      if (useJSONContent) {
+        headers["content-type"] = "application/json";
+      }
+      const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
+      return {
         headers,
-        requestPayload: workflowContext.requestPayload,
+        method: "POST",
+        body,
         url: workflowContext.url,
-        messageId: result.messageId
-      });
+        delay
+      };
+    }
+  );
+  try {
+    const results = await workflowContextClient.batch(invocationBatch);
+    const invocationStatuses = [];
+    for (let i = 0; i < results.length; i++) {
+      const result = results[i];
+      const invocationParams = firstInvocationParams[i];
+      if (result.deduplicated) {
+        await invocationParams.debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
+          message: `Workflow run ${invocationParams.workflowContext.workflowRunId} already exists. A new one isn't created.`,
+          headers: invocationBatch[i].headers,
+          requestPayload: invocationParams.workflowContext.requestPayload,
+          url: invocationParams.workflowContext.url,
+          messageId: result.messageId
+        });
+        invocationStatuses.push("workflow-run-already-exists");
+      } else {
+        await invocationParams.debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
+          headers: invocationBatch[i].headers,
+          requestPayload: invocationParams.workflowContext.requestPayload,
+          url: invocationParams.workflowContext.url,
+          messageId: result.messageId
+        });
+        invocationStatuses.push("success");
+      }
+    }
+    const hasAnyDeduplicated = invocationStatuses.some(
+      (status) => status === "workflow-run-already-exists"
+    );
+    if (hasAnyDeduplicated) {
       return ok("workflow-run-already-exists");
     } else {
-      await debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
-        headers,
-        requestPayload: workflowContext.requestPayload,
-        url: workflowContext.url,
-        messageId: result.messageId
-      });
       return ok("success");
     }
   } catch (error) {
@@ -680,6 +703,8 @@ var triggerRouteFunction = async ({
       return ok("workflow-was-finished");
     } else if (!(error_ instanceof WorkflowAbort)) {
       return err(error_);
+    } else if (error_ instanceof WorkflowNonRetryableError) {
+      return ok(error_);
     } else if (error_.cancelWorkflow) {
       await onCancel();
       return ok("workflow-finished");
@@ -841,7 +866,7 @@ ${atob(callbackMessage.body ?? "")}`
 var getTelemetryHeaders = (telemetry2) => {
   return {
     [TELEMETRY_HEADER_SDK]: telemetry2.sdk,
-    [TELEMETRY_HEADER_FRAMEWORK]: telemetry2.framework,
+    [TELEMETRY_HEADER_FRAMEWORK]: telemetry2.framework ?? "unknown",
     [TELEMETRY_HEADER_RUNTIME]: telemetry2.runtime ?? "unknown"
   };
 };
@@ -1141,7 +1166,7 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
       return { header, status, body };
     }
   }
-  static applicationHeaders = /* @__PURE__ */ new Set([
+  static applicationContentTypes = [
     "application/json",
     "application/xml",
     "application/javascript",
@@ -1150,12 +1175,12 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
     "application/ld+json",
     "application/rss+xml",
     "application/atom+xml"
-  ]);
+  ];
   static isText = (contentTypeHeader) => {
     if (!contentTypeHeader) {
       return false;
     }
-    if (_LazyCallStep.applicationHeaders.has(contentTypeHeader)) {
+    if (_LazyCallStep.applicationContentTypes.some((type) => contentTypeHeader.includes(type))) {
       return true;
     }
     if (contentTypeHeader.startsWith("text/")) {
@@ -2953,10 +2978,10 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
   }
   /**
-   * overwrite cancel method to do nothing
+   * overwrite cancel method to throw WorkflowAbort with the disabledMessage
    */
   async cancel() {
-    return;
+    throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
   }
   /**
    * copies the passed context to create a DisabledWorkflowContext. Then, runs the
@@ -2988,7 +3013,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     try {
       await routeFunction(disabledContext);
     } catch (error) {
-      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage) {
+      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage || error instanceof WorkflowNonRetryableError) {
         return ok("step-found");
       }
       return err(error);
@@ -3209,6 +3234,13 @@ var processOptions = (options) => {
             status: 400
           }
         );
+      } else if (finishCondition instanceof WorkflowNonRetryableError) {
+        return new Response(JSON.stringify(formatWorkflowError(finishCondition)), {
+          headers: {
+            "Upstash-NonRetryable-Error": "true"
+          },
+          status: 489
+        });
       }
       return new Response(JSON.stringify({ workflowRunId }), {
         status: 200
@@ -3401,6 +3433,9 @@ var serveBase = (routeFunction, telemetry2, options) => {
         },
         debug
       });
+      if (result.isOk() && result.value instanceof WorkflowNonRetryableError) {
+        return onStepFinish(workflowRunId, result.value);
+      }
       if (result.isErr()) {
         await debug?.log("ERROR", "ERROR", { error: result.error.message });
         throw result.error;

package/astro.mjs

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

package/{chunk-XVNSBBDC.mjs → chunk-AC5CQCN3.mjs}

@@ -42,7 +42,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.13";
+var VERSION = "v0.2.15";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -80,6 +80,16 @@ var WorkflowAbort = class extends Error {
     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,
@@ -809,59 +819,72 @@ var fromThrowable = Result.fromThrowable;
 
 // src/workflow-requests.ts
 import { QstashError as QstashError3 } from "@upstash/qstash";
-var triggerFirstInvocation = async ({
-  workflowContext,
-  useJSONContent,
-  telemetry,
-  debug,
-  invokeCount,
-  delay
-}) => {
-  const { headers } = getHeaders({
-    initHeaderValue: "true",
-    workflowConfig: {
-      workflowRunId: workflowContext.workflowRunId,
-      workflowUrl: workflowContext.url,
-      failureUrl: workflowContext.failureUrl,
-      retries: workflowContext.retries,
-      telemetry,
-      flowControl: workflowContext.flowControl,
-      useJSONContent: useJSONContent ?? false
-    },
-    invokeCount: invokeCount ?? 0,
-    userHeaders: workflowContext.headers
-  });
-  if (workflowContext.headers.get("content-type")) {
-    headers["content-type"] = workflowContext.headers.get("content-type");
-  }
-  if (useJSONContent) {
-    headers["content-type"] = "application/json";
-  }
-  try {
-    const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
-    const result = await workflowContext.qstashClient.publish({
-      headers,
-      method: "POST",
-      body,
-      url: workflowContext.url,
-      delay
-    });
-    if (result.deduplicated) {
-      await debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
-        message: `Workflow run ${workflowContext.workflowRunId} already exists. A new one isn't created.`,
+var triggerFirstInvocation = async (params) => {
+  const firstInvocationParams = Array.isArray(params) ? params : [params];
+  const workflowContextClient = firstInvocationParams[0].workflowContext.qstashClient;
+  const invocationBatch = firstInvocationParams.map(
+    ({ workflowContext, useJSONContent, telemetry, invokeCount, delay }) => {
+      const { headers } = getHeaders({
+        initHeaderValue: "true",
+        workflowConfig: {
+          workflowRunId: workflowContext.workflowRunId,
+          workflowUrl: workflowContext.url,
+          failureUrl: workflowContext.failureUrl,
+          retries: workflowContext.retries,
+          telemetry,
+          flowControl: workflowContext.flowControl,
+          useJSONContent: useJSONContent ?? false
+        },
+        invokeCount: invokeCount ?? 0,
+        userHeaders: workflowContext.headers
+      });
+      if (workflowContext.headers.get("content-type")) {
+        headers["content-type"] = workflowContext.headers.get("content-type");
+      }
+      if (useJSONContent) {
+        headers["content-type"] = "application/json";
+      }
+      const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
+      return {
         headers,
-        requestPayload: workflowContext.requestPayload,
+        method: "POST",
+        body,
         url: workflowContext.url,
-        messageId: result.messageId
-      });
+        delay
+      };
+    }
+  );
+  try {
+    const results = await workflowContextClient.batch(invocationBatch);
+    const invocationStatuses = [];
+    for (let i = 0; i < results.length; i++) {
+      const result = results[i];
+      const invocationParams = firstInvocationParams[i];
+      if (result.deduplicated) {
+        await invocationParams.debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
+          message: `Workflow run ${invocationParams.workflowContext.workflowRunId} already exists. A new one isn't created.`,
+          headers: invocationBatch[i].headers,
+          requestPayload: invocationParams.workflowContext.requestPayload,
+          url: invocationParams.workflowContext.url,
+          messageId: result.messageId
+        });
+        invocationStatuses.push("workflow-run-already-exists");
+      } else {
+        await invocationParams.debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
+          headers: invocationBatch[i].headers,
+          requestPayload: invocationParams.workflowContext.requestPayload,
+          url: invocationParams.workflowContext.url,
+          messageId: result.messageId
+        });
+        invocationStatuses.push("success");
+      }
+    }
+    const hasAnyDeduplicated = invocationStatuses.some(
+      (status) => status === "workflow-run-already-exists"
+    );
+    if (hasAnyDeduplicated) {
       return ok("workflow-run-already-exists");
     } else {
-      await debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
-        headers,
-        requestPayload: workflowContext.requestPayload,
-        url: workflowContext.url,
-        messageId: result.messageId
-      });
       return ok("success");
     }
   } catch (error) {
@@ -890,6 +913,8 @@ var triggerRouteFunction = async ({
       return ok("workflow-was-finished");
     } else if (!(error_ instanceof WorkflowAbort)) {
       return err(error_);
+    } else if (error_ instanceof WorkflowNonRetryableError) {
+      return ok(error_);
     } else if (error_.cancelWorkflow) {
       await onCancel();
       return ok("workflow-finished");
@@ -1051,7 +1076,7 @@ ${atob(callbackMessage.body ?? "")}`
 var getTelemetryHeaders = (telemetry) => {
   return {
     [TELEMETRY_HEADER_SDK]: telemetry.sdk,
-    [TELEMETRY_HEADER_FRAMEWORK]: telemetry.framework,
+    [TELEMETRY_HEADER_FRAMEWORK]: telemetry.framework ?? "unknown",
     [TELEMETRY_HEADER_RUNTIME]: telemetry.runtime ?? "unknown"
   };
 };
@@ -1351,7 +1376,7 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
       return { header, status, body };
     }
   }
-  static applicationHeaders = /* @__PURE__ */ new Set([
+  static applicationContentTypes = [
     "application/json",
     "application/xml",
     "application/javascript",
@@ -1360,12 +1385,12 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
     "application/ld+json",
     "application/rss+xml",
     "application/atom+xml"
-  ]);
+  ];
   static isText = (contentTypeHeader) => {
     if (!contentTypeHeader) {
       return false;
     }
-    if (_LazyCallStep.applicationHeaders.has(contentTypeHeader)) {
+    if (_LazyCallStep.applicationContentTypes.some((type) => contentTypeHeader.includes(type))) {
       return true;
     }
     if (contentTypeHeader.startsWith("text/")) {
@@ -2997,10 +3022,10 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
   }
   /**
-   * overwrite cancel method to do nothing
+   * overwrite cancel method to throw WorkflowAbort with the disabledMessage
    */
   async cancel() {
-    return;
+    throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
   }
   /**
    * copies the passed context to create a DisabledWorkflowContext. Then, runs the
@@ -3032,7 +3057,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     try {
       await routeFunction(disabledContext);
     } catch (error) {
-      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage) {
+      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage || error instanceof WorkflowNonRetryableError) {
         return ok("step-found");
       }
       return err(error);
@@ -3253,6 +3278,13 @@ var processOptions = (options) => {
             status: 400
           }
         );
+      } else if (finishCondition instanceof WorkflowNonRetryableError) {
+        return new Response(JSON.stringify(formatWorkflowError(finishCondition)), {
+          headers: {
+            "Upstash-NonRetryable-Error": "true"
+          },
+          status: 489
+        });
       }
       return new Response(JSON.stringify({ workflowRunId }), {
         status: 200
@@ -3445,6 +3477,9 @@ var serveBase = (routeFunction, telemetry, options) => {
         },
         debug
       });
+      if (result.isOk() && result.value instanceof WorkflowNonRetryableError) {
+        return onStepFinish(workflowRunId, result.value);
+      }
       if (result.isErr()) {
         await debug?.log("ERROR", "ERROR", { error: result.error.message });
         throw result.error;
@@ -3500,9 +3535,11 @@ export {
   SDK_TELEMETRY,
   WorkflowError,
   WorkflowAbort,
+  WorkflowNonRetryableError,
   getWorkflowRunId,
   StepTypes,
   triggerFirstInvocation,
+  prepareFlowControl,
   WorkflowTool,
   serveManyBase,
   WorkflowContext,

package/cloudflare.d.mts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-C1WIgVLA.mjs';
-import { s as serveManyBase } from './serve-many-BF71QZHQ.mjs';
+import { R as RouteFunction, n as PublicServeOptions, w as InvokableWorkflow } from './types-Dd-3bPoU.mjs';
+import { s as serveManyBase } from './serve-many-AFwJPR3S.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/cloudflare.d.ts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-C1WIgVLA.js';
-import { s as serveManyBase } from './serve-many-BMlN2PAB.js';
+import { R as RouteFunction, n as PublicServeOptions, w as InvokableWorkflow } from './types-Dd-3bPoU.js';
+import { s as serveManyBase } from './serve-many-AaKSQyi7.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';