feat(engine): add engine driver

Author: NathanFlurry

.gitattributes

@@ -7,4 +7,5 @@
 
 *.png binary
 *.jpg binary
+*.tgz binary
 

NEW_SPEC.md

@@ -14,7 +14,9 @@
             "example": "actor-123"
           }
         },
-        "required": ["i"]
+        "required": [
+          "i"
+        ]
       },
       "ResolveQuery": {
         "type": "object",
@@ -676,4 +678,4 @@
       }
     }
   }
-}
+}

NEW_SPEC2.md

@@ -158,20 +158,21 @@
   },
   "dependencies": {
     "@hono/standard-validator": "^0.1.3",
-    "cbor-x": "^1.6.0",
+    "@hono/zod-openapi": "^0.19.10",
     "@rivetkit/fast-json-patch": "^3.1.2",
+    "cbor-x": "^1.6.0",
+    "hono": "^4.7.0",
     "invariant": "^2.2.4",
     "nanoevents": "^9.1.0",
     "on-change": "^5.0.1",
     "p-retry": "^6.2.1",
-    "zod": "^3.25.76",
-    "@hono/zod-openapi": "^0.19.10",
-    "hono": "^4.7.0"
+    "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@hono/node-server": "^1.14.0",
+    "@hono/node-server": "^1.18.2",
     "@hono/node-ws": "^1.1.1",
     "@rivet-gg/actor-core": "^25.1.0",
+    "@rivetkit/engine-runner": "https://pkg.pr.new/rivet-gg/engine/@rivetkit/engine-runner@472",
     "@types/invariant": "^2",
     "@types/node": "^22.13.1",
     "@types/ws": "^8",

clients/openapi/openapi.json

@@ -40,9 +40,7 @@ export interface ActorDriver {
 	 */
 	getDatabase(actorId: string): Promise<unknown | undefined>;
 
-	// TODO:
-	//destroy(): Promise<void>;
-	//readState(): void;
+	shutdown?(immediate: boolean): Promise<void>;
 }
 
 export interface ConnDriver<ConnDriverState = unknown> {

packages/core/package.json

@@ -98,15 +98,15 @@ export interface WebSocketOpts {
  * Creates a WebSocket connection handler
  */
 export async function handleWebSocketConnect(
-	c: HonoContext | undefined,
+	req: Request | undefined,
 	runConfig: RunConfig,
 	actorDriver: ActorDriver,
 	actorId: string,
 	encoding: Encoding,
 	parameters: unknown,
 	authData: unknown,
 ): Promise<UpgradeWebSocketArgs> {
-	const exposeInternalError = c ? getRequestExposeInternalError(c.req) : false;
+	const exposeInternalError = req ? getRequestExposeInternalError(req) : false;
 
 	// Setup promise for the init handlers since all other behavior depends on this
 	const {
@@ -154,7 +154,7 @@ export async function handleWebSocketConnect(
 				try {
 					const connId = generateConnId();
 					const connToken = generateConnToken();
-					const connState = await actor.prepareConn(parameters, c?.req.raw);
+					const connState = await actor.prepareConn(parameters, req);
 
 					// Save socket
 					const connGlobalState =
@@ -575,7 +575,7 @@ export async function handleConnectionMessage(
 }
 
 export async function handleRawWebSocketHandler(
-	c: HonoContext | undefined,
+	req: Request | undefined,
 	path: string,
 	actorDriver: ActorDriver,
 	actorId: string,
@@ -599,8 +599,8 @@ export async function handleRawWebSocketHandler(
 			const normalizedPath = pathname + url.search;
 
 			let newRequest: Request;
-			if (c) {
-				newRequest = new Request(`http://actor${normalizedPath}`, c.req.raw);
+			if (req) {
+				newRequest = new Request(`http://actor${normalizedPath}`, req);
 			} else {
 				newRequest = new Request(`http://actor${normalizedPath}`, {
 					method: "GET",
@@ -657,8 +657,8 @@ export function getRequestEncoding(req: HonoRequest): Encoding {
 	return result.data;
 }
 
-export function getRequestExposeInternalError(req: HonoRequest): boolean {
-	const param = req.header(HEADER_EXPOSE_INTERNAL_ERROR);
+export function getRequestExposeInternalError(req: Request): boolean {
+	const param = req.headers.get(HEADER_EXPOSE_INTERNAL_ERROR);
 	if (!param) {
 		return false;
 	}

packages/core/src/actor/driver.ts

@@ -91,7 +91,7 @@ export function createActorRouter(
 				const authData = authDataRaw ? JSON.parse(authDataRaw) : undefined;
 
 				return await handleWebSocketConnect(
-					c as HonoContext,
+					c.req.raw,
 					runConfig,
 					actorDriver,
 					c.env.actorId,
@@ -220,7 +220,7 @@ export function createActorRouter(
 				});
 
 				return await handleRawWebSocketHandler(
-					c,
+					c.req.raw,
 					pathWithQuery,
 					actorDriver,
 					c.env.actorId,

packages/core/src/actor/router-endpoints.ts

@@ -149,14 +149,25 @@ export class ActorHandleRaw {
 			"getOrCreateForKey" in this.#actorQuery
 		) {
 			// TODO:
+			let name: string;
+			if ("getForKey" in this.#actorQuery) {
+				name = this.#actorQuery.getForKey.name;
+			} else if ("getOrCreateForKey" in this.#actorQuery) {
+				name = this.#actorQuery.getOrCreateForKey.name;
+			} else {
+				assertUnreachable(this.#actorQuery);
+			}
+
 			const actorId = await this.#driver.resolveActorId(
 				undefined,
 				this.#actorQuery,
 				this.#encodingKind,
 				this.#params,
 				signal ? { signal } : undefined,
 			);
-			this.#actorQuery = { getForId: { actorId } };
+
+			this.#actorQuery = { getForId: { actorId, name } };
+
 			return actorId;
 		} else if ("getForId" in this.#actorQuery) {
 			// SKip since it's already resolved

packages/core/src/actor/router.ts

@@ -268,8 +268,9 @@ export class ClientRaw {
 			params: opts?.params,
 		});
 
-		const actorQuery = {
+		const actorQuery: ActorQuery = {
 			getForId: {
+				name,
 				actorId,
 			},
 		};
@@ -400,6 +401,7 @@ export class ClientRaw {
 		// Create handle with actor ID
 		const getForIdQuery = {
 			getForId: {
+				name,
 				actorId,
 			},
 		} satisfies ActorQuery;