@replit/river 0.7.0 → 0.7.2

package/README.md

@@ -10,8 +10,10 @@ It's like tRPC but...
 
 ## Developing
 
+[![Run on Repl.it](https://replit.com/badge/github/replit/river)](https://replit.com/new/github/replit/river)
+
 - `npm i` -- install dependencies
-- `npm check` -- lint
-- `npm format` -- format
-- `npm test` -- run tests
-- `npm publish` -- cut a new release (should bump version in package.json first)
+- `npm run check` -- lint
+- `npm run format` -- format
+- `npm run test` -- run tests
+- `npm run publish` -- cut a new release (should bump version in package.json first)

package/dist/codec/index.d.ts

@@ -1,3 +1,4 @@
+export { BinaryCodec } from './binary';
 export { NaiveJsonCodec } from './json';
 export type { Codec } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/codec/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../codec/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../codec/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC"}

package/dist/codec/index.js

@@ -1 +1,2 @@
+export { BinaryCodec } from './binary';
 export { NaiveJsonCodec } from './json';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@replit/river",
   "sideEffects": false,
   "description": "It's like tRPC but... with JSON Schema Support, duplex streaming and support for service multiplexing. Transport agnostic!",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "type": "module",
   "exports": {
     ".": "./dist/router/index.js",
@@ -27,17 +27,19 @@
   },
   "devDependencies": {
     "@types/ws": "^8.5.5",
+    "@vitest/ui": "^1.0.1",
     "prettier": "^3.0.0",
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
-    "vitest": "^0.34.6"
+    "vitest": "^1.0.1"
   },
   "scripts": {
     "check": "tsc --noEmit && npx prettier . --check",
     "format": "npx prettier . --write",
-    "build": "tsc",
+    "build": "rm -rf ./dist && tsc",
     "prepack": "npm run build",
     "release": "npm publish --access public",
+    "test:ui": "echo \"remember to go to /__vitest__ in the webview\" && vitest --ui --api.host 0.0.0.0 --api.port 3000",
     "test": "vitest",
     "bench": "vitest bench"
   },

package/dist/__tests__/integration.test.d.ts

@@ -1,50 +0,0 @@
-export declare const EchoRequest: import("@sinclair/typebox").TObject<{
-    msg: import("@sinclair/typebox").TString;
-    ignore: import("@sinclair/typebox").TBoolean;
-}>;
-export declare const EchoResponse: import("@sinclair/typebox").TObject<{
-    response: import("@sinclair/typebox").TString;
-}>;
-export declare const TestServiceConstructor: () => {
-    name: "test";
-    state: {
-        count: number;
-    };
-    procedures: {
-        add: {
-            input: import("@sinclair/typebox").TObject<{
-                n: import("@sinclair/typebox").TNumber;
-            }>;
-            output: import("@sinclair/typebox").TObject<{
-                result: import("@sinclair/typebox").TNumber;
-            }>;
-            handler: (context: import("../router").ServiceContextWithState<{
-                count: number;
-            }>, input: import("../transport/message").TransportMessage<{
-                n: number;
-            }>) => Promise<import("../transport/message").TransportMessage<{
-                result: number;
-            }>>;
-            type: "rpc";
-        };
-    } & {
-        echo: {
-            input: import("@sinclair/typebox").TObject<{
-                msg: import("@sinclair/typebox").TString;
-                ignore: import("@sinclair/typebox").TBoolean;
-            }>;
-            output: import("@sinclair/typebox").TObject<{
-                response: import("@sinclair/typebox").TString;
-            }>;
-            handler: (context: import("../router").ServiceContextWithState<{
-                count: number;
-            }>, input: AsyncIterable<import("../transport/message").TransportMessage<{
-                msg: string;
-                ignore: boolean;
-            }>>, output: import("it-pushable").Pushable<import("../transport/message").TransportMessage<{
-                response: string;
-            }>, void, unknown>) => Promise<void>;
-            type: "stream";
-        };
-    };
-};

package/dist/__tests__/integration.test.js

@@ -1,193 +0,0 @@
-import http from 'http';
-import { Type } from '@sinclair/typebox';
-import { ServiceBuilder, serializeService } from '../router/builder';
-import { reply } from '../transport/message';
-import { afterAll, describe, expect, test } from 'vitest';
-import { createWebSocketServer, createWsTransports, onServerReady, asClientRpc, asClientStream, } from '../testUtils';
-import { createServer } from '../router/server';
-import { createClient } from '../router/client';
-export const EchoRequest = Type.Object({
-    msg: Type.String(),
-    ignore: Type.Boolean(),
-});
-export const EchoResponse = Type.Object({ response: Type.String() });
-export const TestServiceConstructor = () => ServiceBuilder.create('test')
-    .initialState({
-    count: 0,
-})
-    .defineProcedure('add', {
-    type: 'rpc',
-    input: Type.Object({ n: Type.Number() }),
-    output: Type.Object({ result: Type.Number() }),
-    async handler(ctx, msg) {
-        const { n } = msg.payload;
-        ctx.state.count += n;
-        return reply(msg, { result: ctx.state.count });
-    },
-})
-    .defineProcedure('echo', {
-    type: 'stream',
-    input: EchoRequest,
-    output: EchoResponse,
-    async handler(_ctx, msgStream, returnStream) {
-        for await (const msg of msgStream) {
-            const req = msg.payload;
-            if (!req.ignore) {
-                returnStream.push(reply(msg, { response: req.msg }));
-            }
-        }
-    },
-})
-    .finalize();
-const OrderingServiceConstructor = () => ServiceBuilder.create('test')
-    .initialState({
-    msgs: [],
-})
-    .defineProcedure('add', {
-    type: 'rpc',
-    input: Type.Object({ n: Type.Number() }),
-    output: Type.Object({ ok: Type.Boolean() }),
-    async handler(ctx, msg) {
-        const { n } = msg.payload;
-        ctx.state.msgs.push(n);
-        return reply(msg, { ok: true });
-    },
-})
-    .defineProcedure('getAll', {
-    type: 'rpc',
-    input: Type.Object({}),
-    output: Type.Object({ msgs: Type.Array(Type.Number()) }),
-    async handler(ctx, msg) {
-        return reply(msg, { msgs: ctx.state.msgs });
-    },
-})
-    .finalize();
-test('serialize service to jsonschema', () => {
-    const service = TestServiceConstructor();
-    expect(serializeService(service)).toStrictEqual({
-        name: 'test',
-        state: { count: 0 },
-        procedures: {
-            add: {
-                input: {
-                    properties: {
-                        n: { type: 'number' },
-                    },
-                    required: ['n'],
-                    type: 'object',
-                },
-                output: {
-                    properties: {
-                        result: { type: 'number' },
-                    },
-                    required: ['result'],
-                    type: 'object',
-                },
-                type: 'rpc',
-            },
-            echo: {
-                input: {
-                    properties: {
-                        msg: { type: 'string' },
-                        ignore: { type: 'boolean' },
-                    },
-                    required: ['msg', 'ignore'],
-                    type: 'object',
-                },
-                output: {
-                    properties: {
-                        response: { type: 'string' },
-                    },
-                    required: ['response'],
-                    type: 'object',
-                },
-                type: 'stream',
-            },
-        },
-    });
-});
-describe('server-side test', () => {
-    const service = TestServiceConstructor();
-    const initialState = { count: 0 };
-    test('rpc basic', async () => {
-        const add = asClientRpc(initialState, service.procedures.add);
-        await expect(add({ n: 3 })).resolves.toStrictEqual({ result: 3 });
-    });
-    test('rpc initial state', async () => {
-        const add = asClientRpc({ count: 5 }, service.procedures.add);
-        await expect(add({ n: 6 })).resolves.toStrictEqual({ result: 11 });
-    });
-    test('stream basic', async () => {
-        const [input, output] = asClientStream(initialState, service.procedures.echo);
-        input.push({ msg: 'abc', ignore: false });
-        input.push({ msg: 'def', ignore: true });
-        input.push({ msg: 'ghi', ignore: false });
-        input.end();
-        await expect(output.next().then((res) => res.value)).resolves.toStrictEqual({
-            response: 'abc',
-        });
-        await expect(output.next().then((res) => res.value)).resolves.toStrictEqual({
-            response: 'ghi',
-        });
-        expect(output.readableLength).toBe(0);
-    });
-});
-describe('client <-> server integration test', async () => {
-    const server = http.createServer();
-    const port = await onServerReady(server);
-    const webSocketServer = await createWebSocketServer(server);
-    afterAll(() => {
-        webSocketServer.clients.forEach((socket) => {
-            socket.close();
-        });
-        server.close();
-    });
-    test('rpc', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, webSocketServer);
-        const serviceDefs = { test: TestServiceConstructor() };
-        const server = await createServer(serverTransport, serviceDefs);
-        const client = createClient(clientTransport);
-        await expect(client.test.add({ n: 3 })).resolves.toStrictEqual({
-            result: 3,
-        });
-    });
-    test('stream', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, webSocketServer);
-        const serviceDefs = { test: TestServiceConstructor() };
-        const server = await createServer(serverTransport, serviceDefs);
-        const client = createClient(clientTransport);
-        const [input, output, close] = await client.test.echo();
-        input.push({ msg: 'abc', ignore: false });
-        input.push({ msg: 'def', ignore: true });
-        input.push({ msg: 'ghi', ignore: false });
-        input.end();
-        await expect(output.next().then((res) => res.value)).resolves.toStrictEqual({
-            response: 'abc',
-        });
-        await expect(output.next().then((res) => res.value)).resolves.toStrictEqual({
-            response: 'ghi',
-        });
-        close();
-    });
-    test('message order is preserved in the face of disconnects', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, webSocketServer);
-        const serviceDefs = { test: OrderingServiceConstructor() };
-        const server = await createServer(serverTransport, serviceDefs);
-        const client = createClient(clientTransport);
-        const expected = [];
-        for (let i = 0; i < 50; i++) {
-            expected.push(i);
-            if (i == 10) {
-                clientTransport.ws?.close();
-            }
-            if (i == 42) {
-                clientTransport.ws?.terminate();
-            }
-            await client.test.add({
-                n: i,
-            });
-        }
-        const res = await client.test.getAll({});
-        return expect(res.msgs).toStrictEqual(expected);
-    });
-});

