@upstash/workflow 0.2.0 → 0.2.1

package/astro.d.mts

@@ -1,5 +1,5 @@
 import { APIContext, APIRoute } from 'astro';
-import { b as WorkflowContext, W as WorkflowServeOptions } from './types-Cki_MHrh.mjs';
+import { b as WorkflowContext, W as WorkflowServeOptions } from './types-Be4hC1mu.mjs';
 import '@upstash/qstash';
 
 declare function serve<TInitialPayload = unknown>(routeFunction: (workflowContext: WorkflowContext<TInitialPayload>, apiContext: APIContext) => Promise<void>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">): {

package/astro.d.ts

@@ -1,5 +1,5 @@
 import { APIContext, APIRoute } from 'astro';
-import { b as WorkflowContext, W as WorkflowServeOptions } from './types-Cki_MHrh.js';
+import { b as WorkflowContext, W as WorkflowServeOptions } from './types-Be4hC1mu.js';
 import '@upstash/qstash';
 
 declare function serve<TInitialPayload = unknown>(routeFunction: (workflowContext: WorkflowContext<TInitialPayload>, apiContext: APIContext) => Promise<void>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">): {

package/astro.js

@@ -118,6 +118,11 @@ 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;
   }
 };
@@ -210,15 +215,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 {
@@ -830,7 +837,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);
     }
   }
@@ -933,7 +943,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,
@@ -943,6 +953,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) {
@@ -1318,7 +1331,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);
@@ -1668,6 +1682,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;
@@ -1675,9 +1690,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 {
@@ -2077,7 +2100,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,
@@ -2119,10 +2142,23 @@ var processOptions = (options) => {
       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;
@@ -2164,6 +2200,7 @@ var determineUrls = async (request, url, baseUrl, failureFunction, failureUrl, d
     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) => {
@@ -2240,7 +2277,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,

package/astro.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-5R2BFC3N.mjs";
+} from "./chunk-ADOBNR4O.mjs";
 
 // platforms/astro.ts
 function serve2(routeFunction, options) {

package/{chunk-5R2BFC3N.mjs → chunk-ADOBNR4O.mjs}

@@ -131,6 +131,11 @@ 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 +228,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 {
@@ -843,7 +850,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);
     }
   }
@@ -946,7 +956,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 +966,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 +1344,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 +1695,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 +1703,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 {
@@ -2090,7 +2113,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,
@@ -2132,10 +2155,23 @@ var processOptions = (options) => {
       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;
@@ -2177,6 +2213,7 @@ var determineUrls = async (request, url, baseUrl, failureFunction, failureUrl, d
     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) => {
@@ -2253,7 +2290,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,

package/cloudflare.d.mts

@@ -1,4 +1,4 @@
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-Cki_MHrh.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-Be4hC1mu.mjs';
 import '@upstash/qstash';
 
 type WorkflowBindings = {

package/cloudflare.d.ts

@@ -1,4 +1,4 @@
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-Cki_MHrh.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-Be4hC1mu.js';
 import '@upstash/qstash';
 
 type WorkflowBindings = {

package/cloudflare.js

@@ -118,6 +118,11 @@ 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;
   }
 };
@@ -210,15 +215,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 {
@@ -830,7 +837,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);
     }
   }
@@ -933,7 +943,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,
@@ -943,6 +953,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) {
@@ -1318,7 +1331,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);
@@ -1668,6 +1682,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;
@@ -1675,9 +1690,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 {
@@ -2077,7 +2100,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,
@@ -2119,10 +2142,23 @@ var processOptions = (options) => {
       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;
@@ -2164,6 +2200,7 @@ var determineUrls = async (request, url, baseUrl, failureFunction, failureUrl, d
     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) => {
@@ -2240,7 +2277,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,

package/cloudflare.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-5R2BFC3N.mjs";
+} from "./chunk-ADOBNR4O.mjs";
 
 // platforms/cloudflare.ts
 var getArgs = (args) => {

package/express.d.mts

@@ -1,4 +1,4 @@
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-Cki_MHrh.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-Be4hC1mu.mjs';
 import { Router } from 'express';
 import '@upstash/qstash';
 

package/express.d.ts

@@ -1,4 +1,4 @@
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-Cki_MHrh.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-Be4hC1mu.js';
 import { Router } from 'express';
 import '@upstash/qstash';