overmux 0.0.3 → 0.0.4

package/dist/internal/server/coordinator/server-child.js

@@ -4,7 +4,7 @@ import { createServer, isIP } from "node:net";
 import { dirname, isAbsolute, join, resolve } from "node:path";
 import { createJiti } from "jiti";
 import { ZodError, z } from "zod";
-import { homedir, tmpdir } from "node:os";
+import { homedir, hostname, tmpdir } from "node:os";
 import { once } from "node:events";
 import { createHash, randomBytes, randomUUID, timingSafeEqual } from "node:crypto";
 import { generateCookie } from "hono/cookie";
@@ -35,6 +35,7 @@ const durationToMilliseconds$1 = (duration) => {
 	return Number.isSafeInteger(milliseconds) ? milliseconds : void 0;
 };
 const aiContextSnippets = ["package-source", "tech-stack-recommendations"];
+const instanceIdSchema$1 = z.string().max(253).regex(/^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?(?![\s\S])/, "Expected a lowercase instance ID with only ASCII letters, digits, internal dots and hyphens");
 const zodTypeSchema = z.custom((value) => value instanceof z.ZodType, "Expected a Zod schema");
 const functionSchema = z.custom((value) => typeof value === "function", "Expected a function");
 const contractRuntimeSchema = z.object({
@@ -102,6 +103,7 @@ const configDefinitionRuntimeSchema = serverConfigRuntimeSchema.extend({
 	aiContextSnippets: z.array(z.enum(aiContextSnippets)).optional(),
 	auth: authConfigRuntimeSchema,
 	debug: z.boolean().optional(),
+	instanceId: z.union([instanceIdSchema$1, z.custom((value) => typeof value === "function", "Expected an instance ID or a function of the bound port")]).optional(),
 	server: serverDefinitionRuntimeSchema,
 	vite: z.string().min(1).optional()
 });
@@ -843,10 +845,40 @@ const createHttpAuthenticationHandlers = ({ auth, authAssetsDirectory }) => {
 		}
 	};
 };
