Switch to replicate.stream in Bun integration test

.github/workflows/ci.yml

@@ -139,4 +139,4 @@ jobs:
           cd integration/${{ matrix.suite }}
           bun uninstall replicate
           bun install "file:../../${{ needs.build.outputs.tarball-name }}"
-          bun test
+          bun test --timeout 30000

README.md

@@ -110,7 +110,7 @@ app.get('/webhooks/replicate', async (c) => {
   const prediction = await c.req.json();
 	console.log(prediction);
   //=> {"id": "xyz", "status": "successful", ... }
-  
+
   // Acknowledge the webhook.
   c.status(200);
   c.json({ok: true});
@@ -217,15 +217,15 @@ Run a model and await the result. Unlike [`replicate.prediction.create`](#replic
 const output = await replicate.run(identifier, options, progress);
 ```
 
-| name                            | type     | description                                                                                                                                                                                                |
-| ------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `identifier`                    | string   | **Required**. The model version identifier in the format `{owner}/{name}:{version}`, for example `stability-ai/sdxl:8beff3369e81422112d93b89ca01426147de542cd4684c244b673b105188fe5f`                      |
-| `options.input`                 | object   | **Required**. An object with the model inputs.                                                                                                                                                             |
-| `options.wait`                  | object   | Options for waiting for the prediction to finish                                                                                                                                                           |
-| `options.wait.interval`         | number   | Polling interval in milliseconds. Defaults to 500                                                                                                                                                          |
-| `options.webhook`               | string   | An HTTPS URL for receiving a webhook when the prediction has new output                                                                                                                                    |
-| `options.webhook_events_filter` | string[] | An array of events which should trigger [webhooks](https://replicate.com/docs/webhooks). Allowable values are `start`, `output`, `logs`, and `completed`                                                   |
-| `options.signal`                | object   | An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the prediction                                                                                                    |
+| name                            | type     | description                                                                                                                                                                                                 |
+| ------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `identifier`                    | string   | **Required**. The model version identifier in the format `{owner}/{name}:{version}`, for example `stability-ai/sdxl:8beff3369e81422112d93b89ca01426147de542cd4684c244b673b105188fe5f`                       |
+| `options.input`                 | object   | **Required**. An object with the model inputs.                                                                                                                                                              |
+| `options.wait`                  | object   | Options for waiting for the prediction to finish                                                                                                                                                            |
+| `options.wait.interval`         | number   | Polling interval in milliseconds. Defaults to 500                                                                                                                                                           |
+| `options.webhook`               | string   | An HTTPS URL for receiving a webhook when the prediction has new output                                                                                                                                     |
+| `options.webhook_events_filter` | string[] | An array of events which should trigger [webhooks](https://replicate.com/docs/webhooks). Allowable values are `start`, `output`, `logs`, and `completed`                                                    |
+| `options.signal`                | object   | An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the prediction                                                                                                     |
 | `progress`                      | function | Callback function that receives the prediction object as it's updated. The function is called when the prediction is created, each time it's updated while polling for completion, and when it's completed. |
 
 Throws `Error` if the prediction failed.
@@ -246,7 +246,7 @@ Example that logs progress as the model is running:
 const model = "stability-ai/sdxl:8beff3369e81422112d93b89ca01426147de542cd4684c244b673b105188fe5f";
 const input = { prompt: "a 19th century portrait of a raccoon gentleman wearing a suit" };
 const onProgress = (prediction) => {
-   const last_log_line = prediction.logs.split("\n").pop() 
+   const last_log_line = prediction.logs.split("\n").pop()
    console.log({id: prediction.id, log: last_log_line})
 }
 const output = await replicate.run(model, { input }, onProgress)
@@ -875,6 +875,21 @@ The `Replicate` constructor and all `replicate.*` methods are fully typed.
 
 We have a few dependencies that have been bundled into the vendor directory rather than adding external npm dependencies.
 
-These have been generated using bundlejs.com and copied into the appropriate directory along with the license and repository information. 
+These have been generated using bundlejs.com and copied into the appropriate directory along with the license and repository information.
 
 * [eventsource-parser/stream](https://bundlejs.com/?bundle&q=eventsource-parser%40latest%2Fstream&config=%7B%22esbuild%22%3A%7B%22format%22%3A%22cjs%22%2C%22minify%22%3Afalse%2C%22platform%22%3A%22neutral%22%7D%7D)
+* [streams-text-encoding/text-decoder-stream](https://bundlejs.com/?q=%40stardazed%2Fstreams-text-encoding&treeshake=%5B%7B+TextDecoderStream+%7D%5D&config=%7B%22esbuild%22%3A%7B%22format%22%3A%22cjs%22%2C%22minify%22%3Afalse%7D%7D)
+
+> [!NOTE]
+> The vendored implementation of `TextDecoderStream` requires
+> the following patch to be applied to the output of bundlejs.com:
+>
+> ```diff
+>   constructor(label, options) {
+> -   this[decDecoder] = new TextDecoder(label, options);
+> -   this[decTransform] = new TransformStream(new TextDecodeTransformer(this[decDecoder]));
+> +   const decoder = new TextDecoder(label || "utf-8", options || {});
+> +   this[decDecoder] = decoder;
+> +   this[decTransform] = new TransformStream(new TextDecodeTransformer(decoder));
+>   }
+> ```

integration/bun/index.test.ts

@@ -19,5 +19,5 @@ import type {
 
 test("main", async () => {
   const output = await main();
-  expect(output as any).toEqual("hello Brünnhilde Bun");
+  expect(output).toContain("Brünnhilde Bun");
 });

integration/bun/index.ts

@@ -5,12 +5,20 @@ const replicate = new Replicate({
 });
 
 export default async function main() {
-  return await replicate.run(
-    "replicate/hello-world:5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa",
-    {
-      input: {
-        text: "Brünnhilde Bun",
-      },
+  const model =
+    "replicate/canary:30e22229542eb3f79d4f945dacb58d32001b02cc313ae6f54eef27904edf3272";
+  const options = {
+    input: {
+      text: "Brünnhilde Bun",
+    },
+  };
+  const output = [];
+
+  for await (const { event, data } of replicate.stream(model, options)) {
+    if (event === "output") {
+      output.push(data);
     }
-  );
+  }
+
+  return output.join("").trim();
 }

lib/stream.js

@@ -4,6 +4,10 @@ const ApiError = require("./error");
 const {
   EventSourceParserStream,
 } = require("../vendor/eventsource-parser/stream");
+const { TextDecoderStream } =
+  typeof globalThis.TextDecoderStream === "undefined"
+    ? require("../vendor/streams-text-encoding/text-decoder-stream")
+    : globalThis;
 
 /**
  * A server-sent event.

vendor/streams-text-encoding/text-decoder-stream.js

@@ -0,0 +1,95 @@
+// Adapted from https://github.com/stardazed/sd-streams
+//
+// MIT License
+//
+// Copyright (c) 2018-Present @zenmumbler
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// /input.ts
+var input_exports = {};
+__export(input_exports, {
+  TextDecoderStream: () => TextDecoderStream
+});
+module.exports = __toCommonJS(input_exports);
+
+// http-url:https://unpkg.com/@stardazed/[email protected]/dist/sd-streams-text-encoding.esm.js
+var decDecoder = Symbol("decDecoder");
+var decTransform = Symbol("decTransform");
+var TextDecodeTransformer = class {
+  constructor(decoder) {
+    this.decoder_ = decoder;
+  }
+  transform(chunk, controller) {
+    if (!(chunk instanceof ArrayBuffer || ArrayBuffer.isView(chunk))) {
+      throw new TypeError("Input data must be a BufferSource");
+    }
+    const text = this.decoder_.decode(chunk, { stream: true });
+    if (text.length !== 0) {
+      controller.enqueue(text);
+    }
+  }
+  flush(controller) {
+    const text = this.decoder_.decode();
+    if (text.length !== 0) {
+      controller.enqueue(text);
+    }
+  }
+};
+var TextDecoderStream = class {
+  constructor(label, options) {
+    const decoder = new TextDecoder(label || "utf-8", options || {});
+    this[decDecoder] = decoder;
+    this[decTransform] = new TransformStream(new TextDecodeTransformer(decoder));
+  }
+  get encoding() {
+    return this[decDecoder].encoding;
+  }
+  get fatal() {
+    return this[decDecoder].fatal;
+  }
+  get ignoreBOM() {
+    return this[decDecoder].ignoreBOM;
+  }
+  get readable() {
+    return this[decTransform].readable;
+  }
+  get writable() {
+    return this[decTransform].writable;
+  }
+};
+var encEncoder = Symbol("encEncoder");
+var encTransform = Symbol("encTransform");