@serverkgg/bridge 0.1.7 → 0.1.9

package/src/steam/steamcmd.test.ts

@@ -1,5 +1,16 @@
 import { describe, expect, it } from "bun:test";
-import { steamcmdArgv, steamcmdFailureText, steamcmdScript, steamcmdUpdateArgs } from "./steamcmd";
+import type { BridgeContext, BridgeExecResult } from "../context";
+import type { BridgeValues } from "../core";
+import {
+	createSteamcmd,
+	SteamcmdFailure,
+	steamcmdArgv,
+	steamcmdFailureOf,
+	steamcmdFailureText,
+	steamcmdRetryable,
+	steamcmdScript,
+	steamcmdUpdateArgs,
+} from "./steamcmd";
 import { SteamcmdLoginKind, steamcmdLoginArgs } from "./steamcmdLogin";
 import { SteamcmdPlatform } from "./steamcmdPlatform";
 
@@ -8,6 +19,86 @@ const OPTIONS = {
 	label: "palworld",
 };
 
+const MANIFEST = [
+	'"AppState"',
+	"{",
+	'\t"appid"\t\t"2394010"',
+	'\t"buildid"\t\t"19582821"',
+	"}",
+].join("\n");
+
+const SUCCESS: BridgeExecResult = {
+	stdout: "Success! App '2394010' fully installed.",
+	stderr: "",
+	code: 0,
+};
+
+interface Logged {
+	message: string;
+	fields?: BridgeValues;
+}
+
+const resultOf = (stdout: string): BridgeExecResult => {
+	return {
+		stdout,
+		stderr: "",
+		code: 8,
+	};
+};
+
+const contextWith = (answers: BridgeExecResult[], files: Record<string, string>) => {
+	const commands: string[][] = [];
+	const logs: Logged[] = [];
+
+	const log = Object.assign(
+		(message: string, fields?: BridgeValues) => {
+			logs.push({
+				message,
+				fields,
+			});
+		},
+		{
+			warn(message: string, fields?: BridgeValues) {
+				logs.push({
+					message,
+					fields,
+				});
+			},
+		},
+	);
+
+	const context = {
+		async exec(command: string[]) {
+			commands.push(command);
+
+			if (command[0] === "pwd") {
+				return {
+					stdout: "/home/container\n",
+					stderr: "",
+					code: 0,
+				};
+			}
+
+			return answers.shift() ?? SUCCESS;
+		},
+		files: {
+			async exists(path: string) {
+				return path in files;
+			},
+			async read(path: string) {
+				return files[path] ?? "";
+			},
+		},
+		log,
+	} as unknown as BridgeContext;
+
+	return {
+		context,
+		commands,
+		logs,
+	};
+};
+
 describe("steamcmdLoginArgs", () => {
 	it("logs in anonymously by default", () => {
 		expect(steamcmdLoginArgs()).toEqual([
@@ -85,12 +176,26 @@ describe("steamcmdArgv", () => {
 });
 
 describe("steamcmdUpdateArgs", () => {
+	it("refreshes the app info before the update", () => {
+		const args = steamcmdUpdateArgs("258550", {
+			validate: false,
+		});
+
+		expect(args.slice(0, 2)).toEqual([
+			"+app_info_update",
+			"1",
+		]);
+		expect(args.indexOf("+app_info_update")).toBeLessThan(args.indexOf("+app_update"));
+	});
+
 	it("updates without validating by default", () => {
 		expect(
 			steamcmdUpdateArgs("258550", {
 				validate: false,
 			}),
 		).toEqual([
+			"+app_info_update",
+			"1",
 			"+app_update",
 			"258550",
 		]);
@@ -102,6 +207,8 @@ describe("steamcmdUpdateArgs", () => {
 				validate: true,
 			}),
 		).toEqual([
+			"+app_info_update",
+			"1",
 			"+app_update",
 			"258550",
 			"validate",
@@ -116,6 +223,8 @@ describe("steamcmdUpdateArgs", () => {
 				branchPassword: "shh",
 			}),
 		).toEqual([
+			"+app_info_update",
+			"1",
 			"+app_update",
 			"90",
 			"-beta",
@@ -133,6 +242,8 @@ describe("steamcmdUpdateArgs", () => {
 				branchPassword: "shh",
 			}),
 		).toEqual([
+			"+app_info_update",
+			"1",
 			"+app_update",
 			"90",
 		]);
@@ -148,6 +259,8 @@ describe("steamcmdUpdateArgs", () => {
 				],
 			}),
 		).toEqual([
+			"+app_info_update",
+			"1",
 			"+app_update",
 			"376030",
 			"-language",
@@ -156,7 +269,142 @@ describe("steamcmdUpdateArgs", () => {
 	});
 });
 
+const FAILURE_CASES = [
+	{
+		output: "Error! App '2394010' state is 0x202 after update job.",
+		failure: SteamcmdFailure.DiskFull,
+	},
+	{
+		output: "Error! App '2394010' state is 0x212 after update job.",
+		failure: SteamcmdFailure.DiskFull,
+	},
+	{
+		output: "Invalid platform",
+		failure: SteamcmdFailure.InvalidPlatform,
+	},
+	{
+		output: "No subscription",
+		failure: SteamcmdFailure.NoSubscription,
+	},
+	{
+		output: "Password check for AppId 896660",
+		failure: SteamcmdFailure.BranchPassword,
+	},
+	{
+		output: "Error! State is 0x402 after update job.",
+		failure: SteamcmdFailure.Transient,
+	},
+	{
+		output: "Error! State is 0x602 after update job.",
+		failure: SteamcmdFailure.Transient,
+	},
+	{
+		output: "Error! App '2394010' state is 0x606 after update job.",
+		failure: SteamcmdFailure.Transient,
+	},
+	{
+		output: "Error! App '232250' state is 0x626 after update job.",
+		failure: SteamcmdFailure.Transient,
+	},
+	{
+		output: "Error! App '317670' state is 0x6A6 after update job.",
+		failure: SteamcmdFailure.Transient,
+	},
+	{
+		output: "Missing configuration",
+		failure: SteamcmdFailure.Transient,
+	},
+	{
+		output: "Update state (0x61) downloading, progress: 1.11 (127644881 / 11530459441)",
+		failure: SteamcmdFailure.Unknown,
+	},
+	{
+		output: "",
+		failure: SteamcmdFailure.Unknown,
+	},
+];
+
+describe("steamcmdFailureOf", () => {
+	for (const item of FAILURE_CASES) {
+		it(`reads ${JSON.stringify(item.output)} as ${item.failure}`, () => {
+			expect(steamcmdFailureOf(resultOf(item.output))).toBe(item.failure);
+		});
+	}
+
+	it("reads the code from stderr too", () => {
+		expect(
+			steamcmdFailureOf({
+				stdout: "",
+				stderr: "Error! App '2394010' state is 0x212 after update job.",
+				code: 8,
+			}),
+		).toBe(SteamcmdFailure.DiskFull);
+	});
+
+	it("puts a full disk ahead of a transient code in the same output", () => {
+		expect(
+			steamcmdFailureOf(
+				resultOf(
+					[
+						"Error! State is 0x602 after update job.",
+						"Error! App '2394010' state is 0x202 after update job.",
+					].join("\n"),
+				),
+			),
+		).toBe(SteamcmdFailure.DiskFull);
+	});
+});
+
+const RETRY_CASES = [
+	{
+		failure: SteamcmdFailure.DiskFull,
+		retryable: false,
+	},
+	{
+		failure: SteamcmdFailure.InvalidPlatform,
+		retryable: false,
+	},
+	{
+		failure: SteamcmdFailure.NoSubscription,
+		retryable: false,
+	},
+	{
+		failure: SteamcmdFailure.BranchPassword,
+		retryable: false,
+	},
+	{
+		failure: SteamcmdFailure.Transient,
+		retryable: true,
+	},
+	{
+		failure: SteamcmdFailure.Unknown,
+		retryable: true,
+	},
+];
+
+describe("steamcmdRetryable", () => {
+	for (const item of RETRY_CASES) {
+		it(`${item.retryable ? "retries" : "does not retry"} a ${item.failure} failure`, () => {
+			expect(steamcmdRetryable(item.failure)).toBe(item.retryable);
+		});
+	}
+});
+
 describe("steamcmdFailureText", () => {
+	it("tells the owner to free space or move up a plan when the disk is full", () => {
+		expect(steamcmdFailureText(resultOf("Error! App '258550' state is 0x202 after update job."), "rust")).toEqual({
+			ar: "امتلأت مساحة سيرفرك، فتعذّر تنزيل rust من Steam. احذف الملفات التي لا تحتاجها من صفحة الملفات أو انتقل إلى باقة أكبر، ثم جرب مرة ثانية.",
+			en: "Your server is out of space, so we couldn't download rust from Steam. Delete files you don't need on the Files page or move to a larger plan, then try again.",
+		});
+	});
+
+	it("says the branch password is wrong and where to fix it", () => {
+		expect(steamcmdFailureText(resultOf("Password check for AppId 896660"), "valheim")).toEqual({
+			ar: "كلمة مرور الفرع على Steam غير صحيحة، فتعذّر تنزيل valheim. صحّحها من الإعدادات.",
+			en: "The Steam branch password is wrong, so we couldn't download valheim. Fix it in the settings.",
+		});
+	});
+
 	it("says the download account does not own the app when steam answers no subscription", () => {
 		expect(
 			steamcmdFailureText(
@@ -186,3 +434,121 @@ describe("steamcmdFailureText", () => {
 		});
 	});
 });
+
+describe("createSteamcmd", () => {
+	it("stops at the first failure a retry cannot fix", async () => {
+		const { context, commands } = contextWith(
+			[
+				resultOf("Error! App '2394010' state is 0x202 after update job."),
+			],
+			{},
+		);
+		const steamcmd = createSteamcmd(context, OPTIONS);
+
+		await expect(
+			steamcmd.run([
+				"+app_update",
+				"2394010",
+			]),
+		).rejects.toThrow(
+			"Your server is out of space, so we couldn't download palworld from Steam. Delete files you don't need on the Files page or move to a larger plan, then try again.",
+		);
+		expect(commands.filter((command) => command[0] !== "pwd")).toHaveLength(1);
+	});
+
+	it("clears the cached app info, updates, then logs the installed build", async () => {
+		const { context, commands, logs } = contextWith([], {
+			".steamcmd": "",
+			".steam": "",
+			"steamapps/appmanifest_2394010.acf": MANIFEST,
+		});
+
+		await createSteamcmd(context, OPTIONS).update({
+			validate: false,
+		});
+
+		expect(commands).toEqual([
+			[
+				"find",
+				".steamcmd",
+				".steam",
+				"-type",
+				"f",
+				"-name",
+				"appinfo.vdf",
+				"-delete",
+			],
+			[
+				"pwd",
+			],
+			[
+				"./.steamcmd/steamcmd.sh",
+				"+force_install_dir",
+				"/home/container",
+				"+login",
+				"anonymous",
+				"+app_info_update",
+				"1",
+				"+app_update",
+				"2394010",
+				"+quit",
+			],
+		]);
+		expect(logs).toEqual([
+			{
+				message: "steamcmd finished the update",
+				fields: {
+					app: "2394010",
+					build: "19582821",
+				},
+			},
+		]);
+	});
+
+	it("skips clearing the app info when no steam directory is there yet", async () => {
+		const { context, commands, logs } = contextWith([], {});
+
+		await createSteamcmd(context, OPTIONS).update({
+			validate: false,
+		});
+
+		expect(commands.map((command) => command[0])).toEqual([
+			"pwd",
+			"./.steamcmd/steamcmd.sh",
+		]);
+		expect(logs).toEqual([
+			{
+				message: "steamcmd finished the update",
+				fields: {
+					app: "2394010",
+					build: null,
+				},
+			},
+		]);
+	});
+
+	it("updates anyway when the app info cannot be cleared", async () => {
+		const { context, commands, logs } = contextWith(
+			[
+				resultOf("find: permission denied"),
+			],
+			{
+				".steamcmd": "",
+			},
+		);
+
+		await createSteamcmd(context, OPTIONS).update({
+			validate: false,
+		});
+
+		expect(commands.map((command) => command[0])).toEqual([
+			"find",
+			"pwd",
+			"./.steamcmd/steamcmd.sh",
+		]);
+		expect(logs.map((entry) => entry.message)).toEqual([
+			"the cached steam app info could not be cleared, updating anyway",
+			"steamcmd finished the update",
+		]);
+	});
+});

package/src/steam/steamcmd.ts

@@ -16,6 +16,8 @@ const STEAM_CLIENT_DIRECTORY = `${STEAM_DIRECTORY}/sdk64`;
 
 const SENTRY_FILE = ".sentry.b64";
 
+const APP_INFO_FILE = "appinfo.vdf";
+
 const UPDATE_TIMEOUT_MS = 3_600_000;
 
 const BOOTSTRAP_TIMEOUT_MS = 300_000;
@@ -26,8 +28,43 @@ const ATTEMPTS = 3;
 
 const RETRY_DELAY_MS = 5000;
 
+const STATE_CODE = /\b0x[0-9a-f]+\b/gi;
+
+const DISK_FULL_STATES = [
+	"0x202",
+	"0x212",
+];
+
+const TRANSIENT_STATES = [
+	"0x402",
+	"0x602",
+	"0x606",
+	"0x626",
+	"0x6a6",
+];
+
 const NO_SUBSCRIPTION = "No subscription";
 
+const BRANCH_PASSWORD = "Password check for AppId";
+
+const INVALID_PLATFORM = /invalid platform/i;
+
+const MISSING_CONFIGURATION = /missing configuration/i;
+
+export enum SteamcmdFailure {
+	DiskFull = "disk-full",
+	InvalidPlatform = "invalid-platform",
+	NoSubscription = "no-subscription",
+	BranchPassword = "branch-password",
+	Transient = "transient",
+	Unknown = "unknown",
+}
+
+const RETRYABLE_FAILURES = new Set([
+	SteamcmdFailure.Transient,
+	SteamcmdFailure.Unknown,
+]);
+
 export interface SteamcmdOptions {
 	appId: string;
 	label: string;
@@ -80,6 +117,8 @@ export const steamcmdArgv = (options: SteamcmdOptions, root: string, args: strin
 
 export const steamcmdUpdateArgs = (appId: string, update: SteamcmdUpdateOptions) => {
 	const args = [
+		"+app_info_update",
+		"1",
 		"+app_update",
 		appId,
 	];
@@ -103,18 +142,67 @@ 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.`,
-		};
+export const steamcmdFailureOf = (result: BridgeExecResult): SteamcmdFailure => {
+	const output = `${result.stdout}\n${result.stderr}`;
+	const states = new Set(Array.from(output.matchAll(STATE_CODE), (match) => match[0].toLowerCase()));
+
+	if (DISK_FULL_STATES.some((state) => states.has(state))) {
+		return SteamcmdFailure.DiskFull;
 	}
 
-	return {
-		ar: `تعذّر تنزيل ${label} من Steam، جرب مرة ثانية.`,
-		en: `We couldn't download ${label} from Steam. Try again.`,
-	};
+	if (INVALID_PLATFORM.test(output)) {
+		return SteamcmdFailure.InvalidPlatform;
+	}
+
+	if (output.includes(NO_SUBSCRIPTION)) {
+		return SteamcmdFailure.NoSubscription;
+	}
+
+	if (output.includes(BRANCH_PASSWORD)) {
+		return SteamcmdFailure.BranchPassword;
+	}
+
+	if (TRANSIENT_STATES.some((state) => states.has(state)) || MISSING_CONFIGURATION.test(output)) {
+		return SteamcmdFailure.Transient;
+	}
+
+	return SteamcmdFailure.Unknown;
+};
+
+export const steamcmdRetryable = (failure: SteamcmdFailure) => {
+	return RETRYABLE_FAILURES.has(failure);
+};
+
+export const steamcmdFailureText = (result: BridgeExecResult, label: string): LocalizedText => {
+	switch (steamcmdFailureOf(result)) {
+		case SteamcmdFailure.DiskFull: {
+			return {
+				ar: `امتلأت مساحة سيرفرك، فتعذّر تنزيل ${label} من Steam. احذف الملفات التي لا تحتاجها من صفحة الملفات أو انتقل إلى باقة أكبر، ثم جرب مرة ثانية.`,
+				en: `Your server is out of space, so we couldn't download ${label} from Steam. Delete files you don't need on the Files page or move to a larger plan, then try again.`,
+			};
+		}
+
+		case SteamcmdFailure.NoSubscription: {
+			return {
+				ar: `رفض Steam تنزيل ${label} لأن حساب التنزيل لا يملكه. تواصل مع الدعم.`,
+				en: `Steam refused to download ${label} because the download account doesn't own it. Contact support.`,
+			};
+		}
+
+		case SteamcmdFailure.BranchPassword: {
+			return {
+				ar: `كلمة مرور الفرع على Steam غير صحيحة، فتعذّر تنزيل ${label}. صحّحها من الإعدادات.`,
+				en: `The Steam branch password is wrong, so we couldn't download ${label}. Fix it in the settings.`,
+			};
+		}
+
+		default: {
+			return {
+				ar: `تعذّر تنزيل ${label} من Steam، جرب مرة ثانية.`,
+				en: `We couldn't download ${label} from Steam. Try again.`,
+			};
+		}
+	}
 };
 
 const installRoot = async (context: BridgeContext) => {
@@ -197,15 +285,20 @@ export const createSteamcmd = (context: BridgeContext, options: SteamcmdOptions)
 
 			failure = result;
 
-			if (attempt < attempts) {
-				context.log("steamcmd did not finish, trying again", {
-					attempt,
-					of: attempts,
-					code: result.code,
-				});
+			const kind = steamcmdFailureOf(result);
 
-				await Bun.sleep(RETRY_DELAY_MS);
+			if (attempt === attempts || !steamcmdRetryable(kind)) {
+				break;
 			}
+
+			context.log("steamcmd did not finish, trying again", {
+				attempt,
+				of: attempts,
+				code: result.code,
+				failure: kind,
+			});
+
+			await Bun.sleep(RETRY_DELAY_MS);
 		}
 
 		if (!failure) {
@@ -213,10 +306,45 @@ export const createSteamcmd = (context: BridgeContext, options: SteamcmdOptions)
 		}
 
 		throw new BridgeUserError(steamcmdFailureText(failure, options.label), {
-			cause: new Error(`steamcmd exited with code ${failure.code} — ${execDetail(failure)}`),
+			cause: new Error(
+				`steamcmd exited with code ${failure.code} (${steamcmdFailureOf(failure)}) — ${execDetail(failure)}`,
+			),
 		});
 	};
 
+	const clearAppInfo = async () => {
+		const roots: string[] = [];
+
+		for (const path of [
+			directory,
+			STEAM_DIRECTORY,
+		]) {
+			if (await context.files.exists(path)) {
+				roots.push(path);
+			}
+		}
+
+		if (roots.length === 0) {
+			return;
+		}
+
+		const result = await context.exec([
+			"find",
+			...roots,
+			"-type",
+			"f",
+			"-name",
+			APP_INFO_FILE,
+			"-delete",
+		]);
+
+		if (result.code !== 0) {
+			context.log.warn("the cached steam app info could not be cleared, updating anyway", {
+				code: result.code,
+			});
+		}
+	};
+
 	return {
 		directory,
 		script,
@@ -271,7 +399,15 @@ export const createSteamcmd = (context: BridgeContext, options: SteamcmdOptions)
 		run,
 
 		async update(update) {
+			await clearAppInfo();
 			await run(steamcmdUpdateArgs(options.appId, update));
+
+			const build = await installedBuildId(context, options.appId);
+
+			context.log("steamcmd finished the update", {
+				app: options.appId,
+				build,
+			});
 		},
 
 		async buildId() {