Extract signal property from the run() options

aron · aron · commit 9f1a89cb20f5 · 2024-05-02T13:14:33.000+01:00
This prevents it being passed to the backend as part of the body. The backend has recently started validating the body payload so this is now resulting as an API error. Fixes replicate#249
diff --git a/index.js b/index.js
@@ -129,7 +129,7 @@ class Replicate {
    * @returns {Promise<object>} - Resolves with the output of running the model
    */
   async run(ref, options, progress) {
-    const { wait, ...data } = options;
+    const { wait, signal, ...data } = options;
 
     const identifier = ModelVersionIdentifier.parse(ref);
 
@@ -153,8 +153,6 @@ class Replicate {
       progress(prediction);
     }
 
-    const { signal } = options;
-
     prediction = await this.wait(
       prediction,
       wait || {},
diff --git a/index.test.ts b/index.test.ts
@@ -1233,11 +1233,14 @@ describe("Replicate client", () => {
     test("Aborts the operation when abort signal is invoked", async () => {
       const controller = new AbortController();
       const { signal } = controller;
+      let body: Record<string, unknown> | undefined;
 
       const scope = nock(BASE_URL)
-        .post("/predictions", (body) => {
+        .post("/predictions", (_body) => {
+          // Should not pass the signal object in the body.
+          body = _body;
           controller.abort();
-          return body;
+          return _body;
         })
         .reply(201, {
           id: "ufawqhfynnddngldkgtslldrkq",
@@ -1263,7 +1266,10 @@ describe("Replicate client", () => {
         }
       );
 
+      expect(body).toBeDefined();
+      expect(body?.["signal"]).toBeUndefined();
       expect(signal.aborted).toBe(true);
+      expect(output).toBeUndefined();
 
       scope.done();
     });
