@upstash/qstash 2.7.21 → 2.7.23

package/workflow.js

@@ -127,7 +127,8 @@ var DLQ = class {
       messages: messagesPayload.messages.map((message) => {
         return {
           ...message,
-          urlGroup: message.topicName
+          urlGroup: message.topicName,
+          ratePerSecond: "rate" in message ? message.rate : void 0
         };
       }),
       cursor: messagesPayload.cursor
@@ -244,6 +245,7 @@ var HttpClient = class {
   options;
   retry;
   headers;
+  telemetryHeaders;
   constructor(config) {
     this.baseUrl = config.baseUrl.replace(/\/$/, "");
     this.authorization = config.authorization;
@@ -256,6 +258,7 @@ var HttpClient = class {
       backoff: config.retry?.backoff ?? ((retryCount) => Math.exp(retryCount) * 50)
     };
     this.headers = config.headers;
+    this.telemetryHeaders = config.telemetryHeaders;
   }
   async request(request) {
     const { response } = await this.requestWithBackoff(request);
@@ -557,7 +560,8 @@ var Messages = class {
     });
     const message = {
       ...messagePayload,
-      urlGroup: messagePayload.topicName
+      urlGroup: messagePayload.topicName,
+      ratePerSecond: "rate" in messagePayload ? messagePayload.rate : void 0
     };
     return message;
   }
@@ -753,7 +757,7 @@ function prefixHeaders(headers) {
   }
   return headers;
 }
-function wrapWithGlobalHeaders(headers, globalHeaders) {
+function wrapWithGlobalHeaders(headers, globalHeaders, telemetryHeaders) {
   if (!globalHeaders) {
     return headers;
   }
@@ -761,6 +765,11 @@ function wrapWithGlobalHeaders(headers, globalHeaders) {
   headers.forEach((value, key) => {
     finalHeaders.set(key, value);
   });
+  telemetryHeaders?.forEach((value, key) => {
+    if (!value)
+      return;
+    finalHeaders.append(key, value);
+  });
   return finalHeaders;
 }
 function processHeaders(request) {
@@ -798,6 +807,19 @@ function processHeaders(request) {
       headers.set("Upstash-Timeout", `${request.timeout}s`);
     }
   }
+  if (request.flowControl?.key) {
+    const parallelism = request.flowControl.parallelism?.toString();
+    const rate = request.flowControl.ratePerSecond?.toString();
+    const controlValue = [
+      parallelism ? `parallelism=${parallelism}` : void 0,
+      rate ? `rate=${rate}` : void 0
+    ].filter(Boolean);
+    if (controlValue.length === 0) {
+      throw new QstashError("Provide at least one of parallelism or ratePerSecond for flowControl");
+    }
+    headers.set("Upstash-Flow-Control-Key", request.flowControl.key);
+    headers.set("Upstash-Flow-Control-Value", controlValue.join(", "));
+  }
   return headers;
 }
 function getRequestPath(request) {
@@ -837,6 +859,15 @@ function decodeBase64(base64) {
     }
   }
 }
