@upstash/workflow 0.1.4 → 0.2.0

package/index.js

@@ -1,9 +1,7 @@
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -17,24 +15,16 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
   Client: () => Client3,
-  QStashWorkflowAbort: () => QStashWorkflowAbort,
-  QStashWorkflowError: () => QStashWorkflowError,
   StepTypes: () => StepTypes,
+  WorkflowAbort: () => WorkflowAbort,
   WorkflowContext: () => WorkflowContext,
+  WorkflowError: () => WorkflowError,
   WorkflowLogger: () => WorkflowLogger,
   serve: () => serve
 });
@@ -42,22 +32,33 @@ module.exports = __toCommonJS(src_exports);
 
 // src/error.ts
 var import_qstash = require("@upstash/qstash");
-var QStashWorkflowError = class extends import_qstash.QstashError {
+var WorkflowError = class extends import_qstash.QstashError {
   constructor(message) {
     super(message);
-    this.name = "QStashWorkflowError";
+    this.name = "WorkflowError";
   }
 };
-var QStashWorkflowAbort = class extends Error {
+var WorkflowAbort = class extends Error {
   stepInfo;
   stepName;
-  constructor(stepName, stepInfo) {
+  /**
+   * 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 = "QStashWorkflowAbort";
+    this.name = "WorkflowAbort";
     this.stepName = stepName;
     this.stepInfo = stepInfo;
+    this.cancelWorkflow = cancelWorkflow;
   }
 };
 var formatWorkflowError = (error) => {
@@ -86,6 +87,44 @@ var makeGetWaitersRequest = async (requester, eventId) => {
   });
   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;
+    } else {
+      const index = steps.findIndex((item) => item.messageId === messageId);
+      if (index === -1) {
+        return [];
+      }
+      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 filteredSteps;
+    }
+  } catch (error) {
+    await debug?.log("ERROR", "ERROR", {
+      message: "failed while fetching steps.",
+      error
+    });
+    throw new WorkflowError(`Failed while pulling steps. ${error}`);
+  }
+};
 
 // src/context/steps.ts
 var BaseLazyStep = class {
@@ -700,6 +739,7 @@ var StepTypes = [
 ];
 
 // src/workflow-requests.ts
+var import_qstash2 = require("@upstash/qstash");
 var triggerFirstInvocation = async (workflowContext, retries, debug) => {
   const { headers } = getHeaders(
     "true",
@@ -710,20 +750,32 @@ var triggerFirstInvocation = async (workflowContext, retries, debug) => {
     workflowContext.failureUrl,
     retries
   );
-  await debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
-    headers,
-    requestPayload: workflowContext.requestPayload,
-    url: workflowContext.url
-  });
   try {
     const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
-    await workflowContext.qstashClient.publish({
+    const result = await workflowContext.qstashClient.publish({
       headers,
       method: "POST",
       body,
       url: workflowContext.url
     });
-    return ok("success");
+    if (result.deduplicated) {
+      await debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
+        message: `Workflow run ${workflowContext.workflowRunId} already exists. A new one isn't created.`,
+        headers,
+        requestPayload: workflowContext.requestPayload,
+        url: workflowContext.url,
+        messageId: result.messageId
+      });
+      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) {
     const error_ = error;
     return err(error_);
@@ -731,7 +783,9 @@ var triggerFirstInvocation = async (workflowContext, retries, debug) => {
 };
 var triggerRouteFunction = async ({
   onCleanup,
-  onStep
+  onStep,
+  onCancel,
+  debug
 }) => {
   try {
     await onStep();
@@ -739,19 +793,50 @@ var triggerRouteFunction = async ({
     return ok("workflow-finished");
   } catch (error) {
     const error_ = error;
-    return error_ instanceof QStashWorkflowAbort ? ok("step-finished") : err(error_);
+    if (error instanceof import_qstash2.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_.cancelWorkflow) {
+      await onCancel();
+      return ok("workflow-finished");
+    } else {
+      return ok("step-finished");
+    }
   }
 };
 var triggerWorkflowDelete = async (workflowContext, debug, cancel = false) => {
   await debug?.log("SUBMIT", "SUBMIT_CLEANUP", {
     deletedWorkflowRunId: workflowContext.workflowRunId
   });
-  const result = await workflowContext.qstashClient.http.request({
-    path: ["v2", "workflows", "runs", `${workflowContext.workflowRunId}?cancel=${cancel}`],
-    method: "DELETE",
-    parseResponseAsJson: false
-  });
-  await debug?.log("SUBMIT", "SUBMIT_CLEANUP", result);
+  try {
+    await workflowContext.qstashClient.http.request({
+      path: ["v2", "workflows", "runs", `${workflowContext.workflowRunId}?cancel=${cancel}`],
+      method: "DELETE",
+      parseResponseAsJson: false
+    });
+    await debug?.log(
+      "SUBMIT",
+      "SUBMIT_CLEANUP",
+      `workflow run ${workflowContext.workflowRunId} deleted.`
+    );
+    return { deleted: true };
+  } catch (error) {
+    if (error instanceof import_qstash2.QstashError && error.status === 404) {
+      await debug?.log("WARN", "SUBMIT_CLEANUP", {
+        message: `Failed to remove workflow run ${workflowContext.workflowRunId} as it doesn't exist.`,
+        name: error.name,
+        errorMessage: error.message
+      });
+      return { deleted: false };
+    }
+    throw error;
+  }
 };
 var recreateUserHeaders = (headers) => {
   const filteredHeaders = new Headers();
@@ -767,15 +852,32 @@ var recreateUserHeaders = (headers) => {
 var handleThirdPartyCallResult = async (request, requestPayload, client, workflowUrl, failureUrl, retries, debug) => {
   try {
     if (request.headers.get("Upstash-Workflow-Callback")) {
-      const callbackMessage = JSON.parse(requestPayload);
+      let callbackPayload;
+      if (requestPayload) {
+        callbackPayload = requestPayload;
+      } else {
+        const workflowRunId2 = request.headers.get("upstash-workflow-runid");
+        const messageId = request.headers.get("upstash-message-id");
+        if (!workflowRunId2)
+          throw new WorkflowError("workflow run id missing in context.call lazy fetch.");
+        if (!messageId) throw new WorkflowError("message id missing in context.call lazy fetch.");
+        const steps = await getSteps(client.http, workflowRunId2, messageId, debug);
+        const failingStep = steps.find((step) => step.messageId === messageId);
+        if (!failingStep)
+          throw new WorkflowError(
+            "Failed to submit the context.call." + (steps.length === 0 ? "No steps found." : `No step was found with matching messageId ${messageId} out of ${steps.length} steps.`)
+          );
+        callbackPayload = atob(failingStep.body);
+      }
+      const callbackMessage = JSON.parse(callbackPayload);
       if (!(callbackMessage.status >= 200 && callbackMessage.status < 300) && callbackMessage.maxRetries && callbackMessage.retried !== callbackMessage.maxRetries) {
         await debug?.log("WARN", "SUBMIT_THIRD_PARTY_RESULT", {
           status: callbackMessage.status,
-          body: atob(callbackMessage.body)
+          body: atob(callbackMessage.body ?? "")
         });
         console.warn(
           `Workflow Warning: "context.call" failed with status ${callbackMessage.status} and will retry (retried ${callbackMessage.retried ?? 0} out of ${callbackMessage.maxRetries} times). Error Message:
-${atob(callbackMessage.body)}`
+${atob(callbackMessage.body ?? "")}`
         );
         return ok("call-will-retry");
       }
@@ -809,7 +911,7 @@ ${atob(callbackMessage.body)}`
       );
       const callResponse = {
         status: callbackMessage.status,
-        body: atob(callbackMessage.body),
+        body: atob(callbackMessage.body ?? ""),
         header: callbackMessage.header
       };
       const callResultStep = {
@@ -840,9 +942,7 @@ ${atob(callbackMessage.body)}`
   } catch (error) {
     const isCallReturn = request.headers.get("Upstash-Workflow-Callback");
     return err(
-      new QStashWorkflowError(
-        `Error when handling call return (isCallReturn=${isCallReturn}): ${error}`
-      )
+      new WorkflowError(`Error when handling call return (isCallReturn=${isCallReturn}): ${error}`)
     );
   }
 };
@@ -850,7 +950,8 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
   const baseHeaders = {
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
-    [WORKFLOW_URL_HEADER]: workflowUrl
+    [WORKFLOW_URL_HEADER]: workflowUrl,
+    [WORKFLOW_FEATURE_HEADER]: "LazyFetch,InitialBody"
   };
   if (!step?.callUrl) {
     baseHeaders[`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`] = WORKFLOW_PROTOCOL_VERSION;
@@ -863,8 +964,8 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
   }
   if (step?.callUrl) {
     baseHeaders["Upstash-Retries"] = callRetries?.toString() ?? "0";
-    baseHeaders[WORKFLOW_FEATURE_HEADER] = "WF_NoDelete";
-    if (retries) {
+    baseHeaders[WORKFLOW_FEATURE_HEADER] = "WF_NoDelete,InitialBody";
+    if (retries !== void 0) {
       baseHeaders["Upstash-Callback-Retries"] = retries.toString();
       baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
     }
@@ -899,6 +1000,7 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
         "Upstash-Callback-Workflow-CallType": "fromCallback",
         "Upstash-Callback-Workflow-Init": "false",
         "Upstash-Callback-Workflow-Url": workflowUrl,
+        "Upstash-Callback-Feature-Set": "LazyFetch,InitialBody",
         "Upstash-Callback-Forward-Upstash-Workflow-Callback": "true",
         "Upstash-Callback-Forward-Upstash-Workflow-StepId": step.stepId.toString(),
         "Upstash-Callback-Forward-Upstash-Workflow-StepName": step.stepName,
@@ -947,7 +1049,7 @@ var verifyRequest = async (body, signature, verifier) => {
       throw new Error("Signature in `Upstash-Signature` header is not valid");
     }
   } catch (error) {
-    throw new QStashWorkflowError(
+    throw new WorkflowError(
       `Failed to verify that the Workflow request comes from QStash: ${error}
 
 If signature is missing, trigger the workflow endpoint by publishing your request to QStash instead of calling it directly.
@@ -987,14 +1089,14 @@ var AutoExecutor = class _AutoExecutor {
    *
    * If a function is already executing (this.executingStep), this
    * means that there is a nested step which is not allowed. In this
-   * case, addStep throws QStashWorkflowError.
+   * case, addStep throws WorkflowError.
    *
    * @param stepInfo step plan to add
    * @returns result of the step function
    */
   async addStep(stepInfo) {
     if (this.executingStep) {
-      throw new QStashWorkflowError(
+      throw new WorkflowError(
         `A step can not be run inside another step. Tried to run '${stepInfo.stepName}' inside '${this.executingStep}'`
       );
     }
@@ -1079,7 +1181,7 @@ var AutoExecutor = class _AutoExecutor {
     const sortedSteps = sortSteps(this.steps);
     const plannedParallelStepCount = sortedSteps[initialStepCount + this.planStepCount]?.concurrent;
     if (parallelCallState !== "first" && plannedParallelStepCount !== parallelSteps.length) {
-      throw new QStashWorkflowError(
+      throw new WorkflowError(
         `Incompatible number of parallel steps when call state was '${parallelCallState}'. Expected ${parallelSteps.length}, got ${plannedParallelStepCount} from the request.`
       );
     }
@@ -1101,7 +1203,7 @@ var AutoExecutor = class _AutoExecutor {
       case "partial": {
         const planStep = this.steps.at(-1);
         if (!planStep || planStep.targetStep === void 0) {
-          throw new QStashWorkflowError(
+          throw new WorkflowError(
             `There must be a last step and it should have targetStep larger than 0.Received: ${JSON.stringify(planStep)}`
           );
         }
@@ -1115,17 +1217,17 @@ var AutoExecutor = class _AutoExecutor {
           );
           await this.submitStepsToQStash([resultStep], [parallelStep]);
         } catch (error) {
-          if (error instanceof QStashWorkflowAbort) {
+          if (error instanceof WorkflowAbort) {
             throw error;
           }
-          throw new QStashWorkflowError(
+          throw new WorkflowError(
             `Error submitting steps to QStash in partial parallel step execution: ${error}`
           );
         }
         break;
       }
       case "discard": {
-        throw new QStashWorkflowAbort("discarded parallel");
+        throw new WorkflowAbort("discarded parallel");
       }
       case "last": {
         const parallelResultSteps = sortedSteps.filter((step) => step.stepId >= initialStepCount).slice(0, parallelSteps.length);
@@ -1176,7 +1278,7 @@ var AutoExecutor = class _AutoExecutor {
    */
   async submitStepsToQStash(steps, lazySteps) {
     if (steps.length === 0) {
-      throw new QStashWorkflowError(
+      throw new WorkflowError(
         `Unable to submit steps to QStash. Provided list is empty. Current step: ${this.stepCount}`
       );
     }
@@ -1216,7 +1318,7 @@ var AutoExecutor = class _AutoExecutor {
         method: "POST",
         parseResponseAsJson: false
       });
-      throw new QStashWorkflowAbort(steps[0].stepName, steps[0]);
+      throw new WorkflowAbort(steps[0].stepName, steps[0]);
     }
     const result = await this.context.qstashClient.batchJSON(
       steps.map((singleStep, index) => {
@@ -1268,7 +1370,7 @@ var AutoExecutor = class _AutoExecutor {
         };
       })
     });
-    throw new QStashWorkflowAbort(steps[0].stepName, steps[0]);
+    throw new WorkflowAbort(steps[0].stepName, steps[0]);
   }
   /**
    * Get the promise by executing the lazt steps list. If there is a single
@@ -1293,7 +1395,7 @@ var AutoExecutor = class _AutoExecutor {
     } else if (Array.isArray(result) && lazyStepList.length === result.length && index < lazyStepList.length) {
       return result[index];
     } else {
-      throw new QStashWorkflowError(
+      throw new WorkflowError(
         `Unexpected parallel call result while executing step ${index}: '${result}'. Expected ${lazyStepList.length} many items`
       );
     }
@@ -1305,12 +1407,12 @@ var AutoExecutor = class _AutoExecutor {
 };
 var validateStep = (lazyStep, stepFromRequest) => {
   if (lazyStep.stepName !== stepFromRequest.stepName) {
-    throw new QStashWorkflowError(
+    throw new WorkflowError(
       `Incompatible step name. Expected '${lazyStep.stepName}', got '${stepFromRequest.stepName}' from the request`
     );
   }
   if (lazyStep.stepType !== stepFromRequest.stepType) {
-    throw new QStashWorkflowError(
+    throw new WorkflowError(
       `Incompatible step type. Expected '${lazyStep.stepType}', got '${stepFromRequest.stepType}' from the request`
     );
   }
@@ -1321,12 +1423,12 @@ var validateParallelSteps = (lazySteps, stepsFromRequest) => {
       validateStep(lazySteps[index], stepFromRequest);
     }
   } catch (error) {
-    if (error instanceof QStashWorkflowError) {
+    if (error instanceof WorkflowError) {
       const lazyStepNames = lazySteps.map((lazyStep) => lazyStep.stepName);
       const lazyStepTypes = lazySteps.map((lazyStep) => lazyStep.stepType);
       const requestStepNames = stepsFromRequest.map((step) => step.stepName);
       const requestStepTypes = stepsFromRequest.map((step) => step.stepType);
-      throw new QStashWorkflowError(
+      throw new WorkflowError(
         `Incompatible steps detected in parallel execution: ${error.message}
   > Step Names from the request: ${JSON.stringify(requestStepNames)}
     Step Types from the request: ${JSON.stringify(requestStepTypes)}
@@ -1439,10 +1541,6 @@ var WorkflowContext = class {
    * headers of the initial request
    */
   headers;
-  /**
-   * initial payload as a raw string
-   */
-  rawInitialPayload;
   /**
    * Map of environment variables and their values.
    *
@@ -1477,7 +1575,6 @@ var WorkflowContext = class {
     failureUrl,
     debug,
     initialPayload,
-    rawInitialPayload,
     env,
     retries
   }) {
@@ -1488,7 +1585,6 @@ var WorkflowContext = class {
     this.failureUrl = failureUrl;
     this.headers = headers;
     this.requestPayload = initialPayload;
-    this.rawInitialPayload = rawInitialPayload ?? JSON.stringify(this.requestPayload);
     this.env = env ?? {};
     this.retries = retries ?? DEFAULT_RETRIES;
     this.executor = new AutoExecutor(this, this.steps, debug);
@@ -1509,7 +1605,7 @@ var WorkflowContext = class {
    * const [result1, result2] = await Promise.all([
    *   context.run("step 1", () => {
    *     return "result1"
-   *   })
+   *   }),
    *   context.run("step 2", async () => {
    *     return await fetchResults()
    *   })
@@ -1527,6 +1623,10 @@ var WorkflowContext = class {
   /**
    * Stops the execution for the duration provided.
    *
+   * ```typescript
+   * await context.sleep('sleep1', 3) // wait for three seconds
+   * ```
+   *
    * @param stepName
    * @param duration sleep duration in seconds
    * @returns undefined
@@ -1537,6 +1637,10 @@ var WorkflowContext = class {
   /**
    * Stops the execution until the date time provided.
    *
+   * ```typescript
+   * await context.sleepUntil('sleep1', Date.now() / 1000 + 3) // wait for three seconds
+   * ```
+   *
    * @param stepName
    * @param datetime time to sleep until. Can be provided as a number (in unix seconds),
    *   as a Date object or a string (passed to `new Date(datetimeString)`)
@@ -1560,7 +1664,7 @@ var WorkflowContext = class {
    * const { status, body } = await context.call<string>(
    *   "post call step",
    *   {
-   *     url: `https://www.some-endpoint.com/api`,
+   *     url: "https://www.some-endpoint.com/api",
    *     method: "POST",
    *     body: "my-payload"
    *   }
@@ -1614,45 +1718,43 @@ var WorkflowContext = class {
     }
   }
   /**
-   * Makes the workflow run wait until a notify request is sent or until the
-   * timeout ends
+   * Pauses workflow execution until a specific event occurs or a timeout is reached.
    *
-   * ```ts
-   * const { eventData, timeout } = await context.waitForEvent(
-   *   "wait for event step",
-   *   "my-event-id",
-   *   100 // timeout after 100 seconds
-   * );
-   * ```
+   *```ts
+   * const result = await workflow.waitForEvent("payment-confirmed", {
+   *   timeout: "5m"
+   * });
+   *```
    *
-   * To notify a waiting workflow run, you can use the notify method:
+   * To notify a waiting workflow:
    *
    * ```ts
    * import { Client } from "@upstash/workflow";
    *
-   * const client = new Client({ token: });
+   * const client = new Client({ token: "<QSTASH_TOKEN>" });
    *
    * await client.notify({
-   *   eventId: "my-event-id",
-   *   eventData: "eventData"
+   *   eventId: "payment.confirmed",
+   *   data: {
+   *     amount: 99.99,
+   *     currency: "USD"
+   *   }
    * })
    * ```
    *
+   * Alternatively, you can use the `context.notify` method.
+   *
    * @param stepName
-   * @param eventId event id to wake up the waiting workflow run
-   * @param timeout timeout duration in seconds
-   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
-   *   timeout is true if the wait times out, if notified it is false. eventData
-   *   is the value passed to `client.notify`.
+   * @param eventId - Unique identifier for the event to wait for
+   * @param options - Configuration options.
+   * @returns `{ timeout: boolean, eventData: unknown }`.
+   *   The `timeout` property specifies if the workflow has timed out. The `eventData`
+   *   is the data passed when notifying this workflow of an event.
    */
-  async waitForEvent(stepName, eventId, timeout) {
-    const result = await this.addStep(
-      new LazyWaitForEventStep(
-        stepName,
-        eventId,
-        typeof timeout === "string" ? timeout : `${timeout}s`
-      )
-    );
+  async waitForEvent(stepName, eventId, options = {}) {
+    const { timeout = "7d" } = options;
+    const timeoutStr = typeof timeout === "string" ? timeout : `${timeout}s`;
+    const result = await this.addStep(new LazyWaitForEventStep(stepName, eventId, timeoutStr));
     try {
       return {
         ...result,
@@ -1662,6 +1764,27 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Notify workflow runs waiting for an event
+   *
+   * ```ts
+   * const { eventId, eventData, notifyResponse } = await context.notify(
+   *   "notify step", "event-id", "event-data"
+   * );
+   * ```
+   *
+   * Upon `context.notify`, the workflow runs waiting for the given eventId (context.waitForEvent)
+   * will receive the given event data and resume execution.
+   *
+   * The response includes the same eventId and eventData. Additionally, there is
+   * a notifyResponse field which contains a list of `Waiter` objects, each corresponding
+   * to a notified workflow run.
+   *
+   * @param stepName
+   * @param eventId event id to notify
+   * @param eventData event data to notify with
+   * @returns notify response which has event id, event data and list of waiters which were notified
+   */
   async notify(stepName, eventId, eventData) {
     const result = await this.addStep(
       new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
@@ -1675,6 +1798,15 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Cancel the current workflow run
+   *
+   * Will throw WorkflowAbort to stop workflow execution.
+   * Shouldn't be inside try/catch.
+   */
+  async cancel() {
+    throw new WorkflowAbort("cancel", void 0, true);
+  }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
    * DisabledWorkflowContext.
@@ -1715,7 +1847,8 @@ var WorkflowLogger = class _WorkflowLogger {
   }
   writeToConsole(logEntry) {
     const JSON_SPACING = 2;
-    console.log(JSON.stringify(logEntry, void 0, JSON_SPACING));
+    const logMethod = logEntry.logLevel === "ERROR" ? console.error : logEntry.logLevel === "WARN" ? console.warn : console.log;
+    logMethod(JSON.stringify(logEntry, void 0, JSON_SPACING));
   }
   shouldLog(level) {
     return LOG_LEVELS.indexOf(level) >= LOG_LEVELS.indexOf(this.options.logLevel);
@@ -1733,11 +1866,13 @@ var WorkflowLogger = class _WorkflowLogger {
 };
 
 // src/utils.ts
-var import_node_crypto = __toESM(require("crypto"));
 var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
 var NANOID_LENGTH = 21;
+function getRandomInt() {
+  return Math.floor(Math.random() * NANOID_CHARS.length);
+}
 function nanoid() {
-  return [...import_node_crypto.default.getRandomValues(new Uint8Array(NANOID_LENGTH))].map((x) => NANOID_CHARS[x % NANOID_CHARS.length]).join("");
+  return Array.from({ length: NANOID_LENGTH }).map(() => NANOID_CHARS[getRandomInt()]).join("");
 }
 function getWorkflowRunId(id) {
   return `wfr_${id ?? nanoid()}`;
@@ -1755,6 +1890,63 @@ function decodeBase64(base64) {
   }
 }
 
+// src/serve/authorization.ts
+var import_qstash3 = require("@upstash/qstash");
+var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
+  static disabledMessage = "disabled-qstash-worklfow-run";
+  /**
+   * overwrite the WorkflowContext.addStep method to always raise WorkflowAbort
+   * error in order to stop the execution whenever we encounter a step.
+   *
+   * @param _step
+   */
+  async addStep(_step) {
+    throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
+  }
+  /**
+   * overwrite cancel method to do nothing
+   */
+  async cancel() {
+    return;
+  }
+  /**
+   * copies the passed context to create a DisabledWorkflowContext. Then, runs the
+   * route function with the new context.
+   *
+   * - returns "run-ended" if there are no steps found or
+   *      if the auth failed and user called `return`
+   * - returns "step-found" if DisabledWorkflowContext.addStep is called.
+   * - if there is another error, returns the error.
+   *
+   * @param routeFunction
+   */
+  static async tryAuthentication(routeFunction, context) {
+    const disabledContext = new _DisabledWorkflowContext({
+      qstashClient: new import_qstash3.Client({
+        baseUrl: "disabled-client",
+        token: "disabled-client"
+      }),
+      workflowRunId: context.workflowRunId,
+      headers: context.headers,
+      steps: [],
+      url: context.url,
+      failureUrl: context.failureUrl,
+      initialPayload: context.requestPayload,
+      env: context.env,
+      retries: context.retries
+    });
+    try {
+      await routeFunction(disabledContext);
+    } catch (error) {
+      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage) {
+        return ok("step-found");
+      }
+      return err(error);
+    }
+    return ok("run-ended");
+  }
+};
+
 // src/workflow-parser.ts
 var getPayload = async (request) => {
   try {
@@ -1763,8 +1955,8 @@ var getPayload = async (request) => {
     return;
   }
 };
-var parsePayload = async (rawPayload, debug) => {
-  const [encodedInitialPayload, ...encodedSteps] = JSON.parse(rawPayload);
+var processRawSteps = (rawSteps) => {
+  const [encodedInitialPayload, ...encodedSteps] = rawSteps;
   const rawInitialPayload = decodeBase64(encodedInitialPayload.body);
   const initialStep = {
     stepId: 0,
@@ -1774,27 +1966,21 @@ var parsePayload = async (rawPayload, debug) => {
     concurrent: NO_CONCURRENCY
   };
   const stepsToDecode = encodedSteps.filter((step) => step.callType === "step");
-  const otherSteps = await Promise.all(
-    stepsToDecode.map(async (rawStep) => {
-      const step = JSON.parse(decodeBase64(rawStep.body));
-      try {
-        step.out = JSON.parse(step.out);
-      } catch {
-        await debug?.log("WARN", "ENDPOINT_START", {
-          message: "failed while parsing out field of step",
-          step
-        });
-      }
-      if (step.waitEventId) {
-        const newOut = {
-          eventData: step.out ? decodeBase64(step.out) : void 0,
-          timeout: step.waitTimeout ?? false
-        };
-        step.out = newOut;
-      }
-      return step;
-    })
-  );
+  const otherSteps = stepsToDecode.map((rawStep) => {
+    const step = JSON.parse(decodeBase64(rawStep.body));
+    try {
+      step.out = JSON.parse(step.out);
+    } catch {
+    }
+    if (step.waitEventId) {
+      const newOut = {
+        eventData: step.out ? decodeBase64(step.out) : void 0,
+        timeout: step.waitTimeout ?? false
+      };
+      step.out = newOut;
+    }
+    return step;
+  });
   const steps = [initialStep, ...otherSteps];
   return {
     rawInitialPayload,
@@ -1842,20 +2028,20 @@ var validateRequest = (request) => {
   const versionHeader = request.headers.get(WORKFLOW_PROTOCOL_VERSION_HEADER);
   const isFirstInvocation = !versionHeader;
   if (!isFirstInvocation && versionHeader !== WORKFLOW_PROTOCOL_VERSION) {
-    throw new QStashWorkflowError(
+    throw new WorkflowError(
       `Incompatible workflow sdk protocol version. Expected ${WORKFLOW_PROTOCOL_VERSION}, got ${versionHeader} from the request.`
     );
   }
   const workflowRunId = isFirstInvocation ? getWorkflowRunId() : request.headers.get(WORKFLOW_ID_HEADER) ?? "";
   if (workflowRunId.length === 0) {
-    throw new QStashWorkflowError("Couldn't get workflow id from header");
+    throw new WorkflowError("Couldn't get workflow id from header");
   }
   return {
     isFirstInvocation,
     workflowRunId
   };
 };
-var parseRequest = async (requestPayload, isFirstInvocation, debug) => {
+var parseRequest = async (requestPayload, isFirstInvocation, workflowRunId, requester, messageId, debug) => {
   if (isFirstInvocation) {
     return {
       rawInitialPayload: requestPayload ?? "",
@@ -1863,10 +2049,18 @@ var parseRequest = async (requestPayload, isFirstInvocation, debug) => {
       isLastDuplicate: false
     };
   } else {
+    let rawSteps;
     if (!requestPayload) {
-      throw new QStashWorkflowError("Only first call can have an empty body");
+      await debug?.log(
+        "INFO",
+        "ENDPOINT_START",
+        "request payload is empty, steps will be fetched from QStash."
+      );
+      rawSteps = await getSteps(requester, workflowRunId, messageId, debug);
+    } else {
+      rawSteps = JSON.parse(requestPayload);
     }
-    const { rawInitialPayload, steps } = await parsePayload(requestPayload, debug);
+    const { rawInitialPayload, steps } = processRawSteps(rawSteps);
     const isLastDuplicate = await checkIfLastOneIsDuplicate(steps, debug);
     const deduplicatedSteps = deduplicateSteps(steps);
     return {
@@ -1876,13 +2070,13 @@ var parseRequest = async (requestPayload, isFirstInvocation, debug) => {
     };
   }
 };
-var handleFailure = async (request, requestPayload, qstashClient, initialPayloadParser, failureFunction, debug) => {
+var handleFailure = async (request, requestPayload, qstashClient, initialPayloadParser, routeFunction, failureFunction, debug) => {
   if (request.headers.get(WORKFLOW_FAILURE_HEADER) !== "true") {
     return ok("not-failure-callback");
   }
   if (!failureFunction) {
     return err(
-      new QStashWorkflowError(
+      new WorkflowError(
         "Workflow endpoint is called to handle a failure, but a failureFunction is not provided in serve options. Either provide a failureUrl or a failureFunction."
       )
     );
@@ -1893,92 +2087,48 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     );
     const decodedBody = body ? decodeBase64(body) : "{}";
     const errorPayload = JSON.parse(decodedBody);
-    const {
-      rawInitialPayload,
-      steps,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      isLastDuplicate: _isLastDuplicate
-    } = await parseRequest(decodeBase64(sourceBody), false, debug);
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
-      initialPayload: initialPayloadParser(rawInitialPayload),
-      rawInitialPayload,
+      initialPayload: initialPayloadParser(decodeBase64(sourceBody)),
       headers: recreateUserHeaders(new Headers(sourceHeader)),
-      steps,
+      steps: [],
       url,
       failureUrl: url,
       debug
     });
-    await failureFunction(workflowContext, status, errorPayload.message, header);
+    const authCheck = await DisabledWorkflowContext.tryAuthentication(
+      routeFunction,
+      workflowContext
+    );
+    if (authCheck.isErr()) {
+      await debug?.log("ERROR", "ERROR", { error: authCheck.error.message });
+      throw authCheck.error;
+    } else if (authCheck.value === "run-ended") {
+      return err(new WorkflowError("Not authorized to run the failure function."));
+    }
+    await failureFunction({
+      context: workflowContext,
+      failStatus: status,
+      failResponse: errorPayload.message,
+      failHeaders: header
+    });
   } catch (error) {
     return err(error);
   }
   return ok("is-failure-callback");
 };
 
-// src/serve/authorization.ts
-var import_qstash2 = require("@upstash/qstash");
-var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
-  static disabledMessage = "disabled-qstash-worklfow-run";
-  /**
-   * overwrite the WorkflowContext.addStep method to always raise QStashWorkflowAbort
-   * error in order to stop the execution whenever we encounter a step.
-   *
-   * @param _step
-   */
-  async addStep(_step) {
-    throw new QStashWorkflowAbort(_DisabledWorkflowContext.disabledMessage);
-  }
-  /**
-   * copies the passed context to create a DisabledWorkflowContext. Then, runs the
-   * route function with the new context.
-   *
-   * - returns "run-ended" if there are no steps found or
-   *      if the auth failed and user called `return`
-   * - returns "step-found" if DisabledWorkflowContext.addStep is called.
-   * - if there is another error, returns the error.
-   *
-   * @param routeFunction
-   */
-  static async tryAuthentication(routeFunction, context) {
-    const disabledContext = new _DisabledWorkflowContext({
-      qstashClient: new import_qstash2.Client({
-        baseUrl: "disabled-client",
-        token: "disabled-client"
-      }),
-      workflowRunId: context.workflowRunId,
-      headers: context.headers,
-      steps: [],
-      url: context.url,
-      failureUrl: context.failureUrl,
-      initialPayload: context.requestPayload,
-      rawInitialPayload: context.rawInitialPayload,
-      env: context.env,
-      retries: context.retries
-    });
-    try {
-      await routeFunction(disabledContext);
-    } catch (error) {
-      if (error instanceof QStashWorkflowAbort && error.stepName === this.disabledMessage) {
-        return ok("step-found");
-      }
-      return err(error);
-    }
-    return ok("run-ended");
-  }
-};
-
 // src/serve/options.ts
-var import_qstash3 = require("@upstash/qstash");
 var import_qstash4 = require("@upstash/qstash");
+var import_qstash5 = require("@upstash/qstash");
 var processOptions = (options) => {
   const environment = options?.env ?? (typeof process === "undefined" ? {} : process.env);
   const receiverEnvironmentVariablesSet = Boolean(
     environment.QSTASH_CURRENT_SIGNING_KEY && environment.QSTASH_NEXT_SIGNING_KEY
   );
   return {
-    qstashClient: new import_qstash4.Client({
+    qstashClient: new import_qstash5.Client({
       baseUrl: environment.QSTASH_URL,
       token: environment.QSTASH_TOKEN
     }),
@@ -1999,7 +2149,7 @@ var processOptions = (options) => {
         throw error;
       }
     },
-    receiver: receiverEnvironmentVariablesSet ? new import_qstash3.Receiver({
+    receiver: receiverEnvironmentVariablesSet ? new import_qstash4.Receiver({
       currentSigningKey: environment.QSTASH_CURRENT_SIGNING_KEY,
       nextSigningKey: environment.QSTASH_NEXT_SIGNING_KEY
     }) : void 0,
@@ -2061,6 +2211,9 @@ var serve = (routeFunction, options) => {
     const { rawInitialPayload, steps, isLastDuplicate } = await parseRequest(
       requestPayload,
       isFirstInvocation,
+      workflowRunId,
+      qstashClient.http,
+      request.headers.get("upstash-message-id"),
       debug
     );
     if (isLastDuplicate) {
@@ -2071,6 +2224,7 @@ var serve = (routeFunction, options) => {
       requestPayload,
       qstashClient,
       initialPayloadParser,
+      routeFunction,
       failureFunction
     );
     if (failureCheck.isErr()) {
@@ -2083,7 +2237,6 @@ var serve = (routeFunction, options) => {
       qstashClient,
       workflowRunId,
       initialPayload: initialPayloadParser(rawInitialPayload),
-      rawInitialPayload,
       headers: recreateUserHeaders(request.headers),
       steps,
       url: workflowUrl,
@@ -2121,7 +2274,11 @@ var serve = (routeFunction, options) => {
         onStep: async () => routeFunction(workflowContext),
         onCleanup: async () => {
           await triggerWorkflowDelete(workflowContext, debug);
-        }
+        },
+        onCancel: async () => {
+          await makeCancelRequest(workflowContext.qstashClient.http, workflowRunId);
+        },
+        debug
       });
       if (result.isErr()) {
         await debug?.log("ERROR", "ERROR", { error: result.error.message });
@@ -2147,35 +2304,93 @@ var serve = (routeFunction, options) => {
 };
 
 // src/client/index.ts
-var import_qstash5 = require("@upstash/qstash");
+var import_qstash6 = require("@upstash/qstash");
 var Client3 = class {
   client;
   constructor(clientConfig) {
     if (!clientConfig.token) {
-      console.warn("[Upstash Workflow] url or the token is not set. client will not work.");
+      console.error(
+        "QStash token is required for Upstash Workflow!\n\nTo fix this:\n1. Get your token from the Upstash Console (https://console.upstash.com/qstash)\n2. Initialize the workflow client with:\n\n   const client = new Client({\n     token: '<YOUR_QSTASH_TOKEN>'\n   });"
+      );
     }
-    this.client = new import_qstash5.Client(clientConfig);
+    this.client = new import_qstash6.Client(clientConfig);
   }
   /**
    * Cancel an ongoing workflow
    *
+   * Returns true if workflow is canceled succesfully. Otherwise, throws error.
+   *
+   * There are multiple ways you can cancel workflows:
+   * - pass one or more workflow run ids to cancel them
+   * - pass a workflow url to cancel all runs starting with this url
+   * - cancel all pending or active workflow runs
+   *
+   * ### Cancel a set of workflow runs
+   *
    * ```ts
-   * import { Client } from "@upstash/workflow";
+   * // cancel a single workflow
+   * await client.cancel({ ids: "<WORKFLOW_RUN_ID>" })
    *
-   * const client = new Client({ token: "<QSTASH_TOKEN>" })
-   * await client.cancel({ workflowRunId: "<WORKFLOW_RUN_ID>" })
+   * // cancel a set of workflow runs
+   * await client.cancel({ ids: [
+   *   "<WORKFLOW_RUN_ID_1>",
+   *   "<WORKFLOW_RUN_ID_2>",
+   * ]})
+   * ```
+   *
+   * ### Cancel workflows starting with a url
+   *
+   * If you have an endpoint called `https://your-endpoint.com` and you
+   * want to cancel all workflow runs on it, you can use `urlStartingWith`.
+   *
+   * Note that this will cancel workflows in all endpoints under
+   * `https://your-endpoint.com`.
+   *
+   * ```ts
+   * await client.cancel({ urlStartingWith: "https://your-endpoint.com" })
    * ```
    *
-   * @param workflowRunId run id of the workflow to delete
+   * ### Cancel *all* workflows
+   *
+   * To cancel all pending and currently running workflows, you can
+   * do it like this:
+   *
+   * ```ts
+   * await client.cancel({ all: true })
+   * ```
+   *
+   * @param ids run id of the workflow to delete
+   * @param urlStartingWith cancel workflows starting with this url. Will be ignored
+   *   if `ids` parameter is set.
+   * @param all set to true in order to cancel all workflows. Will be ignored
+   *   if `ids` or `urlStartingWith` parameters are set.
    * @returns true if workflow is succesfully deleted. Otherwise throws QStashError
    */
-  async cancel({ workflowRunId }) {
+  async cancel({
+    ids,
+    urlStartingWith,
+    all
+  }) {
+    let body;
+    if (ids) {
+      const runIdArray = typeof ids === "string" ? [ids] : ids;
+      body = JSON.stringify({ workflowRunIds: runIdArray });
+    } else if (urlStartingWith) {
+      body = JSON.stringify({ workflowUrl: urlStartingWith });
+    } else if (all) {
+      body = "{}";
+    } else {
+      throw new TypeError("The `cancel` method cannot be called without any options.");
+    }
     const result = await this.client.http.request({
-      path: ["v2", "workflows", "runs", `${workflowRunId}?cancel=true`],
+      path: ["v2", "workflows", "runs"],
       method: "DELETE",
-      parseResponseAsJson: false
+      body,
+      headers: {
+        "Content-Type": "application/json"
+      }
     });
-    return result ?? true;
+    return result;
   }
   /**
    * Notify a workflow run waiting for an event
@@ -2220,13 +2435,13 @@ var Client3 = class {
    * Trigger new workflow run and returns the workflow run id
    *
    * ```ts
-   * const { workflowRunId } await client.trigger({
+   * const { workflowRunId } = await client.trigger({
    *   url: "https://workflow-endpoint.com",
-   *   body: "hello there!", // optional body
-   *   headers: { ... }, // optional headers
-   *   workflowRunId: "my-workflow", // optional workflow run id
-   *   retries: 3 // optional retries in the initial request
-   * })
+   *   body: "hello there!",         // Optional body
+   *   headers: { ... },             // Optional headers
+   *   workflowRunId: "my-workflow", // Optional workflow run ID
+   *   retries: 3                    // Optional retries for the initial request
+   * });
    *
    * console.log(workflowRunId)
    * // wfr_my-workflow
@@ -2272,10 +2487,10 @@ var Client3 = class {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Client,
-  QStashWorkflowAbort,
-  QStashWorkflowError,
   StepTypes,
+  WorkflowAbort,
   WorkflowContext,
+  WorkflowError,
   WorkflowLogger,
   serve
 });