rivetkit 2.0.5 → 2.0.6

package/src/client/raw-utils.ts

@@ -1,5 +1,5 @@
 import invariant from "invariant";
-import { PATH_RAW_WEBSOCKET_PREFIX } from "@/actor/router";
+import { PATH_RAW_WEBSOCKET_PREFIX } from "@/common/actor-router-consts";
 import { deconstructError } from "@/common/utils";
 import { HEADER_CONN_PARAMS, type ManagerDriver } from "@/driver-helpers/mod";
 import type { ActorQuery } from "@/manager/protocol/query";

package/src/client/utils.ts

@@ -1,8 +1,8 @@
 import * as cbor from "cbor-x";
 import invariant from "invariant";
+import type { Encoding } from "@/actor/protocol/serde";
 import { assertUnreachable } from "@/common/utils";
 import type { VersionedDataHandler } from "@/common/versioned-data";
-import type { Encoding } from "@/mod";
 import type { HttpResponseError } from "@/schemas/client-protocol/mod";
 import { HTTP_RESPONSE_ERROR_VERSIONED } from "@/schemas/client-protocol/versioned";
 import {

package/src/common/actor-router-consts.ts

@@ -0,0 +1,38 @@
+// NOTE: This is in a separate file from the router since it needs to be shared between the client & the server. If this was in the router file, the client would end up importing the *entire* actor router and tree shaking would not work.
+
+// MARK: Paths
+export const PATH_CONNECT_WEBSOCKET = "/connect/websocket";
+export const PATH_RAW_WEBSOCKET_PREFIX = "/raw/websocket/";
+
+// MARK: Headers
+export const HEADER_ACTOR_QUERY = "X-RivetKit-Query";
+
+export const HEADER_ENCODING = "X-RivetKit-Encoding";
+
+// IMPORTANT: Params must be in headers or in an E2EE part of the request (i.e. NOT the URL or query string) in order to ensure that tokens can be securely passed in params.
+export const HEADER_CONN_PARAMS = "X-RivetKit-Conn-Params";
+
+// Internal header
+export const HEADER_AUTH_DATA = "X-RivetKit-Auth-Data";
+
+export const HEADER_ACTOR_ID = "X-RivetKit-Actor";
+
+export const HEADER_CONN_ID = "X-RivetKit-Conn";
+
+export const HEADER_CONN_TOKEN = "X-RivetKit-Conn-Token";
+
+/**
+ * Headers that publics can send from public clients.
+ *
+ * Used for CORS.
+ **/
+export const ALLOWED_PUBLIC_HEADERS = [
+	"Content-Type",
+	"User-Agent",
+	HEADER_ACTOR_QUERY,
+	HEADER_ENCODING,
+	HEADER_CONN_PARAMS,
+	HEADER_ACTOR_ID,
+	HEADER_CONN_ID,
+	HEADER_CONN_TOKEN,
+];

package/src/driver-helpers/mod.ts

@@ -8,7 +8,7 @@ export {
 	HEADER_CONN_PARAMS,
 	HEADER_CONN_TOKEN,
 	HEADER_ENCODING,
-} from "@/actor/router-endpoints";
+} from "@/common/actor-router-consts";
 export type {
 	ActorOutput,
 	CreateInput,

package/src/driver-test-suite/test-inline-client-driver.ts

@@ -3,14 +3,14 @@ import type { Context as HonoContext } from "hono";
 import invariant from "invariant";
 import type { WebSocket } from "ws";
 import type { Encoding } from "@/actor/protocol/serde";
+import { assertUnreachable } from "@/actor/utils";
+import { ActorError as ClientActorError } from "@/client/errors";
+import type { Transport } from "@/client/mod";
 import {
 	HEADER_ACTOR_QUERY,
 	HEADER_CONN_PARAMS,
 	HEADER_ENCODING,
-} from "@/actor/router-endpoints";
-import { assertUnreachable } from "@/actor/utils";
-import { ActorError as ClientActorError } from "@/client/errors";
-import type { Transport } from "@/client/mod";
+} from "@/common/actor-router-consts";
 import type { UniversalEventSource } from "@/common/eventsource-interface";
 import type { DeconstructedError } from "@/common/utils";
 import { importWebSocket } from "@/common/websocket";

