@upstash/workflow 0.2.2 → 0.2.4

package/index.js

@@ -90,6 +90,23 @@ var getSteps = async (requester, workflowRunId, messageId, debug) => {
   }
 };
 
+// src/constants.ts
+var WORKFLOW_ID_HEADER = "Upstash-Workflow-RunId";
+var WORKFLOW_INIT_HEADER = "Upstash-Workflow-Init";
+var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
+var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
+var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
+var WORKFLOW_PROTOCOL_VERSION = "1";
+var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
+var DEFAULT_CONTENT_TYPE = "application/json";
+var NO_CONCURRENCY = 1;
+var DEFAULT_RETRIES = 3;
+var VERSION = "v0.2.3";
+var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
+var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
+var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
+var TELEMETRY_HEADER_RUNTIME = "Upstash-Telemetry-Runtime";
+
 // src/error.ts
 var import_qstash2 = require("@upstash/qstash");
 var WorkflowError = class extends import_qstash2.QstashError {
@@ -727,18 +744,6 @@ var Err = class {
 };
 var fromThrowable = Result.fromThrowable;
 
-// src/constants.ts
-var WORKFLOW_ID_HEADER = "Upstash-Workflow-RunId";
-var WORKFLOW_INIT_HEADER = "Upstash-Workflow-Init";
-var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
-var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
-var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
-var WORKFLOW_PROTOCOL_VERSION = "1";
-var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
-var DEFAULT_CONTENT_TYPE = "application/json";
-var NO_CONCURRENCY = 1;
-var DEFAULT_RETRIES = 3;
-
 // src/types.ts
 var StepTypes = [
   "Initial",
@@ -752,16 +757,21 @@ var StepTypes = [
 
 // src/workflow-requests.ts
 var import_qstash3 = require("@upstash/qstash");
-var triggerFirstInvocation = async (workflowContext, retries, useJSONContent, debug) => {
-  const { headers } = getHeaders(
-    "true",
-    workflowContext.workflowRunId,
-    workflowContext.url,
-    workflowContext.headers,
-    void 0,
-    workflowContext.failureUrl,
-    retries
-  );
+var triggerFirstInvocation = async ({
+  workflowContext,
+  useJSONContent,
+  telemetry,
+  debug
+}) => {
+  const { headers } = getHeaders({
+    initHeaderValue: "true",
+    workflowRunId: workflowContext.workflowRunId,
+    workflowUrl: workflowContext.url,
+    userHeaders: workflowContext.headers,
+    failureUrl: workflowContext.failureUrl,
+    retries: workflowContext.retries,
+    telemetry
+  });
   if (useJSONContent) {
     headers["content-type"] = "application/json";
   }
@@ -867,7 +877,16 @@ var recreateUserHeaders = (headers) => {
   }
   return filteredHeaders;
 };
-var handleThirdPartyCallResult = async (request, requestPayload, client, workflowUrl, failureUrl, retries, debug) => {
+var handleThirdPartyCallResult = async ({
+  request,
+  requestPayload,
+  client,
+  workflowUrl,
+  failureUrl,
+  retries,
+  telemetry,
+  debug
+}) => {
   try {
     if (request.headers.get("Upstash-Workflow-Callback")) {
       let callbackPayload;
@@ -926,15 +945,15 @@ ${atob(callbackMessage.body ?? "")}`
         );
       }
       const userHeaders = recreateUserHeaders(request.headers);
-      const { headers: requestHeaders } = getHeaders(
-        "false",
+      const { headers: requestHeaders } = getHeaders({
+        initHeaderValue: "false",
         workflowRunId,
         workflowUrl,
         userHeaders,
-        void 0,
         failureUrl,
-        retries
-      );
+        retries,
+        telemetry
+      });
       const callResponse = {
         status: callbackMessage.status,
         body: atob(callbackMessage.body ?? ""),
@@ -972,12 +991,31 @@ ${atob(callbackMessage.body ?? "")}`
     );
   }
 };
-var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step, failureUrl, retries, callRetries, callTimeout) => {
+var getTelemetryHeaders = (telemetry) => {
+  return {
+    [TELEMETRY_HEADER_SDK]: telemetry.sdk,
+    [TELEMETRY_HEADER_FRAMEWORK]: telemetry.framework,
+    [TELEMETRY_HEADER_RUNTIME]: telemetry.runtime ?? "unknown"
+  };
+};
+var getHeaders = ({
+  initHeaderValue,
+  workflowRunId,
+  workflowUrl,
+  userHeaders,
+  failureUrl,
+  retries,
+  step,
+  callRetries,
+  callTimeout,
+  telemetry
+}) => {
   const baseHeaders = {
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
     [WORKFLOW_URL_HEADER]: workflowUrl,
-    [WORKFLOW_FEATURE_HEADER]: "LazyFetch,InitialBody"
+    [WORKFLOW_FEATURE_HEADER]: "LazyFetch,InitialBody",
+    ...telemetry ? getTelemetryHeaders(telemetry) : {}
   };
   if (!step?.callUrl) {
     baseHeaders[`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`] = WORKFLOW_PROTOCOL_VERSION;
@@ -1051,6 +1089,13 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
         ...Object.fromEntries(
           Object.entries(baseHeaders).map(([header, value]) => [header, [value]])
         ),
+        // to include telemetry headers:
+        ...telemetry ? Object.fromEntries(
+          Object.entries(getTelemetryHeaders(telemetry)).map(([header, value]) => [
+            header,
+            [value]
+          ])
+        ) : {},
         // note: using WORKFLOW_ID_HEADER doesn't work, because Runid -> RunId:
         "Upstash-Workflow-Runid": [workflowRunId],
         [WORKFLOW_INIT_HEADER]: ["false"],
@@ -1089,6 +1134,7 @@ If you want to disable QStash Verification, you should clear env variables QSTAS
 };
 
 // src/context/auto-executor.ts
+var import_qstash4 = require("@upstash/qstash");
 var AutoExecutor = class _AutoExecutor {
   context;
   promises = /* @__PURE__ */ new WeakMap();
@@ -1097,13 +1143,15 @@ var AutoExecutor = class _AutoExecutor {
   nonPlanStepCount;
   steps;
   indexInCurrentList = 0;
+  telemetry;
   stepCount = 0;
   planStepCount = 0;
   executingStep = false;
-  constructor(context, steps, debug) {
+  constructor(context, steps, telemetry, debug) {
     this.context = context;
-    this.debug = debug;
     this.steps = steps;
+    this.telemetry = telemetry;
+    this.debug = debug;
     this.nonPlanStepCount = this.steps.filter((step) => !step.targetStep).length;
   }
   /**
@@ -1246,7 +1294,7 @@ var AutoExecutor = class _AutoExecutor {
           );
           await this.submitStepsToQStash([resultStep], [parallelStep]);
         } catch (error) {
-          if (error instanceof WorkflowAbort) {
+          if (error instanceof WorkflowAbort || error instanceof import_qstash4.QstashError && error.status === 400) {
             throw error;
           }
           throw new WorkflowError(
@@ -1317,15 +1365,16 @@ var AutoExecutor = class _AutoExecutor {
     });
     if (steps[0].waitEventId && steps.length === 1) {
       const waitStep = steps[0];
-      const { headers, timeoutHeaders } = getHeaders(
-        "false",
-        this.context.workflowRunId,
-        this.context.url,
-        this.context.headers,
-        waitStep,
-        this.context.failureUrl,
-        this.context.retries
-      );
+      const { headers, timeoutHeaders } = getHeaders({
+        initHeaderValue: "false",
+        workflowRunId: this.context.workflowRunId,
+        workflowUrl: this.context.url,
+        userHeaders: this.context.headers,
+        step: waitStep,
+        failureUrl: this.context.failureUrl,
+        retries: this.context.retries,
+        telemetry: this.telemetry
+      });
       const waitBody = {
         url: this.context.url,
         timeout: waitStep.timeout,
@@ -1352,17 +1401,18 @@ var AutoExecutor = class _AutoExecutor {
     const result = await this.context.qstashClient.batchJSON(
       steps.map((singleStep, index) => {
         const lazyStep = lazySteps[index];
-        const { headers } = getHeaders(
-          "false",
-          this.context.workflowRunId,
-          this.context.url,
-          this.context.headers,
-          singleStep,
-          this.context.failureUrl,
-          this.context.retries,
-          lazyStep instanceof LazyCallStep ? lazyStep.retries : void 0,
-          lazyStep instanceof LazyCallStep ? lazyStep.timeout : void 0
-        );
+        const { headers } = getHeaders({
+          initHeaderValue: "false",
+          workflowRunId: this.context.workflowRunId,
+          workflowUrl: this.context.url,
+          userHeaders: this.context.headers,
+          step: singleStep,
+          failureUrl: this.context.failureUrl,
+          retries: this.context.retries,
+          callRetries: lazyStep instanceof LazyCallStep ? lazyStep.retries : void 0,
+          callTimeout: lazyStep instanceof LazyCallStep ? lazyStep.timeout : void 0,
+          telemetry: this.telemetry
+        });
         const willWait = singleStep.concurrent === NO_CONCURRENCY || singleStep.stepId === 0;
         singleStep.out = JSON.stringify(singleStep.out);
         return singleStep.callUrl ? (
@@ -1474,6 +1524,127 @@ var sortSteps = (steps) => {
   return [...steps].sort((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/context/api/anthropic.ts
+var import_qstash5 = require("@upstash/qstash");
+
+// src/context/provider.ts
+var getProviderInfo = (api) => {
+  if (!api.provider) {
+    throw new WorkflowError("A Provider must be provided.");
+  }
+  if (api.provider.owner === "upstash") {
+    throw new WorkflowError("Upstash provider isn't supported.");
+  }
+  const { name, provider, ...parameters } = api;
+  if (!provider.baseUrl) throw new TypeError("baseUrl cannot be empty or undefined!");
+  if (!provider.token) throw new TypeError("token cannot be empty or undefined!");
+  if (provider.apiKind !== name) {
+    throw new TypeError(`Unexpected api name. Expected '${provider.apiKind}', received ${name}`);
+  }
+  const providerInfo = {
+    url: provider.getUrl(),
+    baseUrl: provider.baseUrl,
+    route: provider.getRoute(),
+    appendHeaders: provider.getHeaders(parameters),
+    owner: provider.owner,
+    method: provider.method
+  };
+  return provider.onFinish(providerInfo, parameters);
+};
+
+// src/context/api/base.ts
+var BaseWorkflowApi = class {
+  context;
+  constructor({ context }) {
+    this.context = context;
+  }
+  /**
+   * context.call which uses a QStash API
+   *
+   * @param stepName
+   * @param settings
+   * @returns
+   */
+  async callApi(stepName, settings) {
+    const { url, appendHeaders, method } = getProviderInfo(settings.api);
+    const { method: userMethod, body, headers = {}, retries = 0, timeout } = settings;
+    return await this.context.call(stepName, {
+      url,
+      method: userMethod ?? method,
+      body,
+      headers: {
+        ...appendHeaders,
+        ...headers
+      },
+      retries,
+      timeout
+    });
+  }
+};
+
+// src/context/api/anthropic.ts
+var AnthropicAPI = class extends BaseWorkflowApi {
+  async call(stepName, settings) {
+    const { token, operation, ...parameters } = settings;
+    return await this.callApi(stepName, {
+      api: {
+        name: "llm",
+        provider: (0, import_qstash5.anthropic)({ token })
+      },
+      ...parameters
+    });
+  }
+};
+
+// src/context/api/openai.ts
+var import_qstash6 = require("@upstash/qstash");
+var OpenAIAPI = class extends BaseWorkflowApi {
+  async call(stepName, settings) {
+    const { token, organization, operation, ...parameters } = settings;
+    return await this.callApi(stepName, {
+      api: {
+        name: "llm",
+        provider: (0, import_qstash6.openai)({ token, organization })
+      },
+      ...parameters
+    });
+  }
+};
+
+// src/context/api/resend.ts
+var import_qstash7 = require("@upstash/qstash");
+var ResendAPI = class extends BaseWorkflowApi {
+  async call(stepName, settings) {
+    const { token, batch = false, ...parameters } = settings;
+    return await this.callApi(stepName, {
+      api: {
+        name: "email",
+        provider: (0, import_qstash7.resend)({ token, batch })
+      },
+      ...parameters
+    });
+  }
+};
+
+// src/context/api/index.ts
+var WorkflowApi = class extends BaseWorkflowApi {
+  get openai() {
+    return new OpenAIAPI({
+      context: this.context
+    });
+  }
+  get resend() {
+    return new ResendAPI({
+      context: this.context
+    });
+  }
+  get anthropic() {
+    return new AnthropicAPI({
+      context: this.context
+    });
+  }
+};
+
 // src/context/context.ts
 var WorkflowContext = class {
   executor;
@@ -1606,7 +1777,8 @@ var WorkflowContext = class {
     debug,
     initialPayload,
     env,
-    retries
+    retries,
+    telemetry
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
@@ -1617,7 +1789,7 @@ var WorkflowContext = class {
     this.requestPayload = initialPayload;
     this.env = env ?? {};
     this.retries = retries ?? DEFAULT_RETRIES;
-    this.executor = new AutoExecutor(this, this.steps, debug);
+    this.executor = new AutoExecutor(this, this.steps, telemetry, debug);
   }
   /**
    * Executes a workflow step
@@ -1853,6 +2025,11 @@ var WorkflowContext = class {
   async addStep(step) {
     return await this.executor.addStep(step);
   }
+  get api() {
+    return new WorkflowApi({
+      context: this
+    });
+  }
 };
 
 // src/logger.ts
@@ -1930,7 +2107,7 @@ function decodeBase64(base64) {
 }
 
 // src/serve/authorization.ts
-var import_qstash4 = require("@upstash/qstash");
+var import_qstash8 = require("@upstash/qstash");
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
   static disabledMessage = "disabled-qstash-worklfow-run";
   /**
@@ -1961,7 +2138,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
    */
   static async tryAuthentication(routeFunction, context) {
     const disabledContext = new _DisabledWorkflowContext({
-      qstashClient: new import_qstash4.Client({
+      qstashClient: new import_qstash8.Client({
         baseUrl: "disabled-client",
         token: "disabled-client"
       }),
@@ -2125,7 +2302,7 @@ var parseRequest = async (requestPayload, isFirstInvocation, workflowRunId, requ
     };
   }
 };
-var handleFailure = async (request, requestPayload, qstashClient, initialPayloadParser, routeFunction, failureFunction, debug) => {
+var handleFailure = async (request, requestPayload, qstashClient, initialPayloadParser, routeFunction, failureFunction, env, retries, debug) => {
   if (request.headers.get(WORKFLOW_FAILURE_HEADER) !== "true") {
     return ok("not-failure-callback");
   }
@@ -2150,7 +2327,11 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
       steps: [],
       url,
       failureUrl: url,
-      debug
+      debug,
+      env,
+      retries,
+      telemetry: void 0
+      // not going to make requests in authentication check
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -2175,15 +2356,15 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
 };
 
 // src/serve/options.ts
-var import_qstash5 = require("@upstash/qstash");
-var import_qstash6 = require("@upstash/qstash");
+var import_qstash9 = require("@upstash/qstash");
+var import_qstash10 = 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_qstash6.Client({
+    qstashClient: new import_qstash10.Client({
       baseUrl: environment.QSTASH_URL,
       token: environment.QSTASH_TOKEN
     }),
@@ -2217,7 +2398,7 @@ var processOptions = (options) => {
         throw error;
       }
     },
-    receiver: receiverEnvironmentVariablesSet ? new import_qstash5.Receiver({
+    receiver: receiverEnvironmentVariablesSet ? new import_qstash9.Receiver({
       currentSigningKey: environment.QSTASH_CURRENT_SIGNING_KEY,
       nextSigningKey: environment.QSTASH_NEXT_SIGNING_KEY
     }) : void 0,
@@ -2225,6 +2406,7 @@ var processOptions = (options) => {
     env: environment,
     retries: DEFAULT_RETRIES,
     useJSONContent: false,
+    disableTelemetry: false,
     ...options
   };
 };
@@ -2259,7 +2441,7 @@ var determineUrls = async (request, url, baseUrl, failureFunction, failureUrl, d
 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 serveBase = (routeFunction, options) => {
+var serveBase = (routeFunction, telemetry, options) => {
   const {
     qstashClient,
     onStepFinish,
@@ -2272,8 +2454,10 @@ var serveBase = (routeFunction, options) => {
     baseUrl,
     env,
     retries,
-    useJSONContent
+    useJSONContent,
+    disableTelemetry
   } = processOptions(options);
+  telemetry = disableTelemetry ? void 0 : telemetry;
   const debug = WorkflowLogger.getLogger(verbose);
   const handler = async (request) => {
     await debug?.log("INFO", "ENDPOINT_START");
@@ -2309,7 +2493,10 @@ var serveBase = (routeFunction, options) => {
       qstashClient,
       initialPayloadParser,
       routeFunction,
-      failureFunction
+      failureFunction,
+      env,
+      retries,
+      debug
     );
     if (failureCheck.isErr()) {
       throw failureCheck.error;
@@ -2327,7 +2514,8 @@ var serveBase = (routeFunction, options) => {
       failureUrl: workflowFailureUrl,
       debug,
       env,
-      retries
+      retries,
+      telemetry
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -2343,22 +2531,23 @@ var serveBase = (routeFunction, options) => {
         "auth-fail"
       );
     }
-    const callReturnCheck = await handleThirdPartyCallResult(
+    const callReturnCheck = await handleThirdPartyCallResult({
       request,
-      rawInitialPayload,
-      qstashClient,
+      requestPayload: rawInitialPayload,
+      client: qstashClient,
       workflowUrl,
-      workflowFailureUrl,
+      failureUrl: workflowFailureUrl,
       retries,
+      telemetry,
       debug
-    );
+    });
     if (callReturnCheck.isErr()) {
       await debug?.log("ERROR", "SUBMIT_THIRD_PARTY_RESULT", {
         error: callReturnCheck.error.message
       });
       throw callReturnCheck.error;
     } else if (callReturnCheck.value === "continue-workflow") {
-      const result = isFirstInvocation ? await triggerFirstInvocation(workflowContext, retries, useJSONContent, debug) : await triggerRouteFunction({
+      const result = isFirstInvocation ? await triggerFirstInvocation({ workflowContext, useJSONContent, telemetry, debug }) : await triggerRouteFunction({
         onStep: async () => routeFunction(workflowContext),
         onCleanup: async () => {
           await triggerWorkflowDelete(workflowContext, debug);
@@ -2393,11 +2582,18 @@ var serveBase = (routeFunction, options) => {
   return { handler: safeHandler };
 };
 var serve = (routeFunction, options) => {
-  return serveBase(routeFunction, options);
+  return serveBase(
+    routeFunction,
+    {
+      sdk: SDK_TELEMETRY,
+      framework: "unknown"
+    },
+    options
+  );
 };
 
 // src/client/index.ts
-var import_qstash7 = require("@upstash/qstash");
+var import_qstash11 = require("@upstash/qstash");
 var Client4 = class {
   client;
   constructor(clientConfig) {
@@ -2406,7 +2602,7 @@ var Client4 = 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_qstash7.Client(clientConfig);
+    this.client = new import_qstash11.Client(clientConfig);
   }
   /**
    * Cancel an ongoing workflow
@@ -2567,9 +2763,16 @@ var Client4 = class {
       initialPayload: body,
       steps: [],
       url,
-      workflowRunId: finalWorkflowRunId
+      workflowRunId: finalWorkflowRunId,
+      retries,
+      telemetry: void 0
+      // can't know workflow telemetry here
+    });
+    const result = await triggerFirstInvocation({
+      workflowContext: context,
+      telemetry: void 0
+      // can't know workflow telemetry here
     });
-    const result = await triggerFirstInvocation(context, retries ?? DEFAULT_RETRIES);
     if (result.isOk()) {
       return { workflowRunId: finalWorkflowRunId };
     } else {

package/index.mjs

@@ -1,5 +1,4 @@
 import {
-  DEFAULT_RETRIES,
   StepTypes,
   WorkflowAbort,
   WorkflowContext,
@@ -10,7 +9,7 @@ import {
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-Z7WS5XIR.mjs";
+} from "./chunk-ETDFMXER.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -183,9 +182,16 @@ var Client = class {
       initialPayload: body,
       steps: [],
       url,
-      workflowRunId: finalWorkflowRunId
+      workflowRunId: finalWorkflowRunId,
+      retries,
+      telemetry: void 0
+      // can't know workflow telemetry here
+    });
+    const result = await triggerFirstInvocation({
+      workflowContext: context,
+      telemetry: void 0
+      // can't know workflow telemetry here
     });
-    const result = await triggerFirstInvocation(context, retries ?? DEFAULT_RETRIES);
     if (result.isOk()) {
       return { workflowRunId: finalWorkflowRunId };
     } else {

package/nextjs.d.mts

@@ -1,5 +1,5 @@
 import { NextApiHandler } from 'next';
-import { R as RouteFunction, j as PublicServeOptions } from './types-APRap-aV.mjs';
+import { R as RouteFunction, j as PublicServeOptions } from './types-Bt4-paRy.mjs';
 import '@upstash/qstash';
 
 /**

package/nextjs.d.ts

@@ -1,5 +1,5 @@
 import { NextApiHandler } from 'next';
-import { R as RouteFunction, j as PublicServeOptions } from './types-APRap-aV.js';
+import { R as RouteFunction, j as PublicServeOptions } from './types-Bt4-paRy.js';
 import '@upstash/qstash';
 
 /**