@serverkgg/bridge 0.1.1 → 0.1.3

package/src/runtime/bridgeInstall.test.ts

@@ -1,9 +1,9 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { BridgeDesired, BridgeHoldReason, BridgeRuntime } from "../core";
 import { decideInstall, recountHold } from "./bridgeInstall";
 
 describe("decideInstall", () => {
-	test("starts the game when the install returns nothing and the server wants to run", () => {
+	it("starts the game when the install returns nothing and the server wants to run", () => {
 		expect(decideInstall(undefined, BridgeDesired.Running)).toEqual({
 			hold: null,
 			runtime: BridgeRuntime.Starting,
@@ -11,7 +11,7 @@ describe("decideInstall", () => {
 		});
 	});
 
-	test("stays stopped when the install returns nothing and the server wants to stay down", () => {
+	it("stays stopped when the install returns nothing and the server wants to stay down", () => {
 		expect(decideInstall(undefined, BridgeDesired.Stopped)).toEqual({
 			hold: null,
 			runtime: BridgeRuntime.Stopped,
@@ -19,7 +19,7 @@ describe("decideInstall", () => {
 		});
 	});
 
-	test("starts the game when the install answers with no hold", () => {
+	it("starts the game when the install answers with no hold", () => {
 		expect(
 			decideInstall(
 				{
@@ -34,7 +34,7 @@ describe("decideInstall", () => {
 		});
 	});
 
-	test("holds the game stopped when the install answers with a hold", () => {
+	it("holds the game stopped when the install answers with a hold", () => {
 		const hold = {
 			reason: BridgeHoldReason.PendingFiles,
 			count: 2,
@@ -54,7 +54,7 @@ describe("decideInstall", () => {
 		});
 	});
 
-	test("keeps the hold when the server was already stopped", () => {
+	it("keeps the hold when the server was already stopped", () => {
 		const hold = {
 			reason: BridgeHoldReason.PendingFiles,
 			count: 1,
@@ -76,11 +76,11 @@ describe("decideInstall", () => {
 });
 
 describe("recountHold", () => {
-	test("leaves a driver without a hold alone", () => {
+	it("leaves a driver without a hold alone", () => {
 		expect(recountHold(null, 3)).toBeNull();
 	});
 
-	test("moves the count of a pending-files hold to what the driver now lists", () => {
+	it("moves the count of a pending-files hold to what the driver now lists", () => {
 		expect(
 			recountHold(
 				{
@@ -95,7 +95,7 @@ describe("recountHold", () => {
 		});
 	});
 
-	test("keeps the same hold when the count did not move", () => {
+	it("keeps the same hold when the count did not move", () => {
 		const hold = {
 			reason: BridgeHoldReason.PendingFiles,
 			count: 2,
@@ -104,7 +104,7 @@ describe("recountHold", () => {
 		expect(recountHold(hold, 2)).toBe(hold);
 	});
 
-	test("clears the hold when nothing is pending any more", () => {
+	it("clears the hold when nothing is pending any more", () => {
 		expect(
 			recountHold(
 				{

package/src/runtime/bridgeLiveConfig.test.ts

@@ -1,4 +1,4 @@
-import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { afterEach, beforeEach, describe, expect, it } from "bun:test";
 import { mkdtemp, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
@@ -45,7 +45,7 @@ afterEach(async () => {
 });
 
 describe("the bridge live config reader", () => {
-	test("answers from the boot snapshot", async () => {
+	it("answers from the boot snapshot", async () => {
 		const config = configWith({
 			CURSEFORGE_API_KEY: "boot",
 		});
@@ -58,7 +58,7 @@ describe("the bridge live config reader", () => {
 		expect(secrets.secret("MODRINTH_API_KEY")).toBeNull();
 	});
 
-	test("sees a value the agent rewrote into the config", async () => {
+	it("sees a value the agent rewrote into the config", async () => {
 		const config = configWith({
 			CURSEFORGE_API_KEY: "boot",
 		});
@@ -80,7 +80,7 @@ describe("the bridge live config reader", () => {
 		expect(secrets.secret("MODRINTH_API_KEY")).toBe("added");
 	});
 
-	test("keeps the last good values while the config is mid-write", async () => {
+	it("keeps the last good values while the config is mid-write", async () => {
 		const config = configWith({
 			CURSEFORGE_API_KEY: "boot",
 		});
@@ -100,7 +100,7 @@ describe("the bridge live config reader", () => {
 		expect(secrets.secret("CURSEFORGE_API_KEY")).toBe("boot");
 	});
 
-	test("re-reads the file at most once per refresh window", async () => {
+	it("re-reads the file at most once per refresh window", async () => {
 		const config = configWith({
 			CURSEFORGE_API_KEY: "boot",
 		});
@@ -120,7 +120,7 @@ describe("the bridge live config reader", () => {
 		expect(secrets.secret("CURSEFORGE_API_KEY")).toBe("boot");
 	});
 
-	test("sees a variable the customer changed after boot, and the new plan resources", async () => {
+	it("sees a variable the customer changed after boot, and the new plan resources", async () => {
 		const config = configWith({});
 
 		await write(config);

package/src/runtime/bridgeLog.ts

@@ -36,3 +36,13 @@ export const log: BridgeLeveledLogger = Object.assign(
 export const errorText = (error: unknown) => {
 	return error instanceof Error ? error.message : String(error);
 };
+
+export const errorDetail = (error: unknown) => {
+	const text = errorText(error);
+
+	if (!(error instanceof Error) || error.cause === undefined) {
+		return text;
+	}
+
+	return `${text} — ${errorText(error.cause)}`;
+};

package/src/runtime/bridgePending.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { BRIDGE_PENDING_FILES_LIMIT, type BridgePendingFile } from "../protocol";
 import type { BridgeLeveledLogger } from "./bridgeLog";
 import { pendingResult, rejectedPending, unsupportedPending } from "./bridgePending";
@@ -46,7 +46,7 @@ const recorder = () => {
 };
 
 describe("unsupportedPending", () => {
-	test("answers the sentinel a driver without a pending module gets", () => {
+	it("answers the sentinel a driver without a pending module gets", () => {
 		expect(unsupportedPending()).toEqual({
 			supported: false,
 			staging: "",
@@ -58,7 +58,7 @@ describe("unsupportedPending", () => {
 });
 
 describe("pendingResult", () => {
-	test("carries the staging path, the extensions and the files the driver listed", () => {
+	it("carries the staging path, the extensions and the files the driver listed", () => {
 		const { onLog, warnings } = recorder();
 
 		expect(
@@ -83,7 +83,7 @@ describe("pendingResult", () => {
 		expect(warnings).toEqual([]);
 	});
 
-	test("truncates a list longer than the platform takes and warns instead of throwing", () => {
+	it("truncates a list longer than the platform takes and warns instead of throwing", () => {
 		const { onLog, warnings } = recorder();
 
 		const result = pendingResult(
@@ -104,7 +104,7 @@ describe("pendingResult", () => {
 });
 
 describe("rejectedPending", () => {
-	test("names every file still pending as what the upload was expected to be", () => {
+	it("names every file still pending as what the upload was expected to be", () => {
 		const { onLog } = recorder();
 
 		const result = rejectedPending(
@@ -127,7 +127,7 @@ describe("rejectedPending", () => {
 		expect(result.files).toHaveLength(2);
 	});
 
-	test("leaves an empty expectation when the driver has nothing pending left", () => {
+	it("leaves an empty expectation when the driver has nothing pending left", () => {
 		const { onLog } = recorder();
 
 		expect(

package/src/runtime/bridgeRedaction.test.ts

@@ -1,4 +1,4 @@
-import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { afterEach, beforeEach, describe, expect, it } from "bun:test";
 import { mkdtemp, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
@@ -93,7 +93,7 @@ const sourceOf = (initial: Record<string, string>, secrets: Record<string, strin
 };
 
 describe("secretFieldKeys", () => {
-	test("collects every secret form field once and nothing else", () => {
+	it("collects every secret form field once and nothing else", () => {
 		expect(
 			secretFieldKeys(
 				driverWith([
@@ -106,13 +106,13 @@ describe("secretFieldKeys", () => {
 		]);
 	});
 
-	test("finds nothing in a driver with no secret fields", () => {
+	it("finds nothing in a driver with no secret fields", () => {
 		expect(secretFieldKeys(driverWith([]))).toEqual([]);
 	});
 });
 
 describe("createBridgeRedaction", () => {
-	test("is built for every driver and leaves text alone until a secret exists", () => {
+	it("is built for every driver and leaves text alone until a secret exists", () => {
 		const { source, seal } = sourceOf({});
 		const redact = createBridgeRedaction([], source);
 
@@ -125,7 +125,7 @@ describe("createBridgeRedaction", () => {
 		expect(redact(`token ${TOKEN}`)).toBe(`token ${REDACTED}`);
 	});
 
-	test("blanks the platform secrets the manifest declares, with the same length floor", () => {
+	it("blanks the platform secrets the manifest declares, with the same length floor", () => {
 		const redact = createBridgeRedaction(
 			[],
 			sourceOf(
@@ -140,7 +140,7 @@ describe("createBridgeRedaction", () => {
 		expect(redact("key cf-api-key-0123456789 and short")).toBe(`key ${REDACTED} and short`);
 	});
 
-	test("blanks secret fields and platform secrets together", () => {
+	it("blanks secret fields and platform secrets together", () => {
 		const redact = createBridgeRedaction(
 			[
 				"BOT_TOKEN",
@@ -158,7 +158,7 @@ describe("createBridgeRedaction", () => {
 		expect(redact(`${TOKEN} cf-api-key-0123456789`)).toBe(`${REDACTED} ${REDACTED}`);
 	});
 
-	test("replaces every occurrence of a secret value", () => {
+	it("replaces every occurrence of a secret value", () => {
 		const redact = createBridgeRedaction(
 			[
 				"BOT_TOKEN",
@@ -173,7 +173,7 @@ describe("createBridgeRedaction", () => {
 		);
 	});
 
-	test("blanks every line of a multi-line secret the process prints one line at a time", () => {
+	it("blanks every line of a multi-line secret the process prints one line at a time", () => {
 		const key = [
 			"-----BEGIN PRIVATE KEY-----",
 			"MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC7",
@@ -198,7 +198,7 @@ describe("createBridgeRedaction", () => {
 		expect(redact(`whole ${key}`)).toBe(`whole ${REDACTED}`);
 	});
 
-	test("leaves a value under eight characters alone", () => {
+	it("leaves a value under eight characters alone", () => {
 		const redact = createBridgeRedaction(
 			[
 				"RCON_PASSWORD",
@@ -211,7 +211,7 @@ describe("createBridgeRedaction", () => {
 		expect(redact("the password is hunter2")).toBe("the password is hunter2");
 	});
 
-	test("escapes values that look like patterns and prefers the longest overlapping value", () => {
+	it("escapes values that look like patterns and prefers the longest overlapping value", () => {
 		const redact = createBridgeRedaction(
 			[
 				"SHORT",
@@ -226,7 +226,7 @@ describe("createBridgeRedaction", () => {
 		expect(redact("x a.b+c*d?-and-more y a.b+c*d? z aXb+c*d?")).toBe(`x ${REDACTED} y ${REDACTED} z aXb+c*d?`);
 	});
 
-	test("follows a value saved after it was built and forgets the old one", () => {
+	it("follows a value saved after it was built and forgets the old one", () => {
 		const { source, save } = sourceOf({
 			BOT_TOKEN: "old-token-value",
 		});
@@ -250,11 +250,11 @@ describe("createBridgeRedaction", () => {
 describe("redacting what the bridge reports", () => {
 	const redact = (value: string) => value.split(TOKEN).join(REDACTED);
 
-	test("covers both languages of a customer-facing message", () => {
+	it("covers both languages of a customer-facing message", () => {
 		expect(redactLocalized(text(`bad ${TOKEN}`), redact)).toEqual(text(`bad ${REDACTED}`));
 	});
 
-	test("covers the message and every string field of a log line", () => {
+	it("covers the message and every string field of a log line", () => {
 		const lines: unknown[] = [];
 		const record = (level: string) => (message: string, fields?: Record<string, unknown>) => {
 			lines.push({
@@ -345,7 +345,7 @@ describe("redaction over the live config", () => {
 		});
 	});
 
-	test("reads the platform secrets from the config the agent wrote", async () => {
+	it("reads the platform secrets from the config the agent wrote", async () => {
 		const boot = {
 			...configWith({}),
 			secrets: {
@@ -360,7 +360,7 @@ describe("redaction over the live config", () => {
 		expect(redact("cf-api-key-0123456789")).toBe(REDACTED);
 	});
 
-	test("starts as the identity with no secret anywhere and blanks a secret written after boot", async () => {
+	it("starts as the identity with no secret anywhere and blanks a secret written after boot", async () => {
 		const boot = configWith({});
 
 		await write(boot);
@@ -382,7 +382,7 @@ describe("redaction over the live config", () => {
 		expect(redact(`key ${TOKEN}`)).toBe(`key ${REDACTED}`);
 	});
 
-	test("picks up a token the agent writes into the config after boot", async () => {
+	it("picks up a token the agent writes into the config after boot", async () => {
 		const boot = configWith({});
 
 		await write(boot);

package/src/runtime/bridgeRefusalError.ts

@@ -0,0 +1,13 @@
+import type { LocalizedText } from "../core";
+import { BridgeDriverError } from "./bridgeDriver";
+
+export class BridgeRefusalError extends BridgeDriverError {
+	readonly text: LocalizedText | null;
+
+	constructor(message: string, text: LocalizedText | null = null) {
+		super(message);
+
+		this.name = "BridgeRefusalError";
+		this.text = text;
+	}
+}