@upstash/workflow 1.2.0-demo-rc.1 → 1.2.0

package/README.md

@@ -99,6 +99,7 @@ await client.cancel({ workflowRunId: "<WORKFLOW_RUN_ID>" });
 await client.notify({
   eventId: "my-event-id",
   eventData: "my-data", // data passed to the workflow run
+  workflowRunId: "wfr_123", // optional workflow run ID for lookback
 });
 
 // get waiters:

package/astro.d.mts

@@ -1,6 +1,6 @@
 import { APIContext, APIRoute } from 'astro';
-import { j as WorkflowContext, d as WorkflowServeOptions, x as InvokableWorkflow } from './types-CUwgrpCM.mjs';
-import { s as serveManyBase } from './serve-many-CppVPJrh.mjs';
+import { u as WorkflowContext, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B2S08hRU.mjs';
+import { s as serveManyBase } from './serve-many-C6sa_DxN.mjs';
 import '@upstash/qstash';
 import 'zod';
 

package/astro.d.ts

@@ -1,6 +1,6 @@
 import { APIContext, APIRoute } from 'astro';
-import { j as WorkflowContext, d as WorkflowServeOptions, x as InvokableWorkflow } from './types-CUwgrpCM.js';
-import { s as serveManyBase } from './serve-many-Bi8XaOyq.js';
+import { u as WorkflowContext, d as WorkflowServeOptions, I as InvokableWorkflow } from './types-B2S08hRU.js';
+import { s as serveManyBase } from './serve-many-B-fe7bh7.js';
 import '@upstash/qstash';
 import 'zod';
 

package/astro.js

@@ -126,9 +126,10 @@ function isInstanceOf(v, ctor) {
 }
 
 // src/client/utils.ts
-var makeNotifyRequest = async (requester, eventId, eventData) => {
+var makeNotifyRequest = async (requester, eventId, eventData, workflowRunId) => {
+  const path = workflowRunId ? ["v2", "notify", workflowRunId, eventId] : ["v2", "notify", eventId];
   const result = await requester.request({
-    path: ["v2", "notify", eventId],
+    path,
     method: "POST",
     body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
   });
@@ -186,6 +187,7 @@ var getSteps = async (requester, workflowRunId, messageId, dispatchDebug) => {
 var WORKFLOW_ID_HEADER = "Upstash-Workflow-RunId";
 var WORKFLOW_INIT_HEADER = "Upstash-Workflow-Init";
 var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
+var WORKFLOW_CREATED_AT_HEADER = "Upstash-Workflow-CreatedAt";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FAILURE_CALLBACK_HEADER = "Upstash-Workflow-Failure-Callback";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
@@ -721,6 +723,7 @@ var triggerFirstInvocation = async (params) => {
       retries,
       retryDelay,
       flowControl,
+      redact,
       unknownSdk
     }) => {
       const { headers } = getHeaders({
@@ -757,7 +760,8 @@ var triggerFirstInvocation = async (params) => {
         body,
         url: workflowContext.url,
         delay,
-        notBefore
+        notBefore,
+        redact
       };
     }
   );
@@ -916,7 +920,6 @@ ${atob(callbackMessage.body ?? "")}`
           })}`
         );
       }
-      const userHeaders = recreateUserHeaders(request.headers);
       const { headers: requestHeaders } = getHeaders({
         initHeaderValue: "false",
         workflowConfig: {
@@ -924,7 +927,6 @@ ${atob(callbackMessage.body ?? "")}`
           workflowUrl,
           telemetry: telemetry2
         },
-        userHeaders,
         invokeCount: Number(invokeCount)
       });
       const callResponse = {
@@ -1073,7 +1075,6 @@ var BaseLazyStep = class _BaseLazyStep {
         useJSONContent: false,
         telemetry: telemetry2
       },
-      userHeaders: context.headers,
       invokeCount,
       stepInfo: {
         step,
@@ -1431,9 +1432,9 @@ var LazyWaitEventStep = class extends BaseLazyStep {
 };
 var LazyNotifyStep = class extends LazyFunctionStep {
   stepType = "Notify";
-  constructor(context, stepName, eventId, eventData, requester) {
+  constructor(context, stepName, eventId, eventData, requester, workflowRunId) {
     super(context, stepName, async () => {
-      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData, workflowRunId);
       return {
         eventId,
         eventData,
@@ -1503,7 +1504,6 @@ var LazyInvokeStep = class extends BaseLazyStep {
         telemetry: telemetry2,
         useJSONContent: false
       },
-      userHeaders: context.headers,
       invokeCount
     });
     context.qstashClient.http.headers?.forEach((value, key) => {
@@ -1516,6 +1516,7 @@ var LazyInvokeStep = class extends BaseLazyStep {
         Object.entries(invokerHeaders).map((pairs) => [pairs[0], [pairs[1]]])
       ),
       workflowRunId: context.workflowRunId,
+      workflowRunCreatedAt: context.workflowRunCreatedAt,
       workflowUrl: context.url,
       step
     };
@@ -1611,12 +1612,14 @@ var LazyWaitForWebhookStep = class extends LazyWaitEventStep {
     const parsedEventData = BaseLazyStep.tryParsing(eventData);
     const body = parsedEventData.body;
     const parsedBody = typeof body === "string" ? decodeBase64(body) : void 0;
+    const methodUpper = parsedEventData.method.toUpperCase();
+    const canHaveBody = methodUpper !== "GET" && methodUpper !== "HEAD";
     const request = new Request(
       `${parsedEventData.proto}://${parsedEventData.host}${parsedEventData.url}`,
       {
         method: parsedEventData.method,
         headers: parsedEventData.header,
-        body: parsedBody
+        body: canHaveBody ? parsedBody : void 0
       }
     );
     return {
@@ -1750,6 +1753,9 @@ var WorkflowHeaders = class {
     }
   }
   addUserHeaders() {
+    if (!this.userHeaders) {
+      return;
+    }
     for (const [key, value] of this.userHeaders.entries()) {
       const forwardKey = `Forward-${key}`;
       this.headers.workflowHeaders[forwardKey] = value;
@@ -1856,7 +1862,6 @@ var submitParallelSteps = async ({
           workflowUrl: context.url,
           telemetry: telemetry2
         },
-        userHeaders: context.headers,
         invokeCount
       });
       return {
@@ -2109,7 +2114,7 @@ var AutoExecutor = class _AutoExecutor {
           });
           throw new WorkflowAbort(parallelStep.stepName, resultStep);
         } catch (error) {
-          if (isInstanceOf(error, WorkflowAbort) || isInstanceOf(error, import_qstash5.QstashError) && error.status === 400) {
+          if (isInstanceOf(error, WorkflowAbort) || isInstanceOf(error, import_qstash5.QstashError) && error.status === 400 || isInstanceOf(error, import_qstash5.QstashError) && error.status === 412) {
             throw error;
           }
           throw new WorkflowError(
@@ -2583,6 +2588,7 @@ var MiddlewareManager = class {
 };
 
 // src/context/context.ts
+var import_qstash9 = require("@upstash/qstash");
 var WorkflowContext = class {
   executor;
   steps;
@@ -2609,6 +2615,10 @@ var WorkflowContext = class {
    * Run id of the workflow
    */
   workflowRunId;
+  /**
+   * Creation time of the workflow run
+   */
+  workflowRunCreatedAt;
   /**
    * URL of the workflow
    *
@@ -2700,6 +2710,7 @@ var WorkflowContext = class {
   constructor({
     qstashClient,
     workflowRunId,
+    workflowRunCreatedAt,
     headers,
     steps,
     url,
@@ -2712,6 +2723,7 @@ var WorkflowContext = class {
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
+    this.workflowRunCreatedAt = workflowRunCreatedAt;
     this.steps = steps;
     this.url = url;
     this.headers = headers;
@@ -2886,14 +2898,23 @@ var WorkflowContext = class {
    * a notifyResponse field which contains a list of `Waiter` objects, each corresponding
    * to a notified workflow run.
    *
+   * Optionally, you can pass a workflowRunId to enable lookback functionality:
+   *
+   * ```ts
+   * const { eventId, eventData, notifyResponse } = await context.notify(
+   *   "notify step", "event-id", "event-data", "wfr_123"
+   * );
+   * ```
+   *
    * @param stepName
    * @param eventId event id to notify
    * @param eventData event data to notify with
+   * @param workflowRunId optional workflow run id for lookback support
    * @returns notify response which has event id, event data and list of waiters which were notified
    */
-  async notify(stepName, eventId, eventData) {
+  async notify(stepName, eventId, eventData, workflowRunId) {
     return await this.addStep(
-      new LazyNotifyStep(this, stepName, eventId, eventData, this.qstashClient.http)
+      new LazyNotifyStep(this, stepName, eventId, eventData, this.qstashClient.http, workflowRunId)
     );
   }
   async invoke(stepName, settings) {
@@ -2921,7 +2942,14 @@ var WorkflowContext = class {
    * DisabledWorkflowContext.
    */
   async addStep(step) {
-    return await this.executor.addStep(step);
+    try {
+      return await this.executor.addStep(step);
+    } catch (error) {
+      if (isInstanceOf(error, import_qstash9.QstashError) && error.status === 412) {
+        throw new WorkflowNonRetryableError(error.message);
+      }
+      throw error;
+    }
   }
   get api() {
     return new WorkflowApi({
@@ -2930,23 +2958,8 @@ var WorkflowContext = class {
   }
 };
 
-// src/dev-server.ts
-var import_path = require("path");
-var DEV_QSTASH_TOKEN = "eyJVc2VySUQiOiJkZWZhdWx0VXNlciIsIlBhc3N3b3JkIjoiZGVmYXVsdFBhc3N3b3JkIn0=";
-var DEV_QSTASH_CURRENT_SIGNING_KEY = "sig_7kYjw48mhY7kAjqNGcy6cr29RJ6r";
-var DEV_QSTASH_NEXT_SIGNING_KEY = "sig_5ZB6DVzB1wjE8S6rZ7eenA8Pdnhs";
-function getDevCredentials(port) {
-  return {
-    QSTASH_URL: `http://localhost:${port}`,
-    QSTASH_TOKEN: DEV_QSTASH_TOKEN,
-    QSTASH_CURRENT_SIGNING_KEY: DEV_QSTASH_CURRENT_SIGNING_KEY,
-    QSTASH_NEXT_SIGNING_KEY: DEV_QSTASH_NEXT_SIGNING_KEY
-  };
-}
-var CACHE_DIR = (0, import_path.join)("node_modules", ".cache", "upstash");
-
 // src/serve/authorization.ts
-var import_qstash9 = require("@upstash/qstash");
+var import_qstash10 = require("@upstash/qstash");
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
   static disabledMessage = "disabled-qstash-worklfow-run";
   disabled = true;
@@ -2978,11 +2991,12 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
    */
   static async tryAuthentication(routeFunction, context) {
     const disabledContext = new _DisabledWorkflowContext({
-      qstashClient: new import_qstash9.Client({
+      qstashClient: new import_qstash10.Client({
         baseUrl: "disabled-client",
         token: "disabled-client"
       }),
       workflowRunId: context.workflowRunId,
+      workflowRunCreatedAt: context.workflowRunCreatedAt,
       headers: context.headers,
       steps: [],
       url: context.url,
@@ -3184,7 +3198,9 @@ var handleFailure = async ({
     return ok({ result: "failure-function-undefined" });
   }
   try {
-    const { status, header, body, url, sourceBody, workflowRunId } = JSON.parse(requestPayload);
+    const { status, header, body, url, sourceBody, workflowRunId, workflowCreatedAt } = JSON.parse(
+      requestPayload
+    );
     const decodedBody = body ? decodeBase64(body) : "{}";
     let errorMessage = "";
     let failStack = "";
@@ -3213,6 +3229,7 @@ var handleFailure = async ({
       telemetry: void 0,
       // not going to make requests in authentication check
       label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0,
+      workflowRunCreatedAt: workflowCreatedAt,
       middlewareManager: void 0
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
@@ -3241,7 +3258,7 @@ var handleFailure = async ({
 };
 
 // src/serve/multi-region/handlers.ts
-var import_qstash10 = require("@upstash/qstash");
+var import_qstash11 = require("@upstash/qstash");
 
 // src/serve/multi-region/utils.ts
 var VALID_REGIONS = ["EU_CENTRAL_1", "US_EAST_1"];
@@ -3306,7 +3323,7 @@ var getHandlersForRequest = (qstashHandlers, regionHeader, isFirstInvocation) =>
 };
 var createRegionalHandler = (environment, receiverConfig, region, clientOptions) => {
   const clientEnv = readClientEnvironmentVariables(environment, region);
-  const client = new import_qstash10.Client({
+  const client = new import_qstash11.Client({
     ...clientOptions,
     baseUrl: clientEnv.QSTASH_URL,
     token: clientEnv.QSTASH_TOKEN
@@ -3356,7 +3373,7 @@ var getQStashHandlers = ({
     return {
       mode: "single-region",
       handlers: {
-        client: qstashClientOption && "http" in qstashClientOption ? qstashClientOption : new import_qstash10.Client({
+        client: qstashClientOption && "http" in qstashClientOption ? qstashClientOption : new import_qstash11.Client({
           ...qstashClientOption,
           baseUrl: environment.QSTASH_URL,
           token: environment.QSTASH_TOKEN
@@ -3372,7 +3389,7 @@ var getReceiver = (environment, receiverConfig, region) => {
       return void 0;
     }
     const receiverEnv = readReceiverEnvironmentVariables(environment, region);
-    return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash10.Receiver({
+    return receiverEnv.QSTASH_CURRENT_SIGNING_KEY && receiverEnv.QSTASH_NEXT_SIGNING_KEY ? new import_qstash11.Receiver({
       currentSigningKey: receiverEnv.QSTASH_CURRENT_SIGNING_KEY,
       nextSigningKey: receiverEnv.QSTASH_NEXT_SIGNING_KEY
     }) : void 0;
@@ -3598,33 +3615,19 @@ var AUTH_FAIL_MESSAGE = `Failed to authenticate Workflow request. If this is une
 
 // src/serve/index.ts
 var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
-  const environment = options?.env ?? (typeof process === "undefined" ? {} : process.env);
-  const devMode = environment.WORKFLOW_DEV === "true";
-  if (devMode) {
-    const port = Number(environment.WORKFLOW_DEV_PORT) || 8080;
-    const creds = getDevCredentials(port);
-    for (const [k, v] of Object.entries(creds)) {
-      if (!environment[k]) {
-        environment[k] = v;
-      }
-    }
-  }
-  const resolvedOptions = processOptions(
-    options,
-    internalOptions
-  );
+  const {
+    initialPayloadParser,
+    url,
+    failureFunction,
+    baseUrl,
+    env,
+    disableTelemetry,
+    middlewares,
+    internal
+  } = processOptions(options, internalOptions);
+  telemetry2 = disableTelemetry ? void 0 : telemetry2;
+  const { generateResponse: responseGenerator, useJSONContent } = internal;
   const handler = async (request, middlewareManager) => {
-    const {
-      initialPayloadParser,
-      url,
-      failureFunction,
-      baseUrl,
-      env,
-      disableTelemetry: optDisableTelemetry,
-      internal
-    } = resolvedOptions;
-    const currentTelemetry = optDisableTelemetry ? void 0 : telemetry2;
-    const { generateResponse: responseGenerator, useJSONContent } = internal;
     await middlewareManager.dispatchDebug("onInfo", {
       info: `Received request for workflow execution.`
     });
@@ -3704,6 +3707,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
     const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
+    const workflowRunCreatedAt = request.headers.get(WORKFLOW_CREATED_AT_HEADER);
     const workflowContext = new WorkflowContext({
       qstashClient: regionalClient,
       workflowRunId,
@@ -3712,9 +3716,10 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       steps,
       url: workflowUrl,
       env,
-      telemetry: currentTelemetry,
+      telemetry: telemetry2,
       invokeCount,
       label,
+      workflowRunCreatedAt: Number(workflowRunCreatedAt),
       middlewareManager
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
@@ -3738,7 +3743,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       requestPayload: rawInitialPayload,
       client: regionalClient,
       workflowUrl,
-      telemetry: currentTelemetry,
+      telemetry: telemetry2,
       middlewareManager
     });
     if (callReturnCheck.isErr()) {
@@ -3747,7 +3752,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
       const result = isFirstInvocation ? await triggerFirstInvocation({
         workflowContext,
         useJSONContent,
-        telemetry: currentTelemetry,
+        telemetry: telemetry2,
         invokeCount,
         middlewareManager,
         unknownSdk
@@ -3815,9 +3820,7 @@ var serveBase = (routeFunction, telemetry2, options, internalOptions) => {
     );
   };
   const safeHandler = async (request) => {
-    const middlewareManager = new MiddlewareManager(
-      resolvedOptions.middlewares
-    );
+    const middlewareManager = new MiddlewareManager(middlewares);
     try {
       return await handler(request, middlewareManager);
     } catch (error) {

package/astro.mjs

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