@rivetkit/engine-runner 25.7.1-rc.1 → 25.7.2

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Rivet Gaming, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/package.json

@@ -1,38 +1,37 @@
 {
-	"name": "@rivetkit/engine-runner",
-	"version": "25.7.1-rc.1",
-	"type": "module",
-	"exports": {
-		"import": {
-			"types": "./dist/mod.d.ts",
-			"default": "./dist/mod.js"
-		},
-		"require": {
-			"types": "./dist/mod.d.cts",
-			"default": "./dist/mod.cjs"
-		}
-	},
-	"scripts": {
-		"build": "tsup src/mod.ts",
-		"check-types": "tsc --noEmit",
-		"test": "vitest run",
-		"test:watch": "vitest",
-		"bench": "tsx benches/actor-lifecycle.bench.ts"
-	},
-	"dependencies": {
-		"@rivetkit/engine-runner-protocol": "workspace:*",
-		"@rivetkit/engine-tunnel-protocol": "workspace:*",
-		"uuid": "^12.0.0",
-		"pino": "^9.9.5",
-		"ws": "^8.18.3"
-	},
-	"devDependencies": {
-		"@types/node": "^22.13.9",
-		"@types/ws": "^8.18.1",
-		"tinybench": "^5.0.0",
-		"tsup": "^8.5.0",
-		"tsx": "^4.19.3",
-		"typescript": "^5.3.3",
-		"vitest": "^1.6.0"
-	}
-}
+  "name": "@rivetkit/engine-runner",
+  "version": "25.7.2",
+  "type": "module",
+  "exports": {
+    "import": {
+      "types": "./dist/mod.d.ts",
+      "default": "./dist/mod.js"
+    },
+    "require": {
+      "types": "./dist/mod.d.cts",
+      "default": "./dist/mod.cjs"
+    }
+  },
+  "dependencies": {
+    "uuid": "^12.0.0",
+    "pino": "^9.9.5",
+    "ws": "^8.18.3",
+    "@rivetkit/engine-runner-protocol": "25.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.9",
+    "@types/ws": "^8.18.1",
+    "tinybench": "^5.0.0",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.3",
+    "typescript": "^5.3.3",
+    "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "build": "tsup src/mod.ts",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "bench": "tsx benches/actor-lifecycle.bench.ts"
+  }
+}

package/src/mod.ts

@@ -1,9 +1,9 @@
-import WebSocket from "ws";
+import type WebSocket from "ws";
 import { importWebSocket } from "./websocket.js";
 import * as protocol from "@rivetkit/engine-runner-protocol";
 import { unreachable, calculateBackoff } from "./utils";
 import { Tunnel } from "./tunnel";
-import { WebSocketTunnelAdapter } from "./websocket-tunnel-adapter";
+import type { WebSocketTunnelAdapter } from "./websocket-tunnel-adapter";
 import type { Logger } from "pino";
 import { setLogger, logger } from "./log.js";
 
