@replit/river 0.10.4 → 0.10.5

package/dist/transport/impls/ws/server.cjs

@@ -184,6 +184,7 @@ var Transport = class {
   eventDispatcher;
   /**
    * Creates a new Transport instance.
+   * This should also set up {@link onConnect}, and {@link onDisconnect} listeners.
    * @param codec The codec used to encode and decode messages.
    * @param clientId The client ID of this transport.
    */
@@ -409,13 +410,14 @@ var defaultOptions = {
 };
 var WebSocketServerTransport = class extends Transport {
   wss;
-  clientId;
   constructor(wss, clientId, providedOptions) {
     const options = { ...defaultOptions, ...providedOptions };
     super(options.codec, clientId);
     this.wss = wss;
-    this.clientId = clientId;
-    this.setupConnectionStatusListeners();
+    wss.on("listening", () => {
+      log?.info(`${this.clientId} -- server is listening`);
+    });
+    this.wss.on("connection", this.connectionHandler);
   }
   connectionHandler = (ws) => {
     let conn = void 0;
@@ -438,9 +440,6 @@ var WebSocketServerTransport = class extends Transport {
       );
     };
   };
-  setupConnectionStatusListeners() {
-    this.wss.on("connection", this.connectionHandler);
-  }
   async createNewConnection(to) {
     const err = `${this.clientId} -- failed to send msg to ${to}, client probably dropped`;
     log?.warn(err);

package/dist/transport/impls/ws/server.d.cts

@@ -10,10 +10,8 @@ interface Options {
 }
 declare class WebSocketServerTransport extends Transport<WebSocketConnection> {
     wss: WebSocketServer;
-    clientId: TransportClientId;
     constructor(wss: WebSocketServer, clientId: TransportClientId, providedOptions?: Partial<Options>);
     connectionHandler: (ws: WebSocket) => void;
-    setupConnectionStatusListeners(): void;
     createNewConnection(to: string): Promise<void>;
     close(): Promise<void>;
 }

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

@@ -10,10 +10,8 @@ interface Options {
 }
 declare class WebSocketServerTransport extends Transport<WebSocketConnection> {
     wss: WebSocketServer;
-    clientId: TransportClientId;
     constructor(wss: WebSocketServer, clientId: TransportClientId, providedOptions?: Partial<Options>);
     connectionHandler: (ws: WebSocket) => void;
-    setupConnectionStatusListeners(): void;
     createNewConnection(to: string): Promise<void>;
     close(): Promise<void>;
 }

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

@@ -1,10 +1,10 @@
 import {
   WebSocketServerTransport
-} from "../../../chunk-RGMHF6PF.js";
+} from "../../../chunk-PNZXYQME.js";
+import "../../../chunk-SZTOUKL7.js";
 import "../../../chunk-WVT5QXMZ.js";
-import "../../../chunk-PC65ZFWJ.js";
 import "../../../chunk-R6H2BIMC.js";
-import "../../../chunk-AJQU4AZG.js";
+import "../../../chunk-V2YJRBRX.js";
 import "../../../chunk-ZE4MX7DF.js";
 import "../../../chunk-SLUSVGQH.js";
 export {

package/dist/transport/index.cjs

@@ -155,6 +155,7 @@ var Transport = class {
   eventDispatcher;
   /**
    * Creates a new Transport instance.
+   * This should also set up {@link onConnect}, and {@link onDisconnect} listeners.
    * @param codec The codec used to encode and decode messages.
    * @param clientId The client ID of this transport.
    */

package/dist/transport/index.d.cts

@@ -194,18 +194,17 @@ declare abstract class Transport<ConnType extends Connection> {
     eventDispatcher: EventDispatcher<EventTypes>;
     /**
      * Creates a new Transport instance.
+     * This should also set up {@link onConnect}, and {@link onDisconnect} listeners.
      * @param codec The codec used to encode and decode messages.
      * @param clientId The client ID of this transport.
      */
     constructor(codec: Codec, clientId: TransportClientId);
     /**
-     * Abstract method that sets up {@link onConnect}, and {@link onDisconnect} listeners.
-     * The downstream implementation needs to implement this.
-     */
-    abstract setupConnectionStatusListeners(): void;
-    /**
-     * Abstract method that creates a new {@link Connection} object. This should call
-     * {@link onConnect} when the connection is established. The downstream implementation needs to implement this.
+     * Abstract method that creates a new {@link Connection} object.
+     * This should call {@link onConnect} when the connection is established.
+     * The downstream implementation needs to implement this. If the downstream
+     * transport cannot make new outgoing connections (e.g. a server transport),
+     * it is ok to log an error and return.
      * @param to The client ID of the node to connect to.
      * @returns The new connection object.
      */

package/dist/transport/index.d.ts

@@ -194,18 +194,17 @@ declare abstract class Transport<ConnType extends Connection> {
     eventDispatcher: EventDispatcher<EventTypes>;
     /**
      * Creates a new Transport instance.
+     * This should also set up {@link onConnect}, and {@link onDisconnect} listeners.
      * @param codec The codec used to encode and decode messages.
      * @param clientId The client ID of this transport.
      */
     constructor(codec: Codec, clientId: TransportClientId);
     /**
-     * Abstract method that sets up {@link onConnect}, and {@link onDisconnect} listeners.
-     * The downstream implementation needs to implement this.
-     */
-    abstract setupConnectionStatusListeners(): void;
-    /**
-     * Abstract method that creates a new {@link Connection} object. This should call
-     * {@link onConnect} when the connection is established. The downstream implementation needs to implement this.
+     * Abstract method that creates a new {@link Connection} object.
+     * This should call {@link onConnect} when the connection is established.
+     * The downstream implementation needs to implement this. If the downstream
+     * transport cannot make new outgoing connections (e.g. a server transport),
+     * it is ok to log an error and return.
      * @param to The client ID of the node to connect to.
      * @returns The new connection object.
      */

package/dist/transport/index.js

@@ -2,7 +2,7 @@ import "../chunk-ORAG7IAU.js";
 import {
   Connection,
   Transport
-} from "../chunk-AJQU4AZG.js";
+} from "../chunk-V2YJRBRX.js";
 import {
   OpaqueTransportMessageSchema,
   TransportMessageSchema,

package/dist/util/testHelpers.cjs

@@ -38,8 +38,10 @@ __export(testHelpers_exports, {
   createLocalWebSocketClient: () => createLocalWebSocketClient,
   createWebSocketServer: () => createWebSocketServer,
   createWsTransports: () => createWsTransports,
+  getUnixSocketPath: () => getUnixSocketPath,
   iterNext: () => iterNext,
-  onServerReady: () => onServerReady,
+  onUnixSocketServeReady: () => onUnixSocketServeReady,
+  onWsServerReady: () => onWsServerReady,
   payloadToTransportMessage: () => payloadToTransportMessage,
   waitForMessage: () => waitForMessage
 });
@@ -173,6 +175,7 @@ var Transport = class {
   eventDispatcher;
   /**
    * Creates a new Transport instance.
+   * This should also set up {@link onConnect}, and {@link onDisconnect} listeners.
    * @param codec The codec used to encode and decode messages.
    * @param clientId The client ID of this transport.
    */
@@ -466,9 +469,6 @@ var WebSocketClientTransport = class extends Transport {
     this.serverId = serverId;
     this.options = options;
     this.reconnectPromises = /* @__PURE__ */ new Map();
-    this.setupConnectionStatusListeners();
-  }
-  setupConnectionStatusListeners() {
     this.createNewConnection(this.serverId);
   }
   async createNewConnection(to, attempt = 0) {
@@ -809,6 +809,9 @@ function _pushable(getNext, options) {
     },
     get readableLength() {
       return _pushable2.readableLength;
+    },
+    onEmpty: (opts) => {
+      return _pushable2.onEmpty(opts);
     }
   };
   return pushable2;
@@ -820,13 +823,14 @@ var defaultOptions2 = {
 };
 var WebSocketServerTransport = class extends Transport {
   wss;
-  clientId;
   constructor(wss, clientId, providedOptions) {
     const options = { ...defaultOptions2, ...providedOptions };
     super(options.codec, clientId);
     this.wss = wss;
-    this.clientId = clientId;
-    this.setupConnectionStatusListeners();
+    wss.on("listening", () => {
+      log?.info(`${this.clientId} -- server is listening`);
+    });
+    this.wss.on("connection", this.connectionHandler);
   }
   connectionHandler = (ws) => {
     let conn = void 0;
@@ -849,9 +853,6 @@ var WebSocketServerTransport = class extends Transport {
       );
     };
   };
-  setupConnectionStatusListeners() {
-    this.wss.on("connection", this.connectionHandler);
-  }
   async createNewConnection(to) {
     const err = `${this.clientId} -- failed to send msg to ${to}, client probably dropped`;
     log?.warn(err);
@@ -876,10 +877,11 @@ var RiverUncaughtSchema = import_typebox2.Type.Object({
 });
 
 // util/testHelpers.ts
+var import_nanoid2 = require("nanoid");
 async function createWebSocketServer(server) {
   return new import_ws.WebSocketServer({ server });
 }
-async function onServerReady(server) {
+function onWsServerReady(server) {
   return new Promise((resolve, reject) => {
     server.listen(() => {
       const addr = server.address();
@@ -891,6 +893,11 @@ async function onServerReady(server) {
     });
   });
 }
+function onUnixSocketServeReady(server, path) {
+  return new Promise((resolve) => {
+    server.listen(path, resolve);
+  });
+}
 async function createLocalWebSocketClient(port) {
   const sock = new import_isomorphic_ws.default(`ws://localhost:${port}`);
   sock.binaryType = "arraybuffer";
@@ -990,6 +997,9 @@ async function asClientUpload(state, proc, init, extendedContext) {
     return [input, result];
   }
 }
+var getUnixSocketPath = () => {
+  return process.platform === "win32" ? `\\\\?\\pipe\\${(0, import_nanoid2.nanoid)()}` : `/tmp/${(0, import_nanoid2.nanoid)()}.sock`;
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   asClientRpc,
@@ -1000,8 +1010,10 @@ async function asClientUpload(state, proc, init, extendedContext) {
   createLocalWebSocketClient,
   createWebSocketServer,
   createWsTransports,
+  getUnixSocketPath,
   iterNext,
-  onServerReady,
+  onUnixSocketServeReady,
+  onWsServerReady,
   payloadToTransportMessage,
   waitForMessage
 });

package/dist/util/testHelpers.d.cts

@@ -1,13 +1,14 @@
 import * as it_pushable from 'it-pushable';
 import WebSocket from 'isomorphic-ws';
 import { WebSocketServer } from 'ws';
-import http from 'http';
+import http from 'node:http';
 import { WebSocketClientTransport } from '../transport/impls/ws/client.cjs';
 import { TransportClientId, TransportMessage, OpaqueTransportMessage, Transport, Connection } from '../transport/index.cjs';
 import { C as Codec } from '../types-3e5768ec.js';
 import { WebSocketServerTransport } from '../transport/impls/ws/server.cjs';
 import { P as PayloadType, R as RiverError, a as Procedure, S as ServiceContext, b as Result, c as RiverUncaughtSchema } from '../builder-87111051.js';
 import { Static } from '@sinclair/typebox';
+import net from 'node:net';
 import '../connection-f7688cc1.js';
 
 /**
@@ -24,7 +25,8 @@ declare function createWebSocketServer(server: http.Server): Promise<WebSocket.S
  * @returns A promise that resolves with the allocated port number.
  * @throws An error if a port cannot be allocated.
  */
-declare function onServerReady(server: http.Server): Promise<number>;
+declare function onWsServerReady(server: http.Server): Promise<number>;
+declare function onUnixSocketServeReady(server: net.Server, path: string): Promise<void>;
 /**
  * Creates a WebSocket client that connects to a local server at the specified port.
  * This should only be used for testing.
@@ -75,5 +77,6 @@ declare function asClientUpload<State extends object | unknown, I extends Payloa
         message: string;
     };
 } | Result<Static<O>, Static<E>>>]>;
+declare const getUnixSocketPath: () => string;
 
-export { asClientRpc, asClientStream, asClientSubscription, asClientUpload, createDummyTransportMessage, createLocalWebSocketClient, createWebSocketServer, createWsTransports, iterNext, onServerReady, payloadToTransportMessage, waitForMessage };
+export { asClientRpc, asClientStream, asClientSubscription, asClientUpload, createDummyTransportMessage, createLocalWebSocketClient, createWebSocketServer, createWsTransports, getUnixSocketPath, iterNext, onUnixSocketServeReady, onWsServerReady, payloadToTransportMessage, waitForMessage };

package/dist/util/testHelpers.d.ts

@@ -1,13 +1,14 @@
 import * as it_pushable from 'it-pushable';
 import WebSocket from 'isomorphic-ws';
 import { WebSocketServer } from 'ws';
-import http from 'http';
+import http from 'node:http';
 import { WebSocketClientTransport } from '../transport/impls/ws/client.js';
 import { TransportClientId, TransportMessage, OpaqueTransportMessage, Transport, Connection } from '../transport/index.js';
 import { C as Codec } from '../types-3e5768ec.js';
 import { WebSocketServerTransport } from '../transport/impls/ws/server.js';
 import { P as PayloadType, R as RiverError, a as Procedure, S as ServiceContext, b as Result, c as RiverUncaughtSchema } from '../builder-87111051.js';
 import { Static } from '@sinclair/typebox';
+import net from 'node:net';
 import '../connection-8e19874c.js';
 
 /**
@@ -24,7 +25,8 @@ declare function createWebSocketServer(server: http.Server): Promise<WebSocket.S
  * @returns A promise that resolves with the allocated port number.
  * @throws An error if a port cannot be allocated.
  */
-declare function onServerReady(server: http.Server): Promise<number>;
+declare function onWsServerReady(server: http.Server): Promise<number>;
+declare function onUnixSocketServeReady(server: net.Server, path: string): Promise<void>;
 /**
  * Creates a WebSocket client that connects to a local server at the specified port.
  * This should only be used for testing.
@@ -75,5 +77,6 @@ declare function asClientUpload<State extends object | unknown, I extends Payloa
         message: string;
     };
 } | Result<Static<O>, Static<E>>>]>;
+declare const getUnixSocketPath: () => string;
 
-export { asClientRpc, asClientStream, asClientSubscription, asClientUpload, createDummyTransportMessage, createLocalWebSocketClient, createWebSocketServer, createWsTransports, iterNext, onServerReady, payloadToTransportMessage, waitForMessage };
+export { asClientRpc, asClientStream, asClientSubscription, asClientUpload, createDummyTransportMessage, createLocalWebSocketClient, createWebSocketServer, createWsTransports, getUnixSocketPath, iterNext, onUnixSocketServeReady, onWsServerReady, payloadToTransportMessage, waitForMessage };

package/dist/util/testHelpers.js

@@ -1,18 +1,18 @@
 import {
   UNCAUGHT_ERROR,
   pushable
-} from "../chunk-FWPZDOFL.js";
-import "../chunk-ORAG7IAU.js";
+} from "../chunk-IYRPZPSQ.js";
 import {
   WebSocketClientTransport
-} from "../chunk-UU2Z7LDR.js";
+} from "../chunk-IEU7OE5W.js";
 import {
   WebSocketServerTransport
-} from "../chunk-RGMHF6PF.js";
+} from "../chunk-PNZXYQME.js";
+import "../chunk-SZTOUKL7.js";
+import "../chunk-ORAG7IAU.js";
 import "../chunk-WVT5QXMZ.js";
-import "../chunk-PC65ZFWJ.js";
 import "../chunk-R6H2BIMC.js";
-import "../chunk-AJQU4AZG.js";
+import "../chunk-V2YJRBRX.js";
 import {
   msg
 } from "../chunk-ZE4MX7DF.js";
@@ -21,10 +21,11 @@ import "../chunk-SLUSVGQH.js";
 // util/testHelpers.ts
 import WebSocket from "isomorphic-ws";
 import { WebSocketServer } from "ws";
+import { nanoid } from "nanoid";
 async function createWebSocketServer(server) {
   return new WebSocketServer({ server });
 }
-async function onServerReady(server) {
+function onWsServerReady(server) {
   return new Promise((resolve, reject) => {
     server.listen(() => {
       const addr = server.address();
@@ -36,6 +37,11 @@ async function onServerReady(server) {
     });
   });
 }
+function onUnixSocketServeReady(server, path) {
+  return new Promise((resolve) => {
+    server.listen(path, resolve);
+  });
+}
 async function createLocalWebSocketClient(port) {
   const sock = new WebSocket(`ws://localhost:${port}`);
   sock.binaryType = "arraybuffer";
@@ -135,6 +141,9 @@ async function asClientUpload(state, proc, init, extendedContext) {
     return [input, result];
   }
 }
+var getUnixSocketPath = () => {
+  return process.platform === "win32" ? `\\\\?\\pipe\\${nanoid()}` : `/tmp/${nanoid()}.sock`;
+};
 export {
   asClientRpc,
   asClientStream,
@@ -144,8 +153,10 @@ export {
   createLocalWebSocketClient,
   createWebSocketServer,
   createWsTransports,
+  getUnixSocketPath,
   iterNext,
-  onServerReady,
+  onUnixSocketServeReady,
+  onWsServerReady,
   payloadToTransportMessage,
   waitForMessage
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@replit/river",
   "description": "It's like tRPC but... with JSON Schema Support, duplex streaming and support for service multiplexing. Transport agnostic!",
-  "version": "0.10.4",
+  "version": "0.10.5",
   "type": "module",
   "exports": {
     ".": {
@@ -28,6 +28,14 @@
       "import": "./dist/transport/impls/ws/server.js",
       "require": "./dist/transport/impls/ws/server.cjs"
     },
+    "./transport/unixsocket/client": {
+      "import": "./dist/transport/impls/unixsocket/client.js",
+      "require": "./dist/transport/impls/unixsocket/client.cjs"
+    },
+    "./transport/unixsocket/server": {
+      "import": "./dist/transport/impls/unixsocket/server.js",
+      "require": "./dist/transport/impls/unixsocket/server.cjs"
+    },
     "./transport/stdio": {
       "import": "./dist/transport/impls/stdio/stdio.js",
       "require": "./dist/transport/impls/stdio/stdio.cjs"
@@ -55,11 +63,21 @@
   },
   "devDependencies": {
     "@types/ws": "^8.5.5",
-    "@vitest/ui": "^1.0.1",
+    "@vitest/ui": "^1.1.0",
     "prettier": "^3.0.0",
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
-    "vitest": "^1.0.1"
+    "vitest": "^1.1.0"
+  },
+  "scripts": {
+    "check": "tsc --noEmit && npx prettier . --check",
+    "format": "npx prettier . --write",
+    "build": "rm -rf dist && tsup && du -sh dist",
+    "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 --test-timeout=500",
+    "bench": "vitest bench"
   },
   "engines": {
     "node": ">=16"
@@ -70,14 +88,5 @@
     "jsonschema"
   ],
   "author": "Jacky Zhao",
-  "license": "MIT",
-  "scripts": {
-    "check": "tsc --noEmit && npx prettier . --check",
-    "format": "npx prettier . --write",
-    "build": "rm -rf dist && tsup && du -sh dist",
-    "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 --test-timeout=500",
-    "bench": "vitest bench"
-  }
-}
+  "license": "MIT"
+}