rivetkit 2.3.0-rc.5 → 2.3.0-rc.7

package/src/common/utils.ts

@@ -1,9 +1,7 @@
 import type { Next } from "hono";
 import type { ContentfulStatusCode } from "hono/utils/http-status";
 import * as errors from "@/actor/errors";
-import { EXTRA_ERROR_LOG } from "@/utils";
 import { getLogErrorStack } from "@/utils/env-vars";
-import type { Logger } from "./log";
 
 export function assertUnreachable(x: never): never {
 	throw new Error(`Unreachable case: ${x}`);
@@ -38,154 +36,6 @@ export function safeStringify(obj: unknown, maxSize: number) {
 	return JSON.stringify(obj, replacer);
 }
 
-// TODO: Instead of doing this, use a temp var for state and attempt to write
-// it. Roll back state if fails to serialize.
-
-/**
- * Check if a value is CBOR serializable.
- * Optionally pass an onInvalid callback to receive the path to invalid values.
- *
- * For a complete list of supported CBOR tags, see:
- * https://github.com/kriszyp/cbor-x/blob/cc1cf9df8ba72288c7842af1dd374d73e34cdbc1/README.md#list-of-supported-tags-for-decoding
- */
-export function isCborSerializable(
-	value: unknown,
-	onInvalid?: (path: string) => void,
-	currentPath = "",
-): boolean {
-	// Handle primitive types directly
-	if (value === null || value === undefined) {
-		return true;
-	}
-
-	if (typeof value === "number") {
-		if (!Number.isFinite(value)) {
-			onInvalid?.(currentPath);
-			return false;
-		}
-		return true;
-	}
-
-	if (typeof value === "boolean" || typeof value === "string") {
-		return true;
-	}
-
-	// Handle BigInt (CBOR tags 2 and 3)
-	if (typeof value === "bigint") {
-		return true;
-	}
-
-	// Handle Date objects (CBOR tags 0 and 1)
-	if (value instanceof Date) {
-		return true;
-	}
-
-	// Handle typed arrays (CBOR tags 64-82)
-	if (
-		value instanceof Uint8Array ||
-		value instanceof Uint8ClampedArray ||
-		value instanceof Uint16Array ||
-		value instanceof Uint32Array ||
-		value instanceof BigUint64Array ||
-		value instanceof Int8Array ||
-		value instanceof Int16Array ||
-		value instanceof Int32Array ||
-		value instanceof BigInt64Array ||
-		value instanceof Float32Array ||
-		value instanceof Float64Array
-	) {
-		return true;
-	}
-
-	// Handle Map (CBOR tag 259)
-	if (value instanceof Map) {
-		for (const [key, val] of value.entries()) {
-			const keyPath = currentPath
-				? `${currentPath}.key(${String(key)})`
-				: `key(${String(key)})`;
-			const valPath = currentPath
-				? `${currentPath}.value(${String(key)})`
-				: `value(${String(key)})`;
-			if (
-				!isCborSerializable(key, onInvalid, keyPath) ||
-				!isCborSerializable(val, onInvalid, valPath)
-			) {
-				return false;
-			}
-		}
-		return true;
-	}
-
-	// Handle Set (CBOR tag 258)
-	if (value instanceof Set) {
-		let index = 0;
-		for (const item of value.values()) {
-			const itemPath = currentPath
-				? `${currentPath}.set[${index}]`
-				: `set[${index}]`;
-			if (!isCborSerializable(item, onInvalid, itemPath)) {
-				return false;
-			}
-			index++;
-		}
-		return true;
-	}
-
-	// Handle RegExp (CBOR tag 27)
-	if (value instanceof RegExp) {
-		return true;
-	}
-
-	// Handle Error objects (CBOR tag 27)
-	if (value instanceof Error) {
-		return true;
-	}
-
-	// Handle arrays
-	if (Array.isArray(value)) {
-		for (let i = 0; i < value.length; i++) {
-			const itemPath = currentPath ? `${currentPath}[${i}]` : `[${i}]`;
-			if (!isCborSerializable(value[i], onInvalid, itemPath)) {
-				return false;
-			}
-		}
-		return true;
-	}
-
-	// Handle plain objects and records (CBOR tags 105, 51, 57344-57599)
-	if (typeof value === "object") {
-		// Allow plain objects and objects with prototypes (for records and named objects)
-		const proto = Object.getPrototypeOf(value);
-		if (proto !== null && proto !== Object.prototype) {
-			// Check if it's a known serializable object type
-			const protoConstructor = value.constructor;
-			if (protoConstructor && typeof protoConstructor.name === "string") {
-				// Allow objects with named constructors (records, named objects)
-				// This includes user-defined classes and built-in objects
-				// that CBOR can serialize with tag 27 or record tags
-			}
-		}
-
-		// Check all properties recursively
-		for (const key in value) {
-			const propPath = currentPath ? `${currentPath}.${key}` : key;
-			if (
-				!isCborSerializable(
-					value[key as keyof typeof value],
-					onInvalid,
-					propPath,
-				)
-			) {
-				return false;
-			}
-		}
-		return true;
-	}
-
-	// Not serializable
-	onInvalid?.(currentPath);
-	return false;
-}
 
 export interface DeconstructedError {
 	__type: "ActorError";
@@ -195,6 +45,7 @@ export interface DeconstructedError {
 	code: string;
 	message: string;
 	metadata?: unknown;
+	actor?: errors.ActorSpecifier;
 }
 
 function isCanonicalStructuredRivetError(
@@ -221,19 +72,16 @@ function isCanonicalStructuredRivetError(
  */
 export function deconstructError(
 	error: unknown,
-	logger: Logger,
-	extraLog: Record<string, unknown>,
 	exposeInternalError = false,
 ): DeconstructedError {
 	// Build response error information. Only return errors if flagged as public in order to prevent leaking internal behavior.
-	//
-	// We log the error here instead of after generating the code & message because we need to log the original error, not the masked internal error.
 	let statusCode: ContentfulStatusCode;
 	let public_: boolean;
 	let group: string;
 	let code: string;
 	let message: string;
 	let metadata: unknown;
+	let actor: errors.ActorSpecifier | undefined;
 	// Structured errors from core or from pre-built `RivetError` instances are canonical.
 	// Only unstructured errors go through the classifier below.
 	if (isCanonicalStructuredRivetError(error)) {
@@ -249,15 +97,7 @@ export function deconstructError(
 		code = error.code;
 		message = error.message;
 		metadata = error.metadata;
-
-		logger.info({
-			msg: "structured error passthrough",
-			group,
-			code,
-			message,
-			...EXTRA_ERROR_LOG,
-			...extraLog,
-		});
+		actor = error.actor;
 	} else if (errors.ActorError.isActorError(error) && error.public) {
 		// Check if error has statusCode (could be ActorError instance or DeconstructedError)
 		statusCode = (
@@ -268,15 +108,7 @@ export function deconstructError(
 		code = error.code;
 		message = getErrorMessage(error);
 		metadata = error.metadata;
-
-		logger.info({
-			msg: "public error",
-			group,
-			code,
-			message,
-			...EXTRA_ERROR_LOG,
-			...extraLog,
-		});
+		actor = error.actor;
 	} else if (exposeInternalError) {
 		if (errors.ActorError.isActorError(error)) {
 			statusCode = 500;
@@ -285,32 +117,13 @@ export function deconstructError(
 			code = error.code;
 			message = getErrorMessage(error);
 			metadata = error.metadata;
-
-			logger.info({
-				msg: "internal error",
-				group,
-				code,
-				message,
-				stack: (error as Error)?.stack,
-				...EXTRA_ERROR_LOG,
-				...extraLog,
-			});
+			actor = error.actor;
 		} else {
 			statusCode = 500;
 			public_ = false;
 			group = "rivetkit";
 			code = errors.INTERNAL_ERROR_CODE;
 			message = getErrorMessage(error);
-
-			logger.info({
-				msg: "internal error",
-				group,
-				code,
-				message,
-				stack: (error as Error)?.stack,
-				...EXTRA_ERROR_LOG,
-				...extraLog,
-			});
 		}
 	} else {
 		statusCode = 500;
@@ -318,17 +131,12 @@ export function deconstructError(
 		group = "rivetkit";
 		code = errors.INTERNAL_ERROR_CODE;
 		message = errors.INTERNAL_ERROR_DESCRIPTION;
+		if (errors.ActorError.isActorError(error)) {
+			actor = error.actor;
+		}
 		metadata = {
 			//url: `https://hub.rivet.dev/projects/${actorMetadata.project.slug}/environments/${actorMetadata.environment.slug}/actors?actorId=${actorMetadata.actor.id}`,
 		} satisfies errors.InternalErrorMetadata;
-
-		logger.warn({
-			msg: "internal error",
-			error: getErrorMessage(error),
-			stack: (error as Error)?.stack,
-			...EXTRA_ERROR_LOG,
-			...extraLog,
-		});
 	}
 
 	return {
@@ -339,6 +147,7 @@ export function deconstructError(
 		code,
 		message,
 		metadata,
+		actor,
 	};
 }
 

package/src/drivers/engine/actor-driver.ts

@@ -78,7 +78,7 @@ import {
 import { logger } from "./log";
 
 const ENVOY_SSE_PING_INTERVAL = 1000;
-const ENVOY_STOP_WAIT_MS = 15_000;
+const FALLBACK_ENVOY_STOP_WAIT_MS = 15_000;
 const INITIAL_SLEEP_TIMEOUT_MS = 250;
 const REMOTE_ACK_HOOK_QUERY_PARAM = "__rivetkitAckHook";
 
@@ -284,7 +284,7 @@ export class EngineActorDriver implements ActorDriver {
 				logger().debug({
 					msg: "actor crash cleanup errored",
 					actorId,
-					err: stringifyError(err),
+					error: stringifyError(err),
 				});
 			}
 		}
@@ -847,6 +847,7 @@ export class EngineActorDriver implements ActorDriver {
 			return;
 		}
 		this.#isShuttingDown = true;
+		const envoyStopWaitMs = this.#envoyStopWaitMs();
 
 		logger().info({ msg: "stopping engine actor driver", immediate });
 		if (!immediate) {
@@ -861,7 +862,7 @@ export class EngineActorDriver implements ActorDriver {
 				this.startSleep(actorId);
 			}
 
-			const actorSleepDeadline = Date.now() + ENVOY_STOP_WAIT_MS;
+			const actorSleepDeadline = Date.now() + envoyStopWaitMs;
 			while (this.#actors.size > 0 && Date.now() < actorSleepDeadline) {
 				await new Promise((resolve) => setTimeout(resolve, 50));
 			}
@@ -870,7 +871,7 @@ export class EngineActorDriver implements ActorDriver {
 				logger().warn({
 					msg: "timed out waiting for actors to stop before envoy drain",
 					remainingActors: this.#actors.size,
-					waitMs: ENVOY_STOP_WAIT_MS,
+					waitMs: envoyStopWaitMs,
 				});
 				// Snapshot so concurrent removals from `stopActor` do not
 				// invalidate the iterator.
@@ -912,13 +913,13 @@ export class EngineActorDriver implements ActorDriver {
 		const stopped = await Promise.race([
 			this.#envoyStopped.promise.then(() => true),
 			new Promise<false>((resolve) =>
-				setTimeout(() => resolve(false), ENVOY_STOP_WAIT_MS),
+				setTimeout(() => resolve(false), envoyStopWaitMs),
 			),
 		]);
 		if (!stopped) {
 			logger().warn({
 				msg: "timed out waiting for envoy shutdown",
-				waitMs: ENVOY_STOP_WAIT_MS,
+				waitMs: envoyStopWaitMs,
 			});
 		}
 
@@ -929,6 +930,16 @@ export class EngineActorDriver implements ActorDriver {
 		await this.#envoy.started();
 	}
 
+	#envoyStopWaitMs(): number {
+		const actorStopThreshold = Number(
+			this.#envoy.getProtocolMetadata()?.actorStopThreshold,
+		);
+		if (Number.isFinite(actorStopThreshold) && actorStopThreshold > 0) {
+			return actorStopThreshold;
+		}
+		return FALLBACK_ENVOY_STOP_WAIT_MS;
+	}
+
 	async #bindHibernatableConnectSocket(
 		binding: HibernatableConnectBinding,
 		isRestoringHibernatable: boolean,
@@ -1346,7 +1357,7 @@ export class EngineActorDriver implements ActorDriver {
 				logger().warn({
 					msg: "failed to rebind dynamic hibernatable runner websocket",
 					actorId,
-					err: stringifyError(result.reason),
+					error: stringifyError(result.reason),
 				});
 			}
 		}
@@ -1369,7 +1380,7 @@ export class EngineActorDriver implements ActorDriver {
 				logger().warn({
 					msg: "failed to rebind hibernatable connect socket",
 					actorId,
-					err: stringifyError(result.reason),
+					error: stringifyError(result.reason),
 				});
 			}
 		}
@@ -1629,7 +1640,7 @@ export class EngineActorDriver implements ActorDriver {
 					logger().warn({
 						msg: "failed to restore dynamic hibernating requests after actor start",
 						actorId,
-						err: stringifyError(error),
+						error: stringifyError(error),
 					});
 				}
 			} else if (isStaticActorDefinition(definition)) {
@@ -1696,7 +1707,7 @@ export class EngineActorDriver implements ActorDriver {
 					logger().debug({
 						msg: "failed to dispose dynamic runtime after actor start failure",
 						actorId,
-						err: stringifyError(disposeError),
+						error: stringifyError(disposeError),
 					});
 				}
 				this.#dynamicRuntimes.delete(actorId);
@@ -1719,7 +1730,7 @@ export class EngineActorDriver implements ActorDriver {
 				actorId,
 				name,
 				key,
-				err: stringifyError(error),
+				error: stringifyError(error),
 			});
 
 			try {
@@ -1728,7 +1739,7 @@ export class EngineActorDriver implements ActorDriver {
 				logger().debug({
 					msg: "failed to stop actor after start failure",
 					actorId,
-					err: stringifyError(stopError),
+					error: stringifyError(stopError),
 				});
 			}
 		}
@@ -1775,7 +1786,7 @@ export class EngineActorDriver implements ActorDriver {
 				logger().debug({
 					msg: "actor start failed during stop, cleaning up handler",
 					actorId,
-					err: stringifyError(err),
+					error: stringifyError(err),
 				});
 			}
 		}
@@ -1793,7 +1804,7 @@ export class EngineActorDriver implements ActorDriver {
 			} catch (err) {
 				logger().error({
 					msg: "error in onStop, proceeding with removing actor",
-					err: stringifyError(err),
+					error: stringifyError(err),
 				});
 			}
 		}
@@ -1978,8 +1989,8 @@ export class EngineActorDriver implements ActorDriver {
 				isHibernatable,
 				isRestoringHibernatable,
 			);
-		} catch (err) {
-			logger().error({ msg: "building websocket handlers errored", err });
+		} catch (error) {
+			logger().error({ msg: "building websocket handlers errored", error });
 			websocketRaw.close(1011, "ws.route_error");
 			return;
 		}
@@ -2190,12 +2201,7 @@ export class EngineActorDriver implements ActorDriver {
 					isRestoringHibernatable,
 				);
 			} catch (error) {
-				const { group, code } = deconstructError(
-					error,
-					logger(),
-					{},
-					false,
-				);
+				const { group, code } = deconstructError(error, false);
 				logger().error({
 					msg: "failed to bind dynamic hibernatable websocket",
 					actorId,
@@ -2233,12 +2239,7 @@ export class EngineActorDriver implements ActorDriver {
 				},
 			);
 		} catch (error) {
-			const { group, code } = deconstructError(
-				error,
-				logger(),
-				{},
-				false,
-			);
+			const { group, code } = deconstructError(error, false);
 			logger().error({
 				msg: "failed to open dynamic websocket",
 				actorId,

package/src/engine-client/actor-websocket-client.ts

@@ -16,6 +16,7 @@ import { importWebSocket } from "@/common/websocket";
 import { setRemoteHibernatableWebSocketAckTestHooks } from "@/common/websocket-test-hooks";
 import type { ActorGatewayQuery, CrashPolicy } from "@/client/query";
 import type { Encoding, UniversalWebSocket } from "@/mod";
+import type { JsonCompatValue } from "@/common/encoding";
 import { encodeCborCompat, uint8ArrayToBase64 } from "@/serde";
 import { combineUrlPath } from "@/utils";
 import { shouldSkipReadyWait, type GatewayRequestOptions } from "./driver";
@@ -302,7 +303,7 @@ function pushInputQueryParam(
 		return;
 	}
 
-	const encodedInput = encodeCborCompat(input);
+	const encodedInput = encodeCborCompat(input as JsonCompatValue);
 	if (encodedInput.byteLength > maxInputSize) {
 		throw new Error(
 			`Actor query input exceeds maxInputSize (${encodedInput.byteLength} > ${maxInputSize} bytes). Increase client maxInputSize to allow larger query payloads.`,

package/src/engine-client/mod.ts

@@ -23,6 +23,7 @@ import type {
 	RuntimeDisplayInformation,
 } from "@/engine-client/driver";
 import type { Encoding, UniversalWebSocket } from "@/mod";
+import type { JsonCompatValue } from "@/common/encoding";
 import { encodeCborCompat, uint8ArrayToBase64 } from "@/serde";
 import { combineUrlPath, type GetUpgradeWebSocket } from "@/utils";
 import { getNextPhase } from "@/utils/env-vars";
@@ -181,7 +182,7 @@ export class RemoteEngineControlClient implements EngineControlClient {
 			key: serializeActorKey(key),
 			runner_name_selector: this.#config.poolName,
 			input: actorInput
-				? uint8ArrayToBase64(encodeCborCompat(actorInput))
+				? uint8ArrayToBase64(encodeCborCompat(actorInput as JsonCompatValue))
 				: undefined,
 			crash_policy: crashPolicy ?? "sleep",
 		});
@@ -215,7 +216,7 @@ export class RemoteEngineControlClient implements EngineControlClient {
 			runner_name_selector: this.#config.poolName,
 			key: serializeActorKey(key),
 			input: input
-				? uint8ArrayToBase64(encodeCborCompat(input))
+				? uint8ArrayToBase64(encodeCborCompat(input as JsonCompatValue))
 				: undefined,
 			crash_policy: crashPolicy ?? "sleep",
 		});

package/src/registry/config/index.ts

@@ -264,8 +264,8 @@ export const RegistryConfigSchema = z
 			.object({
 				/**
 				 * Wait this many milliseconds for the serve promise to resolve
-				 * after calling `CoreRegistry::shutdown()`. Defaults to 30s,
-				 * matching Kubernetes `terminationGracePeriodSeconds`.
+				 * after calling `CoreRegistry::shutdown()`. Defaults to the
+				 * engine-provided actor stop threshold once the envoy connects.
 				 *
 				 * Must be >= rivetkit-core's drain timeout (20s) + margin.
 				 */
@@ -273,8 +273,7 @@ export const RegistryConfigSchema = z
 					.number()
 					.int()
 					.min(1_000)
-					.optional()
-					.default(30_000),
+					.optional(),
 				/**
 				 * If true, rivetkit will not install SIGINT/SIGTERM handlers.
 				 * Use when the host application owns signal policy and will
@@ -284,7 +283,6 @@ export const RegistryConfigSchema = z
 			})
 			.optional()
 			.default(() => ({
-				gracePeriodMs: 30_000,
 				disableSignalHandlers: false,
 			})),
 	})