@serverkgg/bridge 0.1.7 → 0.1.8

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() {