chore(rivetkit): remove warnings for graceful runner shtudown

Author: NathanFlurry

engine/sdks/typescript/runner/src/mod.ts

@@ -3,7 +3,11 @@ import type { Logger } from "pino";
 import type WebSocket from "ws";
 import { logger, setLogger } from "./log.js";
 import { Tunnel } from "./tunnel";
-import { calculateBackoff, unreachable } from "./utils";
+import {
+	calculateBackoff,
+	parseWebSocketCloseReason,
+	unreachable,
+} from "./utils";
 import { importWebSocket } from "./websocket.js";
 import type { WebSocketTunnelAdapter } from "./websocket-tunnel-adapter";
 
@@ -430,7 +434,9 @@ export class Runner {
 				}
 			}
 		} else {
-			logger()?.warn({
+			// This is often logged when the serverless SSE stream closes after
+			// the runner has already shut down
+			logger()?.debug({
 				msg: "no runner WebSocket to shutdown or already closed",
 				runnerId: this.runnerId,
 				readyState: this.#pegboardWebSocket?.readyState,
@@ -483,7 +489,20 @@ export class Runner {
 		});
 
 		ws.addEventListener("open", () => {
-			logger()?.info({ msg: "connected" });
+			if (this.#reconnectAttempt > 0) {
+				logger()?.info({
+					msg: "runner reconnected",
+					namespace: this.#config.namespace,
+					runnerName: this.#config.runnerName,
+					reconnectAttempt: this.#reconnectAttempt,
+				});
+			} else {
+				logger()?.debug({
+					msg: "runner connected",
+					namespace: this.#config.namespace,
+					runnerName: this.#config.runnerName,
+				});
+			}
 
 			// Reset reconnect attempt counter on successful connection
 			this.#reconnectAttempt = 0;
@@ -650,22 +669,30 @@ export class Runner {
 		});
 
 		ws.addEventListener("close", async (ev) => {
-			logger()?.info({
-				msg: "connection closed",
-				runnerId: this.runnerId,
-				code: ev.code,
-				reason: ev.reason.toString(),
-			});
-
-			this.#config.onDisconnected(ev.code, ev.reason);
-
-			if (ev.reason.toString().startsWith("ws.eviction")) {
+			const closeError = parseWebSocketCloseReason(ev.reason);
+			if (
+				closeError?.group === "ws" &&
+				closeError?.error === "eviction"
+			) {
 				logger()?.info({
 					msg: "runner evicted",
 					runnerId: this.runnerId,
 				});
 
+				this.#config.onDisconnected(ev.code, ev.reason);
+
 				await this.shutdown(true);
+			} else {
+				logger()?.warn({
+					msg: "runner disconnected",
+					namespace: this.#config.namespace,
+					runnerName: this.#config.runnerName,
+					code: ev.code,
+					reason: ev.reason.toString(),
+					closeError,
+				});
+
+				this.#config.onDisconnected(ev.code, ev.reason);
 			}
 
 			// Clear ping loop on close

engine/sdks/typescript/runner/src/utils.ts

@@ -1,3 +1,5 @@
+import { logger } from "./log";
+
 export function unreachable(x: never): never {
 	throw `Unreachable: ${x}`;
 }
@@ -29,3 +31,36 @@ export function calculateBackoff(
 
 	return Math.floor(delay);
 }
+
+export interface ParsedCloseReason {
+	group: string;
+	error: string;
+	rayId?: string;
+}
+
+/**
+ * Parses a WebSocket close reason in the format: {group}.{error} or {group}.{error}#{ray_id}
+ *
+ * Examples:
+ *   - "ws.eviction#t1s80so6h3irenp8ymzltfoittcl00"
+ *   - "ws.client_closed"
+ *
+ * Returns undefined if the format is invalid
+ */
+export function parseWebSocketCloseReason(
+	reason: string,
+): ParsedCloseReason | undefined {
+	const [mainPart, rayId] = reason.split("#");
+	const [group, error] = mainPart.split(".");
+
+	if (!group || !error) {
+		logger()?.warn({ msg: "failed to parse close reason", reason });
+		return undefined;
+	}
+
+	return {
+		group,
+		error,
+		rayId,
+	};
+}

rivetkit-openapi/openapi.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "version": "2.0.22-rc.2",
+    "version": "2.0.22",
     "title": "RivetKit API"
   },
   "components": {

rivetkit-typescript/packages/rivetkit/src/drivers/engine/actor-driver.ts

@@ -111,7 +111,6 @@ export class EngineActorDriver implements ActorDriver {
 		);
 
 		// Create runner configuration
-		let hasDisconnected = false;
 		const engineRunnerConfig: EngineRunnerConfig = {
 			version: this.#version,
 			endpoint: getEndpoint(runConfig),
@@ -125,32 +124,9 @@ export class EngineActorDriver implements ActorDriver {
 			},
 			prepopulateActorNames: buildActorNames(registryConfig),
 			onConnected: () => {
-				if (hasDisconnected) {
-					logger().info({
-						msg: "runner reconnected",
-						namespace: this.#runConfig.namespace,
-						runnerName: this.#runConfig.runnerName,
-					});
-				} else {
-					logger().debug({
-						msg: "runner connected",
-						namespace: this.#runConfig.namespace,
-						runnerName: this.#runConfig.runnerName,
-					});
-				}
-
 				this.#runnerStarted.resolve(undefined);
 			},
-			onDisconnected: (code, reason) => {
-				logger().warn({
-					msg: "runner disconnected",
-					namespace: this.#runConfig.namespace,
-					runnerName: this.#runConfig.runnerName,
-					code,
-					reason,
-				});
-				hasDisconnected = true;
-			},
+			onDisconnected: (_code, _reason) => {},
 			onShutdown: () => {
 				this.#runnerStopped.resolve(undefined);
 				this.#isRunnerStopped = true;