package/dist/transport/impls/stdio.d.ts

@@ -1,40 +0,0 @@
-/// <reference types="node" />
-import { Codec } from '../../codec';
-import { OpaqueTransportMessage, TransportClientId } from '../message';
-import { Transport } from '../types';
-interface Options {
-    codec: Codec;
-}
-/**
- * A transport implementation that uses standard input and output streams.
- * @extends Transport
- */
-export declare class StdioTransport extends Transport {
-    /**
-     * The readable stream to use as input.
-     */
-    input: NodeJS.ReadableStream;
-    /**
-     * The writable stream to use as output.
-     */
-    output: NodeJS.WritableStream;
-    /**
-     * Constructs a new StdioTransport instance.
-     * @param clientId - The ID of the client associated with this transport.
-     * @param input - The readable stream to use as input. Defaults to process.stdin.
-     * @param output - The writable stream to use as output. Defaults to process.stdout.
-     */
-    constructor(clientId: TransportClientId, input?: NodeJS.ReadableStream, output?: NodeJS.WritableStream, providedOptions?: Partial<Options>);
-    /**
-     * Sends a message over the transport.
-     * @param msg - The message to send.
-     * @returns The ID of the sent message.
-     */
-    send(msg: OpaqueTransportMessage): string;
-    /**
-     * Closes the transport.
-     */
-    close(): Promise<void>;
-}
-export {};
-//# sourceMappingURL=stdio.d.ts.map

