rivetkit 2.0.24-rc.1 → 2.0.24

package/src/actor/contexts/on-connect.ts

@@ -0,0 +1,22 @@
+import type { AnyDatabaseProvider } from "../database";
+import { ConnContext } from "./conn";
+
+/**
+ * Context for the onConnect lifecycle hook.
+ * Called when a connection is successfully established.
+ */
+export class OnConnectContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+> extends ConnContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase
+> {}

package/src/actor/contexts/request.ts

@@ -0,0 +1,48 @@
+import type { Conn } from "../conn/mod";
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorInstance } from "../instance/mod";
+import { ConnContext } from "./conn";
+
+/**
+ * Context for raw HTTP request handlers (onRequest).
+ */
+export class RequestContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+> extends ConnContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase
+> {
+	/**
+	 * The incoming HTTP request.
+	 * May be undefined for request contexts initiated without a direct HTTP request.
+	 */
+	public readonly request: Request | undefined;
+
+	/**
+	 * @internal
+	 */
+	constructor(
+		actor: ActorInstance<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TDatabase
+		>,
+		conn: Conn<TState, TConnParams, TConnState, TVars, TInput, TDatabase>,
+		request?: Request,
+	) {
+		super(actor, conn);
+		this.request = request;
+	}
+}

package/src/actor/contexts/websocket.ts

@@ -0,0 +1,48 @@
+import type { Conn } from "../conn/mod";
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorInstance } from "../instance/mod";
+import { ConnContext } from "./conn";
+
+/**
+ * Context for raw WebSocket handlers (onWebSocket).
+ */
+export class WebSocketContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+> extends ConnContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase
+> {
+	/**
+	 * The incoming HTTP request that initiated the WebSocket upgrade.
+	 * May be undefined for WebSocket connections initiated without a direct HTTP request.
+	 */
+	public readonly request: Request | undefined;
+
+	/**
+	 * @internal
+	 */
+	constructor(
+		actor: ActorInstance<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TDatabase
+		>,
+		conn: Conn<TState, TConnParams, TConnState, TVars, TInput, TDatabase>,
+		request?: Request,
+	) {
+		super(actor, conn);
+		this.request = request;
+	}
+}

package/src/actor/definition.ts

@@ -1,9 +1,9 @@
 import type { RegistryConfig } from "@/registry/config";
-import type { ActionContext } from "./action";
 import type { Actions, ActorConfig } from "./config";
-import type { ActorContext } from "./context";
+import type { ActionContext } from "./contexts/action";
+import type { ActorContext } from "./contexts/actor";
 import type { AnyDatabaseProvider } from "./database";
-import { ActorInstance } from "./instance";
+import { ActorInstance } from "./instance/mod";
 
 export type AnyActorDefinition = ActorDefinition<
 	any,

package/src/actor/driver.ts

@@ -3,7 +3,8 @@ import type { AnyClient } from "@/client/client";
 import type { ManagerDriver } from "@/manager/driver";
 import type { RegistryConfig } from "@/registry/config";
 import type { RunnerConfig } from "@/registry/run-config";
