fix(build): validate Discord package after backend dependency install (#128)

zouyonghe · github-actions[bot] · web-flow · commit 69ca5fae44ce · 2026-05-10T00:55:50.000+09:00
* chore(version): sync desktop version to v4.23.0-beta.1 * fix: add backend startup heartbeat liveness probe (#114) * fix: add backend startup heartbeat liveness probe * fix: tighten startup heartbeat validation * refactor: centralize startup heartbeat metadata * fix: surface heartbeat invalidation sooner * fix: harden startup heartbeat parsing * fix: warn on stop-time heartbeat failures * refactor: simplify startup heartbeat control flow * refactor: flatten readiness heartbeat helpers * refactor: clarify heartbeat helper responsibilities * docs: clarify startup heartbeat path coupling * fix: harden startup heartbeat coordination * fix: make startup heartbeat checks monotonic * fix: clean up heartbeat test and exit handling * chore(version): sync desktop version to v4.23.1 * fix(ci): prepare macOS resources before optional signing (#119) * fix(ci): prepare macOS resources before optional signing * test(ci): parse macOS workflow steps structurally * test(ci): parse workflow YAML structurally * test(ci): relax workflow assertions and install test deps * test(ci): share workflow test helpers * test(ci): harden script workflow dependency setup * fix(ci): setup pnpm before enabling pnpm cache * test(ci): relax workflow step assertions * [codex] default desktop chat transport to websocket (#121) * chore(version): sync desktop version to v4.23.0-beta.1 * fix: add backend startup heartbeat liveness probe (#114) * fix: add backend startup heartbeat liveness probe * fix: tighten startup heartbeat validation * refactor: centralize startup heartbeat metadata * fix: surface heartbeat invalidation sooner * fix: harden startup heartbeat parsing * fix: warn on stop-time heartbeat failures * refactor: simplify startup heartbeat control flow * refactor: flatten readiness heartbeat helpers * refactor: clarify heartbeat helper responsibilities * docs: clarify startup heartbeat path coupling * fix: harden startup heartbeat coordination * fix: make startup heartbeat checks monotonic * fix: clean up heartbeat test and exit handling * fix: default desktop chat transport to websocket * fix: respect existing desktop transport preference * fix: harden desktop transport bootstrap * fix: centralize desktop transport contract * fix: harden desktop bridge transport injection --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * chore(version): sync desktop version to v4.23.2 * chore(version): sync desktop version to v4.23.3 * chore(version): sync desktop version to v4.23.5 * chore(version): sync desktop version to v4.23.6 * chore: ignore local task plans * fix(build): validate Discord package after backend dependency install The PyPI 'discord' stub package (v0.0.2) shadows the real 'py-cord' package because both occupy the 'discord' namespace. When the stub is installed by mistake (e.g. cache pollution or dependency resolution glitch), the Discord adapter fails at runtime with: module 'discord' has no attribute 'Bot' This change adds a post-install validation step that imports 'discord' and asserts 'discord.Bot' exists. If the stub is present, the build fails early with a clear error message instead of producing a broken runtime bundle. Closes #8016 --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
diff --git a/scripts/backend/build-backend.mjs b/scripts/backend/build-backend.mjs
@@ -34,6 +34,7 @@ const runtimeCoreLockPath = path.join(appDir, 'runtime-core-lock.json');
 const launcherPath = path.join(outputDir, 'launch_backend.py');
 const launcherTemplatePath = path.join(__dirname, 'templates', 'launch_backend.py');
 const importScannerScriptPath = path.join(__dirname, 'tools', 'scan_imports.py');
+const validateDiscordScriptPath = path.join(__dirname, 'tools', 'validate_discord.py');
 
 const runtimeSource =
   process.env.ASTRBOT_DESKTOP_BACKEND_RUNTIME ||
@@ -584,6 +585,87 @@ const installRuntimeDependencies = (runtimePython) => {
   }
 };
 
+// Configurable via env for slower CI environments.
+const DISCORD_VALIDATION_TIMEOUT_MS =
+  Number(process.env.ASTRBOT_DISCORD_VALIDATION_TIMEOUT) || 30_000;
+// Protocol prefix shared with scripts/backend/tools/validate_discord.py.
+const DISCORD_JSON_PREFIX = 'ASTRBOT_VALIDATE_DISCORD_JSON:';
+
+const extractPrefixedJson = (rawStdout) => {
+  if (!rawStdout) return null;
+  const lines = String(rawStdout).split(/\r?\n/);
+  const jsonLine = lines.find((line) => line.startsWith(DISCORD_JSON_PREFIX));
+  if (!jsonLine) return null;
+  try {
+    return JSON.parse(jsonLine.slice(DISCORD_JSON_PREFIX.length));
+  } catch {
+    return null;
+  }
+};
+
+const validateDiscordPackage = (runtimePython) => {
+  const result = spawnSync(
+    runtimePython.absolute,
+    [validateDiscordScriptPath, DISCORD_JSON_PREFIX],
+    {
+      encoding: 'utf8',
+      cwd: outputDir,
+      windowsHide: true,
+      timeout: DISCORD_VALIDATION_TIMEOUT_MS,
+    },
+  );
+
+  if (result.error) {
+    const isTimeout = result.error.code === 'ETIMEDOUT';
+    const details = [
+      `exit status: ${result.status ?? 'unknown'}`,
+      `error code: ${result.error.code ?? 'unknown'}`,
+      result.signal ? `signal: ${result.signal}` : null,
+      result.stdout ? `stdout: ${String(result.stdout).trim()}` : null,
+      result.stderr ? `stderr: ${String(result.stderr).trim()}` : null,
+    ]
+      .filter(Boolean)
+      .join('; ');
+
+    throw new Error(
+      `Discord package validation could not run (interpreter: ${runtimePython.absolute}). ` +
+      (isTimeout
+        ? `Timed out after ${DISCORD_VALIDATION_TIMEOUT_MS}ms. `
+        : 'This may indicate a Python runtime issue. ') +
+      `Details: ${details}. ` +
+      `Underlying error: ${result.error.message}`,
+    );
+  }
+
+  if (result.status === 0) {
+    console.log('[build-backend] Discord package validation passed.');
+    return;
+  }
+
+  let techDetails = 'unknown error';
+  const parsed = extractPrefixedJson(result.stdout);
+  if (parsed && !parsed.ok) {
+    const parts = [
+      parsed.missing?.length && `missing: ${parsed.missing.join(', ')}`,
+      parsed.file && `package file: ${parsed.file}`,
+      parsed.version && `version: ${parsed.version}`,
+      parsed.error && `error: ${parsed.error}`,
+    ].filter(Boolean);
+    if (parts.length) techDetails = parts.join('; ');
+  } else {
+    const stderr = result.stderr?.trim();
+    const stdout = result.stdout?.trim();
+    techDetails = stderr || stdout || techDetails;
+  }
+
+  throw new Error(
+    `Discord package validation failed (exit code ${result.status}): ${techDetails}. ` +
+    'The most common cause is the PyPI "discord" stub package being installed ' +
+    'instead of "py-cord", but other mis-installs can also trigger this. ' +
+    'Please clean the build environment (pip cache, virtualenv) and retry.',
+  );
+};
+
 const main = () => {
   const resolvedSourceDir = requireSourceDir();
 
@@ -615,6 +697,7 @@ const main = () => {
   copyAppSources(resolvedSourceDir);
   const runtimePython = prepareRuntimeExecutable(runtimeSourceReal);
   installRuntimeDependencies(runtimePython);
+  validateDiscordPackage(runtimePython);
   generateRuntimeCoreLock({
     runtimePython,
     outputPath: runtimeCoreLockPath,
diff --git a/scripts/backend/tools/validate_discord.py b/scripts/backend/tools/validate_discord.py
@@ -0,0 +1,25 @@
+import json
+import sys
+
+
+result = {"ok": False, "missing": ["discord"], "file": None, "version": None}
+try:
+    import discord
+    result["file"] = getattr(discord, "__file__", None)
+    result["version"] = getattr(discord, "__version__", None)
+
+    if not hasattr(discord, "Bot"):
+        result["missing"] = ["discord.Bot"]
+    else:
+        result["ok"] = True
+        result["missing"] = []
+except ImportError as e:
+    result["error"] = f"{type(e).__name__}: {e}"
+except Exception as e:
+    result["error"] = f"{type(e).__name__}: {e}"
+
+# Prefix is passed as argv[1] by the caller so it is defined in one place.
+# Default allows running the script standalone for quick checks.
+prefix = sys.argv[1] if len(sys.argv) > 1 else "ASTRBOT_VALIDATE_DISCORD_JSON:"
+print(f"{prefix}{json.dumps(result)}")
+sys.exit(0 if result["ok"] else 1)
