Cross platform file not found detection (#324)

Author: fjakobs

packages/databricks-sdk-js/src/auth/fromAzureCli.ts

@@ -1,11 +1,8 @@
-import * as child_process from "node:child_process";
-import {promisify} from "node:util";
+import {execFileWithShell, FileNotFoundException} from "../config/execUtils";
 import {refreshableCredentialProvider} from "./refreshableCredentialProvider";
 import {Token} from "./Token";
 import {CredentialProvider, CredentialsProviderError} from "./types";
 
-const execFile = promisify(child_process.execFile);
-
 // Resource ID of the Azure application we need to log in.
 const azureDatabricksLoginAppID = "2ff814a6-3304-4ab8-85cb-cd0e6f879c1d";
 
@@ -29,18 +26,14 @@ export const fromAzureCli = (host?: URL): CredentialProvider => {
     return refreshableCredentialProvider(async () => {
         let stdout = "";
         try {
-            ({stdout} = await execFile(
-                "az",
-                [
-                    "account",
-                    "get-access-token",
-                    "--resource",
-                    azureDatabricksLoginAppID,
-                ],
-                {shell: true}
-            ));
+            ({stdout} = await execFileWithShell("az", [
+                "account",
+                "get-access-token",
+                "--resource",
+                azureDatabricksLoginAppID,
+            ]));
         } catch (e: any) {
-            if (e.code === "ENOENT") {
+            if (e instanceof FileNotFoundException) {
                 throw new CredentialsProviderError(
                     "Can't find 'az' command. Please install Azure CLI: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli'"
                 );

packages/databricks-sdk-js/src/config/execUtils.test.ts

@@ -0,0 +1,16 @@
+import * as assert from "node:assert";
+import {execFileWithShell, FileNotFoundException} from "./execUtils";
+
+describe(__filename, () => {
+    it("should spawn a command", async () => {
+        const {stdout} = await execFileWithShell("echo", ["hello"]);
+        assert.match(stdout, /^hello\r?\n$/m);
+    });
+
+    it("should detect if the command is not found", async () => {
+        await assert.rejects(
+            execFileWithShell("i_dont_exist", []),
+            FileNotFoundException
+        );
+    });
+});

packages/databricks-sdk-js/src/config/execUtils.ts

@@ -0,0 +1,72 @@
+import * as child_process from "node:child_process";
+import {ExecException} from "node:child_process";
+import {promisify} from "node:util";
+
+const execFile = promisify(child_process.execFile);
+
+export interface ExecFileException extends ExecException {
+    stdout?: string;
+    stderr?: string;
+}
+
+export class FileNotFoundException extends Error {}
+
+export function isExecFileException(e: any): e is ExecFileException {
+    return (
+        e.code !== undefined ||
+        e.stderr !== undefined ||
+        e.stdout !== undefined ||
+        e.signal !== undefined
+    );
+}
+
+function isFileNotFound(e: any): e is ExecFileException {
+    // when using plain execFile
+    if (e.code === "ENOENT") {
+        return true;
+    }
+
+    if (!isExecFileException(e)) {
+        return false;
+    }
+
+    // when using execFile with shell on Linux
+    if (
+        e.code === 127 &&
+        e.stderr &&
+        e.stderr.indexOf("command not found") >= 0
+    ) {
+        return true;
+    }
+
+    // when using execFile with shell on Windows
+    if (
+        e.code === 1 &&
+        e.stderr &&
+        e.stderr.indexOf(
+            "is not recognized as an internal or external command"
+        ) >= 0
+    ) {
+        return true;
+    }
+
+    return false;
+}
+
+export async function execFileWithShell(
+    cmd: string,
+    args: Array<string>
+): Promise<{
+    stdout: string;
+    stderr: string;
+}> {
+    try {
+        return await execFile(cmd, args, {shell: true});
+    } catch (e) {
+        if (isFileNotFound(e)) {
+            throw new FileNotFoundException(e.message);
+        } else {
+            throw e;
+        }
+    }
+}

packages/databricks-vscode/src/configuration/AzureCliCheck.ts

@@ -1,11 +1,8 @@
-import * as child_process from "node:child_process";
-import {promisify} from "node:util";
 import {CurrentUserService} from "@databricks/databricks-sdk";
 import {commands, Disposable, Uri, window} from "vscode";
 import {ConnectionManager} from "./ConnectionManager";
 import {AuthProvider} from "./AuthProvider";
-
-const execFile = promisify(child_process.execFile);
+import {execFileWithShell} from "@databricks/databricks-sdk/dist/config/execUtils";
 
 export type Step<S, N> = () => Promise<
     SuccessResult<S> | NextResult<N> | ErrorResult
@@ -182,9 +179,9 @@ export class AzureCliCheck implements Disposable {
     // check if Azure CLI is installed
     public async hasAzureCli(): Promise<boolean> {
         try {
-            const {stdout} = await execFile(this.azBinPath, ["--version"], {
-                shell: true,
-            });
+            const {stdout} = await execFileWithShell(this.azBinPath, [
+                "--version",
+            ]);
             if (stdout.indexOf("azure-cli") !== -1) {
                 return true;
             }
@@ -215,11 +212,10 @@ export class AzureCliCheck implements Disposable {
     // check if Azure CLI is logged in
     public async isAzureCliLoggedIn(): Promise<boolean> {
         try {
-            const {stdout, stderr} = await execFile(
-                this.azBinPath,
-                ["account", "list"],
-                {shell: true}
-            );
+            const {stdout, stderr} = await execFileWithShell(this.azBinPath, [
+                "account",
+                "list",
+            ]);
             if (stdout === "[]") {
                 return false;
             }