@replit/river 0.21.1 → 0.23.0

package/dist/transport/index.d.ts

@@ -1,7 +1,8 @@
 import { C as Codec } from '../types-3e5768ec.js';
-import { O as OpaqueTransportMessage, C as Connection, a as Session, T as TransportClientId, P as PartialTransportMessage, S as SessionOptions, f as ClientHandshakeOptions, g as ServerHandshakeOptions } from '../index-dfad460e.js';
-export { H as HandshakeRequestMetadata, d as OpaqueTransportMessageSchema, b as ParsedHandshakeMetadata, e as TransportMessage, c as TransportMessageSchema, h as isStreamClose, i as isStreamOpen } from '../index-dfad460e.js';
-import '@sinclair/typebox';
+import { O as OpaqueTransportMessage, C as Connection, b as Session, T as TransportClientId, l as PropagationContext, P as PartialTransportMessage, f as ClientHandshakeOptions, c as ServerHandshakeOptions, m as ParsedMetadata, S as SessionOptions } from '../index-a6fe0edd.js';
+export { h as OpaqueTransportMessageSchema, i as TransportMessage, g as TransportMessageSchema, k as isStreamClose, j as isStreamOpen } from '../index-a6fe0edd.js';
+import { TSchema } from '@sinclair/typebox';
+import '@opentelemetry/api';
 
 type ConnectionStatus = 'connect' | 'disconnect';
 declare const ProtocolError: {
@@ -97,13 +98,9 @@ declare class LeakyBucketRateLimit {
 type TransportStatus = 'open' | 'closed' | 'destroyed';
 type TransportOptions = SessionOptions;
 type ProvidedTransportOptions = Partial<TransportOptions>;
-type ClientTransportOptions = TransportOptions & ConnectionRetryOptions & {
-    handshake?: ClientHandshakeOptions;
-};
+type ClientTransportOptions = TransportOptions & ConnectionRetryOptions;
 type ProvidedClientTransportOptions = Partial<ClientTransportOptions>;
-type ServerTransportOptions = TransportOptions & {
-    handshake?: ServerHandshakeOptions;
-};
+type ServerTransportOptions = TransportOptions;
 type ProvidedServerTransportOptions = Partial<ServerTransportOptions>;
 /**
  * Transports manage the lifecycle (creation/deletion) of sessions and connections. Its responsibilities include:
@@ -187,8 +184,8 @@ declare abstract class Transport<ConnType extends Connection> {
      * @param conn The connection object.
      */
     protected onConnect(conn: ConnType, connectedTo: TransportClientId, session: Session<ConnType>, isReconnect: boolean): void;
-    protected createSession(to: TransportClientId, conn?: ConnType): Session<ConnType>;
-    protected getOrCreateSession(to: TransportClientId, conn?: ConnType, sessionId?: string): {
+    protected createSession(to: TransportClientId, conn?: ConnType, propagationCtx?: PropagationContext): Session<ConnType>;
+    protected getOrCreateSession(to: TransportClientId, conn?: ConnType, sessionId?: string, propagationCtx?: PropagationContext): {
         session: Session<ConnType>;
         isReconnect: boolean;
     };
@@ -245,7 +242,7 @@ declare abstract class Transport<ConnType extends Connection> {
      */
     destroy(): void;
 }
-declare abstract class ClientTransport<ConnType extends Connection> extends Transport<ConnType> {
+declare abstract class ClientTransport<ConnType extends Connection, HandshakeMetadata extends TSchema = TSchema> extends Transport<ConnType> {
     /**
      * The options for this transport.
      */
@@ -262,7 +259,12 @@ declare abstract class ClientTransport<ConnType extends Connection> extends Tran
      * tests or a special case where you don't want to reconnect.
      */
     reconnectOnConnectionDrop: boolean;
+    /**
+     * Optional handshake options for this client.
+     */
+    handshakeExtensions?: ClientHandshakeOptions<HandshakeMetadata>;
     constructor(clientId: TransportClientId, providedOptions?: ProvidedClientTransportOptions);
+    extendHandshake(options: ClientHandshakeOptions<HandshakeMetadata>): void;
     protected handleConnection(conn: ConnType, to: TransportClientId): void;
     receiveHandshakeResponseMessage(data: Uint8Array, conn: ConnType): Session<ConnType> | false;
     /**
@@ -279,18 +281,27 @@ declare abstract class ClientTransport<ConnType extends Connection> extends Tran
      * @param to The client ID of the node to connect to.
      */
     connect(to: TransportClientId): Promise<void>;
-    private connectAttempt;
     protected deleteSession(session: Session<ConnType>): void;
     protected sendHandshake(to: TransportClientId, conn: ConnType): Promise<boolean>;
     close(): void;
 }
-declare abstract class ServerTransport<ConnType extends Connection> extends Transport<ConnType> {
+declare abstract class ServerTransport<ConnType extends Connection, CustomMetadataSchema extends TSchema = TSchema> extends Transport<ConnType> {
     /**
      * The options for this transport.
      */
     protected options: ServerTransportOptions;
+    /**
+     * Optional handshake options for the server.
+     */
+    handshakeExtensions?: ServerHandshakeOptions<CustomMetadataSchema>;
+    /**
+     * A map of session handshake data for each session.
+     */
+    sessionHandshakeMetadata: WeakMap<Session<ConnType>, ParsedMetadata>;
     constructor(clientId: TransportClientId, providedOptions?: ProvidedServerTransportOptions);
+    extendHandshake(options: ServerHandshakeOptions<CustomMetadataSchema>): void;
     protected handleConnection(conn: ConnType): void;
+    private validateHandshakeMetadata;
     receiveHandshakeRequestMessage(data: Uint8Array, conn: ConnType): Promise<Session<ConnType> | false>;
 }
 

package/dist/transport/index.js

@@ -5,11 +5,11 @@ import {
   ServerTransport,
   Session,
   Transport
-} from "../chunk-JMXO5L2X.js";
+} from "../chunk-MJUFKPBT.js";
 import {
   OpaqueTransportMessageSchema,
   TransportMessageSchema
-} from "../chunk-5WFL722S.js";
+} from "../chunk-PCKHBAVP.js";
 import "../chunk-OTQNCLFH.js";
 import "../chunk-3AW3IXVD.js";
 export {

package/dist/util/testHelpers.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // util/testHelpers.ts
@@ -25,6 +35,7 @@ __export(testHelpers_exports, {
   asClientSubscription: () => asClientSubscription,
   asClientUpload: () => asClientUpload,
   createDummyTransportMessage: () => createDummyTransportMessage,
+  createLocalWebSocketClient: () => createLocalWebSocketClient,
   createWebSocketServer: () => createWebSocketServer,
   getUnixSocketPath: () => getUnixSocketPath,
   iterNext: () => iterNext,
@@ -35,7 +46,7 @@ __export(testHelpers_exports, {
   waitForMessage: () => waitForMessage
 });
 module.exports = __toCommonJS(testHelpers_exports);
-var import_ws = require("ws");
+var import_ws = __toESM(require("ws"), 1);
 
 // node_modules/p-defer/index.js
 function pDefer() {
@@ -340,6 +351,31 @@ function Err(error) {
 // logging/log.ts
 var log = void 0;
 
+// tracing/index.ts
+var import_api = require("@opentelemetry/api");
+
+// package.json
+var version = "0.23.0";
+
+// tracing/index.ts
+function createSessionTelemetryInfo(session, propagationCtx) {
+  const ctx = propagationCtx ? import_api.propagation.extract(import_api.context.active(), propagationCtx) : import_api.context.active();
+  const span = tracer.startSpan(
+    `session ${session.id}`,
+    {
+      attributes: {
+        component: "river",
+        "river.session.id": session.id,
+        "river.session.to": session.to,
+        "river.session.from": session.from
+      }
+    },
+    ctx
+  );
+  return { span, ctx };
+}
+var tracer = import_api.trace.getTracer("river", version);
+
 // util/stringify.ts
 function coerceErrorString(err) {
   if (err instanceof Error) {
@@ -353,11 +389,13 @@ var import_nanoid2 = require("nanoid");
 
 // transport/session.ts
 var import_nanoid = require("nanoid");
+var import_api2 = require("@opentelemetry/api");
 var nanoid = (0, import_nanoid.customAlphabet)("1234567890abcdefghijklmnopqrstuvxyz", 6);
 var unsafeId = () => nanoid();
 var Session = class {
   codec;
   options;
+  telemetry;
   /**
    * The buffer of messages that have been sent but not yet acknowledged.
    */
@@ -377,12 +415,6 @@ var Session = class {
    * for this session.
    */
   advertisedSessionId;
-  /**
-   * The metadata for this session, as parsed from the handshake.
-   *
-   * Will only ever be populated on the server side.
-   */
-  metadata;
   /**
    * Number of messages we've sent along this session (excluding handshake and acks)
    */
@@ -404,7 +436,7 @@ var Session = class {
    * The interval for sending heartbeats.
    */
   heartbeat;
-  constructor(conn, from, to, options) {
+  constructor(conn, from, to, options, propagationCtx) {
     this.id = `session-${nanoid(12)}`;
     this.options = options;
     this.from = from;
@@ -416,13 +448,14 @@ var Session = class {
       () => this.sendHeartbeat(),
       options.heartbeatIntervalMs
     );
+    this.telemetry = createSessionTelemetryInfo(this, propagationCtx);
   }
   get loggingMetadata() {
     return {
       clientId: this.from,
       connectedTo: this.to,
       sessionId: this.id,
-      connId: this.connection?.debugId
+      connId: this.connection?.id
     };
   }
   /**
@@ -467,6 +500,7 @@ var Session = class {
           `closing connection to ${this.to} due to inactivity (missed ${misses} heartbeats which is ${missDuration}ms)`,
           this.loggingMetadata
         );
+        this.telemetry.span.addEvent("closing connection due to inactivity");
         this.closeStaleConnection();
       }
       return;
@@ -488,21 +522,25 @@ var Session = class {
   sendBufferedMessages(conn) {
     log?.info(`resending ${this.sendBuffer.length} buffered messages`, {
       ...this.loggingMetadata,
-      connId: conn.debugId
+      connId: conn.id
     });
     for (const msg of this.sendBuffer) {
       log?.debug(`resending msg`, {
         ...this.loggingMetadata,
         fullTransportMessage: msg,
-        connId: conn.debugId
+        connId: conn.id
       });
       const ok = conn.send(this.codec.toBuffer(msg));
       if (!ok) {
         const errMsg = `failed to send buffered message to ${this.to} (sus, this is a fresh connection)`;
+        conn.telemetry?.span.setStatus({
+          code: import_api2.SpanStatusCode.ERROR,
+          message: errMsg
+        });
         log?.error(errMsg, {
           ...this.loggingMetadata,
           fullTransportMessage: msg,
-          connId: conn.debugId,
+          connId: conn.id,
           tags: ["invariant-violation"]
         });
         conn.close();
@@ -587,7 +625,6 @@ var Session = class {
 
 // transport/transport.ts
 var import_value = require("@sinclair/typebox/value");
-var import_api = require("@opentelemetry/api");
 
 // codec/json.ts
 var encoder = new TextEncoder();
@@ -642,6 +679,7 @@ var NaiveJsonCodec = {
 };
 
 // transport/transport.ts
+var import_api3 = require("@opentelemetry/api");
 var defaultTransportOptions = {
   heartbeatIntervalMs: 1e3,
   heartbeatsUntilDead: 2,
@@ -664,6 +702,11 @@ var defaultServerTransportOptions = {
 };
 
 // util/testHelpers.ts
+function createLocalWebSocketClient(port) {
+  const sock = new import_ws.default(`ws://localhost:${port}`);
+  sock.binaryType = "arraybuffer";
+  return sock;
+}
 function createWebSocketServer(server) {
   return new import_ws.WebSocketServer({ server });
 }
@@ -737,7 +780,8 @@ function dummyCtx(state, session, extendedContext) {
     to: session.to,
     from: session.from,
     streamId: (0, import_nanoid2.nanoid)(),
-    session
+    session,
+    metadata: {}
   };
 }
 function asClientRpc(state, proc, extendedContext, session = dummySession()) {
@@ -794,6 +838,7 @@ var getUnixSocketPath = () => {
   asClientSubscription,
   asClientUpload,
   createDummyTransportMessage,
+  createLocalWebSocketClient,
   createWebSocketServer,
   getUnixSocketPath,
   iterNext,