@upstash/workflow 0.2.17 → 0.2.19

package/solidjs.js

@@ -84,12 +84,13 @@ var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 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.17";
+var VERSION = "v0.2.18";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -611,7 +612,7 @@ var triggerFirstInvocation = async (params) => {
   const firstInvocationParams = Array.isArray(params) ? params : [params];
   const workflowContextClient = firstInvocationParams[0].workflowContext.qstashClient;
   const invocationBatch = firstInvocationParams.map(
-    ({ workflowContext, useJSONContent, telemetry, invokeCount, delay }) => {
+    ({ workflowContext, useJSONContent, telemetry, invokeCount, delay, notBefore }) => {
       const { headers } = getHeaders({
         initHeaderValue: "true",
         workflowConfig: {
@@ -633,13 +634,17 @@ var triggerFirstInvocation = async (params) => {
       if (useJSONContent) {
         headers["content-type"] = "application/json";
       }
+      if (workflowContext.label) {
+        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
         headers,
         method: "POST",
         body,
         url: workflowContext.url,
-        delay
+        delay,
+        notBefore
       };
     }
   );
@@ -733,10 +738,11 @@ var recreateUserHeaders = (headers) => {
   const pairs = headers.entries();
   for (const [header, value] of pairs) {
     const headerLowerCase = header.toLowerCase();
-    if (!headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
+    const isUserHeader = !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") {
+    headerLowerCase !== "render-proxy-ttl" || headerLowerCase === WORKFLOW_LABEL_HEADER.toLocaleLowerCase();
+    if (isUserHeader) {
       filteredHeaders.append(header, value);
     }
   }
@@ -2699,6 +2705,22 @@ var WorkflowContext = class {
    * and number of requests per second with the same key.
    */
   flowControl;
+  /**
+   * Label to apply to the workflow run.
+   *
+   * Can be used to filter the workflow run logs.
+   *
+   * Can be set by passing a `label` parameter when triggering the workflow
+   * with `client.trigger`:
+   *
+   * ```ts
+   * await client.trigger({
+   *   url: "https://workflow-endpoint.com",
+   *   label: "my-label"
+   * });
+   * ```
+   */
+  label;
   constructor({
     qstashClient,
     workflowRunId,
@@ -2713,7 +2735,8 @@ var WorkflowContext = class {
     retryDelay,
     telemetry,
     invokeCount,
-    flowControl
+    flowControl,
+    label
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
@@ -2726,6 +2749,7 @@ var WorkflowContext = class {
     this.retries = retries ?? DEFAULT_RETRIES;
     this.retryDelay = retryDelay;
     this.flowControl = flowControl;
+    this.label = label;
     this.executor = new AutoExecutor(this, this.steps, telemetry, invokeCount, debug);
   }
   /**
@@ -3026,7 +3050,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       env: context.env,
       retries: context.retries,
       retryDelay: context.retryDelay,
-      flowControl: context.flowControl
+      flowControl: context.flowControl,
+      label: context.label
     });
     try {
       await routeFunction(disabledContext);
@@ -3203,11 +3228,12 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     if (!errorMessage) {
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
+    const userHeaders = recreateUserHeaders(request.headers);
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
       initialPayload: sourceBody ? initialPayloadParser(decodeBase64(sourceBody)) : void 0,
-      headers: recreateUserHeaders(request.headers),
+      headers: userHeaders,
       steps: [],
       url,
       failureUrl: url,
@@ -3216,8 +3242,9 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
       retries,
       retryDelay,
       flowControl,
-      telemetry: void 0
+      telemetry: void 0,
       // not going to make requests in authentication check
+      label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -3250,7 +3277,7 @@ var processOptions = (options) => {
     environment.QSTASH_CURRENT_SIGNING_KEY && environment.QSTASH_NEXT_SIGNING_KEY
   );
   return {
-    qstashClient: new import_qstash11.Client({
+    qstashClient: options?.qstashClient ?? new import_qstash11.Client({
       baseUrl: environment.QSTASH_URL,
       token: environment.QSTASH_TOKEN
     }),
@@ -3426,6 +3453,7 @@ var serveBase = (routeFunction, telemetry, options) => {
       });
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3440,7 +3468,8 @@ var serveBase = (routeFunction, telemetry, options) => {
       retryDelay,
       telemetry,
       invokeCount,
-      flowControl
+      flowControl,
+      label
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,

package/solidjs.mjs

@@ -1,7 +1,7 @@
 import {
   SDK_TELEMETRY,
   serveBase
-} from "./chunk-RP7G4UD5.mjs";
+} from "./chunk-37XOXDLZ.mjs";
 
 // platforms/solidjs.ts
 var serve = (routeFunction, options) => {

package/svelte.d.mts

@@ -1,7 +1,7 @@
 import * as _sveltejs_kit from '@sveltejs/kit';
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types--R_3XZXz.mjs';
-import { s as serveManyBase } from './serve-many-DgDSOvQs.mjs';
+import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types-B7_5AkKQ.mjs';
+import { s as serveManyBase } from './serve-many-CEUYWQvV.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/svelte.d.ts

@@ -1,7 +1,7 @@
 import * as _sveltejs_kit from '@sveltejs/kit';
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types--R_3XZXz.js';
-import { s as serveManyBase } from './serve-many-B3DfoTFt.js';
+import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types-B7_5AkKQ.js';
+import { s as serveManyBase } from './serve-many-BObe3pdI.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/svelte.js

@@ -86,12 +86,13 @@ var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 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.17";
+var VERSION = "v0.2.18";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -613,7 +614,7 @@ var triggerFirstInvocation = async (params) => {
   const firstInvocationParams = Array.isArray(params) ? params : [params];
   const workflowContextClient = firstInvocationParams[0].workflowContext.qstashClient;
   const invocationBatch = firstInvocationParams.map(
-    ({ workflowContext, useJSONContent, telemetry: telemetry2, invokeCount, delay }) => {
+    ({ workflowContext, useJSONContent, telemetry: telemetry2, invokeCount, delay, notBefore }) => {
       const { headers } = getHeaders({
         initHeaderValue: "true",
         workflowConfig: {
@@ -635,13 +636,17 @@ var triggerFirstInvocation = async (params) => {
       if (useJSONContent) {
         headers["content-type"] = "application/json";
       }
+      if (workflowContext.label) {
+        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
         headers,
         method: "POST",
         body,
         url: workflowContext.url,
-        delay
+        delay,
+        notBefore
       };
     }
   );
@@ -735,10 +740,11 @@ var recreateUserHeaders = (headers) => {
   const pairs = headers.entries();
   for (const [header, value] of pairs) {
     const headerLowerCase = header.toLowerCase();
-    if (!headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
+    const isUserHeader = !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") {
+    headerLowerCase !== "render-proxy-ttl" || headerLowerCase === WORKFLOW_LABEL_HEADER.toLocaleLowerCase();
+    if (isUserHeader) {
       filteredHeaders.append(header, value);
     }
   }
@@ -2768,6 +2774,22 @@ var WorkflowContext = class {
    * and number of requests per second with the same key.
    */
   flowControl;
+  /**
+   * Label to apply to the workflow run.
+   *
+   * Can be used to filter the workflow run logs.
+   *
+   * Can be set by passing a `label` parameter when triggering the workflow
+   * with `client.trigger`:
+   *
+   * ```ts
+   * await client.trigger({
+   *   url: "https://workflow-endpoint.com",
+   *   label: "my-label"
+   * });
+   * ```
+   */
+  label;
   constructor({
     qstashClient,
     workflowRunId,
@@ -2782,7 +2804,8 @@ var WorkflowContext = class {
     retryDelay,
     telemetry: telemetry2,
     invokeCount,
-    flowControl
+    flowControl,
+    label
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
@@ -2795,6 +2818,7 @@ var WorkflowContext = class {
     this.retries = retries ?? DEFAULT_RETRIES;
     this.retryDelay = retryDelay;
     this.flowControl = flowControl;
+    this.label = label;
     this.executor = new AutoExecutor(this, this.steps, telemetry2, invokeCount, debug);
   }
   /**
@@ -3095,7 +3119,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       env: context.env,
       retries: context.retries,
       retryDelay: context.retryDelay,
-      flowControl: context.flowControl
+      flowControl: context.flowControl,
+      label: context.label
     });
     try {
       await routeFunction(disabledContext);
@@ -3272,11 +3297,12 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     if (!errorMessage) {
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
+    const userHeaders = recreateUserHeaders(request.headers);
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
       initialPayload: sourceBody ? initialPayloadParser(decodeBase64(sourceBody)) : void 0,
-      headers: recreateUserHeaders(request.headers),
+      headers: userHeaders,
       steps: [],
       url,
       failureUrl: url,
@@ -3285,8 +3311,9 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
       retries,
       retryDelay,
       flowControl,
-      telemetry: void 0
+      telemetry: void 0,
       // not going to make requests in authentication check
+      label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -3319,7 +3346,7 @@ var processOptions = (options) => {
     environment.QSTASH_CURRENT_SIGNING_KEY && environment.QSTASH_NEXT_SIGNING_KEY
   );
   return {
-    qstashClient: new import_qstash11.Client({
+    qstashClient: options?.qstashClient ?? new import_qstash11.Client({
       baseUrl: environment.QSTASH_URL,
       token: environment.QSTASH_TOKEN
     }),
@@ -3495,6 +3522,7 @@ var serveBase = (routeFunction, telemetry2, options) => {
       });
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3509,7 +3537,8 @@ var serveBase = (routeFunction, telemetry2, options) => {
       retryDelay,
       telemetry: telemetry2,
       invokeCount,
-      flowControl
+      flowControl,
+      label
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,

package/svelte.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-RP7G4UD5.mjs";
+} from "./chunk-37XOXDLZ.mjs";
 
 // platforms/svelte.ts
 var telemetry = {

package/{types--R_3XZXz.d.ts → types-B7_5AkKQ.d.mts}

@@ -913,7 +913,23 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * and number of requests per second with the same key.
      */
     readonly flowControl?: FlowControl;
-    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, retryDelay, telemetry, invokeCount, flowControl, }: {
+    /**
+     * Label to apply to the workflow run.
+     *
+     * Can be used to filter the workflow run logs.
+     *
+     * Can be set by passing a `label` parameter when triggering the workflow
+     * with `client.trigger`:
+     *
+     * ```ts
+     * await client.trigger({
+     *   url: "https://workflow-endpoint.com",
+     *   label: "my-label"
+     * });
+     * ```
+     */
+    readonly label?: string;
+    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, retryDelay, telemetry, invokeCount, flowControl, label, }: {
         qstashClient: WorkflowClient;
         workflowRunId: string;
         headers: Headers;
@@ -928,6 +944,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         telemetry?: Telemetry;
         invokeCount?: number;
         flowControl?: FlowControl;
+        label?: string;
     });
     /**
      * Executes a workflow step

package/{types--R_3XZXz.d.mts → types-B7_5AkKQ.d.ts}

@@ -913,7 +913,23 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * and number of requests per second with the same key.
      */
     readonly flowControl?: FlowControl;
-    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, retryDelay, telemetry, invokeCount, flowControl, }: {
+    /**
+     * Label to apply to the workflow run.
+     *
+     * Can be used to filter the workflow run logs.
+     *
+     * Can be set by passing a `label` parameter when triggering the workflow
+     * with `client.trigger`:
+     *
+     * ```ts
+     * await client.trigger({
+     *   url: "https://workflow-endpoint.com",
+     *   label: "my-label"
+     * });
+     * ```
+     */
+    readonly label?: string;
+    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, retryDelay, telemetry, invokeCount, flowControl, label, }: {
         qstashClient: WorkflowClient;
         workflowRunId: string;
         headers: Headers;
@@ -928,6 +944,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         telemetry?: Telemetry;
         invokeCount?: number;
         flowControl?: FlowControl;
+        label?: string;
     });
     /**
      * Executes a workflow step