Return event IDs when sending events

.changeset/unlucky-snails-attack.md

@@ -0,0 +1,5 @@
+---
+"inngest": minor
+---
+
+Return event IDs when sending events using `inngest.send()` and `step.sendEvent()`

etc/inngest.api.md

@@ -106,9 +106,9 @@ export class Inngest<Events extends Record<string, EventPayload> = Record<string
     readonly name: string;
     // Warning: (ae-forgotten-export) The symbol "SingleOrArray" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "PartialK" needs to be exported by the entry point index.d.ts
-    send<Event extends keyof Events>(name: Event, payload: SingleOrArray<PartialK<Omit<Events[Event], "name" | "v">, "ts">>): Promise<void>;
+    send<Event extends keyof Events>(name: Event, payload: SingleOrArray<PartialK<Omit<Events[Event], "name" | "v">, "ts">>): Promise<string[]>;
     // Warning: (ae-forgotten-export) The symbol "SendEventPayload" needs to be exported by the entry point index.d.ts
-    send<Payload extends SendEventPayload<Events>>(payload: Payload): Promise<void>;
+    send<Payload extends SendEventPayload<Events>>(payload: Payload): Promise<string[]>;
     setEventKey(
     eventKey: string): void;
 }

src/components/Inngest.test.ts

@@ -59,10 +59,14 @@ describe("send", () => {
     beforeAll(() => {
       // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       global.fetch = jest.fn(
-        () =>
+        (input: unknown) =>
           Promise.resolve({
             status: 200,
-            json: () => Promise.resolve({}),
+            json: () =>
+              Promise.resolve({
+                ids: Array.isArray(input) ? input.map((_, i) => `${i}`) : ["0"],
+                status: 200,
+              }),
           })
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
       ) as any;
@@ -90,7 +94,7 @@ describe("send", () => {
     test("should succeed if event key specified at instantiation", async () => {
       const inngest = createClient({ name: "test", eventKey: testEventKey });
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
 
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
@@ -105,7 +109,7 @@ describe("send", () => {
       process.env[envKeys.EventKey] = testEventKey;
       const inngest = createClient({ name: "test" });
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
 
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
@@ -120,7 +124,7 @@ describe("send", () => {
       const inngest = createClient({ name: "test" });
       inngest.setEventKey(testEventKey);
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
 
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
@@ -135,15 +139,15 @@ describe("send", () => {
       const inngest = createClient({ name: "test" });
       inngest.setEventKey(testEventKey);
 
-      await expect(inngest.send("test", [])).resolves.toBeUndefined();
+      await expect(inngest.send("test", [])).resolves.toEqual([]);
       expect(global.fetch).not.toHaveBeenCalled();
     });
 
     test("should succeed if an empty list of payloads is given", async () => {
       const inngest = createClient({ name: "test" });
       inngest.setEventKey(testEventKey);
 
-      await expect(inngest.send([])).resolves.toBeUndefined();
+      await expect(inngest.send([])).resolves.toEqual([]);
       expect(global.fetch).not.toHaveBeenCalled();
     });
 
@@ -154,7 +158,7 @@ describe("send", () => {
         env: "foo",
       });
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
         expect.objectContaining({
@@ -175,7 +179,7 @@ describe("send", () => {
         eventKey: testEventKey,
       });
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
         expect.objectContaining({
@@ -197,7 +201,7 @@ describe("send", () => {
         env: "foo",
       });
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
         expect.objectContaining({
@@ -218,7 +222,7 @@ describe("send", () => {
         eventKey: testEventKey,
       });
 
-      await expect(inngest.send(testEvent)).resolves.toBeUndefined();
+      await expect(inngest.send(testEvent)).resolves.toEqual(["0"]);
       expect(global.fetch).toHaveBeenCalledWith(
         expect.stringContaining(`/e/${testEventKey}`),
         expect.objectContaining({

src/components/Inngest.ts

@@ -1,3 +1,4 @@
+import { z } from "zod";
 import { envKeys } from "../helpers/consts";
 import { devServerAvailable, devServerUrl } from "../helpers/devserver";
 import {
@@ -148,7 +149,7 @@ export class Inngest<
   /**
    * Given a response from Inngest, relay the error to the caller.
    */
-  async #getResponseError(response: globalThis.Response): Promise<Error> {
+  #getResponseError(response: globalThis.Response, rawBody: unknown): Error {
     let errorMessage = "Unknown error";
     switch (response.status) {
       case 401:
@@ -164,7 +165,7 @@ export class Inngest<
         errorMessage = "Event key not found";
         break;
       case 406:
-        errorMessage = `${JSON.stringify(await response.json())}`;
+        errorMessage = `${JSON.stringify(rawBody)}`;
         break;
       case 409:
       case 412:
@@ -224,7 +225,7 @@ export class Inngest<
   public async send<Event extends keyof Events>(
     name: Event,
     payload: SingleOrArray<PartialK<Omit<Events[Event], "name" | "v">, "ts">>
-  ): Promise<void>;
+  ): Promise<string[]>;
   /**
    * Send one or many events to Inngest. Takes an entire payload (including
    * name) as each input.
@@ -251,7 +252,7 @@ export class Inngest<
    */
   public async send<Payload extends SendEventPayload<Events>>(
     payload: Payload
-  ): Promise<void>;
+  ): Promise<string[]>;
   public async send<Event extends keyof Events>(
     nameOrPayload:
       | Event
@@ -263,7 +264,7 @@ export class Inngest<
     maybePayload?: SingleOrArray<
       PartialK<Omit<Events[Event], "name" | "v">, "ts">
     >
-  ): Promise<void> {
+  ): Promise<string[]> {
     if (!this.eventKey) {
       throw new Error(
         prettyError({
@@ -306,7 +307,7 @@ export class Inngest<
      * happens, show a warning that this may not be intended, but don't throw.
      */
     if (!payloads.length) {
-      return console.warn(
+      console.warn(
         prettyError({
           type: "warn",
           whatHappened: "`inngest.send()` called with no events",
@@ -317,6 +318,8 @@ export class Inngest<
           stack: true,
         })
       );
+
+      return [];
     }
 
     // When sending events, check if the dev server is available.  If so, use the
@@ -339,11 +342,22 @@ export class Inngest<
       headers: { ...this.headers },
     });
 
-    if (response.status >= 200 && response.status < 300) {
-      return;
-    }
+    let rawBody: unknown;
+
+    try {
+      rawBody = await response.json();
 
-    throw await this.#getResponseError(response);
+      const body = await z
+        .object({
+          ids: z.array(z.string()),
+          status: z.number().min(200).max(299),
+        })
+        .parseAsync(rawBody);
+
+      return body.ids;
+    } catch (err) {
+      throw this.#getResponseError(response, rawBody);
+    }
   }
 
   public createFunction<

src/components/InngestStepTools.test.ts

@@ -244,8 +244,15 @@ describe("sleepUntil", () => {
 
 describe("sendEvent", () => {
   describe("runtime", () => {
-    const fetchMock = jest.fn(() =>
-      Promise.resolve({ status: 200 })
+    const fetchMock = jest.fn((input: unknown) =>
+      Promise.resolve({
+        status: 200,
+        json: () =>
+          Promise.resolve({
+            ids: Array.isArray(input) ? input.map((_, i) => `${i}`) : ["0"],
+            status: 200,
+          }),
+      })
     ) as unknown as typeof fetch;
 
     const client = createClient({

src/components/InngestStepTools.ts

@@ -265,15 +265,15 @@ export const createStepTools = <
      * Returns a promise that will resolve once the event has been sent.
      */
     sendEvent: createTool<{
-      <Payload extends SendEventPayload<Events>>(
-        payload: Payload
-      ): Promise<void>;
+      <Payload extends SendEventPayload<Events>>(payload: Payload): ReturnType<
+        Inngest["send"]
+      >;
       <Event extends keyof Events & string>(
         name: Event,
         payload: SingleOrArray<
           PartialK<Omit<Events[Event], "name" | "v">, "ts">
         >
-      ): Promise<void>;
+      ): ReturnType<Inngest["send"]>;
     }>(
       (nameOrPayload, maybePayload) => {
         let payloads: ValueOf<Events>[];