wyvrnpm 2.10.2 → 2.12.2

package/src/build/msvc-env.js

@@ -1,260 +1,260 @@
-'use strict';
-
-const fs   = require('fs');
-const path = require('path');
-const { spawn } = require('child_process');
-
-const log = require('../logger');
-
-/**
- * Auto-activate the MSVC build environment (the moral equivalent of a
- * "Developer PowerShell for VS 2022") when a source-build on Windows picks
- * a non-VS generator and `cl.exe` isn't on PATH.
- *
- * Without this, Ninja/Make/etc. fail at CMake's compiler-detection step
- * because MSVC's `cl.exe` lives under the VS install tree and is only put
- * on PATH by `vcvarsall.bat`. VS generators sidestep this because MSBuild
- * locates MSVC via VS's own toolset resolution.
- *
- * Strategy:
- *   1. Check if cl.exe is already on PATH → return null (nothing to do).
- *   2. Locate the VS installation via `vswhere.exe -latest`.
- *   3. Run `vcvarsall.bat <arch>` in `cmd /s /c` and capture `set` output.
- *   4. Parse KEY=VALUE lines, return them as a shallow-merged env object
- *      suitable for `child_process.spawn({ env })`.
- *
- * Returns `null` when nothing needs to be done OR when VS isn't found —
- * callers fall back to the ambient environment and CMake produces its own
- * error if that turns out to be missing a compiler.
- */
-
-const VSWHERE_DEFAULT = path.join(
-  process.env['ProgramFiles(x86)'] || 'C:\\Program Files (x86)',
-  'Microsoft Visual Studio', 'Installer', 'vswhere.exe',
-);
-
-function tryCapture(cmd, args, opts = {}) {
-  return new Promise((resolve) => {
-    const proc = spawn(cmd, args, { stdio: ['ignore', 'pipe', 'ignore'], ...opts });
-    let out = '';
-    proc.stdout.on('data', (c) => { out += c.toString(); });
-    proc.on('error', () => resolve(null));
-    proc.on('close', (code) => resolve(code === 0 ? out : null));
-  });
-}
-
-/**
- * @returns {Promise<boolean>}
- */
-async function isClOnPath() {
-  if (process.platform !== 'win32') return false;
-  // `where cl` is the Windows-native PATH probe.
-  return new Promise((resolve) => {
-    const proc = spawn('where', ['cl'], { stdio: 'ignore' });
-    proc.on('error', () => resolve(false));
-    proc.on('close', (code) => resolve(code === 0));
-  });
-}
-
-/**
- * Return the latest VS installation path via vswhere, or null if not found.
- * @returns {Promise<string|null>}
- */
-async function findVsInstall() {
-  if (!fs.existsSync(VSWHERE_DEFAULT)) return null;
-  const out = await tryCapture(VSWHERE_DEFAULT, [
-    '-latest',
-    '-requires', 'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
-    '-property', 'installationPath',
-  ]);
-  return out ? out.trim() : null;
-}
-
-function findVcvarsall(vsInstallPath) {
-  const p = path.join(vsInstallPath, 'VC', 'Auxiliary', 'Build', 'vcvarsall.bat');
-  return fs.existsSync(p) ? p : null;
-}
-
-/**
- * The complete set of arch arguments `vcvarsall.bat` accepts AND that we
- * are willing to splice into a shell command. Explicit allow-list — any
- * value outside this set is rejected (EVALUATION.md S5).
- */
-const VCVARSALL_ARCH_ALLOWLIST = new Set(['x64', 'x86', 'arm64', 'arm']);
-
-const ARCH_MAP = {
-  x86_64: 'x64',
-  x86:    'x86',
-  armv8:  'arm64',
-  armv7:  'arm',
-};
-
-/**
- * Map a wyvrnpm profile arch to the argument `vcvarsall.bat` expects.
- * Throws on an unknown profile arch — silently defaulting to `x64` would
- * (a) produce a build for the wrong target, and (b) hand any shell-unsafe
- * input to cmd.exe through captureVcvarsEnv's template.
- */
-function mapArch(profileArch) {
-  const arg = ARCH_MAP[profileArch];
-  if (!arg || !VCVARSALL_ARCH_ALLOWLIST.has(arg)) {
-    throw new Error(
-      `unsupported MSVC profile arch ${JSON.stringify(profileArch)}; ` +
-      `expected one of ${Object.keys(ARCH_MAP).join(', ')}`,
-    );
-  }
-  return arg;
-}
-
-/**
- * Capture the environment produced by running vcvarsall.bat.
- *
- * Strategy: shell out to `cmd`, run `vcvarsall.bat <arch>`, then print a
- * marker followed by the post-vcvars environment (`set` dumps KEY=VALUE
- * lines for every env var). Everything before the marker is vcvarsall's
- * own output; everything after is the env we want.
- *
- * Uses `shell: true` so Node hands the full command line to `cmd.exe`
- * verbatim — avoids the usual quoting pitfalls when the VS install path
- * contains spaces.
- *
- * @param {string} vcvarsallPath
- * @param {string} archArg
- * @returns {Promise<object|null>}
- */
-async function captureVcvarsEnv(vcvarsallPath, archArg) {
-  // Defense-in-depth at the shell boundary (EVALUATION.md S5). mapArch
-  // already restricts archArg to the allow-list; re-assert here so this
-  // function is safe to call directly (e.g. from a future caller that
-  // skips mapArch). Likewise refuse a vcvarsall path containing a
-  // double-quote — it would break out of the quoted command template.
-  if (!VCVARSALL_ARCH_ALLOWLIST.has(archArg)) {
-    throw new Error(`refusing to spawn cmd.exe with unsafe arch arg ${JSON.stringify(archArg)}`);
-  }
-  if (vcvarsallPath.includes('"')) {
-    throw new Error(`refusing to spawn cmd.exe with quote in vcvarsall path ${JSON.stringify(vcvarsallPath)}`);
-  }
-
-  const MARKER = '___WYVRN_ENV_MARKER___';
-  // `call` is required so the batch file returns control instead of
-  // `exit`-ing the cmd shell; otherwise the `echo` + `set` after it
-  // never run.
-  const cmdLine =
-    `call "${vcvarsallPath}" ${archArg} ` +
-    `&& echo ${MARKER} ` +
-    `&& set`;
-
-  return new Promise((resolve) => {
-    const proc = spawn(cmdLine, {
-      shell: true,
-      stdio: ['ignore', 'pipe', 'pipe'],
-    });
-    let stdout = '';
-    let stderr = '';
-    proc.stdout.on('data', (c) => { stdout += c.toString(); });
-    proc.stderr.on('data', (c) => { stderr += c.toString(); });
-    proc.on('error', (err) => {
-      log.warn(`  vcvarsall spawn error: ${err.message}`);
-      resolve(null);
-    });
-    proc.on('close', (code) => {
-      if (code !== 0) {
-        const tail = (stderr || stdout).trim().split(/\r?\n/).slice(-5).join(' | ');
-        log.warn(`  vcvarsall exited ${code}; last lines: ${tail}`);
-        resolve(null);
-        return;
-      }
-      const markerIdx = stdout.indexOf(MARKER);
-      if (markerIdx === -1) {
-        const tail = stdout.trim().split(/\r?\n/).slice(-5).join(' | ');
-        log.warn(`  vcvarsall marker not found; last stdout lines: ${tail}`);
-        resolve(null);
-        return;
-      }
-      // Everything after the marker line is the env dump.
-      const envDump = stdout.slice(markerIdx + MARKER.length);
-      const env = { ...process.env };
-      let matched = 0;
-      for (const line of envDump.split(/\r?\n/)) {
-        const m = line.match(/^([A-Za-z_][A-Za-z0-9_()]*)=(.*)$/);
-        if (m) { env[m[1]] = m[2]; matched += 1; }
-      }
-      if (matched < 5 || !env.VSINSTALLDIR) {
-        log.warn(
-          `  vcvarsall env dump looks incomplete ` +
-          `(${matched} vars, VSINSTALLDIR=${env.VSINSTALLDIR ? 'set' : 'MISSING'})`,
-        );
-        resolve(null);
-        return;
-      }
-      resolve(env);
-    });
-  });
-}
-
-/**
- * Compute a build-environment override for the given profile, or return
- * null to indicate "use the ambient environment". Callers pass the result
- * as `spawn(..., { env })`.
- *
- * Only activates when:
- *   - Running on Windows
- *   - Profile says compiler=msvc
- *   - `cl.exe` is NOT already on PATH (so we're outside a Dev shell)
- *   - `skipForGenerator` does not start with "Visual Studio" (VS generators
- *     don't need this — MSBuild resolves MSVC itself)
- *
- * @param {{
- *   profile:             { compiler?: string, arch?: string },
- *   skipForGenerator?:   string|null,
- * }} args
- * @returns {Promise<object|null>}
- */
-async function loadMsvcEnv({ profile, skipForGenerator }) {
-  if (process.platform !== 'win32')       return null;
-  if (!profile || profile.compiler !== 'msvc') return null;
-  if (skipForGenerator && skipForGenerator.startsWith('Visual Studio')) return null;
-  if (await isClOnPath())                 return null;
-
-  const vsPath = await findVsInstall();
-  if (!vsPath) {
-    log.warn('  MSVC profile requested but vswhere/VS not found — CMake will error if cl.exe is missing');
-    return null;
-  }
-  const vcvarsall = findVcvarsall(vsPath);
-  if (!vcvarsall) {
-    log.warn(`  MSVC profile requested but vcvarsall.bat not found under ${vsPath}`);
-    return null;
-  }
-
-  let archArg;
-  try {
-    archArg = mapArch(profile.arch);
-  } catch (err) {
-    // Unknown arch for an MSVC profile is genuinely a configuration bug
-    // (MSVC only ships toolsets for x64/x86/arm64/arm). Surface clearly
-    // and fall through to the ambient env — CMake will then error with
-    // a usable compiler-detection message instead of us silently
-    // cross-targeting x64.
-    log.warn(`  ${err.message}`);
-    return null;
-  }
-  log.info(`  activating MSVC build env: vcvarsall.bat ${archArg} (${vsPath})`);
-  const env = await captureVcvarsEnv(vcvarsall, archArg);
-  if (!env) {
-    log.warn(`  vcvarsall.bat ${archArg} failed — CMake will error if cl.exe is missing`);
-    return null;
-  }
-  return env;
-}
-
-module.exports = {
-  loadMsvcEnv,
-  // Exported for tests
-  isClOnPath,
-  findVsInstall,
-  findVcvarsall,
-  mapArch,
-  captureVcvarsEnv,
-  VCVARSALL_ARCH_ALLOWLIST,
-};
+'use strict';
+
+const fs   = require('fs');
+const path = require('path');
+const { spawn } = require('child_process');
+
+const log = require('../logger');
+
+/**
+ * Auto-activate the MSVC build environment (the moral equivalent of a
+ * "Developer PowerShell for VS 2022") when a source-build on Windows picks
+ * a non-VS generator and `cl.exe` isn't on PATH.
+ *
+ * Without this, Ninja/Make/etc. fail at CMake's compiler-detection step
+ * because MSVC's `cl.exe` lives under the VS install tree and is only put
+ * on PATH by `vcvarsall.bat`. VS generators sidestep this because MSBuild
+ * locates MSVC via VS's own toolset resolution.
+ *
+ * Strategy:
+ *   1. Check if cl.exe is already on PATH → return null (nothing to do).
+ *   2. Locate the VS installation via `vswhere.exe -latest`.
+ *   3. Run `vcvarsall.bat <arch>` in `cmd /s /c` and capture `set` output.
+ *   4. Parse KEY=VALUE lines, return them as a shallow-merged env object
+ *      suitable for `child_process.spawn({ env })`.
+ *
+ * Returns `null` when nothing needs to be done OR when VS isn't found —
+ * callers fall back to the ambient environment and CMake produces its own
+ * error if that turns out to be missing a compiler.
+ */
+
+const VSWHERE_DEFAULT = path.join(
+  process.env['ProgramFiles(x86)'] || 'C:\\Program Files (x86)',
+  'Microsoft Visual Studio', 'Installer', 'vswhere.exe',
+);
+
+function tryCapture(cmd, args, opts = {}) {
+  return new Promise((resolve) => {
+    const proc = spawn(cmd, args, { stdio: ['ignore', 'pipe', 'ignore'], ...opts });
+    let out = '';
+    proc.stdout.on('data', (c) => { out += c.toString(); });
+    proc.on('error', () => resolve(null));
+    proc.on('close', (code) => resolve(code === 0 ? out : null));
+  });
+}
+
+/**
+ * @returns {Promise<boolean>}
+ */
+async function isClOnPath() {
+  if (process.platform !== 'win32') return false;
+  // `where cl` is the Windows-native PATH probe.
+  return new Promise((resolve) => {
+    const proc = spawn('where', ['cl'], { stdio: 'ignore' });
+    proc.on('error', () => resolve(false));
+    proc.on('close', (code) => resolve(code === 0));
+  });
+}
+
+/**
+ * Return the latest VS installation path via vswhere, or null if not found.
+ * @returns {Promise<string|null>}
+ */
+async function findVsInstall() {
+  if (!fs.existsSync(VSWHERE_DEFAULT)) return null;
+  const out = await tryCapture(VSWHERE_DEFAULT, [
+    '-latest',
+    '-requires', 'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
+    '-property', 'installationPath',
+  ]);
+  return out ? out.trim() : null;
+}
+
+function findVcvarsall(vsInstallPath) {
+  const p = path.join(vsInstallPath, 'VC', 'Auxiliary', 'Build', 'vcvarsall.bat');
+  return fs.existsSync(p) ? p : null;
+}
+
+/**
+ * The complete set of arch arguments `vcvarsall.bat` accepts AND that we
+ * are willing to splice into a shell command. Explicit allow-list — any
+ * value outside this set is rejected (EVALUATION.md S5).
+ */
+const VCVARSALL_ARCH_ALLOWLIST = new Set(['x64', 'x86', 'arm64', 'arm']);
+
+const ARCH_MAP = {
+  x86_64: 'x64',
+  x86:    'x86',
+  armv8:  'arm64',
+  armv7:  'arm',
+};
+
+/**
+ * Map a wyvrnpm profile arch to the argument `vcvarsall.bat` expects.
+ * Throws on an unknown profile arch — silently defaulting to `x64` would
+ * (a) produce a build for the wrong target, and (b) hand any shell-unsafe
+ * input to cmd.exe through captureVcvarsEnv's template.
+ */
+function mapArch(profileArch) {
+  const arg = ARCH_MAP[profileArch];
+  if (!arg || !VCVARSALL_ARCH_ALLOWLIST.has(arg)) {
+    throw new Error(
+      `unsupported MSVC profile arch ${JSON.stringify(profileArch)}; ` +
+      `expected one of ${Object.keys(ARCH_MAP).join(', ')}`,
+    );
+  }
+  return arg;
+}
+
+/**
+ * Capture the environment produced by running vcvarsall.bat.
+ *
+ * Strategy: shell out to `cmd`, run `vcvarsall.bat <arch>`, then print a
+ * marker followed by the post-vcvars environment (`set` dumps KEY=VALUE
+ * lines for every env var). Everything before the marker is vcvarsall's
+ * own output; everything after is the env we want.
+ *
+ * Uses `shell: true` so Node hands the full command line to `cmd.exe`
+ * verbatim — avoids the usual quoting pitfalls when the VS install path
+ * contains spaces.
+ *
+ * @param {string} vcvarsallPath
+ * @param {string} archArg
+ * @returns {Promise<object|null>}
+ */
+async function captureVcvarsEnv(vcvarsallPath, archArg) {
+  // Defense-in-depth at the shell boundary (EVALUATION.md S5). mapArch
+  // already restricts archArg to the allow-list; re-assert here so this
+  // function is safe to call directly (e.g. from a future caller that
+  // skips mapArch). Likewise refuse a vcvarsall path containing a
+  // double-quote — it would break out of the quoted command template.
+  if (!VCVARSALL_ARCH_ALLOWLIST.has(archArg)) {
+    throw new Error(`refusing to spawn cmd.exe with unsafe arch arg ${JSON.stringify(archArg)}`);
+  }
+  if (vcvarsallPath.includes('"')) {
+    throw new Error(`refusing to spawn cmd.exe with quote in vcvarsall path ${JSON.stringify(vcvarsallPath)}`);
+  }
+
+  const MARKER = '___WYVRN_ENV_MARKER___';
+  // `call` is required so the batch file returns control instead of
+  // `exit`-ing the cmd shell; otherwise the `echo` + `set` after it
+  // never run.
+  const cmdLine =
+    `call "${vcvarsallPath}" ${archArg} ` +
+    `&& echo ${MARKER} ` +
+    `&& set`;
+
+  return new Promise((resolve) => {
+    const proc = spawn(cmdLine, {
+      shell: true,
+      stdio: ['ignore', 'pipe', 'pipe'],
+    });
+    let stdout = '';
+    let stderr = '';
+    proc.stdout.on('data', (c) => { stdout += c.toString(); });
+    proc.stderr.on('data', (c) => { stderr += c.toString(); });
+    proc.on('error', (err) => {
+      log.warn(`  vcvarsall spawn error: ${err.message}`);
+      resolve(null);
+    });
+    proc.on('close', (code) => {
+      if (code !== 0) {
+        const tail = (stderr || stdout).trim().split(/\r?\n/).slice(-5).join(' | ');
+        log.warn(`  vcvarsall exited ${code}; last lines: ${tail}`);
+        resolve(null);
+        return;
+      }
+      const markerIdx = stdout.indexOf(MARKER);
+      if (markerIdx === -1) {
+        const tail = stdout.trim().split(/\r?\n/).slice(-5).join(' | ');
+        log.warn(`  vcvarsall marker not found; last stdout lines: ${tail}`);
+        resolve(null);
+        return;
+      }
+      // Everything after the marker line is the env dump.
+      const envDump = stdout.slice(markerIdx + MARKER.length);
+      const env = { ...process.env };
+      let matched = 0;
+      for (const line of envDump.split(/\r?\n/)) {
+        const m = line.match(/^([A-Za-z_][A-Za-z0-9_()]*)=(.*)$/);
+        if (m) { env[m[1]] = m[2]; matched += 1; }
+      }
+      if (matched < 5 || !env.VSINSTALLDIR) {
+        log.warn(
+          `  vcvarsall env dump looks incomplete ` +
+          `(${matched} vars, VSINSTALLDIR=${env.VSINSTALLDIR ? 'set' : 'MISSING'})`,
+        );
+        resolve(null);
+        return;
+      }
+      resolve(env);
+    });
+  });
+}
+
+/**
+ * Compute a build-environment override for the given profile, or return
+ * null to indicate "use the ambient environment". Callers pass the result
+ * as `spawn(..., { env })`.
+ *
+ * Only activates when:
+ *   - Running on Windows
+ *   - Profile says compiler=msvc
+ *   - `cl.exe` is NOT already on PATH (so we're outside a Dev shell)
+ *   - `skipForGenerator` does not start with "Visual Studio" (VS generators
+ *     don't need this — MSBuild resolves MSVC itself)
+ *
+ * @param {{
+ *   profile:             { compiler?: string, arch?: string },
+ *   skipForGenerator?:   string|null,
+ * }} args
+ * @returns {Promise<object|null>}
+ */
+async function loadMsvcEnv({ profile, skipForGenerator }) {
+  if (process.platform !== 'win32')       return null;
+  if (!profile || profile.compiler !== 'msvc') return null;
+  if (skipForGenerator && skipForGenerator.startsWith('Visual Studio')) return null;
+  if (await isClOnPath())                 return null;
+
+  const vsPath = await findVsInstall();
+  if (!vsPath) {
+    log.warn('  MSVC profile requested but vswhere/VS not found — CMake will error if cl.exe is missing');
+    return null;
+  }
+  const vcvarsall = findVcvarsall(vsPath);
+  if (!vcvarsall) {
+    log.warn(`  MSVC profile requested but vcvarsall.bat not found under ${vsPath}`);
+    return null;
+  }
+
+  let archArg;
+  try {
+    archArg = mapArch(profile.arch);
+  } catch (err) {
+    // Unknown arch for an MSVC profile is genuinely a configuration bug
+    // (MSVC only ships toolsets for x64/x86/arm64/arm). Surface clearly
+    // and fall through to the ambient env — CMake will then error with
+    // a usable compiler-detection message instead of us silently
+    // cross-targeting x64.
+    log.warn(`  ${err.message}`);
+    return null;
+  }
+  log.info(`  activating MSVC build env: vcvarsall.bat ${archArg} (${vsPath})`);
+  const env = await captureVcvarsEnv(vcvarsall, archArg);
+  if (!env) {
+    log.warn(`  vcvarsall.bat ${archArg} failed — CMake will error if cl.exe is missing`);
+    return null;
+  }
+  return env;
+}
+
+module.exports = {
+  loadMsvcEnv,
+  // Exported for tests
+  isClOnPath,
+  findVsInstall,
+  findVcvarsall,
+  mapArch,
+  captureVcvarsEnv,
+  VCVARSALL_ARCH_ALLOWLIST,
+};