@rivetkit/engine-runner 2.0.26 → 2.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivetkit/engine-runner",
-  "version": "2.0.26",
+  "version": "2.0.28",
   "type": "module",
   "exports": {
     "import": {
@@ -16,7 +16,7 @@
     "uuid": "^12.0.0",
     "pino": "^9.9.5",
     "ws": "^8.18.3",
-    "@rivetkit/engine-runner-protocol": "2.0.26"
+    "@rivetkit/engine-runner-protocol": "2.0.28"
   },
   "devDependencies": {
     "@types/node": "^22.18.1",

package/src/mod.ts

@@ -18,7 +18,7 @@ export { RunnerActor, type ActorConfig };
 export { idToStr } from "./utils";
 
 const KV_EXPIRE: number = 30_000;
-const PROTOCOL_VERSION: number = 4;
+const PROTOCOL_VERSION: number = 5;
 
 /** Warn once the backlog significantly exceeds the server's ack batch size. */
 const EVENT_BACKLOG_WARN_THRESHOLD = 10_000;
@@ -291,6 +291,11 @@ export class Runner {
 	}
 
 	async forceStopActor(actorId: string, generation?: number) {
+		this.log?.debug({
+			msg: "force stopping actor",
+			actorId,
+		});
+
 		const actor = this.getActor(actorId, generation);
 		if (!actor) return;
 
@@ -308,12 +313,11 @@ export class Runner {
 		// Close requests after onActorStop so you can send messages over the tunnel
 		this.#tunnel?.closeActiveRequests(actor);
 
+		this.#sendActorStateUpdate(actorId, actor.generation, "stopped");
+
 		// Remove actor after stopping in order to ensure that we can still
-		// call actions on the runner. Do this before sending stopped update in
-		// order to ensure we don't have duplicate actors.
+		// call actions on the runner
 		this.#removeActor(actorId, generation);
-
-		this.#sendActorStateUpdate(actorId, actor.generation, "stopped");
 	}
 
 	#handleLost() {
@@ -980,6 +984,14 @@ export class Runner {
 						error: stringifyError(err),
 					});
 				});
+
+				// NOTE: We don't do this for CommandStopActor because the actor will be removed by that call
+				// so we cant update the checkpoint
+				const actor = this.getActor(
+					commandWrapper.checkpoint.actorId,
+					commandWrapper.checkpoint.generation,
+				);
+				if (actor) actor.lastCommandIdx = commandWrapper.checkpoint.index;
 			} else if (commandWrapper.inner.tag === "CommandStopActor") {
 				// Spawn background promise
 				this.#handleCommandStopActor(commandWrapper).catch((err) => {
@@ -992,12 +1004,6 @@ export class Runner {
 			} else {
 				unreachable(commandWrapper.inner);
 			}
-
-			const actor = this.getActor(
-				commandWrapper.checkpoint.actorId,
-				commandWrapper.inner.val.generation,
-			);
-			if (actor) actor.lastCommandIdx = commandWrapper.checkpoint.index;
 		}
 	}
 