package/src/driver-test-suite/utils.ts

@@ -1,7 +1,8 @@
-import { resolve } from "node:path";
+import invariant from "invariant";
 import { type TestContext, vi } from "vitest";
 import { assertUnreachable } from "@/actor/utils";
 import { type Client, createClient } from "@/client/mod";
+import { RunConfigSchema } from "@/driver-helpers/mod";
 import { createClientWithDriver } from "@/mod";
 import type { registry } from "../../fixtures/driver-test-suite/registry";
 import type { DriverTestConfig } from "./mod";
@@ -43,7 +44,11 @@ export async function setupDriverTest(
 			"bare",
 			driverTestConfig.transport ?? "websocket",
 		);
-		client = createClientWithDriver(managerDriver);
+		invariant(driverTestConfig.transport, "missing transport");
+		const runConfig = RunConfigSchema.parse({
+			transport: driverTestConfig.transport,
+		});
+		client = createClientWithDriver(managerDriver, runConfig);
 	} else {
 		assertUnreachable(driverTestConfig.clientType);
 	}

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

@@ -6,10 +6,26 @@ import { Runner } from "@rivetkit/engine-runner";
 import * as cbor from "cbor-x";
 import { WSContext } from "hono/ws";
 import invariant from "invariant";
+import { lookupInRegistry } from "@/actor/definition";
+import {
+	createGenericConnDrivers,
+	GenericConnGlobalState,
+} from "@/actor/generic-conn-driver";
 import { deserializeActorKey } from "@/actor/keys";
 import { EncodingSchema } from "@/actor/protocol/serde";
+import { type ActorRouter, createActorRouter } from "@/actor/router";
+import {
+	handleRawWebSocketHandler,
+	handleWebSocketConnect,
+} from "@/actor/router-endpoints";
 import type { Client } from "@/client/client";
+import {
+	PATH_CONNECT_WEBSOCKET,
+	PATH_RAW_WEBSOCKET_PREFIX,
+} from "@/common/actor-router-consts";
+import type { UpgradeWebSocketArgs } from "@/common/inline-websocket-adapter2";
 import { getLogger } from "@/common/log";