package/dist/transport/impls/stdio.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stdio.d.ts","sourceRoot":"","sources":["../../../transport/impls/stdio.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC,UAAU,OAAO;IACf,KAAK,EAAE,KAAK,CAAC;CACd;AAQD;;;GAGG;AACH,qBAAa,cAAe,SAAQ,SAAS;IAC3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,cAAc,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAE9B;;;;;OAKG;gBAED,QAAQ,EAAE,iBAAiB,EAC3B,KAAK,GAAE,MAAM,CAAC,cAA8B,EAC5C,MAAM,GAAE,MAAM,CAAC,cAA+B,EAC9C,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAcpC;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,sBAAsB,GAAG,MAAM;IAWzC;;OAEG;IACG,KAAK;CACZ"}

package/dist/transport/impls/stdio.js

@@ -1,56 +0,0 @@
-import { NaiveJsonCodec } from '../../codec/json';
-import { Transport } from '../types';
-import readline from 'readline';
-const defaultOptions = {
-    codec: NaiveJsonCodec,
-};
-const newlineBuff = new TextEncoder().encode('\n');
-/**
- * A transport implementation that uses standard input and output streams.
- * @extends Transport
- */
-export class StdioTransport extends Transport {
-    /**
-     * The readable stream to use as input.
-     */
-    input;
-    /**
-     * The writable stream to use as output.
-     */
-    output;
-    /**
-     * Constructs a new StdioTransport instance.
-     * @param clientId - The ID of the client associated with this transport.
-     * @param input - The readable stream to use as input. Defaults to process.stdin.
-     * @param output - The writable stream to use as output. Defaults to process.stdout.
-     */
-    constructor(clientId, input = process.stdin, output = process.stdout, providedOptions) {
-        const options = { ...defaultOptions, ...providedOptions };
-        super(options.codec, clientId);
-        this.input = input;
-        this.output = output;
-        const rl = readline.createInterface({
-            input: this.input,
-        });
-        const encoder = new TextEncoder();
-        rl.on('line', (msg) => this.onMessage(encoder.encode(msg)));
-    }
-    /**
-     * Sends a message over the transport.
-     * @param msg - The message to send.
-     * @returns The ID of the sent message.
-     */
-    send(msg) {
-        const id = msg.id;
-        const payload = this.codec.toBuffer(msg);
-        const out = new Uint8Array(payload.length + newlineBuff.length);
-        out.set(payload, 0);
-        out.set(newlineBuff, payload.length);
-        this.output.write(out);
-        return id;
-    }
-    /**
-     * Closes the transport.
-     */
-    async close() { }
-}

