chore(core): add actor names to metadata endpoint (#1387)

Author: NathanFlurry

examples/counter-serverless/src/server.ts

@@ -2,6 +2,6 @@ import { registry } from "./registry";
 
 registry.start({
 	runnerKind: "serverless",
-	runEngine: true,
-	autoConfigureServerless: true,
+	autoConfigureServerless: { url: "http://localhost:8080" },
+	endpoint: "http://localhost:6420",
 });

packages/rivetkit/src/common/router.ts

@@ -5,6 +5,7 @@ import {
 	getRequestEncoding,
 	getRequestExposeInternalError,
 } from "@/actor/router-endpoints";
+import { buildActorNames, type RegistryConfig } from "@/registry/config";
 import type { RunnerConfig } from "@/registry/run-config";
 import { getEndpoint } from "@/remote-manager-driver/api-utils";
 import { HttpResponseError } from "@/schemas/client-protocol/mod";
@@ -93,6 +94,7 @@ export interface MetadataResponse {
 			| { serverless: Record<never, never> }
 			| { normal: Record<never, never> };
 	};
+	actorNames: ReturnType<typeof buildActorNames>;
 	/**
 	 * Endpoint that the client should connect to to access this runner.
 	 *
@@ -105,7 +107,11 @@ export interface MetadataResponse {
 	clientEndpoint?: string;
 }
 
-export function handleMetadataRequest(c: HonoContext, runConfig: RunnerConfig) {
+export function handleMetadataRequest(
+	c: HonoContext,
+	registryConfig: RegistryConfig,
+	runConfig: RunnerConfig,
+) {
 	const response: MetadataResponse = {
 		runtime: "rivetkit",
 		version: VERSION,
@@ -115,6 +121,7 @@ export function handleMetadataRequest(c: HonoContext, runConfig: RunnerConfig) {
 					? { serverless: {} }
 					: { normal: {} },
 		},
+		actorNames: buildActorNames(registryConfig),
 		// Do not return client endpoint if default server disabled
 		clientEndpoint:
 			runConfig.overrideServerAddress ??

packages/rivetkit/src/drivers/engine/actor-driver.ts

@@ -33,7 +33,7 @@ import {
 	type ManagerDriver,
 	serializeEmptyPersistData,
 } from "@/driver-helpers/mod";
-import type { RegistryConfig } from "@/registry/config";
+import { buildActorNames, type RegistryConfig } from "@/registry/config";
 import type { RunnerConfig } from "@/registry/run-config";
 import { getEndpoint } from "@/remote-manager-driver/api-utils";
 import {
@@ -103,12 +103,7 @@ export class EngineActorDriver implements ActorDriver {
 			metadata: {
 				inspectorToken: this.#runConfig.inspector.token(),
 			},
-			prepopulateActorNames: Object.fromEntries(
-				Object.keys(this.#registryConfig.use).map((name) => [
-					name,
-					{ metadata: {} },
-				]),
-			),
+			prepopulateActorNames: buildActorNames(registryConfig),
 			onConnected: () => {
 				if (hasDisconnected) {
 					logger().info({

packages/rivetkit/src/manager/router.ts

@@ -212,7 +212,9 @@ function addServerlessRoutes(
 
 	router.get("/health", (c) => handleHealthRequest(c));
 
-	router.get("/metadata", (c) => handleMetadataRequest(c, runConfig));
+	router.get("/metadata", (c) =>
+		handleMetadataRequest(c, registryConfig, runConfig),
+	);
 }
 
 function addManagerRoutes(
@@ -643,7 +645,9 @@ function addManagerRoutes(
 
 	router.get("/health", (c) => handleHealthRequest(c));
 
-	router.get("/metadata", (c) => handleMetadataRequest(c, runConfig));
+	router.get("/metadata", (c) =>
+		handleMetadataRequest(c, registryConfig, runConfig),
+	);
 
 	managerDriver.modifyManagerRouter?.(
 		registryConfig,

packages/rivetkit/src/registry/config.ts

@@ -30,3 +30,11 @@ export type RegistryConfigInput<A extends RegistryActors> = Omit<
 	z.input<typeof RegistryConfigSchema>,
 	"use"
 > & { use: A };
+
+export function buildActorNames(
+	registryConfig: RegistryConfig,
+): Record<string, { metadata: Record<string, any> }> {
+	return Object.fromEntries(
+		Object.keys(registryConfig.use).map((name) => [name, { metadata: {} }]),
+	);
+}