@provartesting/provardx-cli 1.5.0-dev.2 → 1.5.1

package/lib/mcp/tools/sfSpawn.js

@@ -4,6 +4,9 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
 import { spawnSync as _spawnSync } from 'node:child_process';
 /**
  * Thin wrapper around spawnSync so tests can stub sfSpawnHelper.spawnSync.
@@ -15,21 +18,166 @@ export const sfSpawnHelper = {
 // ── Shared error type ─────────────────────────────────────────────────────────
 export class SfNotFoundError extends Error {
     code = 'SF_NOT_FOUND';
-    constructor() {
-        super('sf CLI not found in PATH. Install Salesforce CLI (`npm install -g @salesforce/cli`) and ensure it is in your PATH.');
+    constructor(sfPath) {
+        const where = sfPath ? `at explicit path "${sfPath}"` : 'in PATH or common npm/nvm/volta install locations';
+        super(`sf CLI not found ${where}. ` +
+            'Install Salesforce CLI (npm install -g @salesforce/cli) and ensure the install directory is in your PATH, ' +
+            'or pass sf_path pointing to the sf executable directly ' +
+            '(e.g. "~/.nvm/versions/node/v22.0.0/bin/sf").');
         this.name = 'SfNotFoundError';
     }
 }
+const MAX_BUFFER = 50 * 1024 * 1024; // 50 MB — prevents ENOBUFS on verbose Provar runs
+// ── SF CLI discovery ──────────────────────────────────────────────────────────
+/**
+ * Returns candidate sf CLI paths in common install locations.
+ * Used as a fallback when `sf` is not in PATH.
+ */
+export function getSfCommonPaths() {
+    const home = os.homedir();
+    if (process.platform === 'win32') {
+        const appData = process.env['APPDATA'] ?? path.join(home, 'AppData', 'Roaming');
+        return [
+            path.join(appData, 'npm', 'sf.cmd'),
+            path.join('C:', 'Program Files', 'nodejs', 'sf.cmd'),
+            path.join('C:', 'Program Files (x86)', 'nodejs', 'sf.cmd'),
+            // Windows standalone installer (https://developer.salesforce.com/tools/salesforcecli)
+            path.join('C:', 'Program Files', 'sf', 'bin', 'sf.cmd'),
+            path.join('C:', 'Program Files', 'sf', 'client', 'bin', 'sf.cmd'),
+        ];
+    }
+    const candidates = [
+        '/usr/local/bin/sf',
+        path.join(home, '.npm-global', 'bin', 'sf'),
+        path.join(home, '.local', 'bin', 'sf'),
+        path.join(home, '.volta', 'bin', 'sf'),
+    ];
+    // nvm — scan the three most-recently installed Node versions
+    const nvmBinDir = path.join(process.env['NVM_DIR'] ?? path.join(home, '.nvm'), 'versions', 'node');
+    if (fs.existsSync(nvmBinDir)) {
+        try {
+            for (const v of fs.readdirSync(nvmBinDir).sort().reverse().slice(0, 3)) {
+                candidates.push(path.join(nvmBinDir, v, 'bin', 'sf'));
+            }
+        }
+        catch {
+            /* skip */
+        }
+    }
+    return candidates;
+}
+// Proactively resolve the sf executable path once on first use and cache it.
+// This ensures sf is always found even when ENOENT is masked by other errors (e.g. ENOBUFS).
+let cachedSfPath; // undefined = not yet probed
+/**
+ * Exposed for testing only — pre-seeds the cached sf executable path, bypassing the probe spawn.
+ * Pass `undefined` to reset the cache so the next call triggers a fresh probe.
+ */
+export function setSfPathCacheForTesting(value) {
+    cachedSfPath = value;
+}
+// Platform override used in tests so Windows-specific shell logic can be exercised on any OS.
+let sfPlatformOverride;
+/** Exposed for testing only — overrides process.platform for needsWindowsShell decisions. */
+export function setSfPlatformForTesting(platform) {
+    sfPlatformOverride = platform;
+}
+/**
+ * Returns true when spawning `executable` requires the Windows shell.
+ * On Windows, `.cmd` and `.bat` batch scripts cannot be executed directly by
+ * Node's spawnSync — they must be invoked through cmd.exe (i.e. shell: true).
+ * The bare name "sf" also needs this treatment on Windows because the file on
+ * disk is actually "sf.cmd" and Node won't auto-append the extension.
+ */
+export function needsWindowsShell(executable, platform = process.platform) {
+    if (platform !== 'win32')
+        return false;
+    const lower = executable.toLowerCase();
+    return lower.endsWith('.cmd') || lower.endsWith('.bat') || !path.extname(lower);
+}
+function resolveSfExecutable() {
+    if (cachedSfPath !== undefined)
+        return cachedSfPath;
+    const platform = sfPlatformOverride ?? process.platform;
+    // Two-phase probe avoids false-positives on Windows with shell:true.
+    // When shell:true is used, cmd.exe spawns successfully even when `sf` is
+    // missing — it exits non-zero with "not recognised" in stderr but sets no
+    // probe.error. Trying shell:false first catches both cases correctly.
+    //
+    // First attempt: shell:false (works on Linux/macOS; gives ENOENT on Windows if
+    // sf.cmd is on PATH but requires the shell).
+    const probe = sfSpawnHelper.spawnSync('sf', ['--version'], {
+        encoding: 'utf-8',
+        shell: false,
+        maxBuffer: 1024 * 1024,
+    });
+    if (!probe.error && probe.status === 0) {
+        cachedSfPath = 'sf';
+        return cachedSfPath;
+    }
+    // Windows fallback: retry with shell:true when the plain probe failed
+    // with ENOENT — meaning sf.cmd exists on PATH but can't run without the shell.
+    if (platform === 'win32' && probe.error?.code === 'ENOENT') {
+        const probeShell = sfSpawnHelper.spawnSync('sf', ['--version'], {
+            encoding: 'utf-8',
+            shell: true,
+            maxBuffer: 1024 * 1024,
+        });
+        if (!probeShell.error && probeShell.status === 0) {
+            cachedSfPath = 'sf';
+            return cachedSfPath;
+        }
+    }
+    // Fall back to common install locations
+    for (const candidate of getSfCommonPaths()) {
+        if (fs.existsSync(candidate)) {
+            cachedSfPath = candidate;
+            return cachedSfPath;
+        }
+    }
+    cachedSfPath = null;
+    return null;
+}
+/**
+ * Reject shell metacharacters in an sf_path that will be executed via shell:true.
+ * On Windows, cmd.exe interprets & | ; < > ` ' " and newlines as shell syntax.
+ * A valid filesystem path should never contain these characters.
+ */
+function assertShellSafePath(sfPath) {
+    if (/[&|;<>`'"\n\r]/.test(sfPath)) {
+        throw Object.assign(new Error('sf_path contains characters that are unsafe for shell execution on Windows ' +
+            '(& | ; < > ` \' " or line-breaks). Provide an absolute filesystem path to the sf executable.'), { code: 'INVALID_SF_PATH' });
+    }
+}
 /**
  * Run `sf <args>` synchronously and return stdout, stderr, and exit code.
- * Throws SfNotFoundError if the `sf` binary is not in PATH.
+ * Throws SfNotFoundError if the `sf` binary cannot be found.
+ * Pass `sfPath` to override auto-discovery with an explicit executable path.
  */