package/dist/transport/impls/stdio.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=stdio.test.d.ts.map

package/dist/transport/impls/stdio.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stdio.test.d.ts","sourceRoot":"","sources":["../../../transport/impls/stdio.test.ts"],"names":[],"mappings":""}

package/dist/transport/impls/stdio.test.js

@@ -1,20 +0,0 @@
-import { describe, test, expect } from 'vitest';
-import stream from 'node:stream';
-import { StdioTransport } from './stdio';
-import { waitForMessage } from '..';
-import { payloadToTransportMessage } from '../../testUtils';
-describe('sending and receiving across node streams works', () => {
-    test('basic send/receive', async () => {
-        const clientToServer = new stream.PassThrough();
-        const serverToClient = new stream.PassThrough();
-        const serverTransport = new StdioTransport('SERVER', clientToServer, serverToClient);
-        const clientTransport = new StdioTransport('client', serverToClient, clientToServer);
-        const msg = {
-            msg: 'cool',
-            test: 123,
-        };
-        const p = waitForMessage(serverTransport);
-        clientTransport.send(payloadToTransportMessage(msg));
-        await expect(p).resolves.toStrictEqual(msg);
-    });
-});

package/dist/transport/impls/ws.d.ts

@@ -1,71 +0,0 @@
-/// <reference types="ws" />
-import WebSocket from 'isomorphic-ws';
-import { Transport } from '../types';
-import { MessageId, OpaqueTransportMessage, TransportClientId } from '../message';
-import { type Codec } from '../../codec';
-interface Options {
-    retryIntervalMs: number;
-    codec: Codec;
-    binaryType: 'arraybuffer' | 'blob';
-}
-type WebSocketResult = {
-    ws: WebSocket;
-} | {
-    err: string;
-};
-/**
- * A transport implementation that uses a WebSocket connection with automatic reconnection.
- * @class
- * @extends Transport
- */
-export declare class WebSocketTransport extends Transport {
-    /**
-     * A function that returns a Promise that resolves to a WebSocket instance.
-     */
-    wsGetter: () => Promise<WebSocket>;
-    ws?: WebSocket;
-    options: Options;
-    /**
-     * A flag indicating whether the transport has been destroyed.
-     * A destroyed transport will not attempt to reconnect and cannot be used again.
-     */
-    state: 'open' | 'closed' | 'destroyed';
-    /**
-     * An ongoing reconnect attempt if it exists. When the attempt finishes, it contains a
-     * {@link WebSocketResult} object when a connection is established or an error occurs.
-     */
-    reconnectPromise?: Promise<WebSocketResult>;
-    /**
-     * An array of message IDs that are waiting to be sent over the WebSocket connection.
-     * This builds up if the WebSocket is down for a period of time.
-     */
-    sendQueue: Array<MessageId>;
-    /**
-     * Creates a new WebSocketTransport instance.
-     * @param wsGetter A function that returns a Promise that resolves to a WebSocket instance.
-     * @param clientId The ID of the client using the transport.
-     * @param providedOptions An optional object containing configuration options for the transport.
-     */
-    constructor(wsGetter: () => Promise<WebSocket>, clientId: TransportClientId, providedOptions?: Partial<Options>);
-    /**
-     * Begins a new attempt to establish a WebSocket connection.
-     */
-    private tryConnect;
-    /**
-     * Sends a message over the WebSocket connection. If the WebSocket connection is
-     * not healthy, it will queue until the connection is successful.
-     * @param msg The message to send.
-     * @returns The ID of the sent message.
-     */
-    send(msg: OpaqueTransportMessage): MessageId;
-    /**
-     * Closes the WebSocket transport. Any messages sent while the transport is closed will be silently discarded.
-     */
-    close(): Promise<void | undefined>;
-    /**
-     * Destroys the WebSocket transport. Any messages sent while the transport is closed will throw an error.
-     */
-    destroy(): Promise<void | undefined>;
-}
-export {};
-//# sourceMappingURL=ws.d.ts.map

