@upstash/workflow 0.2.0 → 0.2.2

package/index.js

@@ -20,7 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  Client: () => Client3,
+  Client: () => Client4,
   StepTypes: () => StepTypes,
   WorkflowAbort: () => WorkflowAbort,
   WorkflowContext: () => WorkflowContext,
@@ -30,48 +30,8 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// 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 formatWorkflowError = (error) => {
-  return error instanceof Error ? {
-    error: error.name,
-    message: error.message
-  } : {
-    error: "Error",
-    message: "An error occured while executing workflow."
-  };
-};
-
 // 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],
@@ -105,32 +65,82 @@ var getSteps = async (requester, workflowRunId, messageId, debug) => {
       await debug?.log("INFO", "ENDPOINT_START", {
         message: `Pulled ${steps.length} steps from QStashand returned them without filtering with messageId.`
       });
-      return steps;
+      return { steps, workflowRunEnded: false };
     } else {
       const index = steps.findIndex((item) => item.messageId === messageId);
       if (index === -1) {
-        return [];
+        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 filteredSteps;
+      return { steps: filteredSteps, workflowRunEnded: false };
     }
   } catch (error) {
-    await debug?.log("ERROR", "ERROR", {
-      message: "failed while fetching steps.",
-      error
-    });
-    throw new WorkflowError(`Failed while pulling steps. ${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;
+    }
   }
 };
 
+// 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 formatWorkflowError = (error) => {
+  return error instanceof Error ? {
+    error: error.name,
+    message: error.message
+  } : {
+    error: "Error",
+    message: "An error occured while executing workflow."
+  };
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
   // will be set in the subclasses
   constructor(stepName) {
+    if (!stepName) {
+      throw new WorkflowError(
+        "A workflow step name cannot be undefined or an empty string. Please provide a name for your workflow step."
+      );
+    }
     this.stepName = stepName;
   }
 };
@@ -223,15 +233,17 @@ var LazyCallStep = class extends BaseLazyStep {
   method;
   body;
   headers;
-  stepType = "Call";
   retries;
-  constructor(stepName, url, method, body, headers, retries) {
+  timeout;
+  stepType = "Call";
+  constructor(stepName, url, method, body, headers, retries, timeout) {
     super(stepName);
     this.url = url;
     this.method = method;
     this.body = body;
     this.headers = headers;
     this.retries = retries;
+    this.timeout = timeout;
   }
   getPlanStep(concurrent, targetStep) {
     return {
@@ -739,8 +751,8 @@ var StepTypes = [
 ];
 
 // src/workflow-requests.ts
-var import_qstash2 = require("@upstash/qstash");
-var triggerFirstInvocation = async (workflowContext, retries, debug) => {
+var import_qstash3 = require("@upstash/qstash");
+var triggerFirstInvocation = async (workflowContext, retries, useJSONContent, debug) => {
   const { headers } = getHeaders(
     "true",
     workflowContext.workflowRunId,
@@ -750,6 +762,9 @@ var triggerFirstInvocation = async (workflowContext, retries, debug) => {
     workflowContext.failureUrl,
     retries
   );
+  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({
@@ -793,7 +808,7 @@ var triggerRouteFunction = async ({
     return ok("workflow-finished");
   } catch (error) {
     const error_ = error;
-    if (error instanceof import_qstash2.QstashError && error.status === 400) {
+    if (error instanceof 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,
@@ -827,7 +842,7 @@ var triggerWorkflowDelete = async (workflowContext, debug, cancel = false) => {
     );
     return { deleted: true };
   } catch (error) {
-    if (error instanceof import_qstash2.QstashError && error.status === 404) {
+    if (error instanceof import_qstash3.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,
@@ -843,7 +858,10 @@ var recreateUserHeaders = (headers) => {
   const pairs = headers.entries();
   for (const [header, value] of pairs) {
     const headerLowerCase = header.toLowerCase();
-    if (!headerLowerCase.startsWith("upstash-workflow-") && !headerLowerCase.startsWith("x-vercel-") && !headerLowerCase.startsWith("x-forwarded-") && headerLowerCase !== "cf-connecting-ip") {
+    if (!headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
+    !headerLowerCase.startsWith("x-vercel-") && !headerLowerCase.startsWith("x-forwarded-") && // https://blog.cloudflare.com/preventing-request-loops-using-cdn-loop/
+    headerLowerCase !== "cf-connecting-ip" && headerLowerCase !== "cdn-loop" && headerLowerCase !== "cf-ew-via" && headerLowerCase !== "cf-ray" && // For Render https://render.com
+    headerLowerCase !== "render-proxy-ttl") {
       filteredHeaders.append(header, value);
     }
   }
@@ -861,11 +879,19 @@ var handleThirdPartyCallResult = async (request, requestPayload, client, workflo
         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 { steps, workflowRunEnded } = await getSteps(
+          client.http,
+          workflowRunId2,
+          messageId,
+          debug
+        );
+        if (workflowRunEnded) {
+          return ok("workflow-ended");
+        }
         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.`)
+            "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);
       }
