fix: PR #11 打磨——mcpp self env 加超时保护、回退探测支持注入、测试平台可移植、补 CHANGELOG

Author: wellwei

CHANGELOG.md

@@ -1,5 +1,11 @@
 # 更新日志
 
+## 0.2.7
+
+- 修复「一键配置模块代码提示」在标准 mcpp 安装（install.sh / AUR）下无法发现 mcpp 内置
+  xlings 的问题：xlings 发现以 `mcpp self env` 为权威来源（项目级契约），路径探测仅作回退；
+  为 `mcpp self env` 调用增加超时保护，并补齐测试（PR #11）。
+
 ## 0.2.6
 
 - 新增 **mcpp: 一键配置模块代码提示** 向导：按「安装/切换工具链 → 构建 → 重载 → clangd

src/llvmTools.ts

@@ -142,17 +142,26 @@ const XLINGS_BINARY_LINE = /^\s*xlings binary\s*=\s*(.+?)\s*$/im;
 // environment; it owns its tool paths). Works for install.sh, AUR and any
 // custom MCPP_PREFIX layout. Falls back to the historical path heuristics for
 // standalone ~/.xlings installs and for mcpp versions without the line.
+//
+// The subprocess is bounded by MCPP_SELF_ENV_TIMEOUT_MS: the wizard reaches
+// this step only after mcpp is initialized (toolchain list / build already
+// ran), so 60s is generous while still guarding against an extreme hang.
+const MCPP_SELF_ENV_TIMEOUT_MS = 60_000;
+
 export async function resolveXlingsExecutable(
   mcppExecutable: string,
   runner: ProcessRunner = runProcess,
+  options?: FindXlingsOptions,
 ): Promise<string | undefined> {
-  const result = await runner(mcppExecutable, ["self", "env"]);
+  const result = await runner(mcppExecutable, ["self", "env"], undefined, {
+    timeoutMs: MCPP_SELF_ENV_TIMEOUT_MS,
+  });
   const match = `${result.stdout}\n${result.stderr}`.match(XLINGS_BINARY_LINE);
   const reported = match?.[1]?.trim();
   if (reported !== undefined && reported.length > 0 && existsSync(reported)) {
     return reported;
   }
-  return findXlingsExecutable();
+  return findXlingsExecutable(options);
 }
 
 export async function runXlingsCommand(

test/llvmTools.test.ts

@@ -13,6 +13,9 @@ import {
   resolveXlingsExecutable,
 } from "../src/llvmTools";
 
+// `xlings` on POSIX, `xlings.exe` on Windows — mirrors mcpp's exe_suffix.
+const xlingsBinaryName = process.platform === "win32" ? "xlings.exe" : "xlings";
+
 test("extracts version string from ToolIdentity", () => {
   assert.equal(
     llvmToolsVersionSpec({ major: 22, minor: 1, patch: 8, revision: "abc1234" }),
@@ -76,7 +79,7 @@ test("findXlingsExecutable returns a string or undefined", () => {
 test("findXlingsExecutable finds the xlings bundled in $MCPP_HOME/registry/bin", () => {
   const home = mkdtempSync(path.join(os.tmpdir(), "mcpp-vscode-mcpp-home-"));
   const registryBin = path.join(home, "registry", "bin");
-  const xlingsPath = path.join(registryBin, "xlings");
+  const xlingsPath = path.join(registryBin, xlingsBinaryName);
   mkdirSync(registryBin, { recursive: true });
   writeFileSync(xlingsPath, "#!/bin/sh\n");
   try {
@@ -92,7 +95,7 @@ test("findXlingsExecutable finds the xlings bundled in $MCPP_HOME/registry/bin",
 test("findXlingsExecutable falls back to $HOME/.mcpp/registry/bin when MCPP_HOME is unset", () => {
   const home = mkdtempSync(path.join(os.tmpdir(), "mcpp-vscode-home-"));
   const registryBin = path.join(home, ".mcpp", "registry", "bin");
-  const xlingsPath = path.join(registryBin, "xlings");
+  const xlingsPath = path.join(registryBin, xlingsBinaryName);
   mkdirSync(registryBin, { recursive: true });
   writeFileSync(xlingsPath, "#!/bin/sh\n");
   try {
@@ -107,7 +110,7 @@ test("findXlingsExecutable falls back to $HOME/.mcpp/registry/bin when MCPP_HOME
 
 test("findXlingsExecutable honors MCPP_VENDORED_XLINGS", () => {
   const root = mkdtempSync(path.join(os.tmpdir(), "mcpp-vscode-vendored-"));
-  const vendored = path.join(root, "opt-mcpp", "registry", "bin", "xlings");
+  const vendored = path.join(root, "opt-mcpp", "registry", "bin", xlingsBinaryName);
   mkdirSync(path.dirname(vendored), { recursive: true });
   writeFileSync(vendored, "#!/bin/sh\n");
   try {
@@ -122,7 +125,7 @@ test("findXlingsExecutable honors MCPP_VENDORED_XLINGS", () => {
 
 test("resolveXlingsExecutable reads the xlings binary from `mcpp self env`", async () => {
   const root = mkdtempSync(path.join(os.tmpdir(), "mcpp-vscode-selfenv-"));
-  const xlingsPath = path.join(root, "registry", "bin", "xlings");
+  const xlingsPath = path.join(root, "registry", "bin", xlingsBinaryName);
   mkdirSync(path.dirname(xlingsPath), { recursive: true });
   writeFileSync(xlingsPath, "#!/bin/sh\n");
   const runner = async () => ({
@@ -140,20 +143,47 @@ test("resolveXlingsExecutable reads the xlings binary from `mcpp self env`", asy
   }
 });
 
-test("resolveXlingsExecutable falls back when the reported path does not exist", async () => {
+test("resolveXlingsExecutable passes a timeout to `mcpp self env`", async () => {
+  let captured: { timeoutMs?: number } | undefined;
+  const runner = async (
+    _executable: string,
+    _args: string[],
+    _cwd?: string,
+    options?: { timeoutMs?: number },
+  ) => {
+    captured = options;
+    return { exitCode: 0, stdout: "", stderr: "" };
+  };
+  await resolveXlingsExecutable("/tools/mcpp", runner);
+  assert.equal(captured?.timeoutMs, 60_000);
+});
+
+test("resolveXlingsExecutable falls back to path probing when the reported path does not exist", async () => {
+  const home = mkdtempSync(path.join(os.tmpdir(), "mcpp-vscode-fallback-missing-"));
   const runner = async () => ({
     exitCode: 0,
     stdout: "xlings binary = /no/such/xlings\n",
     stderr: "",
   });
-  const result = await resolveXlingsExecutable("/tools/mcpp", runner);
-  // Fallback heuristics find nothing in this environment, so the result is
-  // undefined unless a standalone ~/.xlings or PATH xlings happens to exist.
-  assert.ok(result === undefined || typeof result === "string");
+  try {
+    assert.equal(
+      await resolveXlingsExecutable("/tools/mcpp", runner, { home, env: {} }),
+      undefined,
+    );
+  } finally {
+    rmSync(home, { recursive: true, force: true });
+  }
 });
 
-test("resolveXlingsExecutable falls back when `mcpp self env` fails", async () => {
+test("resolveXlingsExecutable falls back to path probing when `mcpp self env` fails", async () => {
+  const home = mkdtempSync(path.join(os.tmpdir(), "mcpp-vscode-fallback-fail-"));
   const runner = async () => ({ exitCode: 1, stdout: "", stderr: "boom\n" });
-  const result = await resolveXlingsExecutable("/tools/mcpp", runner);
-  assert.ok(result === undefined || typeof result === "string");
+  try {
+    assert.equal(
+      await resolveXlingsExecutable("/tools/mcpp", runner, { home, env: {} }),
+      undefined,
+    );
+  } finally {
+    rmSync(home, { recursive: true, force: true });
+  }
 });