package/dist/transport/impls/ws.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../../../transport/impls/ws.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,OAAO,EACL,SAAS,EACT,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC,UAAU,OAAO;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;IACb,UAAU,EAAE,aAAa,GAAG,MAAM,CAAC;CACpC;AAQD,KAAK,eAAe,GAAG;IAAE,EAAE,EAAE,SAAS,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3D;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,EAAE,CAAC,EAAE,SAAS,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,QAAQ,GAAG,WAAW,CAAC;IAEvC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAE5C;;;OAGG;IACH,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE5B;;;;;OAKG;gBAED,QAAQ,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,EAClC,QAAQ,EAAE,iBAAiB,EAC3B,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAWpC;;OAEG;YACW,UAAU;IAuExB;;;;;OAKG;IACH,IAAI,CAAC,GAAG,EAAE,sBAAsB,GAAG,SAAS;IA4B5C;;OAEG;IACG,KAAK;IAMX;;OAEG;IACG,OAAO;CAKd"}

package/dist/transport/impls/ws.js

@@ -1,156 +0,0 @@
-import { Transport } from '../types';
-import { NaiveJsonCodec } from '../../codec/json';
-import { log } from '../../logging';
-const defaultOptions = {
-    retryIntervalMs: 250,
-    codec: NaiveJsonCodec,
-    binaryType: 'arraybuffer',
-};
-/**
- * A transport implementation that uses a WebSocket connection with automatic reconnection.
- * @class
- * @extends Transport
- */
-export class WebSocketTransport extends Transport {
-    /**
-     * A function that returns a Promise that resolves to a WebSocket instance.
-     */
-    wsGetter;
-    ws;
-    options;
-    /**
-     * A flag indicating whether the transport has been destroyed.
-     * A destroyed transport will not attempt to reconnect and cannot be used again.
-     */
-    state;
-    /**
-     * An ongoing reconnect attempt if it exists. When the attempt finishes, it contains a
-     * {@link WebSocketResult} object when a connection is established or an error occurs.
-     */
-    reconnectPromise;
-    /**
-     * An array of message IDs that are waiting to be sent over the WebSocket connection.
-     * This builds up if the WebSocket is down for a period of time.
-     */
-    sendQueue;
-    /**
-     * Creates a new WebSocketTransport instance.
-     * @param wsGetter A function that returns a Promise that resolves to a WebSocket instance.
-     * @param clientId The ID of the client using the transport.
-     * @param providedOptions An optional object containing configuration options for the transport.
-     */
-    constructor(wsGetter, clientId, providedOptions) {
-        const options = { ...defaultOptions, ...providedOptions };
-        super(options.codec, clientId);
-        this.state = 'open';
-        this.wsGetter = wsGetter;
-        this.options = options;
-        this.sendQueue = [];
-        this.tryConnect();
-    }
-    /**
-     * Begins a new attempt to establish a WebSocket connection.
-     */
-    async tryConnect() {
-        if (this.state !== 'open') {
-            return;
-        }
-        // wait until it's ready or we get an error
-        this.reconnectPromise ??= new Promise(async (resolve) => {
-            log?.info(`${this.clientId} -- establishing a new websocket`);
-            const ws = await this.wsGetter();
-            if (ws.readyState === ws.OPEN) {
-                return resolve({ ws });
-            }
-            if (ws.readyState === ws.CLOSING || ws.readyState === ws.CLOSED) {
-                return resolve({ err: 'ws is closing or closed' });
-            }
-            ws.addEventListener('open', function onOpen() {
-                ws.removeEventListener('open', onOpen);
-                resolve({ ws });
-            });
-            ws.addEventListener('error', function onError(err) {
-                ws.removeEventListener('error', onError);
-                resolve({ err: err.message });
-            });
-            ws.addEventListener('close', function onClose(evt) {
-                ws.removeEventListener('close', onClose);
-                resolve({ err: evt.reason });
-            });
-        });
-        const res = await this.reconnectPromise;
-        // only send if we resolved a valid websocket
-        if ('ws' in res && res.ws.readyState === res.ws.OPEN) {
-            log?.info(`${this.clientId} -- websocket ok`);
-            this.ws = res.ws;
-            this.ws.binaryType = 'arraybuffer';
-            this.ws.onmessage = (msg) => this.onMessage(msg.data);
-            this.ws.onclose = () => {
-                this.reconnectPromise = undefined;
-                this.tryConnect().catch();
-            };
-            // send outstanding
-            for (const id of this.sendQueue) {
-                const msg = this.sendBuffer.get(id);
-                if (!msg) {
-                    const err = 'tried to resend a message we received an ack for';
-                    log?.error(err);
-                    throw new Error(err);
-                }
-                log?.info(`${this.clientId} -- sending ${JSON.stringify(msg)}`);
-                this.ws.send(this.codec.toBuffer(msg));
-            }
-            this.sendQueue = [];
-            return;
-        }
-        // otherwise try and reconnect again
-        log?.warn(`${this.clientId} -- websocket failed, trying again in ${this.options.retryIntervalMs}ms`);
-        this.reconnectPromise = undefined;
-        setTimeout(() => this.tryConnect(), this.options.retryIntervalMs);
-    }
-    /**
-     * Sends a message over the WebSocket connection. If the WebSocket connection is
-     * not healthy, it will queue until the connection is successful.
-     * @param msg The message to send.
-     * @returns The ID of the sent message.
-     */
-    send(msg) {
-        const id = msg.id;
-        if (this.state === 'destroyed') {
-            const err = 'ws is destroyed, cant send';
-            log?.error(err + `: ${JSON.stringify(msg)}`);
-            throw new Error(err);
-        }
-        else if (this.state === 'closed') {
-            log?.info(`ws is closed, discarding msg: ${JSON.stringify(msg)}`);
-            return msg.id;
-        }
-        this.sendBuffer.set(id, msg);
-        if (this.ws && this.ws.readyState === this.ws.OPEN) {
-            log?.info(`${this.clientId} -- sending ${JSON.stringify(msg)}`);
-            this.ws.send(this.codec.toBuffer(msg));
-        }
-        else {
-            log?.info(`${this.clientId} -- transport not ready, queuing ${JSON.stringify(msg)}`);
-            this.sendQueue.push(id);
-            this.tryConnect().catch();
-        }
-        return id;
-    }
-    /**
-     * Closes the WebSocket transport. Any messages sent while the transport is closed will be silently discarded.
-     */
-    async close() {
-        log?.info('closed ws transport');
-        this.state = 'closed';
-        return this.ws?.close();
-    }
-    /**
-     * Destroys the WebSocket transport. Any messages sent while the transport is closed will throw an error.
-     */
-    async destroy() {
-        log?.info('destroyed ws transport');
-        this.state = 'destroyed';
-        return this.ws?.close();
-    }
-}

