rename events to logs

examples/solidjs/README.md

@@ -40,4 +40,4 @@ curl -X POST "https://qstash.upstash.io/v2/publish/<NGROK_URL>/api" \
   -d '{"message":"Hello, World!"}'
 ```
 
-Check the Events from QStash dashboard at Upstash Console to see that the request was completed successfully.
+Check the logs from QStash dashboard at Upstash Console to see that the request was completed successfully.

examples/svelte/README.md

@@ -40,4 +40,4 @@ curl -X POST "https://qstash.upstash.io/v2/publish/<NGROK_URL>/api" \
   -d '{"message":"Hello, World!"}'
 ```
 
-Check the Events from QStash dashboard at Upstash Console to see that the request was completed successfully.
+Check the logs from QStash dashboard at Upstash Console to see that the request was completed successfully.

src/client/client.ts

@@ -7,9 +7,9 @@ import { Queue } from "./queue";
 import { Schedules } from "./schedules";
 import type {
   BodyInit,
-  Event,
+  Log,
   FlowControl,
-  GetEventsPayload,
+  GetLogsPayload,
   HeadersInit,
   HTTPMethods,
   State,
@@ -260,12 +260,19 @@ export type PublishJsonRequest = Omit<PublishRequest, "body"> & {
   body: unknown;
 };
 
-export type EventsRequest = {
+export type LogsRequest = {
   cursor?: string | number;
-  filter?: EventsRequestFilter;
+  filter?: LogsRequestFilter;
 };
 
-type EventsRequestFilter = {
+/**
+ * Deprecated, use `LogsRequest` type instead.
+ *
+ * @deprecated
+ */
+export type EventsRequest = LogsRequest;
+
+type LogsRequestFilter = {
   messageId?: string;
   state?: State;
   url?: string;
@@ -279,11 +286,25 @@ type EventsRequestFilter = {
   count?: number;
 };
 
-export type GetEventsResponse = {
+export type GetLogsResponse = {
   cursor?: string;
-  events: Event[];
+  /**
+   * Deprecated, use the `logs` field instead.
+   *
+   * @deprecated
+   */
+  events: Log[];
+
+  logs: Log[];
 };
 
+/**
+ * Deprecated, use `GetLogsResponse` instead.
+ *
+ * @deprecated
+ */
+export type GetEventsResponse = GetLogsResponse;
+
 export type QueueRequest = {
   queueName?: string;
 };
@@ -500,7 +521,7 @@ export class Client {
    * }
    * ```
    */
-  public async events(request?: EventsRequest): Promise<GetEventsResponse> {
+  public async logs(request?: LogsRequest): Promise<GetLogsResponse> {
     const query: Record<string, string> = {};
 
     if (typeof request?.cursor === "number" && request.cursor > 0) {
@@ -521,21 +542,50 @@ export class Client {
       }
     }
 
-    const responsePayload = await this.http.request<GetEventsPayload>({
+    const responsePayload = await this.http.request<GetLogsPayload>({
       path: ["v2", "events"],
       method: "GET",
       query,
     });
+
+    const finalLogs = responsePayload.events.map((event) => {
+      return {
+        ...event,
+        urlGroup: event.topicName,
+      };
+    });
+
     return {
       cursor: responsePayload.cursor,
-      events: responsePayload.events.map((event) => {
-        return {
-          ...event,
-          urlGroup: event.topicName,
-        };
-      }),
+      logs: finalLogs,
+      events: finalLogs,
     };
   }
+
+  /**
+   * Deprecated, use the `logs` function instead.
+   *
+   * 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
+   * }
+   * ```
+   *
+   * @returns
+   */
+  public async events(request?: LogsRequest): Promise<GetLogsResponse> {
+    return this.logs(request);
+  }
 }
 
 export type PublishToApiResponse = {

src/client/logs.test.ts

@@ -0,0 +1,46 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { describe, expect, test } from "bun:test";
+import { Client } from "./client";
+import { parseCursor } from "./utils";
+
+describe("logs", () => {
+  const client = new Client({ token: process.env.QSTASH_TOKEN! });
+
+  test("should use cursor", async () => {
+    const result1 = await client.logs();
+
+    const result2 = await client.logs({ cursor: result1.cursor });
+
+    if (result1.cursor && result2.cursor) {
+      expect(parseCursor(result1.cursor).timestamp).toBeGreaterThan(
+        parseCursor(result2.cursor).timestamp
+      );
+    }
+  });
+
+  test("should have both events and logs fields", async () => {
+    const result = await client.logs();
+
+    expect(result).toHaveProperty("events");
+    expect(result).toHaveProperty("logs");
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    expect(result.events).toEqual(result.logs);
+  });
+
+  test("the old events field should still work", async () => {
+    const result = await client.events();
+
+    expect(result).toHaveProperty("events");
+    expect(result).toHaveProperty("logs");
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    expect(result.events).toEqual(result.logs);
+
+    const result2 = await client.events({ cursor: result.cursor });
+
+    if (result.cursor && result2.cursor) {
+      expect(parseCursor(result.cursor).timestamp).toBeGreaterThan(
+        parseCursor(result2.cursor).timestamp
+      );
+    }
+  });
+});

src/client/types.ts

@@ -2,7 +2,7 @@ export type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FA
 
 export type HTTPMethods = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
 
-export type Event = {
+export type Log = {
   time: number;
   state: State;
   messageId: string;
@@ -16,13 +16,35 @@ export type Event = {
   body?: string; // base64 encoded
 };
 
-export type EventPayload = Omit<Event, "urlGroup"> & { topicName: string };
+/**
+ * Deprecated, use the `Log` type instead
+ *
+ * @deprecated
+ */
+export type Event = Log;
 
-export type GetEventsPayload = {
+export type LogPayload = Omit<Log, "urlGroup"> & { topicName: string };
+
+/**
+ * Deprecated, use `LogPayload` instead
+ *
+ * @deprecated
+ */
+export type EventPayload = LogPayload;
+
+// The response returned from the QStash API
+export type GetLogsPayload = {
   cursor?: string;
-  events: EventPayload[];
+  events: LogPayload[];
 };
 
+/**
+ * Deprecated, use `GetLogsPayload` instead
+ *
+ * @deprecated
+ */
+export type GetEventsPayload = GetLogsPayload;
+
 export type WithCursor<T> = T & { cursor?: number };
 
 export type BodyInit = Blob | FormData | URLSearchParams | ReadableStream<Uint8Array> | string;