@serverkgg/bridge 0.1.1 → 0.1.3

package/src/steam/steamcmd.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, test } from "bun:test";
-import { steamcmdArgv, steamcmdScript, steamcmdUpdateArgs } from "./steamcmd";
+import { describe, expect, it } from "bun:test";
+import { steamcmdArgv, steamcmdFailureText, steamcmdScript, steamcmdUpdateArgs } from "./steamcmd";
 import { SteamcmdLoginKind, steamcmdLoginArgs } from "./steamcmdLogin";
 import { SteamcmdPlatform } from "./steamcmdPlatform";
 
@@ -9,13 +9,13 @@ const OPTIONS = {
 };
 
 describe("steamcmdLoginArgs", () => {
-	test("logs in anonymously by default", () => {
+	it("logs in anonymously by default", () => {
 		expect(steamcmdLoginArgs()).toEqual([
 			"anonymous",
 		]);
 	});
 
-	test("passes the account credentials through", () => {
+	it("passes the account credentials through", () => {
 		expect(
 			steamcmdLoginArgs({
 				kind: SteamcmdLoginKind.Account,
@@ -30,14 +30,14 @@ describe("steamcmdLoginArgs", () => {
 });
 
 describe("steamcmdScript", () => {
-	test("lives inside the copied steamcmd directory", () => {
+	it("lives inside the copied steamcmd directory", () => {
 		expect(steamcmdScript()).toBe(".steamcmd/steamcmd.sh");
 		expect(steamcmdScript(".sc")).toBe(".sc/steamcmd.sh");
 	});
 });
 
 describe("steamcmdArgv", () => {
-	test("forces the install directory and logs in before the command", () => {
+	it("forces the install directory and logs in before the command", () => {
 		expect(
 			steamcmdArgv(OPTIONS, "/home/container", [
 				"+app_update",
@@ -55,7 +55,7 @@ describe("steamcmdArgv", () => {
 		]);
 	});
 
-	test("forces the windows platform before the login", () => {
+	it("forces the windows platform before the login", () => {
 		const argv = steamcmdArgv(
 			{
 				...OPTIONS,
@@ -70,7 +70,7 @@ describe("steamcmdArgv", () => {
 		expect(argv.indexOf("+@sSteamCmdForcePlatformType")).toBeLessThan(argv.indexOf("+login"));
 	});
 
-	test("leaves the platform alone on linux", () => {
+	it("leaves the platform alone on linux", () => {
 		expect(
 			steamcmdArgv(
 				{
@@ -85,7 +85,7 @@ describe("steamcmdArgv", () => {
 });
 
 describe("steamcmdUpdateArgs", () => {
-	test("updates without validating by default", () => {
+	it("updates without validating by default", () => {
 		expect(
 			steamcmdUpdateArgs("258550", {
 				validate: false,
@@ -96,7 +96,7 @@ describe("steamcmdUpdateArgs", () => {
 		]);
 	});
 
-	test("adds validate last of the update flags", () => {
+	it("adds validate last of the update flags", () => {
 		expect(
 			steamcmdUpdateArgs("258550", {
 				validate: true,
@@ -108,7 +108,7 @@ describe("steamcmdUpdateArgs", () => {
 		]);
 	});
 
-	test("passes a branch and its password", () => {
+	it("passes a branch and its password", () => {
 		expect(
 			steamcmdUpdateArgs("90", {
 				validate: true,
@@ -126,7 +126,7 @@ describe("steamcmdUpdateArgs", () => {
 		]);
 	});
 
-	test("ignores a branch password without a branch", () => {
+	it("ignores a branch password without a branch", () => {
 		expect(
 			steamcmdUpdateArgs("90", {
 				validate: false,
@@ -138,7 +138,7 @@ describe("steamcmdUpdateArgs", () => {
 		]);
 	});
 
-	test("appends the extra arguments", () => {
+	it("appends the extra arguments", () => {
 		expect(
 			steamcmdUpdateArgs("376030", {
 				validate: false,
@@ -155,3 +155,34 @@ describe("steamcmdUpdateArgs", () => {
 		]);
 	});
 });
+
+describe("steamcmdFailureText", () => {
+	it("says the download account does not own the app when steam answers no subscription", () => {
+		expect(
+			steamcmdFailureText(
+				{
+					stdout: "No subscription",
+					stderr: "",
+					code: 8,
+				},
+				"assetto",
+			).en,
+		).toBe("Steam refused to download assetto because the download account doesn't own it. Contact support.");
+	});
+
+	it("says the download failed for any other exit", () => {
+		expect(
+			steamcmdFailureText(
+				{
+					stdout: "",
+					stderr: "",
+					code: 8,
+				},
+				"palworld",
+			),
+		).toEqual({
+			ar: "تعذّر تنزيل palworld من Steam، جرب مرة ثانية.",
+			en: "We couldn't download palworld from Steam. Try again.",
+		});
+	});
+});

package/src/steam/steamcmd.ts

@@ -1,4 +1,5 @@
-import type { BridgeContext } from "../context";
+import type { BridgeContext, BridgeExecResult } from "../context";
+import { BridgeUserError, type LocalizedText } from "../core";
 import { execDetail } from "../utils";
 import { installedBuildId } from "./steamApp";
 import { type SteamcmdLogin, SteamcmdLoginKind, steamcmdLoginArgs } from "./steamcmdLogin";
@@ -25,6 +26,8 @@ const ATTEMPTS = 3;
 
 const RETRY_DELAY_MS = 5000;
 
+const NO_SUBSCRIPTION = "No subscription";
+
 export interface SteamcmdOptions {
 	appId: string;
 	label: string;
@@ -100,6 +103,20 @@ export const steamcmdUpdateArgs = (appId: string, update: SteamcmdUpdateOptions)
 	return args;
 };
 
+export const steamcmdFailureText = (result: BridgeExecResult, label: string): LocalizedText => {
+	if (`${result.stdout}\n${result.stderr}`.includes(NO_SUBSCRIPTION)) {
+		return {
+			ar: `رفض Steam تنزيل ${label} لأن حساب التنزيل لا يملكه. تواصل مع الدعم.`,
+			en: `Steam refused to download ${label} because the download account doesn't own it. Contact support.`,
+		};
+	}
+
+	return {
+		ar: `تعذّر تنزيل ${label} من Steam، جرب مرة ثانية.`,
+		en: `We couldn't download ${label} from Steam. Try again.`,
+	};
+};
+
 const installRoot = async (context: BridgeContext) => {
 	const result = await context.exec([
 		"pwd",
@@ -162,7 +179,7 @@ export const createSteamcmd = (context: BridgeContext, options: SteamcmdOptions)
 
 		const attempts = runOptions.attempts ?? ATTEMPTS;
 
-		let failure = "";
+		let failure: BridgeExecResult | null = null;
 
 		for (let attempt = 1; attempt <= attempts; attempt++) {
 			const result = await context.exec(argv, {
@@ -178,7 +195,7 @@ export const createSteamcmd = (context: BridgeContext, options: SteamcmdOptions)
 				return;
 			}
 
-			failure = `steamcmd exited with code ${result.code} — ${execDetail(result)}`;
+			failure = result;
 
 			if (attempt < attempts) {
 				context.log("steamcmd did not finish, trying again", {
@@ -191,7 +208,13 @@ export const createSteamcmd = (context: BridgeContext, options: SteamcmdOptions)
 			}
 		}
 
-		throw new Error(failure);
+		if (!failure) {
+			throw new Error("steamcmd was not run");
+		}
+
+		throw new BridgeUserError(steamcmdFailureText(failure, options.label), {
+			cause: new Error(`steamcmd exited with code ${failure.code} — ${execDetail(failure)}`),
+		});
 	};
 
 	return {

package/src/steam/steamcmdNarrator.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import type { BridgeLog } from "../context";
 import type { BridgeValues } from "../core";
 import { steamcmdNarrator } from "./steamcmdNarrator";
@@ -20,7 +20,7 @@ const recorder = () => {
 };
 
 describe("steamcmdNarrator", () => {
-	test("reports download progress in ten percent steps", () => {
+	it("reports download progress in ten percent steps", () => {
 		const { log, lines, fields } = recorder();
 		const narrate = steamcmdNarrator(log, "palworld");
 
@@ -57,7 +57,7 @@ describe("steamcmdNarrator", () => {
 		]);
 	});
 
-	test("starts counting again when the phase changes", () => {
+	it("starts counting again when the phase changes", () => {
 		const { log, fields } = recorder();
 		const narrate = steamcmdNarrator(log, "rust");
 
@@ -74,7 +74,7 @@ describe("steamcmdNarrator", () => {
 		]);
 	});
 
-	test("passes notable lines through with the ansi stripped", () => {
+	it("passes notable lines through with the ansi stripped", () => {
 		const { log, lines } = recorder();
 		const narrate = steamcmdNarrator(log, "rust");
 

package/src/steam/workshop.test.ts

@@ -1,8 +1,8 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { workshopContentPath, workshopDownloadArgs, workshopFormBody } from "./workshop";
 
 describe("workshopFormBody", () => {
-	test("writes the count and the indexed ids", () => {
+	it("writes the count and the indexed ids", () => {
 		expect(
 			workshopFormBody("itemcount", [
 				"450814997",
@@ -11,7 +11,7 @@ describe("workshopFormBody", () => {
 		).toBe("itemcount=2&publishedfileids%5B0%5D=450814997&publishedfileids%5B1%5D=1234");
 	});
 
-	test("names the count field the collection api expects", () => {
+	it("names the count field the collection api expects", () => {
 		expect(
 			workshopFormBody("collectioncount", [
 				"1",
@@ -21,7 +21,7 @@ describe("workshopFormBody", () => {
 });
 
 describe("workshopDownloadArgs", () => {
-	test("asks steamcmd for every item", () => {
+	it("asks steamcmd for every item", () => {
 		expect(
 			workshopDownloadArgs("440900", [
 				"1",
@@ -39,7 +39,7 @@ describe("workshopDownloadArgs", () => {
 });
 
 describe("workshopContentPath", () => {
-	test("points at where steamcmd unpacks an item", () => {
+	it("points at where steamcmd unpacks an item", () => {
 		expect(workshopContentPath("440900", "12345")).toBe("steamapps/workshop/content/440900/12345");
 	});
 });

package/src/utils/changedSettingKeys.test.ts

@@ -0,0 +1,65 @@
+import { describe, expect, it } from "bun:test";
+import { changedSettingKeys } from "./changedSettingKeys";
+
+describe("changedSettingKeys", () => {
+	it("keeps only the keys whose value really changed", () => {
+		expect(
+			changedSettingKeys(
+				{
+					difficulty: "easy",
+					expRate: "1.000000",
+					pvp: "True",
+					name: "My server",
+				},
+				{
+					difficulty: "hard",
+					expRate: 1,
+					pvp: true,
+					name: "My server",
+				},
+			),
+		).toEqual([
+			"difficulty",
+		]);
+	});
+
+	it("counts a key the stored values do not hold as changed", () => {
+		expect(
+			changedSettingKeys(
+				{},
+				{
+					seed: "42",
+				},
+			),
+		).toEqual([
+			"seed",
+		]);
+	});
+
+	it("counts every written key as changed when nothing could be read first", () => {
+		const written = {
+			difficulty: "hard",
+			pvp: false,
+		};
+
+		expect(changedSettingKeys(null, written)).toEqual([
+			"difficulty",
+			"pvp",
+		]);
+		expect(changedSettingKeys(undefined, written)).toEqual([
+			"difficulty",
+			"pvp",
+		]);
+	});
+
+	it("answers nothing for an empty write", () => {
+		expect(
+			changedSettingKeys(
+				{
+					difficulty: "easy",
+				},
+				{},
+			),
+		).toEqual([]);
+	});
+});

package/src/utils/changedSettingKeys.ts

@@ -0,0 +1,6 @@
+import type { BridgeValues } from "../core";
+import { sameSettingValue } from "./sameSettingValue";
+
+export const changedSettingKeys = (before: BridgeValues | null | undefined, written: BridgeValues): string[] => {
+	return Object.keys(written).filter((key) => !before || !sameSettingValue(before[key], written[key]));
+};

package/src/utils/describeExecFailure.test.ts

@@ -0,0 +1,34 @@
+import { describe, expect, it } from "bun:test";
+import { describeExecFailure } from "./describeExecFailure";
+
+describe("describeExecFailure", () => {
+	it("names the subject and the exit code in both languages", () => {
+		const text = describeExecFailure(
+			{
+				stdout: "",
+				stderr: "java.lang.RuntimeException",
+				code: 1,
+			},
+			"Forge installer",
+		);
+
+		expect(text).toEqual({
+			ar: "فشل Forge installer بكود الخروج 1.",
+			en: "Forge installer failed with exit code 1.",
+		});
+	});
+
+	it("keeps the process output out of the customer text", () => {
+		const text = describeExecFailure(
+			{
+				stdout: "token=abc",
+				stderr: "at /home/game/secret",
+				code: 2,
+			},
+			"unzip",
+		);
+
+		expect(JSON.stringify(text)).not.toContain("secret");
+		expect(JSON.stringify(text)).not.toContain("token");
+	});
+});

package/src/utils/describeExecFailure.ts

@@ -0,0 +1,9 @@
+import type { BridgeExecResult } from "../context";
+import type { LocalizedText } from "../core";
+
+export const describeExecFailure = (result: BridgeExecResult, subject: string): LocalizedText => {
+	return {
+		ar: `فشل ${subject} بكود الخروج ${result.code}.`,
+		en: `${subject} failed with exit code ${result.code}.`,
+	};
+};

package/src/utils/index.ts

@@ -1,4 +1,7 @@
+export * from "./changedSettingKeys";
+export * from "./describeExecFailure";
 export * from "./execDetail";
 export * from "./glob";
+export * from "./sameSettingValue";
 export * from "./stripAnsi";
 export * from "./token";

package/src/utils/sameSettingValue.test.ts

@@ -0,0 +1,35 @@
+import { describe, expect, it } from "bun:test";
+import { sameSettingValue } from "./sameSettingValue";
+
+describe("sameSettingValue", () => {
+	it("treats a float the ini codec wrote as equal to the integer the form sends", () => {
+		expect(sameSettingValue("1.000000", 1)).toBe(true);
+		expect(sameSettingValue("1", "1.000000")).toBe(true);
+	});
+
+	it("treats decimals that differ only in trailing zeros as equal", () => {
+		expect(sameSettingValue("0.5", "0.50")).toBe(true);
+	});
+
+	it("treats boolean text as equal whatever its case", () => {
+		expect(sameSettingValue("True", "true")).toBe(true);
+		expect(sameSettingValue("False", false)).toBe(true);
+		expect(sameSettingValue(true, "FALSE")).toBe(false);
+	});
+
+	it("never treats an empty value as zero", () => {
+		expect(sameSettingValue("", "0")).toBe(false);
+		expect(sameSettingValue(null, 0)).toBe(false);
+	});
+
+	it("keeps a leading-zero string different from its number, since it may be an id", () => {
+		expect(sameSettingValue("01", "1")).toBe(false);
+	});
+
+	it("compares the trimmed text of anything else", () => {
+		expect(sameSettingValue(" easy ", "easy")).toBe(true);
+		expect(sameSettingValue("easy", "hard")).toBe(false);
+		expect(sameSettingValue("2", "3")).toBe(false);
+		expect(sameSettingValue(undefined, "")).toBe(true);
+	});
+});

package/src/utils/sameSettingValue.ts

@@ -0,0 +1,40 @@
+import type { BridgeValue } from "../core";
+
+const PLAIN_NUMBER = /^-?(0|[1-9]\d*)(\.\d+)?$/;
+
+const BOOLEAN_TEXT: Readonly<Record<string, boolean>> = {
+	true: true,
+	false: false,
+};
+
+const settingText = (value: BridgeValue | undefined) => {
+	return value === undefined || value === null ? "" : String(value).trim();
+};
+
+const numberOf = (text: string) => {
+	return PLAIN_NUMBER.test(text) ? Number(text) : null;
+};
+
+const booleanOf = (text: string) => {
+	return BOOLEAN_TEXT[text.toLowerCase()] ?? null;
+};
+
+export const sameSettingValue = (left: BridgeValue | undefined, right: BridgeValue | undefined): boolean => {
+	const a = settingText(left);
+	const b = settingText(right);
+
+	if (a === b) {
+		return true;
+	}
+
+	const leftNumber = numberOf(a);
+	const rightNumber = numberOf(b);
+
+	if (leftNumber !== null && rightNumber !== null) {
+		return leftNumber === rightNumber;
+	}
+
+	const leftBoolean = booleanOf(a);
+
+	return leftBoolean !== null && leftBoolean === booleanOf(b);
+};

package/src/utils/token.test.ts

@@ -1,8 +1,8 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { generateToken, TOKEN_ALPHABET } from "./token";
 
 describe("generateToken", () => {
-	test("returns a token of the requested length from the default alphabet", () => {
+	it("returns a token of the requested length from the default alphabet", () => {
 		const token = generateToken(40);
 
 		expect(token).toHaveLength(40);
@@ -13,15 +13,15 @@ describe("generateToken", () => {
 		).toBe(true);
 	});
 
-	test("uses the alphabet it is given", () => {
+	it("uses the alphabet it is given", () => {
 		expect(generateToken(32, "ab")).toMatch(/^[ab]{32}$/);
 	});
 
-	test("does not repeat itself", () => {
+	it("does not repeat itself", () => {
 		expect(generateToken(24)).not.toBe(generateToken(24));
 	});
 
-	test("draws every character of a small alphabet", () => {
+	it("draws every character of a small alphabet", () => {
 		const seen = new Set([
 			...generateToken(2000, "abc"),
 		]);
@@ -37,13 +37,13 @@ describe("generateToken", () => {
 		]);
 	});
 
-	test("refuses a length that is not a positive integer", () => {
+	it("refuses a length that is not a positive integer", () => {
 		expect(() => generateToken(0)).toThrow();
 		expect(() => generateToken(-4)).toThrow();
 		expect(() => generateToken(1.5)).toThrow();
 	});
 
-	test("refuses an unusable alphabet", () => {
+	it("refuses an unusable alphabet", () => {
 		expect(() => generateToken(8, "")).toThrow();
 		expect(() => generateToken(8, "x".repeat(257))).toThrow();
 	});

package/src/wine/protonCommand.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import type { BridgeContext } from "../context";
 import { protonCommand, protonCompatPath } from "./protonCommand";
 
@@ -13,13 +13,13 @@ const context = {
 } as unknown as BridgeContext;
 
 describe("protonCompatPath", () => {
-	test("gives every app its own compat data directory", () => {
+	it("gives every app its own compat data directory", () => {
 		expect(protonCompatPath("2430930")).toBe(".proton/2430930");
 	});
 });
 
 describe("protonCommand", () => {
-	test("builds an env prefix pointing inside the container home", async () => {
+	it("builds an env prefix pointing inside the container home", async () => {
 		expect(
 			await protonCommand(context, {
 				appId: "2430930",
@@ -41,7 +41,7 @@ describe("protonCommand", () => {
 		]);
 	});
 
-	test("ensures the compat and steam directories", async () => {
+	it("ensures the compat and steam directories", async () => {
 		ensured.length = 0;
 
 		await protonCommand(context, {
@@ -55,7 +55,7 @@ describe("protonCommand", () => {
 		]);
 	});
 
-	test("honours another proton build", async () => {
+	it("honours another proton build", async () => {
 		expect(
 			await protonCommand(context, {
 				appId: "1",

package/src/wine/wineCommand.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import type { BridgeContext } from "../context";
 import { wineCommand, wineDllOverrides } from "./wineCommand";
 
@@ -13,7 +13,7 @@ const context = {
 } as unknown as BridgeContext;
 
 describe("wineDllOverrides", () => {
-	test("joins the overrides the way wine reads them", () => {
+	it("joins the overrides the way wine reads them", () => {
 		expect(
 			wineDllOverrides({
 				winhttp: "n,b",
@@ -24,7 +24,7 @@ describe("wineDllOverrides", () => {
 });
 
 describe("wineCommand", () => {
-	test("builds an env prefix pointing inside the container home", async () => {
+	it("builds an env prefix pointing inside the container home", async () => {
 		expect(
 			await wineCommand(context, {
 				exe: "VRisingServer.exe",
@@ -45,7 +45,7 @@ describe("wineCommand", () => {
 		]);
 	});
 
-	test("ensures the prefix directory it points at", async () => {
+	it("ensures the prefix directory it points at", async () => {
 		ensured.length = 0;
 
 		await wineCommand(context, {
@@ -58,7 +58,7 @@ describe("wineCommand", () => {
 		]);
 	});
 
-	test("wraps the game in xvfb-run when asked", async () => {
+	it("wraps the game in xvfb-run when asked", async () => {
 		const argv = await wineCommand(context, {
 			exe: "a.exe",
 			xvfb: true,
@@ -72,7 +72,7 @@ describe("wineCommand", () => {
 		]);
 	});
 
-	test("adds the dll overrides and extra environment", async () => {
+	it("adds the dll overrides and extra environment", async () => {
 		const argv = await wineCommand(context, {
 			exe: "a.exe",
 			dllOverrides: {

package/src/wine/winePrefix.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import type { BridgeContext, BridgeExecOptions } from "../context";
 import { prepareWinePrefix, WINE_PREFIX_STAMP } from "./winePrefix";
 
@@ -45,7 +45,7 @@ const testContext = (code = 0) => {
 };
 
 describe("prepareWinePrefix", () => {
-	test("boots a wine prefix once and stamps it", async () => {
+	it("boots a wine prefix once and stamps it", async () => {
 		const { context, runs, stored } = testContext();
 
 		await prepareWinePrefix(context);
@@ -63,7 +63,7 @@ describe("prepareWinePrefix", () => {
 		expect(runs).toHaveLength(1);
 	});
 
-	test("boots the prefix through proton when asked", async () => {
+	it("boots the prefix through proton when asked", async () => {
 		const { context, runs } = testContext();
 
 		await prepareWinePrefix(context, {
@@ -79,7 +79,7 @@ describe("prepareWinePrefix", () => {
 		]);
 	});
 
-	test("boots again when the runtime changed from wine to proton", async () => {
+	it("boots again when the runtime changed from wine to proton", async () => {
 		const { context, runs } = testContext();
 
 		await prepareWinePrefix(context);
@@ -91,7 +91,7 @@ describe("prepareWinePrefix", () => {
 		expect(runs).toHaveLength(2);
 	});
 
-	test("refuses a proton prefix with no app id", async () => {
+	it("refuses a proton prefix with no app id", async () => {
 		const { context } = testContext();
 
 		await expect(
@@ -101,7 +101,7 @@ describe("prepareWinePrefix", () => {
 		).rejects.toThrow("steam app id");
 	});
 
-	test("raises when wineboot fails and leaves no stamp", async () => {
+	it("raises when wineboot fails and leaves no stamp", async () => {
 		const { context, stored } = testContext(1);
 
 		await expect(prepareWinePrefix(context)).rejects.toThrow("wineboot exploded");