[VSC-1681 | 1304] isBinInPath remove use of which where (#1565)

brianignacio5 · web-flow · commit 18f47c77c3a2 · 2025-06-04T08:12:10.000+08:00
* isBinInPath remove use of which where

* call stat after path exists check

* Fix binaryPath update

* use canAccessFile

* fix manual py path

* rm remaining ref which where

* rm utils dependency
diff --git a/.prettierignore b/.prettierignore
@@ -29,3 +29,4 @@ esp_debug_adapter/
 external/
 test-resources/
 docs_espressif/
+profiles
diff --git a/src/build/buildTask.ts b/src/build/buildTask.ts
@@ -86,12 +86,10 @@ export class BuildTask {
     };
     const canAccessCMake = await isBinInPath(
       "cmake",
-      this.currentWorkspace.fsPath,
       modifiedEnv
     );
     const canAccessNinja = await isBinInPath(
       "ninja",
-      this.currentWorkspace.fsPath,
       modifiedEnv
     );
 
diff --git a/src/clang/index.ts b/src/clang/index.ts
@@ -34,7 +34,6 @@ export async function validateEspClangExists(workspaceFolder: Uri) {
 
   const espClangdPath = await isBinInPath(
     "clangd",
-    workspaceFolder.fsPath,
     modifiedEnv
   );
   if (espClangdPath && espClangdPath.includes("esp-clang")) {
diff --git a/src/espIdf/debugAdapter/debugAdapterManager.ts b/src/espIdf/debugAdapter/debugAdapterManager.ts
@@ -90,7 +90,7 @@ export class DebugAdapterManager extends EventEmitter {
       if (this.isRunning()) {
         return;
       }
-      if (!isBinInPath("openocd", this.currentWorkspace.fsPath, this.env)) {
+      if (!isBinInPath("openocd", this.env)) {
         return reject(
           new Error("Invalid OpenOCD bin path or access is denied for the user")
         );
diff --git a/src/espIdf/openOcd/openOcdManager.ts b/src/espIdf/openOcd/openOcdManager.ts
@@ -61,7 +61,7 @@ export class OpenOCDManager extends EventEmitter {
 
   public async version(): Promise<string> {
     const modifiedEnv = await appendIdfAndToolsToPath(this.workspace);
-    if (!isBinInPath("openocd", this.workspace.fsPath, modifiedEnv)) {
+    if (!isBinInPath("openocd", modifiedEnv)) {
       return "";
     }
     const resp = await sspawn("openocd", ["--version"], {
@@ -157,7 +157,7 @@ export class OpenOCDManager extends EventEmitter {
       return;
     }
     const modifiedEnv = await appendIdfAndToolsToPath(this.workspace);
-    if (!isBinInPath("openocd", this.workspace.fsPath, modifiedEnv)) {
+    if (!isBinInPath("openocd", modifiedEnv)) {
       throw new Error(
         "Invalid OpenOCD bin path or access is denied for the user"
       );
diff --git a/src/espIdf/tracing/gdbHeapTraceManager.ts b/src/espIdf/tracing/gdbHeapTraceManager.ts
@@ -68,7 +68,6 @@ export class GdbHeapTraceManager {
         const gdbTool = getToolchainToolName(idfTarget, "gdb");
         const isGdbToolInPath = await isBinInPath(
           gdbTool,
-          workspace.fsPath,
           modifiedEnv
         );
         if (!isGdbToolInPath) {
diff --git a/src/pythonManager.ts b/src/pythonManager.ts
@@ -518,27 +518,19 @@ export async function getUnixPythonList(workingDir: string) {
     let python3Versions: string[] = [];
 
     try {
-      const pythonVersionsRaw = await utils.execChildProcess(
-        "which",
-        ["-a", "python"],
-        workingDir
+      pythonVersions = await utils.getAllBinPathInEnvPath(
+        "python",
+        process.env
       );
-      pythonVersions = pythonVersionsRaw.trim()
-        ? pythonVersionsRaw.trim().split("\n")
-        : [];
     } catch (pythonError) {
       Logger.warn("Error finding python versions", pythonError);
     }
 
     try {
-      const python3VersionsRaw = await utils.execChildProcess(
-        "which",
-        ["-a", "python3"],
-        workingDir
+      python3Versions = await utils.getAllBinPathInEnvPath(
+        "python3",
+        process.env
       );
-      python3Versions = python3VersionsRaw.trim()
-        ? python3VersionsRaw.trim().split("\n")
-        : [];
     } catch (python3Error) {
       Logger.warn("Error finding python3 versions", python3Error);
     }
diff --git a/src/qemu/qemuManager.ts b/src/qemu/qemuManager.ts
@@ -184,7 +184,6 @@ export class QemuManager extends EventEmitter {
     }
     const isQemuBinInPath = await isBinInPath(
       qemuExecutable,
-      workspaceFolder.fsPath,
       modifiedEnv
     );
     if (!isQemuBinInPath) {
diff --git a/src/setup/espIdfJson.ts b/src/setup/espIdfJson.ts
@@ -93,7 +93,7 @@ export async function addIdfPath(
   espIdfObj["idfSelectedId"] = idfId;
   if (!espIdfObj.gitPath) {
     if (gitPath === "git") {
-      gitPath = await isBinInPath(gitPath, idfPath, process.env);
+      gitPath = await isBinInPath(gitPath, process.env);
     }
     espIdfObj.gitPath = gitPath;
   }
diff --git a/src/setup/setupInit.ts b/src/setup/setupInit.ts
@@ -171,7 +171,6 @@ export async function getSetupInitialValues(
 
       const canAccessCMake = await utils.isBinInPath(
         "cmake",
-        extensionPath,
         process.env
       );
 
@@ -183,7 +182,6 @@ export async function getSetupInitialValues(
 
       const canAccessNinja = await utils.isBinInPath(
         "ninja",
-        extensionPath,
         process.env
       );
 
@@ -246,15 +244,13 @@ export async function isCurrentInstallValid(workspaceFolder: Uri) {
   if (process.platform !== "win32") {
     const canAccessCMake = await utils.isBinInPath(
       "cmake",
-      containerPath,
       process.env
     );
     if (!canAccessCMake) {
       extraReqPaths.push("cmake");
     }
     const canAccessNinja = await utils.isBinInPath(
       "ninja",
-      containerPath,
       process.env
     );
     if (!canAccessNinja) {
diff --git a/src/support/configurationAccess.ts b/src/support/configurationAccess.ts
@@ -2,13 +2,13 @@
  * Project: ESP-IDF VSCode Extension
  * File Created: Wednesday, 30th December 2020 4:03:52 pm
  * Copyright 2020 Espressif Systems (Shanghai) CO LTD
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *    http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,7 +18,7 @@
 import { constants } from "fs-extra";
 import { delimiter } from "path";
 import * as vscode from "vscode";
-import { canAccessFile } from "../utils";
+import { canAccessFile, isBinInPath } from "../utils";
 import { execChildProcess } from "./execChildProcess";
 import { reportObj } from "./types";
 
@@ -74,18 +74,10 @@ export async function getConfigurationAccess(
     }
   }
   if (process.platform !== "win32") {
-    const cmakePathInEnv = await execChildProcess(
-      "which",
-      ["cmake"],
-      context.extensionPath
-    );
+    const cmakePathInEnv = await isBinInPath("cmake", process.env);
     reportedResult.configurationAccess.cmakeInEnv =
       cmakePathInEnv && cmakePathInEnv.indexOf("not found") === -1;
-    const ninjaPathInEnv = await execChildProcess(
-      "which",
-      ["ninja"],
-      context.extensionPath
-    );
+    const ninjaPathInEnv = await isBinInPath("ninja", process.env);
     reportedResult.configurationAccess.ninjaInEnv =
       ninjaPathInEnv && ninjaPathInEnv.indexOf("not found") === -1;
   }
diff --git a/src/test/project.test.ts b/src/test/project.test.ts
@@ -76,7 +76,6 @@ suite("Project tests", () => {
     );
     const compilerAbsolutePath = await isBinInPath(
       "xtensa-esp32-elf-gcc",
-      targetFolder,
       process.env
     );
     let compilerRelativePath = compilerAbsolutePath.split(
diff --git a/src/ui-test/configure-test.ts b/src/ui-test/configure-test.ts
@@ -17,9 +17,8 @@
  */
 
 import { expect } from "chai";
-import { spawn } from "child_process";
-import { readJSON } from "fs-extra";
-import { EOL } from "os";
+import { accessSync } from "fs";
+import { constants, pathExists, stat } from "fs-extra";
 import { delimiter, join, sep } from "path";
 import { By, EditorView, WebView, Workbench } from "vscode-extension-tester";
 
@@ -47,33 +46,24 @@ describe("Configure extension", () => {
     workDirectory: string,
     env: NodeJS.ProcessEnv
   ) {
-    const cmd = process.platform === "win32" ? "where" : "which";
-
-    return new Promise<string>((resolve, reject) => {
-      const options = {
-        cwd: workDirectory,
-        env,
-      };
-      const child = spawn(cmd, [binaryName], options);
-      let buff = Buffer.alloc(0);
-      const sendToBuffer = (data: Buffer) => {
-        buff = Buffer.concat([buff, data]);
-      };
-
-      child.stdout.on("data", sendToBuffer);
-      child.stderr.on("data", sendToBuffer);
-
-      child.on("exit", (code) => {
-        if (code !== 0) {
-          const err = new Error(
-            `non zero exit code ${code}. ${EOL + EOL + buff}`
-          );
-          console.error(err.message);
-          return reject(err);
+    let pathNameInEnv: string = Object.keys(process.env).find(
+      (k) => k.toUpperCase() == "PATH"
+    );
+    const pathDirs = env[pathNameInEnv].split(delimiter);
+    for (const pathDir of pathDirs) {
+      let binaryPath = join(pathDir, binaryName);
+      if (process.platform === "win32" && !binaryName.endsWith(".exe")) {
+        binaryPath = `${binaryPath}.exe`;
+      }
+      const doesPathExists = await pathExists(binaryPath);
+      if (doesPathExists) {
+        const pathStats = await stat(binaryPath);
+        if (pathStats.isFile() && pathStats.mode & 0o111) {
+          return binaryPath;
         }
-        return resolve(buff.toString());
-      });
-    });
+      }
+    }
+    return "";
   }
 
   async function selectEspIdfVersion(view: WebView) {
@@ -168,9 +158,7 @@ describe("Configure extension", () => {
       By.xpath(`.//h2[@data-config-id='setup-is-finished']`)
     );
     const setupFinishedText = await setupFinishedElement.getText();
-    expect(setupFinishedText).to.be.equal(
-      "All settings have been configured."
-    );
+    expect(setupFinishedText).to.be.equal("All settings have been configured.");
     if (view) {
       await view.switchBack();
       await new EditorView().closeAllEditors();
@@ -206,9 +194,6 @@ describe("Configure extension", () => {
     await idfToolsSelectChoices[idfToolsSelectChoices.length - 1].click();
 
     // Get current settings
-    const settingsJsonObj = await readJSON(
-      join(__dirname, "../../test-resources/settings/User/settings.json")
-    );
     const modifiedEnv: { [key: string]: string } = <{ [key: string]: string }>(
       Object.assign({}, process.env)
     );
@@ -248,9 +233,7 @@ describe("Configure extension", () => {
       By.xpath(`.//h2[@data-config-id='setup-is-finished']`)
     );
     const setupFinishedText = await setupFinishedElement.getText();
-    expect(setupFinishedText).to.be.equal(
-      "All settings have been configured."
-    );
+    expect(setupFinishedText).to.be.equal("All settings have been configured.");
     if (view) {
       await view.switchBack();
       await new EditorView().closeAllEditors();
@@ -287,9 +270,7 @@ describe("Configure extension", () => {
       By.xpath(`.//h2[@data-config-id='setup-is-finished']`)
     );
     const setupFinishedText = await setupFinishedElement.getText();
-    expect(setupFinishedText).to.be.equal(
-      "All settings have been configured."
-    );
+    expect(setupFinishedText).to.be.equal("All settings have been configured.");
 
     if (view) {
       await view.switchBack();
diff --git a/src/utils.ts b/src/utils.ts
diff --git a/src/views/setup/components/selectPyVersion.vue b/src/views/setup/components/selectPyVersion.vue

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ export class DebugAdapterManager extends EventEmitter {`
`90`	`90`	`if (this.isRunning()) {`
`91`	`91`	`return;`
`92`	`92`	`}`
`93`		`- if (!isBinInPath("openocd", this.currentWorkspace.fsPath, this.env)) {`
	`93`	`+ if (!isBinInPath("openocd", this.env)) {`
`94`	`94`	`return reject(`
`95`	`95`	`new Error("Invalid OpenOCD bin path or access is denied for the user")`
`96`	`96`	`);`
Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,6 @@ export class QemuManager extends EventEmitter {`
`184`	`184`	`}`
`185`	`185`	`const isQemuBinInPath = await isBinInPath(`
`186`	`186`	`qemuExecutable,`
`187`		`- workspaceFolder.fsPath,`
`188`	`187`	`modifiedEnv`
`189`	`188`	`);`
`190`	`189`	`if (!isQemuBinInPath) {`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ export async function addIdfPath(`
`93`	`93`	`espIdfObj["idfSelectedId"] = idfId;`
`94`	`94`	`if (!espIdfObj.gitPath) {`
`95`	`95`	`if (gitPath === "git") {`
`96`		`- gitPath = await isBinInPath(gitPath, idfPath, process.env);`
	`96`	`+ gitPath = await isBinInPath(gitPath, process.env);`
`97`	`97`	`}`
`98`	`98`	`espIdfObj.gitPath = gitPath;`
`99`	`99`	`}`