@@ -1069,7 +1075,7 @@ export class Runner {
 			.val as protocol.CommandStartActor;
 
 		const actorId = commandWrapper.checkpoint.actorId;
-		const generation = startCommand.generation;
+		const generation = commandWrapper.checkpoint.generation;
 		const config = startCommand.config;
 
 		const actorConfig: ActorConfig = {
@@ -1150,7 +1156,7 @@ export class Runner {
 			.val as protocol.CommandStopActor;
 
 		const actorId = commandWrapper.checkpoint.actorId;
-		const generation = stopCommand.generation;
+		const generation = commandWrapper.checkpoint.generation;
 
 		await this.forceStopActor(actorId, generation);
 	}
@@ -1177,14 +1183,13 @@ export class Runner {
 		}
 
 		const intentEvent: protocol.EventActorIntent = {
-			actorId,
-			generation,
 			intent: actorIntent,
 		};
 
 		const eventWrapper: protocol.EventWrapper = {
 			checkpoint: {
 				actorId,
+				generation,
 				index: actor.nextEventIdx++,
 			},
 			inner: {
@@ -1226,14 +1231,13 @@ export class Runner {
 		}
 
 		const stateUpdateEvent: protocol.EventActorStateUpdate = {
-			actorId,
-			generation,
 			state: actorState,
 		};
 
 		const eventWrapper: protocol.EventWrapper = {
 			checkpoint: {
 				actorId,
+				generation,
 				index: actor.nextEventIdx++,
 			},
 			inner: {
@@ -1261,6 +1265,7 @@ export class Runner {
 
 			lastCommandCheckpoints.push({
 				actorId: actor.actorId,
+				generation: actor.generation,
 				index: actor.lastCommandIdx,
 			});
 		}
@@ -1569,14 +1574,13 @@ export class Runner {
 		if (!actor) return;
 
 		const alarmEvent: protocol.EventActorSetAlarm = {
-			actorId,
-			generation: actor.generation,
 			alarmTs: alarmTs !== null ? BigInt(alarmTs) : null,
 		};
 
 		const eventWrapper: protocol.EventWrapper = {
 			checkpoint: {
 				actorId,
+				generation: actor.generation,
 				index: actor.nextEventIdx++,
 			},
 			inner: {

package/src/stringify.ts

@@ -115,7 +115,7 @@ export function stringifyToClientTunnelMessageKind(
 export function stringifyCommand(command: protocol.Command): string {
 	switch (command.tag) {
 		case "CommandStartActor": {
-			const { generation, config, hibernatingRequests } =
+			const { config, hibernatingRequests } =
 				command.val;
 			const keyStr = config.key === null ? "null" : `"${config.key}"`;
 			const inputStr =
@@ -126,11 +126,10 @@ export function stringifyCommand(command: protocol.Command): string {
 				hibernatingRequests.length > 0
 					? `[${hibernatingRequests.map((hr) => `{gatewayId: ${idToStr(hr.gatewayId)}, requestId: ${idToStr(hr.requestId)}}`).join(", ")}]`
 					: "[]";
-			return `CommandStartActor{generation: ${generation}, config: {name: "${config.name}", key: ${keyStr}, createTs: ${stringifyBigInt(config.createTs)}, input: ${inputStr}}, hibernatingRequests: ${hibernatingRequestsStr}}`;
+			return `CommandStartActor{config: {name: "${config.name}", key: ${keyStr}, createTs: ${stringifyBigInt(config.createTs)}, input: ${inputStr}}, hibernatingRequests: ${hibernatingRequestsStr}}`;
 		}
 		case "CommandStopActor": {
-			const { generation } = command.val;
-			return `CommandStopActor{generation: ${generation}}`;
+			return `CommandStopActor`;
 		}
 	}
 }
@@ -142,7 +141,7 @@ export function stringifyCommand(command: protocol.Command): string {
 export function stringifyCommandWrapper(
 	wrapper: protocol.CommandWrapper,
 ): string {
-	return `CommandWrapper{actorId: "${wrapper.checkpoint.actorId}", index: ${stringifyBigInt(wrapper.checkpoint.index)}, inner: ${stringifyCommand(wrapper.inner)}}`;
+	return `CommandWrapper{actorId: "${wrapper.checkpoint.actorId}", generation: "${wrapper.checkpoint.generation}", index: ${stringifyBigInt(wrapper.checkpoint.index)}, inner: ${stringifyCommand(wrapper.inner)}}`;
 }
 
 /**
@@ -152,17 +151,17 @@ export function stringifyCommandWrapper(
 export function stringifyEvent(event: protocol.Event): string {
 	switch (event.tag) {
 		case "EventActorIntent": {
-			const { actorId, generation, intent } = event.val;
+			const { intent } = event.val;
 			const intentStr =
 				intent.tag === "ActorIntentSleep"
 					? "Sleep"
 					: intent.tag === "ActorIntentStop"
 						? "Stop"
 						: "Unknown";
-			return `EventActorIntent{actorId: "${actorId}", generation: ${generation}, intent: ${intentStr}}`;
+			return `EventActorIntent{intent: ${intentStr}}`;
 		}
 		case "EventActorStateUpdate": {
-			const { actorId, generation, state } = event.val;
+			const { state } = event.val;
 			let stateStr: string;
 			if (state.tag === "ActorStateRunning") {
 				stateStr = "Running";
@@ -173,13 +172,13 @@ export function stringifyEvent(event: protocol.Event): string {
 			} else {
 				stateStr = "Unknown";
 			}
-			return `EventActorStateUpdate{actorId: "${actorId}", generation: ${generation}, state: ${stateStr}}`;
+			return `EventActorStateUpdate{state: ${stateStr}}`;
 		}
 		case "EventActorSetAlarm": {
-			const { actorId, generation, alarmTs } = event.val;
+			const { alarmTs } = event.val;
 			const alarmTsStr =
 				alarmTs === null ? "null" : stringifyBigInt(alarmTs);
-			return `EventActorSetAlarm{actorId: "${actorId}", generation: ${generation}, alarmTs: ${alarmTsStr}}`;
+			return `EventActorSetAlarm{alarmTs: ${alarmTsStr}}`;
 		}
 	}
 }
@@ -189,7 +188,7 @@ export function stringifyEvent(event: protocol.Event): string {
  * Handles ArrayBuffers, BigInts, and Maps that can't be JSON.stringified
  */
 export function stringifyEventWrapper(wrapper: protocol.EventWrapper): string {
-	return `EventWrapper{actorId: ${wrapper.checkpoint.actorId}, index: ${stringifyBigInt(wrapper.checkpoint.index)}, inner: ${stringifyEvent(wrapper.inner)}}`;
+	return `EventWrapper{actorId: ${wrapper.checkpoint.actorId}, generation: "${wrapper.checkpoint.generation}", index: ${stringifyBigInt(wrapper.checkpoint.index)}, inner: ${stringifyEvent(wrapper.inner)}}`;
 }
 
 /**