@@ -946,7 +972,7 @@ ${atob(callbackMessage.body ?? "")}`
     );
   }
 };
-var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step, failureUrl, retries, callRetries) => {
+var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step, failureUrl, retries, callRetries, callTimeout) => {
   const baseHeaders = {
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
@@ -956,6 +982,9 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
   if (!step?.callUrl) {
     baseHeaders[`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`] = WORKFLOW_PROTOCOL_VERSION;
   }
+  if (callTimeout) {
+    baseHeaders[`Upstash-Timeout`] = callTimeout.toString();
+  }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
     if (!step?.callUrl) {
@@ -1331,7 +1360,8 @@ var AutoExecutor = class _AutoExecutor {
           singleStep,
           this.context.failureUrl,
           this.context.retries,
-          lazyStep instanceof LazyCallStep ? lazyStep.retries : void 0
+          lazyStep instanceof LazyCallStep ? lazyStep.retries : void 0,
+          lazyStep instanceof LazyCallStep ? lazyStep.timeout : void 0
         );
         const willWait = singleStep.concurrent === NO_CONCURRENCY || singleStep.stepId === 0;
         singleStep.out = JSON.stringify(singleStep.out);
@@ -1681,6 +1711,7 @@ var WorkflowContext = class {
    * @param body call body
    * @param headers call headers
    * @param retries number of call retries. 0 by default
+   * @param timeout max duration to wait for the endpoint to respond. in seconds.
    * @returns call result as {
    *     status: number;
    *     body: unknown;
@@ -1688,9 +1719,17 @@ var WorkflowContext = class {
    *   }
    */
   async call(stepName, settings) {
-    const { url, method = "GET", body, headers = {}, retries = 0 } = settings;
+    const { url, method = "GET", body, headers = {}, retries = 0, timeout } = settings;
     const result = await this.addStep(
-      new LazyCallStep(stepName, url, method, body, headers, retries)
+      new LazyCallStep(
+        stepName,
+        url,
+        method,
+        body,
+        headers,
+        retries,
+        timeout
+      )
     );
     if (typeof result === "string") {
       try {
@@ -1891,7 +1930,7 @@ function decodeBase64(base64) {
 }
 
 // src/serve/authorization.ts
-var import_qstash3 = require("@upstash/qstash");
+var import_qstash4 = require("@upstash/qstash");
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
   static disabledMessage = "disabled-qstash-worklfow-run";
   /**
@@ -1922,7 +1961,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
    */
   static async tryAuthentication(routeFunction, context) {
     const disabledContext = new _DisabledWorkflowContext({
-      qstashClient: new import_qstash3.Client({
+      qstashClient: new import_qstash4.Client({
         baseUrl: "disabled-client",
         token: "disabled-client"
       }),
@@ -2046,7 +2085,8 @@ var parseRequest = async (requestPayload, isFirstInvocation, workflowRunId, requ
     return {
       rawInitialPayload: requestPayload ?? "",
       steps: [],
-      isLastDuplicate: false
+      isLastDuplicate: false,
+      workflowRunEnded: false
     };
   } else {
     let rawSteps;
@@ -2056,7 +2096,21 @@ var parseRequest = async (requestPayload, isFirstInvocation, workflowRunId, requ
         "ENDPOINT_START",
         "request payload is empty, steps will be fetched from QStash."
       );
-      rawSteps = await getSteps(requester, workflowRunId, messageId, debug);
+      const { steps: fetchedSteps, workflowRunEnded } = await getSteps(
+        requester,
+        workflowRunId,
+        messageId,
+        debug
+      );
+      if (workflowRunEnded) {
+        return {
+          rawInitialPayload: void 0,
+          steps: void 0,
+          isLastDuplicate: void 0,
+          workflowRunEnded: true
+        };
+      }
+      rawSteps = fetchedSteps;
     } else {
       rawSteps = JSON.parse(requestPayload);
     }
@@ -2066,7 +2120,8 @@ var parseRequest = async (requestPayload, isFirstInvocation, workflowRunId, requ
     return {
       rawInitialPayload,
       steps: deduplicatedSteps,
-      isLastDuplicate
+      isLastDuplicate,
+      workflowRunEnded: false
     };
   }
 };
@@ -2090,7 +2145,7 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
-      initialPayload: initialPayloadParser(decodeBase64(sourceBody)),
+      initialPayload: sourceBody ? initialPayloadParser(decodeBase64(sourceBody)) : void 0,
       headers: recreateUserHeaders(new Headers(sourceHeader)),
       steps: [],
       url,
@@ -2120,22 +2175,35 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
 };
 
 // src/serve/options.ts
-var import_qstash4 = require("@upstash/qstash");
 var import_qstash5 = require("@upstash/qstash");
+var import_qstash6 = 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_qstash5.Client({
+    qstashClient: new import_qstash6.Client({
       baseUrl: environment.QSTASH_URL,
       token: environment.QSTASH_TOKEN
     }),
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    onStepFinish: (workflowRunId, _finishCondition) => new Response(JSON.stringify({ workflowRunId }), {
-      status: 200
-    }),
+    onStepFinish: (workflowRunId, finishCondition) => {
+      if (finishCondition === "auth-fail") {
+        console.error(AUTH_FAIL_MESSAGE);
+        return new Response(
+          JSON.stringify({
+            message: AUTH_FAIL_MESSAGE,
+            workflowRunId
+          }),
+          {
+            status: 400
+          }
+        );
+      }
+      return new Response(JSON.stringify({ workflowRunId }), {
+        status: 200
+      });
+    },
     initialPayloadParser: (initialRequest) => {
       if (!initialRequest) {
         return void 0;
@@ -2149,13 +2217,14 @@ var processOptions = (options) => {
         throw error;
       }
     },
-    receiver: receiverEnvironmentVariablesSet ? new import_qstash4.Receiver({
+    receiver: receiverEnvironmentVariablesSet ? new import_qstash5.Receiver({
       currentSigningKey: environment.QSTASH_CURRENT_SIGNING_KEY,
       nextSigningKey: environment.QSTASH_NEXT_SIGNING_KEY
     }) : void 0,
     baseUrl: environment.UPSTASH_WORKFLOW_URL,
     env: environment,
     retries: DEFAULT_RETRIES,
+    useJSONContent: false,
     ...options
   };
 };
@@ -2172,14 +2241,25 @@ var determineUrls = async (request, url, baseUrl, failureFunction, failureUrl, d
     });
   }
   const workflowFailureUrl = failureFunction ? workflowUrl : failureUrl;
+  if (workflowUrl.includes("localhost")) {
+    await debug?.log("WARN", "ENDPOINT_START", {
+      message: `Workflow URL contains localhost. This can happen in local development, but shouldn't happen in production unless you have a route which contains localhost. Received: ${workflowUrl}`
+    });
+  }
+  if (!(workflowUrl.startsWith("http://") || workflowUrl.startsWith("https://"))) {
+    throw new WorkflowError(
+      `Workflow URL should start with 'http://' or 'https://'. Recevied is '${workflowUrl}'`
+    );
+  }
   return {
     workflowUrl,
     workflowFailureUrl
   };
 };
