refactor: studio -> inspector

Author: jog1t

examples/next-js/src/app/api/registry/[...all]/route.ts

@@ -6,8 +6,8 @@ const server = registry.createServer({
 	// It should match the path in your Next.js API route
 	// For example, if your API route is at /api/registry/[...all], this should be "/api/registry"
 	basePath: "/api/registry",
-	studio: {
-		// Tell RivetKit Studio where to find RivetKit Registry
+	inspector: {
+		// Tell RivetKit Inspector where to find RivetKit Registry
 		defaultEndpoint: "http://localhost:3000/api/registry",
 	},
 });

packages/core/src/actor/router.ts

@@ -235,7 +235,7 @@ export function createActorRouter(
 		}
 	});
 
-	if (runConfig.studio.enabled) {
+	if (runConfig.inspector.enabled) {
 		router.route(
 			"/inspect",
 			new Hono<ActorInspectorRouterEnv & { Bindings: ActorRouterBindings }>()

packages/core/src/driver-test-suite/mod.ts

@@ -157,7 +157,7 @@ export async function createTestRuntime(
 	const config: RunConfig = RunConfigSchema.parse({
 		driver,
 		getUpgradeWebSocket: () => upgradeWebSocket!,
-		studio: {
+		inspector: {
 			enabled: true,
 			token: () => "token",
 		},

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

@@ -85,7 +85,7 @@ export class EngineActorDriver implements ActorDriver {
 			runnerName: config.runnerName,
 			runnerKey: config.runnerKey,
 			metadata: {
-				inspectorToken: this.#runConfig.studio.token(),
+				inspectorToken: this.#runConfig.inspector.token(),
 			},
 			prepopulateActorNames: Object.fromEntries(
 				Object.keys(this.#registryConfig.use).map((name) => [

packages/core/src/drivers/engine/manager-driver.ts

@@ -40,9 +40,9 @@ export class EngineManagerDriver implements ManagerDriver {
 	constructor(config: Config, runConfig: RunConfig) {
 		this.#config = config;
 		this.#runConfig = runConfig;
-		if (!this.#runConfig.studio.token()) {
+		if (!this.#runConfig.inspector.token()) {
 			const token = generateRandomString();
-			this.#runConfig.studio.token = () => token;
+			this.#runConfig.inspector.token = () => token;
 		}
 		this.#importWebSocketPromise = importWebSocket();
 	}

packages/core/src/drivers/file-system/manager.ts

@@ -54,9 +54,9 @@ export class FileSystemManagerDriver implements ManagerDriver {
 		this.#state = state;
 		this.#driverConfig = driverConfig;
 
-		if (runConfig.studio.enabled) {
-			if (!this.#runConfig.studio.token()) {
-				this.#runConfig.studio.token = () =>
+		if (runConfig.inspector.enabled) {
+			if (!this.#runConfig.inspector.token()) {
+				this.#runConfig.inspector.token = () =>
 					this.#state.getOrCreateInspectorAccessToken();
 			}
 			const startedAt = new Date().toISOString();

packages/core/src/inspector/config.ts

@@ -6,7 +6,7 @@ import { getEnvUniversal } from "@/utils";
 type CorsOptions = NonNullable<Parameters<typeof cors>[0]>;
 
 const defaultTokenFn = () => {
-	const envToken = getEnvUniversal("RIVETKIT_STUDIO_TOKEN");
+	const envToken = getEnvUniversal("RIVETKIT_INSPECTOR_TOKEN");
 
 	if (envToken) {
 		return envToken;
@@ -18,19 +18,19 @@ const defaultTokenFn = () => {
 const defaultEnabled = () => {
 	return (
 		getEnvUniversal("NODE_ENV") !== "production" ||
-		!getEnvUniversal("RIVETKIT_STUDIO_DISABLE")
+		!getEnvUniversal("RIVETKIT_INSPECTOR_DISABLE")
 	);
 };
 
-const defaultStudioOrigins = [
+const defaultInspectorOrigins = [
 	"http://localhost:43708",
 	"https://studio.rivet.gg",
 ];
 
 const defaultCors: CorsOptions = {
 	origin: (origin) => {
 		if (
-			defaultStudioOrigins.includes(origin) ||
+			defaultInspectorOrigins.includes(origin) ||
 			(origin.startsWith("https://") && origin.endsWith("rivet-gg.vercel.app"))
 		) {
 			return origin;
@@ -59,7 +59,7 @@ export const InspectorConfigSchema = z
 			.default(() => defaultCors),
 
 		/**
-		 * Token used to access the Studio.
+		 * Token used to access the Inspector.
 		 */
 		token: z
 			.function()
@@ -68,9 +68,9 @@ export const InspectorConfigSchema = z
 			.default(() => defaultTokenFn),
 
 		/**
-		 * Default RivetKit server endpoint for Rivet Studio to connect to. This should be the same endpoint as what you use for your Rivet client to connect to RivetKit.
+		 * Default RivetKit server endpoint for Rivet Inspector to connect to. This should be the same endpoint as what you use for your Rivet client to connect to RivetKit.
 		 *
-		 * This is a convenience property just for printing out the studio URL.
+		 * This is a convenience property just for printing out the inspector URL.
 		 */
 		defaultEndpoint: z.string().optional(),
 	})

packages/core/src/inspector/utils.ts

@@ -28,7 +28,7 @@ export function compareSecrets(providedSecret: string, validSecret: string) {
 
 export const secureInspector = (runConfig: RunConfig) =>
 	createMiddleware(async (c, next) => {
-		if (!runConfig.studio.enabled) {
+		if (!runConfig.inspector.enabled) {
 			return c.text("Inspector is not enabled", 503);
 		}
 
@@ -37,7 +37,7 @@ export const secureInspector = (runConfig: RunConfig) =>
 			return c.text("Unauthorized", 401);
 		}
 
-		const inspectorToken = runConfig.studio.token?.();
+		const inspectorToken = runConfig.inspector.token?.();
 		if (!inspectorToken) {
 			return c.text("Unauthorized", 401);
 		}
@@ -50,16 +50,16 @@ export const secureInspector = (runConfig: RunConfig) =>
 		await next();
 	});
 
-export function getStudioUrl(runConfig: RunConfigInput | undefined) {
-	if (!runConfig?.studio?.enabled) {
+export function getInspectorUrl(runConfig: RunConfigInput | undefined) {
+	if (!runConfig?.inspector?.enabled) {
 		return "disabled";
 	}
 
-	const accessToken = runConfig?.studio?.token?.();
+	const accessToken = runConfig?.inspector?.token?.();
 
 	if (!accessToken) {
 		inspectorLogger().warn(
-			"Studio Token is not set, but Studio is enabled. Please set it in the run configuration `inspector.token` or via `RIVETKIT_STUDIO_TOKEN` environment variable. Studio will not be accessible.",
+			"Inspector Token is not set, but Inspector is enabled. Please set it in the run configuration `inspector.token` or via `RIVETKIT_INSPECTOR_TOKEN` environment variable. Inspector will not be accessible.",
 		);
 		return "disabled";
 	}
@@ -68,8 +68,8 @@ export function getStudioUrl(runConfig: RunConfigInput | undefined) {
 
 	url.searchParams.set("t", accessToken);
 
-	if (runConfig?.studio?.defaultEndpoint) {
-		url.searchParams.set("u", runConfig.studio.defaultEndpoint);
+	if (runConfig?.inspector?.defaultEndpoint) {
+		url.searchParams.set("u", runConfig.inspector.defaultEndpoint);
 	}
 
 	return url.href;

packages/core/src/manager/router.ts

@@ -160,7 +160,7 @@ export function createManagerRouter(
 
 	router.use("*", loggerMiddleware(logger()));
 
-	if (runConfig.cors || runConfig.studio?.cors) {
+	if (runConfig.cors || runConfig.inspector?.cors) {
 		router.use("*", async (c, next) => {
 			// Don't apply to WebSocket routes
 			// HACK: This could be insecure if we had a varargs path. We have to check the path suffix for WS since we don't know the path that this router was mounted.
@@ -179,19 +179,19 @@ export function createManagerRouter(
 
 			return cors({
 				...(runConfig.cors ?? {}),
-				...(runConfig.studio?.cors ?? {}),
+				...(runConfig.inspector?.cors ?? {}),
 				origin: (origin, c) => {
-					const studioOrigin = runConfig.studio?.cors?.origin;
+					const inspectorOrigin = runConfig.inspector?.cors?.origin;
 
-					if (studioOrigin !== undefined) {
-						if (typeof studioOrigin === "function") {
-							const allowed = studioOrigin(origin, c);
+					if (inspectorOrigin !== undefined) {
+						if (typeof inspectorOrigin === "function") {
+							const allowed = inspectorOrigin(origin, c);
 							if (allowed) return allowed;
 							// Proceed to next CORS config if none provided
-						} else if (Array.isArray(studioOrigin)) {
-							return studioOrigin.includes(origin) ? origin : undefined;
+						} else if (Array.isArray(inspectorOrigin)) {
+							return inspectorOrigin.includes(origin) ? origin : undefined;
 						} else {
-							return studioOrigin;
+							return inspectorOrigin;
 						}
 					}
 
@@ -207,12 +207,12 @@ export function createManagerRouter(
 					return null;
 				},
 				allowMethods: (origin, c) => {
-					const studioMethods = runConfig.studio?.cors?.allowMethods;
-					if (studioMethods) {
-						if (typeof studioMethods === "function") {
-							return studioMethods(origin, c);
+					const inspectorMethods = runConfig.inspector?.cors?.allowMethods;
+					if (inspectorMethods) {
+						if (typeof inspectorMethods === "function") {
+							return inspectorMethods(origin, c);
 						}
-						return studioMethods;
+						return inspectorMethods;
 					}
 
 					if (runConfig.cors?.allowMethods) {
@@ -226,14 +226,14 @@ export function createManagerRouter(
 				},
 				allowHeaders: [
 					...(runConfig.cors?.allowHeaders ?? []),
-					...(runConfig.studio?.cors?.allowHeaders ?? []),
+					...(runConfig.inspector?.cors?.allowHeaders ?? []),
 					...ALLOWED_PUBLIC_HEADERS,
 					"Content-Type",
 					"User-Agent",
 				],
 				credentials:
 					runConfig.cors?.credentials ??
-					runConfig.studio?.cors?.credentials ??
+					runConfig.inspector?.cors?.credentials ??
 					true,
 			})(c, next);
 		});
@@ -562,12 +562,12 @@ export function createManagerRouter(
 		});
 	}
 
-	if (runConfig.studio?.enabled) {
+	if (runConfig.inspector?.enabled) {
 		router.route(
 			"/actors/inspect",
 			new Hono()
 				.use(
-					cors(runConfig.studio.cors),
+					cors(runConfig.inspector.cors),
 					secureInspector(runConfig),
 					universalActorProxy({
 						registryConfig,
@@ -584,7 +584,7 @@ export function createManagerRouter(
 			"/inspect",
 			new Hono()
 				.use(
-					cors(runConfig.studio.cors),
+					cors(runConfig.inspector.cors),
 					secureInspector(runConfig),
 					async (c, next) => {
 						const inspector = managerDriver.inspector;

packages/core/src/registry/mod.ts

@@ -3,7 +3,7 @@ import { createActorRouter } from "@/actor/router";
 import { type Client, createClientWithDriver } from "@/client/client";
 import { chooseDefaultDriver } from "@/drivers/default";
 import { createInlineClientDriver } from "@/inline-client-driver/mod";
-import { getStudioUrl } from "@/inspector/utils";
+import { getInspectorUrl } from "@/inspector/utils";
 import { createManagerRouter } from "@/manager/router";
 import {
 	type RegistryActors,
@@ -73,9 +73,9 @@ export class Registry<A extends RegistryActors> {
 			definitions: Object.keys(this.#config.use).length,
 			...driverLog,
 		});
-		if (config.studio?.enabled) {
-			logger().info("studio ready", {
-				url: getStudioUrl(config),
+		if (config.inspector?.enabled) {
+			logger().info("inspector ready", {
+				url: getInspectorUrl(config),
 			});
 		}