-import type { AnyActorInstance } from "./instance";
+import { type AnyConn, Conn } from "./conn/mod";
+import type { AnyActorInstance } from "./instance/mod";
 
 export type ActorDriverBuilder = (
 	registryConfig: RegistryConfig,
@@ -19,10 +20,27 @@ export interface ActorDriver {
 
 	getContext(actorId: string): unknown;
 
-	readPersistedData(actorId: string): Promise<Uint8Array | undefined>;
+	// Batch KV operations
+	/** Batch write multiple key-value pairs. Keys and values are Uint8Arrays. */
+	kvBatchPut(
+		actorId: string,
+		entries: [Uint8Array, Uint8Array][],
+	): Promise<void>;
 
-	/** ActorInstance ensure that only one instance of writePersistedData is called in parallel at a time. */
-	writePersistedData(actorId: string, data: Uint8Array): Promise<void>;
+	/** Batch read multiple keys. Returns null for keys that don't exist. */
+	kvBatchGet(
+		actorId: string,
+		keys: Uint8Array[],
+	): Promise<(Uint8Array | null)[]>;
+
+	/** Batch delete multiple keys. */
+	kvBatchDelete(actorId: string, keys: Uint8Array[]): Promise<void>;
+
+	/** List all keys with a given prefix. */
+	kvListPrefix(
+		actorId: string,
+		prefix: Uint8Array,
+	): Promise<[Uint8Array, Uint8Array][]>;
 
 	// Schedule
 	/** ActorInstance ensure that only one instance of setAlarm is called in parallel at a time. */
@@ -38,10 +56,17 @@ export interface ActorDriver {
 	/**
 	 * Requests the actor to go to sleep.
 	 *
-	 * This will call `_stop` independently.
+	 * This will call `ActorInstance.onStop` independently.
 	 */
 	startSleep?(actorId: string): void;
 
+	/**
+	 * Destroys the actor and its associated data.
+	 *
+	 * This will call `ActorInstance.onStop` independently.
+	 */
+	startDestroy(actorId: string): void;
+
 	/**
 	 * Shuts down the actor runner.
 	 */
@@ -53,4 +78,10 @@ export interface ActorDriver {
 
 	/** Extra properties to add to logs for each actor. */
 	getExtraActorLogParams?(): Record<string, string>;
+
+	onBeforeActorStart?(actor: AnyActorInstance): Promise<void>;
+	onCreateConn?(conn: AnyConn): void;
+	onDestroyConn?(conn: AnyConn): void;
+	onBeforePersistConn?(conn: AnyConn): void;
+	onAfterPersistConn?(conn: AnyConn): void;
 }

package/src/actor/errors.ts

@@ -133,22 +133,6 @@ export class InvalidEncoding extends ActorError {
 	}
 }
 
-export class ConnNotFound extends ActorError {
-	constructor(id?: string) {
-		super("connection", "not_found", `Connection not found for ID: ${id}`, {
-			public: true,
-		});
-	}
-}
-
-export class IncorrectConnToken extends ActorError {
-	constructor() {
-		super("connection", "incorrect_token", "Incorrect connection token.", {
-			public: true,
-		});
-	}
-}
-
 export class MessageTooLong extends ActorError {
 	constructor() {
 		super(
@@ -255,17 +239,28 @@ export class ActorNotFound extends ActorError {
 	}
 }
 
-export class ActorAlreadyExists extends ActorError {
+export class ActorDuplicateKey extends ActorError {
 	constructor(name: string, key: string[]) {
 		super(
 			"actor",
-			"already_exists",
+			"duplicate_key",
 			`Actor already exists with name '${name}' and key '${JSON.stringify(key)}' (https://www.rivet.dev/docs/actors/clients/#actor-client)`,
 			{ public: true },
 		);
 	}
 }
 
+export class ActorStopping extends ActorError {
+	constructor(identifier?: string) {
+		super(
+			"actor",
+			"stopping",
+			identifier ? `Actor stopping: ${identifier}` : "Actor stopping",
+			{ public: true },
+		);
+	}
+}
+
 export class ProxyError extends ActorError {
 	constructor(operation: string, error?: unknown) {
 		super(
@@ -333,12 +328,12 @@ export class DatabaseNotEnabled extends ActorError {
 	}
 }
 
-export class FetchHandlerNotDefined extends ActorError {
+export class RequestHandlerNotDfeined extends ActorError {
 	constructor() {
 		super(
 			"handler",
-			"fetch_not_defined",
-			"Raw HTTP handler not defined. Actor must implement `onFetch` to handle raw HTTP requests. (https://www.rivet.dev/docs/actors/fetch-and-websocket-handler/)",
+			"request_not_defined",
+			"Raw request handler not defined. Actor must implement `onRequest` to handle raw HTTP requests. (https://www.rivet.dev/docs/actors/fetch-and-websocket-handler/)",
 			{ public: true },
 		);
 		this.statusCode = 404;
@@ -357,12 +352,12 @@ export class WebSocketHandlerNotDefined extends ActorError {
 	}
 }
 
-export class InvalidFetchResponse extends ActorError {
+export class InvalidRequestHandlerResponse extends ActorError {
 	constructor() {
 		super(
 			"handler",
-			"invalid_fetch_response",
-			"Actor's onFetch handler must return a Response object. Returning void/undefined is not allowed. (https://www.rivet.dev/docs/actors/fetch-and-websocket-handler/)",
+			"invalid_request_handler_response",
+			"Actor's onRequest handler must return a Response object. Returning void/undefined is not allowed. (https://www.rivet.dev/docs/actors/fetch-and-websocket-handler/)",
 			{ public: true },
 		);
 		this.statusCode = 500;