+var AUTH_FAIL_MESSAGE = `Failed to authenticate Workflow request. If this is unexpected, see the caveat https://upstash.com/docs/workflow/basics/caveats#avoid-non-deterministic-code-outside-context-run`;
 
 // src/serve/index.ts
-var serve = (routeFunction, options) => {
+var serveBase = (routeFunction, options) => {
   const {
     qstashClient,
     onStepFinish,
@@ -2191,7 +2271,8 @@ var serve = (routeFunction, options) => {
     failureFunction,
     baseUrl,
     env,
-    retries
+    retries,
+    useJSONContent
   } = processOptions(options);
   const debug = WorkflowLogger.getLogger(verbose);
   const handler = async (request) => {
@@ -2208,7 +2289,7 @@ var serve = (routeFunction, options) => {
     await verifyRequest(requestPayload, request.headers.get("upstash-signature"), receiver);
     const { isFirstInvocation, workflowRunId } = validateRequest(request);
     debug?.setWorkflowRunId(workflowRunId);
-    const { rawInitialPayload, steps, isLastDuplicate } = await parseRequest(
+    const { rawInitialPayload, steps, isLastDuplicate, workflowRunEnded } = await parseRequest(
       requestPayload,
       isFirstInvocation,
       workflowRunId,
@@ -2216,8 +2297,11 @@ var serve = (routeFunction, options) => {
       request.headers.get("upstash-message-id"),
       debug
     );
+    if (workflowRunEnded) {
+      return onStepFinish(workflowRunId, "workflow-already-ended");
+    }
     if (isLastDuplicate) {
-      return onStepFinish("no-workflow-id", "duplicate-step");
+      return onStepFinish(workflowRunId, "duplicate-step");
     }
     const failureCheck = await handleFailure(
       request,
@@ -2231,7 +2315,7 @@ var serve = (routeFunction, options) => {
       throw failureCheck.error;
     } else if (failureCheck.value === "is-failure-callback") {
       await debug?.log("WARN", "RESPONSE_DEFAULT", "failureFunction executed");
-      return onStepFinish("no-workflow-id", "failure-callback");
+      return onStepFinish(workflowRunId, "failure-callback");
     }
     const workflowContext = new WorkflowContext({
       qstashClient,
@@ -2253,7 +2337,11 @@ var serve = (routeFunction, options) => {
       await debug?.log("ERROR", "ERROR", { error: authCheck.error.message });
       throw authCheck.error;
     } else if (authCheck.value === "run-ended") {
-      return onStepFinish("no-workflow-id", "auth-fail");
+      await debug?.log("ERROR", "ERROR", { error: AUTH_FAIL_MESSAGE });
+      return onStepFinish(
+        isFirstInvocation ? "no-workflow-id" : workflowContext.workflowRunId,
+        "auth-fail"
+      );
     }
     const callReturnCheck = await handleThirdPartyCallResult(
       request,
@@ -2270,7 +2358,7 @@ var serve = (routeFunction, options) => {
       });
       throw callReturnCheck.error;
     } else if (callReturnCheck.value === "continue-workflow") {
-      const result = isFirstInvocation ? await triggerFirstInvocation(workflowContext, retries, debug) : await triggerRouteFunction({
+      const result = isFirstInvocation ? await triggerFirstInvocation(workflowContext, retries, useJSONContent, debug) : await triggerRouteFunction({
         onStep: async () => routeFunction(workflowContext),
         onCleanup: async () => {
           await triggerWorkflowDelete(workflowContext, debug);
@@ -2286,6 +2374,8 @@ var serve = (routeFunction, options) => {
       }
       await debug?.log("INFO", "RESPONSE_WORKFLOW");
       return onStepFinish(workflowContext.workflowRunId, "success");
+    } else if (callReturnCheck.value === "workflow-ended") {
+      return onStepFinish(workflowContext.workflowRunId, "workflow-already-ended");
     }
     await debug?.log("INFO", "RESPONSE_DEFAULT");
     return onStepFinish("no-workflow-id", "fromCallback");
@@ -2302,10 +2392,13 @@ var serve = (routeFunction, options) => {
   };
   return { handler: safeHandler };
 };
+var serve = (routeFunction, options) => {
+  return serveBase(routeFunction, options);
+};
 
 // src/client/index.ts
-var import_qstash6 = require("@upstash/qstash");
-var Client3 = class {
+var import_qstash7 = require("@upstash/qstash");
+var Client4 = class {
   client;
   constructor(clientConfig) {
     if (!clientConfig.token) {
@@ -2313,7 +2406,7 @@ var Client3 = class {
         "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_qstash6.Client(clientConfig);
+    this.client = new import_qstash7.Client(clientConfig);
   }
   /**
    * Cancel an ongoing workflow