@serverkgg/bridge 0.0.1 → 0.0.3

package/src/runtime/bridgeSupervisor.ts

@@ -1,6 +1,6 @@
 import type { BridgeCommandOptions, BridgeReply } from "../context";
 import { BridgeRuntime, BridgeStream } from "../core";
-import type { BridgeLogger } from "./bridgeLog";
+import type { BridgeLeveledLogger } from "./bridgeLog";
 import { errorText } from "./bridgeLog";
 import { settleUid, unprivilegedArgv } from "./bridgePrivilege";
 
@@ -32,7 +32,7 @@ export interface SupervisorOptions {
 	resolveCommand: () => Promise<string[]>;
 	gracefulStop?: () => Promise<void>;
 	onReady?: () => void;
-	onLog: BridgeLogger;
+	onLog: BridgeLeveledLogger;
 }
 
 type LineWatcher = (entry: SupervisorLine) => void;
@@ -295,7 +295,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 		} catch (error) {
 			runtime = BridgeRuntime.Crashed;
 
-			options.onLog("game failed to restart", {
+			options.onLog.error("game failed to restart", {
 				error: errorText(error),
 			});
 		}
@@ -322,7 +322,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 			breaker = true;
 			runtime = BridgeRuntime.Crashed;
 
-			options.onLog("game crash loop detected, not restarting", {
+			options.onLog.error("game crash loop detected, not restarting", {
 				code,
 				restarts,
 			});
@@ -332,7 +332,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 
 		runtime = BridgeRuntime.Starting;
 
-		options.onLog("game exited, restarting", {
+		options.onLog.warn("game exited, restarting", {
 			code,
 			restarts,
 		});
@@ -405,7 +405,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 
 			if (options.gracefulStop) {
 				const graceful = options.gracefulStop().catch((error: unknown) => {
-					options.onLog("graceful stop failed", {
+					options.onLog.warn("graceful stop failed", {
 						error: errorText(error),
 					});
 				});

package/src/runtime/bridgeZip.ts

@@ -18,13 +18,20 @@ const DEFLATED = 8;
 
 const ENCRYPTED_FLAG = 0x1;
 
-const MAX_ENTRIES = 2048;
+export const ZIP_ENTRY_LIMIT = 2048;
+
+export const ZIP_TREE_ENTRY_LIMIT = 8192;
 
 const MAX_ENTRY_BYTES = 128 * 1024 * 1024;
 
+const UNIX_MODE_FORMAT_MASK = 0xf0_00;
+
+const UNIX_MODE_SYMLINK = 0xa0_00;
+
 export interface ZipEntry {
 	name: string;
 	data: Uint8Array;
+	symlink: boolean;
 }
 
 const findEndOfCentralDirectory = (buffer: Buffer) => {
@@ -39,7 +46,7 @@ const findEndOfCentralDirectory = (buffer: Buffer) => {
 	return -1;
 };
 
-export const readZip = (buffer: Buffer): ZipEntry[] => {
+export const readZip = (buffer: Buffer, maxEntries: number = ZIP_ENTRY_LIMIT): ZipEntry[] => {
 	const eocd = findEndOfCentralDirectory(buffer);
 
 	if (eocd === -1) {
@@ -49,7 +56,7 @@ export const readZip = (buffer: Buffer): ZipEntry[] => {
 	const total = buffer.readUInt16LE(eocd + 10);
 	const directoryOffset = buffer.readUInt32LE(eocd + 16);
 
-	if (total > MAX_ENTRIES) {
+	if (total > maxEntries) {
 		throw new Error(`archive has too many entries (${total})`);
 	}
 
@@ -69,8 +76,10 @@ export const readZip = (buffer: Buffer): ZipEntry[] => {
 		const nameLength = buffer.readUInt16LE(cursor + 28);
 		const extraLength = buffer.readUInt16LE(cursor + 30);
 		const commentLength = buffer.readUInt16LE(cursor + 32);
+		const externalAttributes = buffer.readUInt32LE(cursor + 38);
 		const localOffset = buffer.readUInt32LE(cursor + 42);
 		const name = buffer.subarray(cursor + 46, cursor + 46 + nameLength).toString("utf8");
+		const symlink = ((externalAttributes >>> 16) & UNIX_MODE_FORMAT_MASK) === UNIX_MODE_SYMLINK;
 
 		cursor += 46 + nameLength + extraLength + commentLength;
 
@@ -95,6 +104,7 @@ export const readZip = (buffer: Buffer): ZipEntry[] => {
 			entries.push({
 				name,
 				data: compressed,
+				symlink,
 			});
 
 			continue;
@@ -115,6 +125,7 @@ export const readZip = (buffer: Buffer): ZipEntry[] => {
 		entries.push({
 			name,
 			data,
+			symlink,
 		});
 	}
 

package/src/runtime/index.ts

@@ -1,18 +1 @@
-export * from "./bridgeCodec";
-export * from "./bridgeConfigReader";
-export * from "./bridgeContext";
-export * from "./bridgeDriver";
-export * from "./bridgeEvents";
-export * from "./bridgeExec";
-export * from "./bridgeFiles";
-export * from "./bridgeLog";
-export * from "./bridgeNet";
-export * from "./bridgePath";
-export * from "./bridgePrivilege";
-export * from "./bridgeProbe";
-export * from "./bridgeRegistry";
-export * from "./bridgeServer";
-export * from "./bridgeState";
-export * from "./bridgeSupervisor";
-export * from "./bridgeZip";
 export * from "./serve";

package/src/runtime/serve.ts

@@ -79,7 +79,7 @@ export const serve = async (driver: BridgeDriver) => {
 		},
 		onReady() {
 			void Promise.resolve(driver.lifecycle.onReady?.(context)).catch((error: unknown) => {
-				log("lifecycle ready hook failed", {
+				log.warn("lifecycle ready hook failed", {
 					error: errorText(error),
 				});
 			});
@@ -219,6 +219,47 @@ export const serve = async (driver: BridgeDriver) => {
 				await driver.backup?.release?.(context);
 			}
 		},
+		async onDescribe() {
+			const describe = driver.install.describe;
+
+			if (!describe) {
+				return {
+					supported: false,
+					version: null,
+					variant: null,
+					build: null,
+				};
+			}
+
+			return {
+				supported: true,
+				...(await describe(context)),
+			};
+		},
+		async onAnnounce(message) {
+			const announce = driver.announce;
+
+			if (!announce) {
+				return {
+					supported: false,
+					delivered: false,
+				};
+			}
+
+			if (!supervisor.running) {
+				return {
+					supported: true,
+					delivered: false,
+				};
+			}
+
+			await announce.announce(context, message);
+
+			return {
+				supported: true,
+				delivered: true,
+			};
+		},
 	});
 
 	await chmod(socketPath(config), SOCKET_MODE);
@@ -271,7 +312,7 @@ export const serve = async (driver: BridgeDriver) => {
 
 		supervisor.setRuntime(BridgeRuntime.Crashed);
 
-		log("install failed", {
+		log.error("install failed", {
 			error: installError,
 		});
 
@@ -286,7 +327,7 @@ export const serve = async (driver: BridgeDriver) => {
 		} catch (error) {
 			supervisor.setRuntime(BridgeRuntime.Crashed);
 
-			log("start failed", {
+			log.error("start failed", {
 				error: errorText(error),
 			});
 		}

package/src/terminal/bridgeTerminalArg.ts

@@ -0,0 +1,11 @@
+import type { LocalizedText } from "../core";
+
+export interface BridgeTerminalArg {
+	key: string;
+	label?: LocalizedText;
+	required?: boolean;
+	variadic?: boolean;
+	values?: string[];
+	module?: string;
+	column?: string;
+}

package/src/terminal/bridgeTerminalCommand.ts

@@ -0,0 +1,11 @@
+import type { LocalizedText } from "../core";
+import type { BridgeTerminalArg } from "./bridgeTerminalArg";
+
+export interface BridgeTerminalCommand {
+	name: string;
+	summary: LocalizedText;
+	syntax?: string;
+	args?: BridgeTerminalArg[];
+	danger?: boolean;
+	requiresRunning?: boolean;
+}

package/src/terminal/bridgeTerminalLevel.ts

@@ -0,0 +1,6 @@
+export enum BridgeTerminalLevel {
+	Debug = "debug",
+	Info = "info",
+	Warn = "warn",
+	Error = "error",
+}

package/src/terminal/bridgeTerminalRule.ts

@@ -0,0 +1,8 @@
+import type { BridgeStream } from "../core";
+import type { BridgeTerminalLevel } from "./bridgeTerminalLevel";
+
+export interface BridgeTerminalRule {
+	match: RegExp;
+	level: BridgeTerminalLevel;
+	stream?: BridgeStream;
+}

package/src/terminal/index.ts

@@ -0,0 +1,4 @@
+export * from "./bridgeTerminalArg";
+export * from "./bridgeTerminalCommand";
+export * from "./bridgeTerminalLevel";
+export * from "./bridgeTerminalRule";

package/src/manifest/checks.ts

@@ -1,50 +0,0 @@
-import type { Manifest, ManifestPort } from "./manifest";
-
-const overlaps = (a: ManifestPort, b: ManifestPort) => {
-	return a.host.min <= b.host.max && b.host.min <= a.host.max;
-};
-
-export const checkManifest = (manifest: Manifest) => {
-	const portKeys = manifest.runtime.ports.map((port) => port.key);
-
-	if (new Set(portKeys).size !== portKeys.length) {
-		throw new Error("runtime declares duplicate port keys");
-	}
-
-	const ports = manifest.runtime.ports;
-
-	for (let index = 0; index < ports.length; index += 1) {
-		for (let other = index + 1; other < ports.length; other += 1) {
-			const a = ports[index];
-			const b = ports[other];
-
-			if (!a || !b || a.protocol !== b.protocol) {
-				continue;
-			}
-
-			if (overlaps(a, b)) {
-				throw new Error(`ports "${a.key}" and "${b.key}" declare overlapping ${a.protocol} host ranges`);
-			}
-		}
-	}
-
-	const guideIds = manifest.guides.map((guide) => guide.id);
-
-	if (new Set(guideIds).size !== guideIds.length) {
-		throw new Error("guides declare duplicate ids");
-	}
-
-	const bodies: string[] = [];
-
-	for (const guide of manifest.guides) {
-		if (guide.body.ar === guide.body.en) {
-			throw new Error(`guide "${guide.id}" reuses one body file for both locales`);
-		}
-
-		bodies.push(guide.body.ar, guide.body.en);
-	}
-
-	if (new Set(bodies).size !== bodies.length) {
-		throw new Error("guides declare duplicate body paths");
-	}
-};