+const overmuxSettingsPath = "/_overmux/settings";
+const overmuxLogoutPath = "/_overmux/logout";
+const safeRelativeNotificationLink = (link) => {
+	let decoded;
+	try {
+		decoded = decodeURIComponent(link);
+	} catch {
+		return false;
+	}
+	return !decoded.startsWith("//") && !decoded.includes("\\") && ![...decoded].some((character) => {
+		const codePoint = character.codePointAt(0) ?? 0;
+		return codePoint < 32 || codePoint === 127;
+	});
+};
+const notificationLinkSchema = z.union([z.string().max(4096).startsWith("/").refine(safeRelativeNotificationLink), z.string().max(4096).url().refine((link) => {
+	if (!URL.canParse(link)) return false;
+	const url = new URL(link);
+	return ["http:", "https:"].includes(url.protocol) && !url.username && !url.password;
+})]);
+const notificationSchema = z.object({
+	body: z.string().max(4096).optional(),
+	open: z.object({ link: notificationLinkSchema }).strict().optional(),
+	title: z.string().min(1).max(4096)
+}).strict();
+const instanceIdSchema = z.string().max(253).regex(/^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?(?![\s\S])/, "Expected a lowercase instance ID with only ASCII letters, digits, internal dots and hyphens");
+const createInstanceIdentity = (instanceId) => ({
+	instanceId: instanceIdSchema.parse(instanceId),
+	deepLinkPrefix: `overmux://${instanceId}`
+});
 //#endregion
 //#region src/internal/server/auth/instance-control.ts
 const maxControlMessageBytes = 16384;
 const controlRequestSchema = z.discriminatedUnion("type", [
+	z.object({ type: z.literal("get-instance") }).strict(),
 	z.object({ type: z.literal("ping") }).strict(),
 	z.object({ type: z.literal("create-login") }).strict(),
 	z.object({ type: z.literal("issue-bearer") }).strict(),
@@ -872,6 +904,9 @@ const sessionSchema = z.object({
 	revokedAt: z.string().optional()
 }).strict();
 z.object({
+	instanceId: instanceIdSchema,
+	ok: z.literal(true)
+}).strict(), z.object({
 	login: loginGrantSchema,
 	ok: z.literal(true)
 }).strict(), z.object({
@@ -950,7 +985,11 @@ const readNewlineFrame = ({ maximumBytes, socket, timeout }) => new Promise((res
 const writeResponse = (socket, response) => {
 	socket.end(`${JSON.stringify(response)}\n`);
 };
-const handleRequest = async (auth, request) => {
+const handleRequest = async ({ auth, instanceId, request }) => {
+	if (request.type === "get-instance") return {
+		instanceId,
+		ok: true
+	};
 	if (request.type === "ping") return { ok: true };
 	if (request.type === "create-login") return {
 		login: await auth.createLoginGrant(),
@@ -973,14 +1012,18 @@ const handleRequest = async (auth, request) => {
 		ok: true
 	};
 };
-const handleConnection = async ({ auth, socket }) => {
+const handleConnection = async ({ auth, instanceId, socket }) => {
 	try {
 		const frame = await readNewlineFrame({
 			maximumBytes: maxControlMessageBytes,
 			socket
 		});
 		const request = controlRequestSchema.parse(JSON.parse(frame.toString()));
-		writeResponse(socket, await handleRequest(auth, request));
+		writeResponse(socket, await handleRequest({
+			auth,
+			instanceId,
+			request
+		}));
 	} catch (cause) {
 		writeResponse(socket, {
 			error: cause instanceof Error ? cause.message : "Invalid control request",
@@ -988,7 +1031,7 @@ const handleConnection = async ({ auth, socket }) => {
 		});
 	}
 };
-const startInstanceControl = async ({ auth, apiUrl, port, url }) => {
+const startInstanceControl = async ({ auth, apiUrl, instanceId, port, url }) => {
 	const directory = runtimeDirectory();
 	await mkdir(directory, {
 		mode: 448,
@@ -1004,6 +1047,7 @@ const startInstanceControl = async ({ auth, apiUrl, port, url }) => {
 		socket.once("close", () => sockets.delete(socket));
 		handleConnection({
 			auth,
+			instanceId,
 			socket
 		});
 	});
@@ -1054,30 +1098,6 @@ const backgroundNotificationSubscriptionSchema = z.object({
 }).strict();
 z.object({ publicKey: deliveryKeySchema }).strict();
 const backgroundNotificationDisableRequestSchema = z.object({ endpoint: backgroundNotificationSubscriptionSchema.shape.endpoint }).strict();
-const overmuxSettingsPath = "/_overmux/settings";
-const overmuxLogoutPath = "/_overmux/logout";
-const safeRelativeNotificationLink = (link) => {
-	let decoded;
-	try {
-		decoded = decodeURIComponent(link);
-	} catch {
-		return false;
-	}
-	return !decoded.startsWith("//") && !decoded.includes("\\") && ![...decoded].some((character) => {
-		const codePoint = character.codePointAt(0) ?? 0;
-		return codePoint < 32 || codePoint === 127;
-	});
-};
-const notificationLinkSchema = z.union([z.string().max(4096).startsWith("/").refine(safeRelativeNotificationLink), z.string().max(4096).url().refine((link) => {
-	if (!URL.canParse(link)) return false;
-	const url = new URL(link);
-	return ["http:", "https:"].includes(url.protocol) && !url.username && !url.password;
-})]);
-const notificationSchema = z.object({
-	body: z.string().max(4096).optional(),
-	open: z.object({ link: notificationLinkSchema }).strict().optional(),
-	title: z.string().min(1).max(4096)
-}).strict();
 const webSocketCloseCode = {
 	authenticationRevoked: 4001,
 	authenticationUnavailable: 4002
@@ -1085,7 +1105,7 @@ const webSocketCloseCode = {
 z.object({
 	debug: z.boolean(),
 	operations: z.array(z.string().min(1)),
-	protocolVersion: z.literal(9),
+	protocolVersion: z.literal(10),
 	resources: z.array(z.string().min(1)),
 	streams: z.array(z.string().min(1))
 });
@@ -1191,7 +1211,12 @@ const protocolErrorMessageSchema = z.object({
 	subscriptionId: operationIdSchema.optional(),
 	type: z.literal("error")
 });
+const serverInfoMessageSchema = z.object({
+	type: z.literal("server-info"),
+	instanceId: instanceIdSchema
+}).strict();
 const serverProtocolMessageSchema = z.discriminatedUnion("type", [
+	serverInfoMessageSchema,
 	resourceResultMessageSchema,
 	resourceInvalidatedMessageSchema,
 	streamOpenedMessageSchema,
@@ -2334,6 +2359,10 @@ const createWebSocketServer = ({ auth, developmentWebTarget, runtime, server, se
 				sessionSockets,
 				socket: webSocket
 			});
+			webSocket.send(encodeProtocolFrame({
+				type: "server-info",
+				instanceId: runtime.instance.getInstanceId()
+			}));
 			webSocketServer.emit("connection", webSocket, request);
 			attachWebSocketConnection({
 				runtime,
@@ -2607,6 +2636,30 @@ const createNotificationService = ({ backgroundNotifications, logger }) => {
 	};
 };
 //#endregion
+//#region src/internal/server/runtime/runtime-instance.ts
+const createRuntimeInstance = (configured) => {
+	let identity;
+	const get = () => {
+		if (!identity) throw new Error("Overmux instance identity is not ready");
+		return identity;
+	};
+	return {
+		context: {
+			getInstanceId: () => get().instanceId,
+			getDeepLinkPrefix: () => get().deepLinkPrefix
+		},
+		establish: (port) => {
+			if (identity) throw new Error("Overmux instance identity is already established");
+			try {
+				identity = createInstanceIdentity(typeof configured === "function" ? configured({ port }) : configured ?? `${hostname()}-${port}`);
+			} catch (cause) {
+				throw new Error("Invalid Overmux instance ID; configure instanceId with a canonical lowercase ID", { cause });
+			}
+			return identity;
+		}
+	};
+};
+//#endregion
 //#region src/internal/server/runtime/runtime-lifecycle.ts
 const asError = (cause) => cause instanceof Error ? cause : new Error(String(cause));
 const disposeAll = async (disposers) => {
@@ -2728,7 +2781,7 @@ const getInvalidatedResourceIds = (graph, resourceId) => {
 };
 //#endregion
 //#region src/internal/server/runtime/runtime-resources.ts
-const createRuntimeResources = ({ definitions, lifecycle }) => {
+const createRuntimeResources = ({ definitions, instance, lifecycle }) => {
 	const graph = createResourceDependencyGraph(definitions);
 	const invalidationListeners = /* @__PURE__ */ new Set();
 	const contracts = /* @__PURE__ */ new Map();
@@ -2753,6 +2806,7 @@ const createRuntimeResources = ({ definitions, lifecycle }) => {
 		});
 	};
 	const context = (signal) => ({
+		instance,
 		invalidate,
 		signal: lifecycle.requestSignal(signal)
 	});
@@ -2887,9 +2941,11 @@ const createRuntimeStreams = ({ context, definitions, lifecycle }) => {
 //#region src/internal/server/runtime/create-runtime.ts
 const createRuntime = async ({ config, debug = false, notifications = { send: async () => void 0 }, signal }) => {
 	const lifecycle = createRuntimeLifecycle(signal);
+	const instance = createRuntimeInstance(config.instanceId);
 	try {
 		const resources = createRuntimeResources({
 			definitions: config.server.resources ?? {},
+			instance: instance.context,
 			lifecycle
 		});
 		const context = resources.context;
@@ -2905,14 +2961,17 @@ const createRuntime = async ({ config, debug = false, notifications = { send: as
 		});
 		lifecycle.signal.throwIfAborted();
 		lifecycle.completePreparation();
+		const manifest = {
+			debug,
+			operations: [...operations.names],
+			protocolVersion: 10,
+			resources: [...resources.names],
+			streams: [...streams.names]
+		};
 		return {
-			manifest: {
-				debug,
-				operations: [...operations.names],
-				protocolVersion: 9,
-				resources: [...resources.names],
-				streams: [...streams.names]
-			},
+			instance: instance.context,
+			establishInstance: instance.establish,
+			manifest,
 			dispose: lifecycle.dispose,
 			getOperation: operations.get,
 			getResource: resources.get,
@@ -2925,8 +2984,9 @@ const createRuntime = async ({ config, debug = false, notifications = { send: as
 };
 //#endregion
 //#region src/internal/server/server-startup-options.ts
+const serverStartupOverridesRuntimeSchema = serverConfigRuntimeSchema.omit({ port: true }).extend({ port: z.number().int().min(0).max(65535).optional() });
 const resolveServerStartupOptions = ({ config, configPath, overrides = {} }) => {
-	const validatedOverrides = serverConfigRuntimeSchema.omit({ port: true }).extend({ port: z.number().int().min(0).max(65535).optional() }).parse(overrides);
+	const validatedOverrides = serverStartupOverridesRuntimeSchema.parse(overrides);
 	const configuredLogFile = config.logFile ? resolve(dirname(configPath), config.logFile) : void 0;
 	const logFile = validatedOverrides.logFile ? resolve(validatedOverrides.logFile) : configuredLogFile;
 	const configuredWebAssetsDir = config.productionWebAssetsDir ? resolve(dirname(configPath), config.productionWebAssetsDir) : void 0;
@@ -3076,12 +3136,20 @@ const startApplicationTransport = async ({ auth, authOrigins, authService, backg
 		serverLogger: logger,
 		webAssetsDir: developmentWebTarget ? void 0 : startup.productionWebAssetsDir
 	});
+	let ready = false;
 	const server = serve({
-		fetch: app.fetch,
+		fetch: (request, env) => ready ? app.fetch(request, env) : new Response("Starting", { status: 503 }),
 		hostname: startup.host,
 		port: startup.port
 	});
 	resources.add(() => closeNodeServer(server, runtime.dispose));
+	const address = await getServerAddress(server);
+	runtime.establishInstance(address.port);
+	const urlHost = startup.host.includes(":") ? `[${startup.host}]` : startup.host;
+	const localUrl = `http://${urlHost}:${address.port}`;
+	const controlApiHost = startup.host === "0.0.0.0" ? "127.0.0.1" : startup.host === "::" ? "[::1]" : urlHost;
+	const origins = authOrigins.establish(localUrl);
+	authService.setOrigins(origins);
 	const webSockets = createWebSocketServer({
 		auth,
 		developmentWebTarget,
@@ -3092,15 +3160,11 @@ const startApplicationTransport = async ({ auth, authOrigins, authService, backg
 	resources.add(webSockets.close);
 	announceRestarting = webSockets.announceRestarting;
 	notifications.attachLiveDelivery(webSockets.broadcastNotification);
-	const address = await getServerAddress(server);
-	const urlHost = startup.host.includes(":") ? `[${startup.host}]` : startup.host;
-	const localUrl = `http://${urlHost}:${address.port}`;
-	const controlApiHost = startup.host === "0.0.0.0" ? "127.0.0.1" : startup.host === "::" ? "[::1]" : urlHost;
-	const origins = authOrigins.establish(localUrl);
-	authService.setOrigins(origins);
+	ready = true;
 	const instanceControl = await startInstanceControl({
 		auth: authService,
 		apiUrl: `http://${controlApiHost}:${address.port}`,
+		instanceId: runtime.instance.getInstanceId(),
 		port: address.port,
 		url: origins[0]
 	});