+function getRuntime() {
+  if (typeof process === "object" && typeof process.versions == "object" && process.versions.bun)
+    return `bun@${process.versions.bun}`;
+  if (typeof EdgeRuntime === "string")
+    return "edge-light";
+  else if (typeof process === "object" && typeof process.version === "string")
+    return `node@${process.version}`;
+  return "";
+}
 
 // src/client/queue.ts
 var Queue = class {
@@ -911,7 +942,8 @@ var Queue = class {
     }
     const headers = wrapWithGlobalHeaders(
       processHeaders(request),
-      this.http.headers
+      this.http.headers,
+      this.http.telemetryHeaders
     );
     const destination = getRequestPath(request);
     const response = await this.http.request({
@@ -1014,9 +1046,24 @@ var Schedules = class {
     if (request.queueName !== void 0) {
       headers.set("Upstash-Queue-Name", request.queueName);
     }
+    if (request.flowControl?.key) {
+      const parallelism = request.flowControl.parallelism?.toString();
+      const rate = request.flowControl.ratePerSecond?.toString();
+      const controlValue = [
+        parallelism ? `parallelism=${parallelism}` : void 0,
+        rate ? `rate=${rate}` : void 0
+      ].filter(Boolean);
+      if (controlValue.length === 0) {
+        throw new QstashError(
+          "Provide at least one of parallelism or ratePerSecond for flowControl"
+        );
+      }
+      headers.set("Upstash-Flow-Control-Key", request.flowControl.key);
+      headers.set("Upstash-Flow-Control-Value", controlValue.join(", "));
+    }
     return await this.http.request({
       method: "POST",
-      headers: wrapWithGlobalHeaders(headers, this.http.headers),
+      headers: wrapWithGlobalHeaders(headers, this.http.headers, this.http.telemetryHeaders),
       path: ["v2", "schedules", request.destination],
       body: request.body
     });
@@ -1025,19 +1072,27 @@ var Schedules = class {
    * Get a schedule
    */
   async get(scheduleId) {
-    return await this.http.request({
+    const schedule = await this.http.request({
       method: "GET",
       path: ["v2", "schedules", scheduleId]
     });
+    if ("rate" in schedule)
+      schedule.ratePerSecond = schedule.rate;
+    return schedule;
   }
   /**
    * List your schedules
    */
   async list() {
-    return await this.http.request({
+    const schedules = await this.http.request({
       method: "GET",
       path: ["v2", "schedules"]
     });
+    for (const schedule of schedules) {
+      if ("rate" in schedule)
+        schedule.ratePerSecond = schedule.rate;
+    }
+    return schedules;
   }
   /**
    * Delete a schedule
@@ -1134,20 +1189,37 @@ var UrlGroups = class {
   }
 };
 
+// version.ts
+var VERSION = "v2.7.23";
+
 // src/client/client.ts
 var Client = class {
   http;
   token;
   constructor(config) {
     const environment = typeof process === "undefined" ? {} : process.env;
-    const baseUrl = config?.baseUrl ? config.baseUrl.replace(/\/$/, "") : environment.QSTASH_URL ?? "https://qstash.upstash.io";
+    let baseUrl = (config?.baseUrl ?? environment.QSTASH_URL ?? "https://qstash.upstash.io").replace(/\/$/, "");
+    if (baseUrl === "https://qstash.upstash.io/v2/publish") {
+      baseUrl = "https://qstash.upstash.io";
+    }
     const token = config?.token ?? environment.QSTASH_TOKEN;
+    const enableTelemetry = environment.UPSTASH_DISABLE_TELEMETRY ? false : config?.enableTelemetry ?? true;
+    const isCloudflare = typeof caches !== "undefined" && "default" in caches;
+    const telemetryHeaders = new Headers(
+      enableTelemetry ? {
+        "Upstash-Telemetry-Sdk": `upstash-qstash-js@${VERSION}`,
+        "Upstash-Telemetry-Platform": isCloudflare ? "cloudflare" : environment.VERCEL ? "vercel" : environment.AWS_REGION ? "aws" : "",
+        "Upstash-Telemetry-Runtime": getRuntime()
+      } : {}
+    );
     this.http = new HttpClient({
       retry: config?.retry,
       baseUrl,
       authorization: `Bearer ${token}`,
       //@ts-expect-error caused by undici and bunjs type overlap
-      headers: prefixHeaders(new Headers(config?.headers ?? {}))
+      headers: prefixHeaders(new Headers(config?.headers ?? {})),
+      //@ts-expect-error caused by undici and bunjs type overlap
+      telemetryHeaders
     });
     if (!token) {
       console.warn(
@@ -1229,7 +1301,8 @@ var Client = class {
   async publish(request) {
     const headers = wrapWithGlobalHeaders(
       processHeaders(request),
-      this.http.headers
+      this.http.headers,
+      this.http.telemetryHeaders
     );
     const response = await this.http.request({
       path: ["v2", "publish", getRequestPath(request)],
@@ -1260,7 +1333,11 @@ var Client = class {
   async batch(request) {
     const messages = [];
     for (const message of request) {
-      const headers = wrapWithGlobalHeaders(processHeaders(message), this.http.headers);
+      const headers = wrapWithGlobalHeaders(
+        processHeaders(message),
+        this.http.headers,
+        this.http.telemetryHeaders
+      );
       const headerEntries = Object.fromEntries(headers.entries());
       messages.push({
         destination: getRequestPath(message),
@@ -1315,7 +1392,7 @@ var Client = class {
    * }
    * ```
    */
-  async events(request) {
+  async logs(request) {
     const query = {};
     if (typeof request?.cursor === "number" && request.cursor > 0) {
       query.cursor = request.cursor.toString();
@@ -1337,16 +1414,42 @@ var Client = class {
       method: "GET",
       query
     });
+    const logs = responsePayload.events.map((event) => {
+      return {
+        ...event,
+        urlGroup: event.topicName
+      };
+    });
     return {
       cursor: responsePayload.cursor,
-      events: responsePayload.events.map((event) => {
-        return {
-          ...event,
-          urlGroup: event.topicName
-        };
-      })
+      logs,
+      events: logs
     };
   }
+  /**
+   * @deprecated Will be removed in the next major release. Use the `logs` method instead.
+   *
+   * Retrieve your logs.
+   *
+   * The logs endpoint is paginated and returns only 100 logs at a time.
+   * If you want to receive more logs, you can use the cursor to paginate.
+   *
+   * The cursor is a unix timestamp with millisecond precision
+   *
+   * @example
+   * ```ts
+   * let cursor = Date.now()
+   * const logs: Log[] = []
+   * while (cursor > 0) {
+   *   const res = await qstash.logs({ cursor })
+   *   logs.push(...res.logs)
+   *   cursor = res.cursor ?? 0
+   * }
+   * ```
+   */
+  async events(request) {
+    return await this.logs(request);
+  }
 };
 
 // src/client/workflow/constants.ts

package/workflow.mjs

@@ -6,7 +6,7 @@ import {
   WorkflowLogger,
   processOptions,
   serve
-} from "./chunk-QHCEWG63.mjs";
+} from "./chunk-G7CVCBTL.mjs";
 export {
   DisabledWorkflowContext,
   StepTypes,