package/dist/transport/impls/ws.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=ws.test.d.ts.map

package/dist/transport/impls/ws.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ws.test.d.ts","sourceRoot":"","sources":["../../../transport/impls/ws.test.ts"],"names":[],"mappings":""}

package/dist/transport/impls/ws.test.js

@@ -1,64 +0,0 @@
-import http from 'http';
-import { describe, test, expect, afterAll } from 'vitest';
-import { createWebSocketServer, createWsTransports, createDummyTransportMessage, onServerReady, } from '../../testUtils';
-import { waitForMessage } from '..';
-describe('sending and receiving across websockets works', async () => {
-    const server = http.createServer();
-    const port = await onServerReady(server);
-    const wss = await createWebSocketServer(server);
-    afterAll(() => {
-        wss.clients.forEach((socket) => {
-            socket.close();
-        });
-        server.close();
-    });
-    test('basic send/receive', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, wss);
-        const msg = createDummyTransportMessage();
-        clientTransport.send(msg);
-        return expect(waitForMessage(serverTransport, (recv) => recv.id === msg.id)).resolves.toStrictEqual(msg.payload);
-    });
-});
-describe('retry logic', async () => {
-    const server = http.createServer();
-    const port = await onServerReady(server);
-    const wss = await createWebSocketServer(server);
-    afterAll(() => {
-        wss.clients.forEach((socket) => {
-            socket.close();
-        });
-        server.close();
-    });
-    // TODO: right now, we only test client-side disconnects, we probably
-    // need to also write tests for server-side crashes (but this involves clearing/restoring state)
-    // not going to worry about this rn but for future
-    test('ws transport is recreated after clean disconnect', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, wss);
-        const msg1 = createDummyTransportMessage();
-        const msg2 = createDummyTransportMessage();
-        clientTransport.send(msg1);
-        await expect(waitForMessage(serverTransport, (recv) => recv.id === msg1.id)).resolves.toStrictEqual(msg1.payload);
-        clientTransport.ws?.close();
-        clientTransport.send(msg2);
-        return expect(waitForMessage(serverTransport, (recv) => recv.id === msg2.id)).resolves.toStrictEqual(msg2.payload);
-    });
-    test('ws transport is recreated after unclean disconnect', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, wss);
-        const msg1 = createDummyTransportMessage();
-        const msg2 = createDummyTransportMessage();
-        clientTransport.send(msg1);
-        await expect(waitForMessage(serverTransport, (recv) => recv.id === msg1.id)).resolves.toStrictEqual(msg1.payload);
-        clientTransport.ws?.terminate();
-        clientTransport.send(msg2);
-        return expect(waitForMessage(serverTransport, (recv) => recv.id === msg2.id)).resolves.toStrictEqual(msg2.payload);
-    });
-    test('ws transport is not recreated after destroy', async () => {
-        const [clientTransport, serverTransport] = createWsTransports(port, wss);
-        const msg1 = createDummyTransportMessage();
-        const msg2 = createDummyTransportMessage();
-        clientTransport.send(msg1);
-        await expect(waitForMessage(serverTransport, (recv) => recv.id === msg1.id)).resolves.toStrictEqual(msg1.payload);
-        clientTransport.destroy();
-        return expect(() => clientTransport.send(msg2)).toThrow(new Error('ws is destroyed, cant send'));
-    });
-});