-export function runSfCommand(args) {
-    const result = sfSpawnHelper.spawnSync('sf', args, { encoding: 'utf-8', shell: false });
+export function runSfCommand(args, sfPath) {
+    // Treat empty/whitespace sfPath as absent so auto-discovery runs instead of
+    // throwing SfNotFoundError with no useful path hint.
+    const trimmedSfPath = sfPath?.trim();
+    const resolvedSfPath = trimmedSfPath !== '' ? trimmedSfPath : undefined;
+    const executable = resolvedSfPath ?? resolveSfExecutable();
+    if (!executable)
+        throw new SfNotFoundError();
+    const platform = sfPlatformOverride ?? process.platform;
+    const useShell = needsWindowsShell(executable, platform);
+    // Guard against injection when shell:true is used with a user-supplied path.
+    // Common install locations returned by resolveSfExecutable() are safe by construction.
+    if (useShell && resolvedSfPath) {
+        assertShellSafePath(resolvedSfPath);
+    }
+    const result = sfSpawnHelper.spawnSync(executable, args, {
+        encoding: 'utf-8',
+        shell: useShell,
+        maxBuffer: MAX_BUFFER,
+    });
     if (result.error) {
         const err = result.error;
         if (err.code === 'ENOENT') {
-            throw new SfNotFoundError();
+            throw new SfNotFoundError(resolvedSfPath);
         }
         throw result.error;
     }

package/lib/mcp/tools/sfSpawn.js.map

@@ -1 +1 @@
-{"version":3,"file":"sfSpawn.js","sourceRoot":"","sources":["../../../src/mcp/tools/sfSpawn.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,SAAS,EAAE,UAAU;CACtB,CAAC;AAEF,iFAAiF;AAEjF,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxB,IAAI,GAAG,cAAc,CAAC;IACtC;QACE,KAAK,CACH,oHAAoH,CACrH,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAUD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAc;IACzC,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAExF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,GAAG,GAAG,MAAM,CAAC,KAA8B,CAAC;QAClD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,eAAe,EAAE,CAAC;QAC9B,CAAC;QACD,MAAM,MAAM,CAAC,KAAK,CAAC;IACrB,CAAC;IAED,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;QAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;QAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC;KAC7B,CAAC;AACJ,CAAC;AAED,iFAAiF;AAEjF;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC"}
+{"version":3,"file":"sfSpawn.js","sourceRoot":"","sources":["../../../src/mcp/tools/sfSpawn.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,SAAS,EAAE,UAAU;CACtB,CAAC;AAEF,iFAAiF;AAEjF,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxB,IAAI,GAAG,cAAc,CAAC;IACtC,YAAmB,MAAe;QAChC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,qBAAqB,MAAM,GAAG,CAAC,CAAC,CAAC,mDAAmD,CAAC;QAC5G,KAAK,CACH,oBAAoB,KAAK,IAAI;YAC3B,4GAA4G;YAC5G,yDAAyD;YACzD,+CAA+C,CAClD,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAUD,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,kDAAkD;AAEvF,iFAAiF;AAEjF;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IAC1B,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAChF,OAAO;YACL,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACpD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,QAAQ,CAAC;YAC1D,sFAAsF;YACtF,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC;SAClE,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG;QACjB,mBAAmB;QACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;KACvC,CAAC;IACF,6DAA6D;IAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IACnG,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACvE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,UAAU;QACZ,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,6EAA6E;AAC7E,6FAA6F;AAC7F,IAAI,YAAuC,CAAC,CAAC,6BAA6B;AAE1E;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAgC;IACvE,YAAY,GAAG,KAAK,CAAC;AACvB,CAAC;AAED,8FAA8F;AAC9F,IAAI,kBAA+C,CAAC;AAEpD,6FAA6F;AAC7F,MAAM,UAAU,uBAAuB,CAAC,QAAqC;IAC3E,kBAAkB,GAAG,QAAQ,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ;IAC/E,IAAI,QAAQ,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;IACvC,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAClF,CAAC;AAED,SAAS,mBAAmB;IAC1B,IAAI,YAAY,KAAK,SAAS;QAAE,OAAO,YAAY,CAAC;IACpD,MAAM,QAAQ,GAAG,kBAAkB,IAAI,OAAO,CAAC,QAAQ,CAAC;IAExD,qEAAqE;IACrE,yEAAyE;IACzE,0EAA0E;IAC1E,sEAAsE;IACtE,EAAE;IACF,+EAA+E;IAC/E,6CAA6C;IAC7C,MAAM,KAAK,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE;QACzD,QAAQ,EAAE,OAAO;QACjB,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,IAAI,GAAG,IAAI;KACvB,CAAC,CAAC;IACH,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,YAAY,GAAG,IAAI,CAAC;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,sEAAsE;IACtE,+EAA+E;IAC/E,IAAI,QAAQ,KAAK,OAAO,IAAK,KAAK,CAAC,KAA2C,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAClG,MAAM,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE;YAC9D,QAAQ,EAAE,OAAO;YACjB,KAAK,EAAE,IAAI;YACX,SAAS,EAAE,IAAI,GAAG,IAAI;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjD,YAAY,GAAG,IAAI,CAAC;YACpB,OAAO,YAAY,CAAC;QACtB,CAAC;IACH,CAAC;IAED,wCAAwC;IACxC,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,EAAE,CAAC;QAC3C,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,YAAY,GAAG,SAAS,CAAC;YACzB,OAAO,YAAY,CAAC;QACtB,CAAC;IACH,CAAC;IACD,YAAY,GAAG,IAAI,CAAC;IACpB,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,MAAc;IACzC,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,MAAM,CAAC,MAAM,CACjB,IAAI,KAAK,CACP,6EAA6E;YAC3E,8FAA8F,CACjG,EACD,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAC5B,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,IAAc,EAAE,MAAe;IAC1D,4EAA4E;IAC5E,qDAAqD;IACrD,MAAM,aAAa,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC;IACrC,MAAM,cAAc,GAAG,aAAa,KAAK,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,MAAM,UAAU,GAAG,cAAc,IAAI,mBAAmB,EAAE,CAAC;IAC3D,IAAI,CAAC,UAAU;QAAE,MAAM,IAAI,eAAe,EAAE,CAAC;IAE7C,MAAM,QAAQ,GAAG,kBAAkB,IAAI,OAAO,CAAC,QAAQ,CAAC;IACxD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEzD,6EAA6E;IAC7E,uFAAuF;IACvF,IAAI,QAAQ,IAAI,cAAc,EAAE,CAAC;QAC/B,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE;QACvD,QAAQ,EAAE,OAAO;QACjB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,UAAU;KACtB,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,GAAG,GAAG,MAAM,CAAC,KAA8B,CAAC;QAClD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,MAAM,CAAC,KAAK,CAAC;IACrB,CAAC;IAED,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;QAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;QAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC;KAC7B,CAAC;AACJ,CAAC;AAED,iFAAiF;AAEjF;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC"}