+import type { UniversalWebSocket } from "@/common/websocket-interface";
 import {
 	type ActorDriver,
 	type AnyActorInstance,
@@ -19,23 +35,8 @@ import {
 	type ManagerDriver,
 	serializeEmptyPersistData,
 } from "@/driver-helpers/mod";
-import type {
-	ActorRouter,
-	RegistryConfig,
-	RunConfig,
-	UniversalWebSocket,
-	UpgradeWebSocketArgs,
-} from "@/mod";
-import {
-	createActorRouter,
-	createGenericConnDrivers,
-	GenericConnGlobalState,
-	handleRawWebSocketHandler,
-	handleWebSocketConnect,
-	lookupInRegistry,
-	PATH_CONNECT_WEBSOCKET,
-	PATH_RAW_WEBSOCKET_PREFIX,
-} from "@/mod";
+import type { RegistryConfig } from "@/registry/config";
+import type { RunConfig } from "@/registry/run-config";
 import type { Config } from "./config";
 import { KEYS } from "./kv";
 import { logger } from "./log";

package/src/manager/driver.ts

@@ -1,8 +1,8 @@
 import type { Env, Hono, Context as HonoContext } from "hono";
 import type { ActorKey, Encoding, UniversalWebSocket } from "@/actor/mod";
 import type { ManagerInspector } from "@/inspector/manager";
-import type { RunConfig } from "@/mod";
 import type { RegistryConfig } from "@/registry/config";
+import type { RunConfig } from "@/registry/run-config";
 
 export type ManagerDriverBuilder = (
 	registryConfig: RegistryConfig,

package/src/manager/protocol/query.ts

@@ -7,7 +7,7 @@ import {
 	HEADER_CONN_PARAMS,
 	HEADER_CONN_TOKEN,
 	HEADER_ENCODING,
-} from "@/actor/router-endpoints";
+} from "@/common/actor-router-consts";
 
 // Maximum size of a key component in bytes
 // Set to 128 bytes to allow for separators and escape characters in the full key

package/src/registry/mod.ts

@@ -1,4 +1,3 @@
-import type { Hono } from "hono";
 import { type Client, createClientWithDriver } from "@/client/client";
 import { configureBaseLogger, configureDefaultLogger } from "@/common/log";
 import { chooseDefaultDriver } from "@/drivers/default";
@@ -149,5 +148,11 @@ export function setup<A extends RegistryActors>(
 	return new Registry(config);
 }
 
-export type { RegistryConfig, RegistryActors, RunConfig, DriverConfig };
+export type {
+	RegistryConfig,
+	RegistryActors,
+	RunConfig,
+	RunConfigInput,
+	DriverConfig,
+};
 export { RegistryConfigSchema };

package/src/registry/serve.ts

@@ -1,5 +1,4 @@
 import { Hono } from "hono";
-import { getEnvUniversal } from "@/utils";
 import { logger } from "./log";
 
 export async function crossPlatformServe(
@@ -11,7 +10,10 @@ export async function crossPlatformServe(
 	// Import @hono/node-server
 	let serve: any;
 	try {
-		const dep = await import("@hono/node-server");
+		const dep = await import(
+			/* webpackIgnore: true */
+			"@hono/node-server"
+		);
 		serve = dep.serve;
 	} catch (err) {
 		logger().error(
@@ -27,7 +29,10 @@ export async function crossPlatformServe(
 	// Import @hono/node-ws
 	let createNodeWebSocket: any;
 	try {
-		const dep = await import("@hono/node-ws");
+		const dep = await import(
+			/* webpackIgnore: true */
+			"@hono/node-ws"
+		);
 		createNodeWebSocket = dep.createNodeWebSocket;
 	} catch (err) {
 		logger().error(

package/src/remote-manager-driver/actor-websocket-client.ts

@@ -1,9 +1,9 @@
+import type { ClientConfig } from "@/client/config";
 import {
 	HEADER_AUTH_DATA,
 	HEADER_CONN_PARAMS,
 	HEADER_ENCODING,
-} from "@/actor/router-endpoints";
-import type { ClientConfig } from "@/client/config";
+} from "@/common/actor-router-consts";
 import { importWebSocket } from "@/common/websocket";
 import type { Encoding, UniversalWebSocket } from "@/mod";
 import { combineUrlPath } from "@/utils";

package/src/remote-manager-driver/mod.ts

@@ -1,7 +1,6 @@
 import * as cbor from "cbor-x";
-import type { Hono, Context as HonoContext } from "hono";
+import type { Context as HonoContext } from "hono";
 import invariant from "invariant";
-import { ActorAlreadyExists } from "@/actor/errors";
 import { deserializeActorKey, serializeActorKey } from "@/actor/keys";
 import type { ClientConfig } from "@/client/client";
 import { noopNext } from "@/common/utils";
@@ -14,9 +13,7 @@ import type {
 	ManagerDisplayInformation,
 	ManagerDriver,
 } from "@/driver-helpers/mod";
-import type { ManagerInspector } from "@/inspector/manager";
-import type { Encoding, RegistryConfig, UniversalWebSocket } from "@/mod";
-import type { RunConfig } from "@/registry/run-config";
+import type { Encoding, UniversalWebSocket } from "@/mod";
 import { combineUrlPath } from "@/utils";
 import { sendHttpRequestToActor } from "./actor-http-client";
 import {