@@ -28,6 +28,7 @@ export interface RunnerConfig {
 	logger?: Logger;
 	version: number;
 	endpoint: string;
+	token?: string;
 	pegboardEndpoint?: string;
 	pegboardRelayEndpoint?: string;
 	namespace: string;
@@ -102,12 +103,14 @@ export class Runner {
 	#kvCleanupInterval?: NodeJS.Timeout;
 
 	// Tunnel for HTTP/WebSocket forwarding
-	#tunnel?: Tunnel;
+	#tunnel: Tunnel;
 
 	constructor(config: RunnerConfig) {
 		this.#config = config;
 		if (this.#config.logger) setLogger(this.#config.logger);
 
+		this.#tunnel = new Tunnel(this);
+
 		// TODO(RVT-4986): Prune when server acks events
 		// Start pruning old events every minute
 		this.#eventPruneInterval = setInterval(() => {
@@ -137,9 +140,7 @@ export class Runner {
 		if (!actor) return;
 
 		// Unregister actor from tunnel
-		if (this.#tunnel) {
-			this.#tunnel.unregisterActor(actor);
-		}
+		this.#tunnel.unregisterActor(actor);
 
 		// If onActorStop times out, Pegboard will handle this timeout with ACTOR_STOP_THRESHOLD_DURATION_MS
 		try {
@@ -244,10 +245,9 @@ export class Runner {
 
 		logger()?.info("starting runner");
 
+		this.#tunnel.start();
+
 		try {
-			// Connect tunnel first and wait for it to be ready before connecting runner WebSocket
-			// This prevents a race condition where the runner appears ready but can't accept network requests
-			await this.#openTunnelAndWait();
 			await this.#openPegboardWebSocket();
 		} catch (error) {
 			this.#started = false;
@@ -312,7 +312,7 @@ export class Runner {
 		// Close WebSocket
 		if (
 			this.#pegboardWebSocket &&
-			this.#pegboardWebSocket.readyState === WebSocket.OPEN
+			this.#pegboardWebSocket.readyState === 1
 		) {
 			const pegboardWebSocket = this.#pegboardWebSocket;
 			if (immediate) {
@@ -334,7 +334,7 @@ export class Runner {
 					});
 					if (
 						this.#pegboardWebSocket &&
-						this.#pegboardWebSocket.readyState === WebSocket.OPEN
+						this.#pegboardWebSocket.readyState === 1
 					) {
 						this.#pegboardWebSocket.send(encoded);
 					} else {
@@ -405,52 +405,16 @@ export class Runner {
 		const wsEndpoint = endpoint
 			.replace("http://", "ws://")
 			.replace("https://", "wss://");
-		return `${wsEndpoint}?protocol_version=1&namespace=${encodeURIComponent(this.#config.namespace)}&runner_key=${this.#config.runnerKey}`;
-	}
-
-	async #openTunnelAndWait(): Promise<void> {
-		return new Promise((resolve, reject) => {
-			const url = this.pegboardTunnelUrl;
-			logger()?.info({ msg: "opening tunnel to:", url });
-			logger()?.info({
-				msg: "current runner id:",
-				runnerId: this.runnerId || "none",
-			});
-			logger()?.info({
-				msg: "active actors count:",
-				actors: this.#actors.size,
-			});
-
-			let connected = false;
-
-			this.#tunnel = new Tunnel(this, url, {
-				onConnected: () => {
-					if (!connected) {
-						connected = true;
-						logger()?.info("tunnel connected");
-						resolve();
-					}
-				},
-				onDisconnected: () => {
-					if (!connected) {
-						// First connection attempt failed
-						reject(new Error("Tunnel connection failed"));
-					}
-					// If already connected, tunnel will handle reconnection automatically
-				},
-			});
-			this.#tunnel.start();
-		});
+		return `${wsEndpoint}?protocol_version=1&namespace=${encodeURIComponent(this.#config.namespace)}&runner_name=${encodeURIComponent(this.#config.runnerName)}&runner_key=${encodeURIComponent(this.#config.runnerKey)}`;
 	}
 
 	// MARK: Runner protocol
 	async #openPegboardWebSocket() {
+		const protocols = ["rivet", `rivet_target.runner`];
+		if (this.config.token) protocols.push(`rivet_token.${this.config.token}`);
+
 		const WS = await importWebSocket();
-		const ws = new WS(this.pegboardUrl, {
-			headers: {
-				"x-rivet-target": "runner-ws",
-			},
-		}) as any as WebSocket;
+		const ws = new WS(this.pegboardUrl, protocols) as any as WebSocket;
 		this.#pegboardWebSocket = ws;
 
 		ws.addEventListener("open", () => {
@@ -491,7 +455,7 @@ export class Runner {
 				metadata: JSON.stringify(this.#config.metadata),
 			};
 
-			this.#sendToServer({
+			this.__sendToServer({
 				tag: "ToServerInit",
 				val: init,
 			});
@@ -502,8 +466,8 @@ export class Runner {
 			// Start ping interval
 			const pingInterval = 1000;
 			const pingLoop = setInterval(() => {
-				if (ws.readyState === WebSocket.OPEN) {
-					this.#sendToServer({
+				if (ws.readyState === 1) {
+					this.__sendToServer({
 						tag: "ToServerPing",
 						val: {
 							ts: BigInt(Date.now()),
@@ -519,7 +483,7 @@ export class Runner {
 			// Start command acknowledgment interval (5 minutes)
 			const ackInterval = 5 * 60 * 1000; // 5 minutes in milliseconds
 			const ackLoop = setInterval(() => {
-				if (ws.readyState === WebSocket.OPEN) {
+				if (ws.readyState === 1) {
 					this.#sendCommandAcknowledgment();
 				} else {
 					clearInterval(ackLoop);
@@ -530,13 +494,13 @@ export class Runner {
 		});
 
 		ws.addEventListener("message", async (ev) => {
-			let buf;
+			let buf: Uint8Array;
 			if (ev.data instanceof Blob) {
 				buf = new Uint8Array(await ev.data.arrayBuffer());
 			} else if (Buffer.isBuffer(ev.data)) {
 				buf = new Uint8Array(ev.data);
 			} else {
-				throw new Error("expected binary data, got " + typeof ev.data);
+				throw new Error(`expected binary data, got ${typeof ev.data}`);
 			}
 
 			// Parse message
@@ -545,7 +509,6 @@ export class Runner {
 			// Handle message
 			if (message.tag === "ToClientInit") {
 				const init = message.val;
-				const hadRunnerId = !!this.runnerId;
 				this.runnerId = init.runnerId;
 
 				// Store the runner lost threshold from metadata
@@ -572,11 +535,17 @@ export class Runner {
 			} else if (message.tag === "ToClientKvResponse") {
 				const kvResponse = message.val;
 				this.#handleKvResponse(kvResponse);
+			} else if (message.tag === "ToClientTunnelMessage") {
+				this.#tunnel?.handleTunnelMessage(message.val);
+			} else if (message.tag === "ToClientClose") {
+				// TODO: Close ws
+			} else {
+				unreachable(message);
 			}
 		});
 
 		ws.addEventListener("error", (ev) => {
-			logger()?.error("WebSocket error:", ev.error);
+			logger()?.error(`WebSocket error: ${ev.error}`);
 		});
 
 		ws.addEventListener("close", (ev) => {
@@ -633,6 +602,8 @@ export class Runner {
 				this.#handleCommandStartActor(commandWrapper);
 			} else if (commandWrapper.inner.tag === "CommandStopActor") {
 				this.#handleCommandStopActor(commandWrapper);
+			} else {
+				unreachable(commandWrapper.inner);
 			}
 
 			this.#lastCommandIdx = Number(commandWrapper.index);
@@ -743,7 +714,7 @@ export class Runner {
 			val: eventWrapper.inner.val,
 		});
 
-		this.#sendToServer({
+		this.__sendToServer({
 			tag: "ToServerEvents",
 			val: [eventWrapper],
 		});
@@ -804,7 +775,7 @@ export class Runner {
 			val: eventWrapper.inner.val,
 		});
 
-		this.#sendToServer({
+		this.__sendToServer({
 			tag: "ToServerEvents",
 			val: [eventWrapper],
 		});
@@ -825,7 +796,7 @@ export class Runner {
 
 		//logger()?.log("Sending command acknowledgment", this.#lastCommandIdx);
 
-		this.#sendToServer({
+		this.__sendToServer({
 			tag: "ToServerAckCommands",
 			val: {
 				lastCommandIdx: BigInt(this.#lastCommandIdx),
@@ -1154,7 +1125,7 @@ export class Runner {
 			timestamp: Date.now(),
 		});
 
-		this.#sendToServer({
+		this.__sendToServer({
 			tag: "ToServerEvents",
 			val: [eventWrapper],
 		});
@@ -1177,7 +1148,7 @@ export class Runner {
 			const requestId = this.#nextRequestId++;
 			const isConnected =
 				this.#pegboardWebSocket &&
-				this.#pegboardWebSocket.readyState === WebSocket.OPEN;
+				this.#pegboardWebSocket.readyState === 1;
 
 			// Store the request
 			const requestEntry = {
@@ -1209,7 +1180,7 @@ export class Runner {
 				data: request.data,
 			};
 
-			this.#sendToServer({
+			this.__sendToServer({
 				tag: "ToServerKvRequest",
 				val: kvRequest,
 			});
@@ -1226,7 +1197,7 @@ export class Runner {
 	#processUnsentKvRequests() {
 		if (
 			!this.#pegboardWebSocket ||
-			this.#pegboardWebSocket.readyState !== WebSocket.OPEN
+			this.#pegboardWebSocket.readyState !== 1
 		) {
 			return;
 		}
@@ -1244,7 +1215,13 @@ export class Runner {
 		}
 	}
 
-	#sendToServer(message: protocol.ToServer) {
+	__webSocketReady(): boolean {
+		return this.#pegboardWebSocket
+			? this.#pegboardWebSocket.readyState === 1
+			: false;
+	}
+
+	__sendToServer(message: protocol.ToServer) {
 		if (this.#shutdown) {
 			logger()?.warn(
 				"Runner is shut down, cannot send message to server",
@@ -1255,7 +1232,7 @@ export class Runner {
 		const encoded = protocol.encodeToServer(message);
 		if (
 			this.#pegboardWebSocket &&
-			this.#pegboardWebSocket.readyState === WebSocket.OPEN
+			this.#pegboardWebSocket.readyState === 1
 		) {
 			this.#pegboardWebSocket.send(encoded);
 		} else {
@@ -1306,7 +1283,7 @@ export class Runner {
 
 		// Resend events in batches
 		const events = eventsToResend.map((item) => item.event);
-		this.#sendToServer({
+		this.__sendToServer({
 			tag: "ToServerEvents",
 			val: events,
 		});