package/dist/transport/types.d.ts

@@ -1,50 +0,0 @@
-import { Codec } from '../codec/types';
-import { MessageId, OpaqueTransportMessage, TransportClientId } from './message';
-/**
- * Abstract base for a transport layer for communication between nodes in a River network.
- * Any River transport methods need to implement this interface.
- * @abstract
- */
-export declare abstract class Transport {
-    /**
-     * The {@link Codec} used to encode and decode messages.
-     */
-    codec: Codec;
-    /**
-     * The client ID of this transport.
-     */
-    clientId: TransportClientId;
-    /**
-     * The set of message handlers registered with this transport.
-     */
-    handlers: Set<(msg: OpaqueTransportMessage) => void>;
-    /**
-     * The buffer of messages that have been sent but not yet acknowledged.
-     */
-    sendBuffer: Map<MessageId, OpaqueTransportMessage>;
-    /**
-     * Creates a new Transport instance.
-     * @param codec The codec used to encode and decode messages.
-     * @param clientId The client ID of this transport.
-     */
-    constructor(codec: Codec, clientId: TransportClientId);
-    /**
-     * Called when a message is received by this transport.
-     * You generally shouldn't need to override this in downstream transport implementations.
-     * @param msg The received message.
-     */
-    onMessage(msg: Uint8Array): void;
-    /**
-     * Adds a message listener to this transport.
-     * @param handler The message handler to add.
-     */
-    addMessageListener(handler: (msg: OpaqueTransportMessage) => void): void;
-    /**
-     * Removes a message listener from this transport.
-     * @param handler The message handler to remove.
-     */
-    removeMessageListener(handler: (msg: OpaqueTransportMessage) => void): void;
-    abstract send(msg: OpaqueTransportMessage): MessageId;
-    abstract close(): Promise<void>;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/transport/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../transport/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,OAAO,EAEL,SAAS,EACT,sBAAsB,EAGtB,iBAAiB,EAGlB,MAAM,WAAW,CAAC;AAGnB;;;;GAIG;AACH,8BAAsB,SAAS;IAC7B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,sBAAsB,KAAK,IAAI,CAAC,CAAC;IAGrD;;OAEG;IACH,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;IAEnD;;;;OAIG;gBACS,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,iBAAiB;IAOrD;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,UAAU;IAoDzB;;;OAGG;IACH,kBAAkB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,sBAAsB,KAAK,IAAI,GAAG,IAAI;IAIxE;;;OAGG;IACH,qBAAqB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,sBAAsB,KAAK,IAAI,GAAG,IAAI;IAI3E,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,sBAAsB,GAAG,SAAS;IACrD,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAChC"}

package/dist/transport/types.js

@@ -1,95 +0,0 @@
-import { Value } from '@sinclair/typebox/value';
-import { OpaqueTransportMessageSchema, TransportAckSchema, isAck, reply, } from './message';
-import { log } from '../logging';
-/**
- * Abstract base for a transport layer for communication between nodes in a River network.
- * Any River transport methods need to implement this interface.
- * @abstract
- */
-export class Transport {
-    /**
-     * The {@link Codec} used to encode and decode messages.
-     */
-    codec;
-    /**
-     * The client ID of this transport.
-     */
-    clientId;
-    /**
-     * The set of message handlers registered with this transport.
-     */
-    handlers;
-    // TODO; we can do much better here on retry (maybe resending the sendBuffer on fixed interval)
-    /**
-     * The buffer of messages that have been sent but not yet acknowledged.
-     */
-    sendBuffer;
-    /**
-     * Creates a new Transport instance.
-     * @param codec The codec used to encode and decode messages.
-     * @param clientId The client ID of this transport.
-     */
-    constructor(codec, clientId) {
-        this.handlers = new Set();
-        this.sendBuffer = new Map();
-        this.codec = codec;
-        this.clientId = clientId;
-    }
-    /**
-     * Called when a message is received by this transport.
-     * You generally shouldn't need to override this in downstream transport implementations.
-     * @param msg The received message.
-     */
-    onMessage(msg) {
-        const parsedMsg = this.codec.fromBuffer(msg);
-        if (parsedMsg === null) {
-            log?.warn(`${this.clientId} -- received malformed msg: ${new TextDecoder().decode(msg)}`);
-            return;
-        }
-        let stringifiedMessage;
-        if (log) {
-            stringifiedMessage = JSON.stringify(parsedMsg);
-        }
-        if (Value.Check(TransportAckSchema, parsedMsg) &&
-            isAck(parsedMsg.controlFlags)) {
-            // process ack
-            log?.info(`${this.clientId} -- received ack: ${stringifiedMessage}`);
-            if (this.sendBuffer.has(parsedMsg.payload.ack)) {
-                this.sendBuffer.delete(parsedMsg.payload.ack);
-            }
-        }
-        else if (Value.Check(OpaqueTransportMessageSchema, parsedMsg)) {
-            // regular river message
-            log?.info(`${this.clientId} -- received msg: ${stringifiedMessage}`);
-            // ignore if not for us
-            if (parsedMsg.to !== this.clientId && parsedMsg.to !== 'broadcast') {
-                return;
-            }
-            // handle actual message
-            for (const handler of this.handlers) {
-                handler(parsedMsg);
-            }
-            const ackMsg = reply(parsedMsg, { ack: parsedMsg.id });
-            ackMsg.controlFlags = 1 /* ControlFlags.AckBit */;
-            ackMsg.from = this.clientId;
-            this.send(ackMsg);
-        }
-        else {
-            log?.warn(`${this.clientId} -- received invalid transport msg: ${stringifiedMessage}`);
-        }
-    }
-    /**
-     * Adds a message listener to this transport.
-     * @param handler The message handler to add.
-     */
-    addMessageListener(handler) {
-        this.handlers.add(handler);
-    }
-    /**
-     * Removes a message listener from this transport.
-     * @param handler The message handler to remove.
-     */
-    removeMessageListener(handler) {
-        this.handlers.delete(handler);
-    }
-}