@rivetkit/engine-runner 2.3.0-rc.3 → 2.3.0-rc.5

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rivetkit/engine-runner",
-	"version": "2.3.0-rc.3",
+	"version": "2.3.0-rc.5",
 	"type": "module",
 	"files": [
 		"dist",
@@ -25,8 +25,8 @@
 		"bench": "tsx benches/actor-lifecycle.bench.ts"
 	},
 	"dependencies": {
-		"@rivetkit/virtual-websocket": "2.3.0-rc.3",
-		"@rivetkit/engine-runner-protocol": "2.3.0-rc.3",
+		"@rivetkit/virtual-websocket": "2.3.0-rc.5",
+		"@rivetkit/engine-runner-protocol": "2.3.0-rc.5",
 		"uuid": "^12.0.0",
 		"pino": "^9.9.5",
 		"ws": "^8.18.3"

package/src/mod.ts

@@ -12,9 +12,7 @@ import {
 	unreachable,
 } from "./utils";
 import { importWebSocket } from "./websocket.js";
-import {
-	v4 as uuidv4,
-} from "uuid";
+import { v4 as uuidv4 } from "uuid";
 
 export type { HibernatingWebSocketMetadata };
 export { RunnerActor, type ActorConfig };
@@ -562,9 +560,18 @@ export class Runner {
 		this.#kvRequests.clear();
 
 		// Close WebSocket
-		const pegboardWebSocket = this.getPegboardWebSocketIfReady();
-		if (pegboardWebSocket) {
-			if (immediate) {
+		//
+		// A CONNECTING socket cannot send graceful stopping messages, so
+		// it is always closed directly. Without this, a shutdown that
+		// races with a reconnect leaves the in-flight WebSocket alive
+		// while the rest of the runner state (tunnel, intervals) has been
+		// torn down.
+		const pegboardWebSocket = this.#pegboardWebSocket;
+		const readyState = pegboardWebSocket?.readyState;
+		const isOpen = readyState === 1;
+		const isConnecting = readyState === 0;
+		if (pegboardWebSocket && (isOpen || isConnecting)) {
+			if (immediate || isConnecting) {
 				// Stop immediately
 				pegboardWebSocket.close(1000, "pegboard.runner_shutdown");
 			} else {
@@ -876,6 +883,10 @@ export class Runner {
 				if (this.runnerId !== init.runnerId) {
 					this.runnerId = init.runnerId;
 
+					// Invalidate cached child logger so subsequent log
+					// lines pick up the new runnerId.
+					this.#logCached = undefined;
+
 					// Clear actors if runner id changed
 					this.#stopAllActors();
 				}
@@ -1253,9 +1264,10 @@ export class Runner {
 			actorState = {
 				tag: "ActorStateStopped",
 				val: {
-					code: actor.stopIntentSent || this.#draining
-						? protocol.StopCode.Ok
-						: protocol.StopCode.Error,
+					code:
+						actor.stopIntentSent || this.#draining
+							? protocol.StopCode.Ok
+							: protocol.StopCode.Error,
 					message: null,
 				},
 			};

package/src/tunnel.ts

@@ -10,7 +10,13 @@ import {
 	stringifyToClientTunnelMessageKind,
 	stringifyToServerTunnelMessageKind,
 } from "./stringify";
-import { arraysEqual, idToStr, MAX_PAYLOAD_SIZE, stringifyError, unreachable } from "./utils";
+import {
+	arraysEqual,
+	idToStr,
+	MAX_PAYLOAD_SIZE,
+	stringifyError,
+	unreachable,
+} from "./utils";
 import {
 	HIBERNATABLE_SYMBOL,
 	WebSocketTunnelAdapter,

package/src/websocket-tunnel-adapter.ts

@@ -1,7 +1,16 @@
 import type { Logger } from "pino";
-import { VirtualWebSocket, type UniversalWebSocket, type RivetMessageEvent } from "@rivetkit/virtual-websocket";
+import {
+	VirtualWebSocket,
+	type UniversalWebSocket,
+	type RivetMessageEvent,
+} from "@rivetkit/virtual-websocket";
 import type { Tunnel } from "./tunnel";
-import { MAX_PAYLOAD_SIZE, wrappingAddU16, wrappingLteU16, wrappingSubU16 } from "./utils";
+import {
+	MAX_PAYLOAD_SIZE,
+	wrappingAddU16,
+	wrappingLteU16,
+	wrappingSubU16,
+} from "./utils";
 
 export const HIBERNATABLE_SYMBOL = Symbol("hibernatable");
 
@@ -77,18 +86,28 @@ export class WebSocketTunnelAdapter {
 
 			messageData = data;
 		} else if (data instanceof ArrayBuffer) {
-			if (data.byteLength > MAX_PAYLOAD_SIZE) throw new Error("WebSocket message too large");
+			if (data.byteLength > MAX_PAYLOAD_SIZE)
+				throw new Error("WebSocket message too large");
 
 			isBinary = true;
 			messageData = data;
 		} else if (ArrayBuffer.isView(data)) {
-			if (data.byteLength > MAX_PAYLOAD_SIZE) throw new Error("WebSocket message too large");
+			if (data.byteLength > MAX_PAYLOAD_SIZE)
+				throw new Error("WebSocket message too large");
 
 			isBinary = true;
 			const view = data;
-			const buffer = view.buffer instanceof SharedArrayBuffer
-				? new Uint8Array(view.buffer, view.byteOffset, view.byteLength).slice().buffer
-				: view.buffer.slice(view.byteOffset, view.byteOffset + view.byteLength);
+			const buffer =
+				view.buffer instanceof SharedArrayBuffer
+					? new Uint8Array(
+							view.buffer,
+							view.byteOffset,
+							view.byteLength,
+						).slice().buffer
+					: view.buffer.slice(
+							view.byteOffset,
+							view.byteOffset + view.byteLength,
+						);
 			messageData = buffer as ArrayBuffer;
 		} else {
 			throw new Error("Unsupported data type");
@@ -101,7 +120,11 @@ export class WebSocketTunnelAdapter {
 	_handleOpen(requestId: ArrayBuffer): void {
 		if (this.#readyState !== 0) return;
 		this.#readyState = 1;
-		this.#ws.dispatchEvent({ type: "open", rivetRequestId: requestId, target: this.#ws });
+		this.#ws.dispatchEvent({
+			type: "open",
+			rivetRequestId: requestId,
+			target: this.#ws,
+		});
 	}
 
 	// Called by Tunnel when message is received
@@ -147,7 +170,10 @@ export class WebSocketTunnelAdapter {
 					expectedIndex,
 					receivedIndex: serverMessageIndex,
 					closeReason,
-					gap: wrappingSubU16(wrappingSubU16(serverMessageIndex, previousIndex), 1),
+					gap: wrappingSubU16(
+						wrappingSubU16(serverMessageIndex, previousIndex),
+						1,
+					),
 				});
 				this.#close(1008, closeReason, true);
 				return true;
@@ -162,7 +188,10 @@ export class WebSocketTunnelAdapter {
 			if (this.#binaryType === "nodebuffer") {
 				messageData = Buffer.from(data);
 			} else if (this.#binaryType === "arraybuffer") {
-				messageData = data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength);
+				messageData = data.buffer.slice(
+					data.byteOffset,
+					data.byteOffset + data.byteLength,
+				);
 			}
 		}
 
@@ -178,7 +207,11 @@ export class WebSocketTunnelAdapter {
 	}
 
 	// Called by Tunnel when close is received
-	_handleClose(_requestId: ArrayBuffer, code?: number, reason?: string): void {
+	_handleClose(
+		_requestId: ArrayBuffer,
+		code?: number,
+		reason?: string,
+	): void {
 		this.#close(code, reason, true);
 	}
 
@@ -192,7 +225,11 @@ export class WebSocketTunnelAdapter {
 		this.#close(code, reason, true);
 	}
 
-	#close(code: number | undefined, reason: string | undefined, sendCallback: boolean): void {
+	#close(
+		code: number | undefined,
+		reason: string | undefined,
+		sendCallback: boolean,
+	): void {
 		if (this.#readyState >= 2) return;
 
 		this.#readyState = 2;