@replit/river 0.200.0-rc.7 → 0.200.0-rc.8

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

@@ -197,11 +197,20 @@ var ControlMessageHandshakeRequestSchema = import_typebox.Type.Object({
 var HandshakeErrorRetriableResponseCodes = import_typebox.Type.Union([
   import_typebox.Type.Literal("SESSION_STATE_MISMATCH")
 ]);
+var HandshakeErrorCustomHandlerFatalResponseCodes = import_typebox.Type.Union([
+  // The custom validation handler rejected the handler because the client is unsupported.
+  import_typebox.Type.Literal("REJECTED_UNSUPPORTED_CLIENT"),
+  // The custom validation handler rejected the handshake.
+  import_typebox.Type.Literal("REJECTED_BY_CUSTOM_HANDLER")
+]);
 var HandshakeErrorFatalResponseCodes = import_typebox.Type.Union([
+  HandshakeErrorCustomHandlerFatalResponseCodes,
+  // The ciient sent a handshake that doesn't comply with the extended handshake metadata.
   import_typebox.Type.Literal("MALFORMED_HANDSHAKE_META"),
+  // The ciient sent a handshake that doesn't comply with ControlMessageHandshakeRequestSchema.
   import_typebox.Type.Literal("MALFORMED_HANDSHAKE"),
-  import_typebox.Type.Literal("PROTOCOL_VERSION_MISMATCH"),
-  import_typebox.Type.Literal("REJECTED_BY_CUSTOM_HANDLER")
+  // The client's protocol version does not match the server's.
+  import_typebox.Type.Literal("PROTOCOL_VERSION_MISMATCH")
 ]);
 var HandshakeErrorResponseCodes = import_typebox.Type.Union([
   HandshakeErrorRetriableResponseCodes,
@@ -314,6 +323,7 @@ var defaultTransportOptions = {
   sessionDisconnectGraceMs: 5e3,
   connectionTimeoutMs: 2e3,
   handshakeTimeoutMs: 1e3,
+  enableTransparentSessionReconnects: true,
   codec: NaiveJsonCodec
 };
 var defaultConnectionRetryOptions = {
@@ -448,6 +458,7 @@ var StateMachineState = class {
         }
         if (prop === "_handleClose") {
           return () => {
+            target._isConsumed = true;
             target._handleStateExit();
             target._handleClose();
           };
@@ -530,15 +541,18 @@ var IdentifiedSession = class extends CommonSession {
   }
   get loggingMetadata() {
     const spanContext = this.telemetry.span.spanContext();
-    return {
+    const metadata = {
       clientId: this.from,
       connectedTo: this.to,
-      sessionId: this.id,
-      telemetry: {
+      sessionId: this.id
+    };
+    if (this.telemetry.span.isRecording()) {
+      metadata.telemetry = {
         traceId: spanContext.traceId,
         spanId: spanContext.spanId
-      }
-    };
+      };
+    }
+    return metadata;
   }
   constructMsg(partialMsg) {
     const msg = {
@@ -567,9 +581,32 @@ var IdentifiedSession = class extends CommonSession {
     this.telemetry.span.end();
   }
 };
+var IdentifiedSessionWithGracePeriod = class extends IdentifiedSession {
+  graceExpiryTime;
+  gracePeriodTimeout;
+  listeners;
+  constructor(props) {
+    super(props);
+    this.listeners = props.listeners;
+    this.graceExpiryTime = props.graceExpiryTime;
+    this.gracePeriodTimeout = setTimeout(() => {
+      this.listeners.onSessionGracePeriodElapsed();
+    }, this.graceExpiryTime - Date.now());
+  }
+  _handleStateExit() {
+    super._handleStateExit();
+    if (this.gracePeriodTimeout) {
+      clearTimeout(this.gracePeriodTimeout);
+      this.gracePeriodTimeout = void 0;
+    }
+  }
+  _handleClose() {
+    super._handleClose();
+  }
+};
 
 // transport/sessionStateMachine/SessionConnecting.ts
-var SessionConnecting = class extends IdentifiedSession {
+var SessionConnecting = class extends IdentifiedSessionWithGracePeriod {
   state = "Connecting" /* Connecting */;
   connPromise;
   listeners;
@@ -578,9 +615,6 @@ var SessionConnecting = class extends IdentifiedSession {
     super(props);
     this.connPromise = props.connPromise;
     this.listeners = props.listeners;
-    this.connectionTimeout = setTimeout(() => {
-      this.listeners.onConnectionTimeout();
-    }, this.options.connectionTimeoutMs);
     this.connPromise.then(
       (conn) => {
         if (this._isConsumed)
@@ -593,17 +627,33 @@ var SessionConnecting = class extends IdentifiedSession {
         this.listeners.onConnectionFailed(err);
       }
     );
+    this.connectionTimeout = setTimeout(() => {
+      this.listeners.onConnectionTimeout();
+    }, this.options.connectionTimeoutMs);
   }
   // close a pending connection if it resolves, ignore errors if the promise
   // ends up rejected anyways
   bestEffortClose() {
-    void this.connPromise.then((conn) => conn.close()).catch(() => {
+    const logger = this.log;
+    const metadata = this.loggingMetadata;
+    this.connPromise.then((conn) => {
+      conn.close();
+      logger?.info(
+        "connection eventually resolved but session has transitioned, closed connection",
+        {
+          ...metadata,
+          ...conn.loggingMetadata
+        }
+      );
+    }).catch(() => {
     });
   }
   _handleStateExit() {
     super._handleStateExit();
-    clearTimeout(this.connectionTimeout);
-    this.connectionTimeout = void 0;
+    if (this.connectionTimeout) {
+      clearTimeout(this.connectionTimeout);
+      this.connectionTimeout = void 0;
+    }
   }
   _handleClose() {
     this.bestEffortClose();
@@ -612,26 +662,13 @@ var SessionConnecting = class extends IdentifiedSession {
 };
 
 // transport/sessionStateMachine/SessionNoConnection.ts
-var SessionNoConnection = class extends IdentifiedSession {
+var SessionNoConnection = class extends IdentifiedSessionWithGracePeriod {
   state = "NoConnection" /* NoConnection */;
-  listeners;
-  gracePeriodTimeout;
-  constructor(props) {
-    super(props);
-    this.listeners = props.listeners;
-    this.gracePeriodTimeout = setTimeout(() => {
-      this.listeners.onSessionGracePeriodElapsed();
-    }, this.options.sessionDisconnectGraceMs);
-  }
   _handleClose() {
     super._handleClose();
   }
   _handleStateExit() {
     super._handleStateExit();
-    if (this.gracePeriodTimeout) {
-      clearTimeout(this.gracePeriodTimeout);
-      this.gracePeriodTimeout = void 0;
-    }
   }
 };
 
@@ -639,7 +676,7 @@ var SessionNoConnection = class extends IdentifiedSession {
 var import_api = require("@opentelemetry/api");
 
 // package.json
-var version = "0.200.0-rc.7";
+var version = "0.200.0-rc.8";
 
 // tracing/index.ts
 function createSessionTelemetryInfo(sessionId, to, from, propagationCtx) {
@@ -678,20 +715,24 @@ var SessionWaitingForHandshake = class extends CommonSession {
     this.conn.addErrorListener(this.listeners.onConnectionErrored);
     this.conn.addCloseListener(this.listeners.onConnectionClosed);
   }
+  get loggingMetadata() {
+    return {
+      clientId: this.from,
+      connId: this.conn.id,
+      ...this.conn.loggingMetadata
+    };
+  }
   onHandshakeData = (msg) => {
     const parsedMsg = this.parseMsg(msg);
     if (parsedMsg === null) {
-      this.listeners.onInvalidHandshake("could not parse message");
+      this.listeners.onInvalidHandshake(
+        "could not parse message",
+        "MALFORMED_HANDSHAKE"
+      );
       return;
     }
     this.listeners.onHandshake(parsedMsg);
   };
-  get loggingMetadata() {
-    return {
-      clientId: this.from,
-      connId: this.conn.id
-    };
-  }
   sendHandshake(msg) {
     return this.conn.send(this.options.codec.toBuffer(msg));
   }
@@ -708,7 +749,7 @@ var SessionWaitingForHandshake = class extends CommonSession {
 };
 
 // transport/sessionStateMachine/SessionHandshaking.ts
-var SessionHandshaking = class extends IdentifiedSession {
+var SessionHandshaking = class extends IdentifiedSessionWithGracePeriod {
   state = "Handshaking" /* Handshaking */;
   conn;
   listeners;
@@ -724,10 +765,19 @@ var SessionHandshaking = class extends IdentifiedSession {
     this.conn.addErrorListener(this.listeners.onConnectionErrored);
     this.conn.addCloseListener(this.listeners.onConnectionClosed);
   }
+  get loggingMetadata() {
+    return {
+      ...super.loggingMetadata,
+      ...this.conn.loggingMetadata
+    };
+  }
   onHandshakeData = (msg) => {
     const parsedMsg = this.parseMsg(msg);
     if (parsedMsg === null) {
-      this.listeners.onInvalidHandshake("could not parse message");
+      this.listeners.onInvalidHandshake(
+        "could not parse message",
+        "MALFORMED_HANDSHAKE"
+      );
       return;
     }
     this.listeners.onHandshake(parsedMsg);
@@ -740,7 +790,10 @@ var SessionHandshaking = class extends IdentifiedSession {
     this.conn.removeDataListener(this.onHandshakeData);
     this.conn.removeErrorListener(this.listeners.onConnectionErrored);
     this.conn.removeCloseListener(this.listeners.onConnectionClosed);
-    clearTimeout(this.handshakeTimeout);
+    if (this.handshakeTimeout) {
+      clearTimeout(this.handshakeTimeout);
+      this.handshakeTimeout = void 0;
+    }
   }
   _handleClose() {
     super._handleClose();
@@ -805,6 +858,12 @@ var SessionConnected = class extends IdentifiedSession {
       this.heartbeatMisses++;
     }, this.options.heartbeatIntervalMs);
   }
+  get loggingMetadata() {
+    return {
+      ...super.loggingMetadata,
+      ...this.conn.loggingMetadata
+    };
+  }
   startActiveHeartbeat() {
     this.isActivelyHeartbeating = true;
   }
@@ -820,8 +879,10 @@ var SessionConnected = class extends IdentifiedSession {
   }
   onMessageData = (msg) => {
     const parsedMsg = this.parseMsg(msg);
-    if (parsedMsg === null)
+    if (parsedMsg === null) {
+      this.listeners.onInvalidMessage("could not parse message");
       return;
+    }
     if (parsedMsg.seq !== this.ack) {
       if (parsedMsg.seq < this.ack) {
         this.log?.debug(
@@ -878,7 +939,7 @@ var SessionConnected = class extends IdentifiedSession {
 };
 
 // transport/sessionStateMachine/SessionBackingOff.ts
-var SessionBackingOff = class extends IdentifiedSession {
+var SessionBackingOff = class extends IdentifiedSessionWithGracePeriod {
   state = "BackingOff" /* BackingOff */;
   listeners;
   backoffTimeout;
@@ -916,6 +977,12 @@ function inheritSharedSession(session) {
     protocolVersion: session.protocolVersion
   };
 }
+function inheritSharedSessionWithGrace(session) {
+  return {
+    ...inheritSharedSession(session),
+    graceExpiryTime: session.graceExpiryTime
+  };
+}
 var SessionStateGraph = {
   entrypoints: {
     NoConnection: (to, from, listeners, options, protocolVersion, log) => {
@@ -929,6 +996,7 @@ var SessionStateGraph = {
         to,
         seq: 0,
         ack: 0,
+        graceExpiryTime: Date.now() + options.sessionDisconnectGraceMs,
         sendBuffer,
         telemetry,
         options,
@@ -961,7 +1029,7 @@ var SessionStateGraph = {
   transition: {
     // happy path transitions
     NoConnectionToBackingOff: (oldSession, backoffMs, listeners) => {
-      const carriedState = inheritSharedSession(oldSession);
+      const carriedState = inheritSharedSessionWithGrace(oldSession);
       oldSession._handleStateExit();
       const session = new SessionBackingOff({
         backoffMs,
@@ -978,7 +1046,7 @@ var SessionStateGraph = {
       return session;
     },
     BackingOffToConnecting: (oldSession, connPromise, listeners) => {
-      const carriedState = inheritSharedSession(oldSession);
+      const carriedState = inheritSharedSessionWithGrace(oldSession);
       oldSession._handleStateExit();
       const session = new SessionConnecting({
         connPromise,
@@ -995,7 +1063,7 @@ var SessionStateGraph = {
       return session;
     },
     ConnectingToHandshaking: (oldSession, conn, listeners) => {
-      const carriedState = inheritSharedSession(oldSession);
+      const carriedState = inheritSharedSessionWithGrace(oldSession);
       oldSession._handleStateExit();
       const session = new SessionHandshaking({
         conn,
@@ -1073,9 +1141,12 @@ var SessionStateGraph = {
     },
     // disconnect paths
     BackingOffToNoConnection: (oldSession, listeners) => {
-      const carriedState = inheritSharedSession(oldSession);
+      const carriedState = inheritSharedSessionWithGrace(oldSession);
       oldSession._handleStateExit();
-      const session = new SessionNoConnection({ listeners, ...carriedState });
+      const session = new SessionNoConnection({
+        listeners,
+        ...carriedState
+      });
       session.log?.info(
         `session ${session.id} transition from BackingOff to NoConnection`,
         {
@@ -1086,10 +1157,13 @@ var SessionStateGraph = {
       return session;
     },
     ConnectingToNoConnection: (oldSession, listeners) => {
-      const carriedState = inheritSharedSession(oldSession);
+      const carriedState = inheritSharedSessionWithGrace(oldSession);
       oldSession.bestEffortClose();
       oldSession._handleStateExit();
-      const session = new SessionNoConnection({ listeners, ...carriedState });
+      const session = new SessionNoConnection({
+        listeners,
+        ...carriedState
+      });
       session.log?.info(
         `session ${session.id} transition from Connecting to NoConnection`,
         {
@@ -1100,10 +1174,13 @@ var SessionStateGraph = {
       return session;
     },
     HandshakingToNoConnection: (oldSession, listeners) => {
-      const carriedState = inheritSharedSession(oldSession);
+      const carriedState = inheritSharedSessionWithGrace(oldSession);
       oldSession.conn.close();
       oldSession._handleStateExit();
-      const session = new SessionNoConnection({ listeners, ...carriedState });
+      const session = new SessionNoConnection({
+        listeners,
+        ...carriedState
+      });
       session.log?.info(
         `session ${session.id} transition from Handshaking to NoConnection`,
         {
@@ -1115,9 +1192,14 @@ var SessionStateGraph = {
     },
     ConnectedToNoConnection: (oldSession, listeners) => {
       const carriedState = inheritSharedSession(oldSession);
+      const graceExpiryTime = Date.now() + oldSession.options.sessionDisconnectGraceMs;
       oldSession.conn.close();
       oldSession._handleStateExit();
-      const session = new SessionNoConnection({ listeners, ...carriedState });
+      const session = new SessionNoConnection({
+        listeners,
+        graceExpiryTime,
+        ...carriedState
+      });
       session.log?.info(
         `session ${session.id} transition from Connected to NoConnection`,
         {
@@ -1134,24 +1216,42 @@ var ClientSessionStateGraph = {
   entrypoint: SessionStateGraph.entrypoints.NoConnection,
   transition: {
     // happy paths
+    // NoConnection -> BackingOff: attempt to connect
     NoConnectionToBackingOff: transitions.NoConnectionToBackingOff,
+    // BackingOff -> Connecting: backoff period elapsed, start connection
     BackingOffToConnecting: transitions.BackingOffToConnecting,
+    // Connecting -> Handshaking: connection established, start handshake
     ConnectingToHandshaking: transitions.ConnectingToHandshaking,
+    // Handshaking -> Connected: handshake complete, session ready
     HandshakingToConnected: transitions.HandshakingToConnected,
     // disconnect paths
+    // BackingOff -> NoConnection: unused
     BackingOffToNoConnection: transitions.BackingOffToNoConnection,
+    // Connecting -> NoConnection: connection failed or connection timeout
     ConnectingToNoConnection: transitions.ConnectingToNoConnection,
+    // Handshaking -> NoConnection: connection closed or handshake timeout
     HandshakingToNoConnection: transitions.HandshakingToNoConnection,
+    // Connected -> NoConnection: connection closed
     ConnectedToNoConnection: transitions.ConnectedToNoConnection
+    // destroy/close paths
+    // NoConnection -> x: grace period elapsed
+    // BackingOff -> x: grace period elapsed
+    // Connecting -> x: grace period elapsed
+    // Handshaking -> x: grace period elapsed or invalid handshake message or handshake rejection
+    // Connected -> x: grace period elapsed or invalid message
   }
 };
 var ServerSessionStateGraph = {
   entrypoint: SessionStateGraph.entrypoints.WaitingForHandshake,
   transition: {
     // happy paths
+    // WaitingForHandshake -> Connected: handshake complete, session ready
     WaitingForHandshakeToConnected: transitions.WaitingForHandshakeToConnected,
     // disconnect paths
+    // Connected -> NoConnection: connection closed
     ConnectedToNoConnection: transitions.ConnectedToNoConnection
+    // destroy/close paths
+    // WaitingForHandshake -> x: handshake timeout elapsed or invalid handshake message or handshake rejection or connection closed
   }
 };
 
@@ -1220,8 +1320,8 @@ var Transport = class {
   removeEventListener(type, handler) {
     this.eventDispatcher.removeEventListener(type, handler);
   }
-  protocolError(type, message) {
-    this.eventDispatcher.dispatchEvent("protocolError", { type, message });
+  protocolError(message) {
+    this.eventDispatcher.dispatchEvent("protocolError", message);
   }
   /**
    * Default close implementation for transports. You should override this in the downstream
@@ -1268,8 +1368,9 @@ var Transport = class {
       status: "disconnect",
       session
     });
+    const to = session.to;
     session.close();
-    this.sessions.delete(session.to);
+    this.sessions.delete(to);
   }
   // common listeners
   onSessionGracePeriodElapsed(session) {
@@ -1426,13 +1527,17 @@ var ServerTransport = class extends Transport {
           receivedHandshake = true;
           void this.onHandshakeRequest(pendingSession, msg);
         },
-        onInvalidHandshake: (reason) => {
+        onInvalidHandshake: (reason, code) => {
           this.log?.error(
             `invalid handshake: ${reason}`,
             pendingSession.loggingMetadata
           );
           this.deletePendingSession(pendingSession);
-          this.protocolError(ProtocolError.HandshakeFailed, reason);
+          this.protocolError({
+            type: ProtocolError.HandshakeFailed,
+            code,
+            message: reason
+          });
         }
       },
       this.options,
@@ -1457,7 +1562,11 @@ var ServerTransport = class extends Transport {
         }
       })
     );
-    this.protocolError(ProtocolError.HandshakeFailed, reason);
+    this.protocolError({
+      type: ProtocolError.HandshakeFailed,
+      code,
+      message: reason
+    });
     this.deletePendingSession(session);
   }
   async onHandshakeRequest(session, msg) {
@@ -1494,19 +1603,58 @@ var ServerTransport = class extends Transport {
       return;
     }
     let oldSession = this.sessions.get(msg.from);
-    const parsedMetadata = await this.validateHandshakeMetadata(
-      session,
-      oldSession,
-      msg.payload.metadata,
-      msg.from
-    );
-    if (parsedMetadata === false) {
-      return;
+    let parsedMetadata = {};
+    if (this.handshakeExtensions) {
+      if (!import_value2.Value.Check(this.handshakeExtensions.schema, msg.payload.metadata)) {
+        this.rejectHandshakeRequest(
+          session,
+          msg.from,
+          "received malformed handshake metadata",
+          "MALFORMED_HANDSHAKE_META",
+          {
+            ...session.loggingMetadata,
+            connectedTo: msg.from,
+            validationErrors: [
+              ...import_value2.Value.Errors(
+                this.handshakeExtensions.schema,
+                msg.payload.metadata
+              )
+            ]
+          }
+        );
+        return;
+      }
+      const previousParsedMetadata = oldSession ? this.sessionHandshakeMetadata.get(oldSession.to) : void 0;
+      const parsedMetadataOrFailureCode = await this.handshakeExtensions.validate(
+        msg.payload.metadata,
+        previousParsedMetadata
+      );
+      if (session._isConsumed) {
+        return;
+      }
+      if (import_value2.Value.Check(
+        HandshakeErrorCustomHandlerFatalResponseCodes,
+        parsedMetadataOrFailureCode
+      )) {
+        this.rejectHandshakeRequest(
+          session,
+          msg.from,
+          "rejected by handshake handler",
+          parsedMetadataOrFailureCode,
+          {
+            ...session.loggingMetadata,
+            connectedTo: msg.from,
+            clientId: this.clientId
+          }
+        );
+        return;
+      }
+      parsedMetadata = parsedMetadataOrFailureCode;
     }
     let connectCase = "new session";
     const clientNextExpectedSeq = msg.payload.expectedSessionState.nextExpectedSeq;
     const clientNextSentSeq = msg.payload.expectedSessionState.nextSentSeq ?? 0;
-    if (oldSession && oldSession.id === msg.payload.sessionId) {
+    if (this.options.enableTransparentSessionReconnects && oldSession && oldSession.id === msg.payload.sessionId) {
       connectCase = "transparent reconnection";
       const ourNextSeq = oldSession.nextSeq();
       const ourAck = oldSession.ack;
@@ -1565,10 +1713,11 @@ var ServerTransport = class extends Transport {
     }
     if (!oldSession && (clientNextSentSeq > 0 || clientNextExpectedSeq > 0)) {
       connectCase = "unknown session";
+      const rejectionMessage = this.options.enableTransparentSessionReconnects ? `client is trying to reconnect to a session the server don't know about: ${msg.payload.sessionId}` : `client is attempting a transparent reconnect to a session but the server does not support it: ${msg.payload.sessionId}`;
       this.rejectHandshakeRequest(
         session,
         msg.from,
-        `client is trying to reconnect to a session the server don't know about: ${msg.payload.sessionId}`,
+        rejectionMessage,
         "SESSION_STATE_MISMATCH",
         {
           ...session.loggingMetadata,
@@ -1619,7 +1768,10 @@ var ServerTransport = class extends Transport {
         },
         onMessage: (msg2) => this.handleMsg(msg2),
         onInvalidMessage: (reason) => {
-          this.protocolError(ProtocolError.MessageOrderingViolated, reason);
+          this.protocolError({
+            type: ProtocolError.MessageOrderingViolated,
+            message: reason
+          });
           this.deleteSession(connectedSession);
         }
       },
@@ -1630,47 +1782,6 @@ var ServerTransport = class extends Transport {
     this.pendingSessions.delete(session);
     connectedSession.startActiveHeartbeat();
   }
-  async validateHandshakeMetadata(handshakingSession, existingSession, rawMetadata, from) {
-    let parsedMetadata = {};
-    if (this.handshakeExtensions) {
-      if (!import_value2.Value.Check(this.handshakeExtensions.schema, rawMetadata)) {
-        this.rejectHandshakeRequest(
-          handshakingSession,
-          from,
-          "received malformed handshake metadata",
-          "MALFORMED_HANDSHAKE_META",
-          {
-            ...handshakingSession.loggingMetadata,
-            connectedTo: from,
-            validationErrors: [
-              ...import_value2.Value.Errors(this.handshakeExtensions.schema, rawMetadata)
-            ]
-          }
-        );
-        return false;
-      }
-      const previousParsedMetadata = existingSession ? this.sessionHandshakeMetadata.get(existingSession.to) : void 0;
-      parsedMetadata = await this.handshakeExtensions.validate(
-        rawMetadata,
-        previousParsedMetadata
-      );
-      if (parsedMetadata === false) {
-        this.rejectHandshakeRequest(
-          handshakingSession,
-          from,
-          "rejected by handshake handler",
-          "REJECTED_BY_CUSTOM_HANDLER",
-          {
-            ...handshakingSession.loggingMetadata,
-            connectedTo: from,
-            clientId: this.clientId
-          }
-        );
-        return false;
-      }
-    }
-    return parsedMetadata;
-  }
 };
 
 // transport/impls/ws/server.ts