opik 0.0.1

package/src/opik/rest_api/core/fetcher/signals.ts

@@ -0,0 +1,38 @@
+const TIMEOUT = "timeout";
+
+export function getTimeoutSignal(timeoutMs: number): { signal: AbortSignal; abortId: NodeJS.Timeout } {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+export function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal {
+    // Allowing signals to be passed either as array
+    // of signals or as multiple arguments.
+    const signals = <AbortSignal[]>(args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
+
+    const controller = new AbortController();
+
+    for (const signal of signals) {
+        if (signal.aborted) {
+            // Exiting early if one of the signals
+            // is already aborted.
+            controller.abort((signal as any)?.reason);
+            break;
+        }
+
+        // Listening for signals and removing the listeners
+        // when at least one symbol is aborted.
+        signal.addEventListener("abort", () => controller.abort((signal as any)?.reason), {
+            signal: controller.signal,
+        });
+    }
+
+    return controller.signal;
+}

package/src/opik/rest_api/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.ts

@@ -0,0 +1,256 @@
+import type { Writable } from "readable-stream";
+import { EventCallback, StreamWrapper } from "./chooseStreamWrapper";
+
+export class Node18UniversalStreamWrapper<ReadFormat extends Uint8Array | Uint16Array | Uint32Array>
+    implements
+        StreamWrapper<Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>, ReadFormat>
+{
+    private readableStream: ReadableStream<ReadFormat>;
+    private reader: ReadableStreamDefaultReader<ReadFormat>;
+    private events: Record<string, EventCallback[] | undefined>;
+    private paused: boolean;
+    private resumeCallback: ((value?: unknown) => void) | null;
+    private encoding: string | null;
+
+    constructor(readableStream: ReadableStream<ReadFormat>) {
+        this.readableStream = readableStream;
+        this.reader = this.readableStream.getReader();
+        this.events = {
+            data: [],
+            end: [],
+            error: [],
+            readable: [],
+            close: [],
+            pause: [],
+            resume: [],
+        };
+        this.paused = false;
+        this.resumeCallback = null;
+        this.encoding = null;
+    }
+
+    public on(event: string, callback: EventCallback): void {
+        this.events[event]?.push(callback);
+    }
+
+    public off(event: string, callback: EventCallback): void {
+        this.events[event] = this.events[event]?.filter((cb) => cb !== callback);
+    }
+
+    public pipe(
+        dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>
+    ): Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat> {
+        this.on("data", async (chunk) => {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._write(chunk);
+            } else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            } else {
+                dest.write(chunk);
+            }
+        });
+
+        this.on("end", async () => {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._end();
+            } else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.close();
+            } else {
+                dest.end();
+            }
+        });
+
+        this.on("error", async (error) => {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._error(error);
+            } else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            } else {
+                dest.destroy(error);
+            }
+        });
+
+        this._startReading();
+
+        return dest;
+    }
+
+    public pipeTo(
+        dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>
+    ): Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat> {
+        return this.pipe(dest);
+    }
+
+    public unpipe(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): void {
+        this.off("data", async (chunk) => {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._write(chunk);
+            } else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            } else {
+                dest.write(chunk);
+            }
+        });
+
+        this.off("end", async () => {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._end();
+            } else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.close();
+            } else {
+                dest.end();
+            }
+        });
+
+        this.off("error", async (error) => {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._error(error);
+            } else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            } else {
+                dest.destroy(error);
+            }
+        });
+    }
+
+    public destroy(error?: Error): void {
+        this.reader
+            .cancel(error)
+            .then(() => {
+                this._emit("close");
+            })
+            .catch((err) => {
+                this._emit("error", err);
+            });
+    }
+
+    public pause(): void {
+        this.paused = true;
+        this._emit("pause");
+    }
+
+    public resume(): void {
+        if (this.paused) {
+            this.paused = false;
+            this._emit("resume");
+            if (this.resumeCallback) {
+                this.resumeCallback();
+                this.resumeCallback = null;
+            }
+        }
+    }
+
+    public get isPaused(): boolean {
+        return this.paused;
+    }
+
+    public async read(): Promise<ReadFormat | undefined> {
+        if (this.paused) {
+            await new Promise((resolve) => {
+                this.resumeCallback = resolve;
+            });
+        }
+        const { done, value } = await this.reader.read();
+
+        if (done) {
+            return undefined;
+        }
+        return value;
+    }
+
+    public setEncoding(encoding: string): void {
+        this.encoding = encoding;
+    }
+
+    public async text(): Promise<string> {
+        const chunks: ReadFormat[] = [];
+
+        while (true) {
+            const { done, value } = await this.reader.read();
+            if (done) {
+                break;
+            }
+            if (value) {
+                chunks.push(value);
+            }
+        }
+
+        const decoder = new TextDecoder(this.encoding || "utf-8");
+        return decoder.decode(await new Blob(chunks).arrayBuffer());
+    }
+
+    public async json<T>(): Promise<T> {
+        const text = await this.text();
+        return JSON.parse(text);
+    }
+
+    private _write(chunk: ReadFormat): void {
+        this._emit("data", chunk);
+    }
+
+    private _end(): void {
+        this._emit("end");
+    }
+
+    private _error(error: any): void {
+        this._emit("error", error);
+    }
+
+    private _emit(event: string, data?: any): void {
+        if (this.events[event]) {
+            for (const callback of this.events[event] || []) {
+                callback(data);
+            }
+        }
+    }
+
+    private async _startReading(): Promise<void> {
+        try {
+            this._emit("readable");
+            while (true) {
+                if (this.paused) {
+                    await new Promise((resolve) => {
+                        this.resumeCallback = resolve;
+                    });
+                }
+                const { done, value } = await this.reader.read();
+                if (done) {
+                    this._emit("end");
+                    this._emit("close");
+                    break;
+                }
+                if (value) {
+                    this._emit("data", value);
+                }
+            }
+        } catch (error) {
+            this._emit("error", error);
+        }
+    }
+
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat> {
+        return {
+            next: async () => {
+                if (this.paused) {
+                    await new Promise((resolve) => {
+                        this.resumeCallback = resolve;
+                    });
+                }
+                const { done, value } = await this.reader.read();
+                if (done) {
+                    return { done: true, value: undefined };
+                }
+                return { done: false, value };
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+}

package/src/opik/rest_api/core/fetcher/stream-wrappers/NodePre18StreamWrapper.ts

@@ -0,0 +1,106 @@
+import type { Readable, Writable } from "readable-stream";
+import { EventCallback, StreamWrapper } from "./chooseStreamWrapper";
+
+export class NodePre18StreamWrapper implements StreamWrapper<Writable, Buffer> {
+    private readableStream: Readable;
+    private encoding: string | undefined;
+
+    constructor(readableStream: Readable) {
+        this.readableStream = readableStream;
+    }
+
+    public on(event: string, callback: EventCallback): void {
+        this.readableStream.on(event, callback);
+    }
+
+    public off(event: string, callback: EventCallback): void {
+        this.readableStream.off(event, callback);
+    }
+
+    public pipe(dest: Writable): Writable {
+        this.readableStream.pipe(dest);
+        return dest;
+    }
+
+    public pipeTo(dest: Writable): Writable {
+        return this.pipe(dest);
+    }
+
+    public unpipe(dest?: Writable): void {
+        if (dest) {
+            this.readableStream.unpipe(dest);
+        } else {
+            this.readableStream.unpipe();
+        }
+    }
+
+    public destroy(error?: Error): void {
+        this.readableStream.destroy(error);
+    }
+
+    public pause(): void {
+        this.readableStream.pause();
+    }
+
+    public resume(): void {
+        this.readableStream.resume();
+    }
+
+    public get isPaused(): boolean {
+        return this.readableStream.isPaused();
+    }
+
+    public async read(): Promise<Buffer | undefined> {
+        return new Promise((resolve, reject) => {
+            const chunk = this.readableStream.read();
+            if (chunk) {
+                resolve(chunk);
+            } else {
+                this.readableStream.once("readable", () => {
+                    const chunk = this.readableStream.read();
+                    resolve(chunk);
+                });
+                this.readableStream.once("error", reject);
+            }
+        });
+    }
+
+    public setEncoding(encoding?: string): void {
+        this.readableStream.setEncoding(encoding as BufferEncoding);
+        this.encoding = encoding;
+    }
+
+    public async text(): Promise<string> {
+        const chunks: Uint8Array[] = [];
+        const encoder = new TextEncoder();
+        this.readableStream.setEncoding((this.encoding || "utf-8") as BufferEncoding);
+
+        for await (const chunk of this.readableStream) {
+            chunks.push(encoder.encode(chunk));
+        }
+
+        const decoder = new TextDecoder(this.encoding || "utf-8");
+        return decoder.decode(Buffer.concat(chunks));
+    }
+
+    public async json<T>(): Promise<T> {
+        const text = await this.text();
+        return JSON.parse(text);
+    }
+
+    public [Symbol.asyncIterator](): AsyncIterableIterator<Buffer> {
+        const readableStream = this.readableStream;
+        const iterator = readableStream[Symbol.asyncIterator]();
+
+        // Create and return an async iterator that yields buffers
+        return {
+            async next(): Promise<IteratorResult<Buffer>> {
+                const { value, done } = await iterator.next();
+                return { value: value as Buffer, done };
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+}

package/src/opik/rest_api/core/fetcher/stream-wrappers/UndiciStreamWrapper.ts

@@ -0,0 +1,243 @@
+import { StreamWrapper } from "./chooseStreamWrapper";
+
+type EventCallback = (data?: any) => void;
+
+export class UndiciStreamWrapper<ReadFormat extends Uint8Array | Uint16Array | Uint32Array>
+    implements StreamWrapper<UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>, ReadFormat>
+{
+    private readableStream: ReadableStream<ReadFormat>;
+    private reader: ReadableStreamDefaultReader<ReadFormat>;
+    private events: Record<string, EventCallback[] | undefined>;
+    private paused: boolean;
+    private resumeCallback: ((value?: unknown) => void) | null;
+    private encoding: string | null;
+
+    constructor(readableStream: ReadableStream<ReadFormat>) {
+        this.readableStream = readableStream;
+        this.reader = this.readableStream.getReader();
+        this.events = {
+            data: [],
+            end: [],
+            error: [],
+            readable: [],
+            close: [],
+            pause: [],
+            resume: [],
+        };
+        this.paused = false;
+        this.resumeCallback = null;
+        this.encoding = null;
+    }
+
+    public on(event: string, callback: EventCallback): void {
+        this.events[event]?.push(callback);
+    }
+
+    public off(event: string, callback: EventCallback): void {
+        this.events[event] = this.events[event]?.filter((cb) => cb !== callback);
+    }
+
+    public pipe(
+        dest: UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>
+    ): UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat> {
+        this.on("data", (chunk) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._write(chunk);
+            } else {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            }
+        });
+
+        this.on("end", () => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._end();
+            } else {
+                const writer = dest.getWriter();
+                writer.close();
+            }
+        });
+
+        this.on("error", (error) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._error(error);
+            } else {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            }
+        });
+
+        this._startReading();
+
+        return dest;
+    }
+
+    public pipeTo(
+        dest: UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>
+    ): UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat> {
+        return this.pipe(dest);
+    }
+
+    public unpipe(dest: UndiciStreamWrapper<ReadFormat> | WritableStream): void {
+        this.off("data", (chunk) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._write(chunk);
+            } else {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            }
+        });
+
+        this.off("end", () => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._end();
+            } else {
+                const writer = dest.getWriter();
+                writer.close();
+            }
+        });
+
+        this.off("error", (error) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._error(error);
+            } else {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            }
+        });
+    }
+
+    public destroy(error?: Error): void {
+        this.reader
+            .cancel(error)
+            .then(() => {
+                this._emit("close");
+            })
+            .catch((err) => {
+                this._emit("error", err);
+            });
+    }
+
+    public pause(): void {
+        this.paused = true;
+        this._emit("pause");
+    }
+
+    public resume(): void {
+        if (this.paused) {
+            this.paused = false;
+            this._emit("resume");
+            if (this.resumeCallback) {
+                this.resumeCallback();
+                this.resumeCallback = null;
+            }
+        }
+    }
+
+    public get isPaused(): boolean {
+        return this.paused;
+    }
+
+    public async read(): Promise<ReadFormat | undefined> {
+        if (this.paused) {
+            await new Promise((resolve) => {
+                this.resumeCallback = resolve;
+            });
+        }
+        const { done, value } = await this.reader.read();
+        if (done) {
+            return undefined;
+        }
+        return value;
+    }
+
+    public setEncoding(encoding: string): void {
+        this.encoding = encoding;
+    }
+
+    public async text(): Promise<string> {
+        const chunks: BlobPart[] = [];
+
+        while (true) {
+            const { done, value } = await this.reader.read();
+            if (done) {
+                break;
+            }
+            if (value) {
+                chunks.push(value);
+            }
+        }
+
+        const decoder = new TextDecoder(this.encoding || "utf-8");
+        return decoder.decode(await new Blob(chunks).arrayBuffer());
+    }
+
+    public async json<T>(): Promise<T> {
+        const text = await this.text();
+        return JSON.parse(text);
+    }
+
+    private _write(chunk: ReadFormat): void {
+        this._emit("data", chunk);
+    }
+
+    private _end(): void {
+        this._emit("end");
+    }
+
+    private _error(error: any): void {
+        this._emit("error", error);
+    }
+
+    private _emit(event: string, data?: any): void {
+        if (this.events[event]) {
+            for (const callback of this.events[event] || []) {
+                callback(data);
+            }
+        }
+    }
+
+    private async _startReading(): Promise<void> {
+        try {
+            this._emit("readable");
+            while (true) {
+                if (this.paused) {
+                    await new Promise((resolve) => {
+                        this.resumeCallback = resolve;
+                    });
+                }
+                const { done, value } = await this.reader.read();
+                if (done) {
+                    this._emit("end");
+                    this._emit("close");
+                    break;
+                }
+                if (value) {
+                    this._emit("data", value);
+                }
+            }
+        } catch (error) {
+            this._emit("error", error);
+        }
+    }
+
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat> {
+        return {
+            next: async () => {
+                if (this.paused) {
+                    await new Promise((resolve) => {
+                        this.resumeCallback = resolve;
+                    });
+                }
+                const { done, value } = await this.reader.read();
+                if (done) {
+                    return { done: true, value: undefined };
+                }
+                return { done: false, value };
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+}

package/src/opik/rest_api/core/fetcher/stream-wrappers/chooseStreamWrapper.ts

@@ -0,0 +1,33 @@
+import type { Readable } from "readable-stream";
+import { RUNTIME } from "../../runtime";
+
+export type EventCallback = (data?: any) => void;
+
+export interface StreamWrapper<WritableStream, ReadFormat> {
+    setEncoding(encoding?: string): void;
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: WritableStream): WritableStream;
+    pipeTo(dest: WritableStream): WritableStream;
+    unpipe(dest?: WritableStream): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<ReadFormat | undefined>;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
+}
+
+export async function chooseStreamWrapper(responseBody: any): Promise<Promise<StreamWrapper<any, any>>> {
+    if (RUNTIME.type === "node" && RUNTIME.parsedVersion != null && RUNTIME.parsedVersion >= 18) {
+        return new (await import("./Node18UniversalStreamWrapper")).Node18UniversalStreamWrapper(
+            responseBody as ReadableStream
+        );
+    } else if (RUNTIME.type !== "node" && typeof fetch === "function") {
+        return new (await import("./UndiciStreamWrapper")).UndiciStreamWrapper(responseBody as ReadableStream);
+    } else {
+        return new (await import("./NodePre18StreamWrapper")).NodePre18StreamWrapper(responseBody as Readable);
+    }
+}

package/src/opik/rest_api/core/index.ts

@@ -0,0 +1,4 @@
+export * from "./fetcher";
+export * from "./runtime";
+export * from "./api-promise";
+export * as serialization from "./schemas";

package/src/opik/rest_api/core/runtime/index.ts

@@ -0,0 +1 @@
+export { RUNTIME } from "./runtime";