Handle missing ~/.databrickscfg (#383)

Author: fjakobs

packages/databricks-vscode/package.json

@@ -517,7 +517,7 @@
     "scripts": {
         "vscode:prepublish": "rm -rf out && yarn run package:compile && yarn run package:copy-webview-toolkit",
         "package": "vsce package",
-        "package:cli:fetch": "BRICKS_VERSION=v0.0.15 && bash ./scripts/fetch-bricks-cli.sh ${BRICKS_VERSION} ${BRICKS_ARCH:-}",
+        "package:cli:fetch": "BRICKS_VERSION=v0.0.17 && bash ./scripts/fetch-bricks-cli.sh ${BRICKS_VERSION} ${BRICKS_ARCH:-}",
         "package:cli:link": "rm -f ./bin/bricks && ln -s ../../../../bricks/bricks bin",
         "package:compile": "yarn run esbuild:base",
         "package:copy-webview-toolkit": "cp ./node_modules/@vscode/webview-ui-toolkit/dist/toolkit.js ./out/toolkit.js",
@@ -604,4 +604,4 @@
         ],
         "report-dir": "coverage"
     }
-}
+}

packages/databricks-vscode/scripts/fetch-bricks-cli.sh

@@ -19,8 +19,5 @@ popd
 mkdir -p bin
 cd ./bin
 rm -rf bricks
-BRICKS_BINARY=$(cd $BRICKS_DIR && ls bricks*)
-# strip the version from the binary name but keep exe on Windows
-BRICKS_TARGET_NAME=$(echo $BRICKS_BINARY | sed -E 's/(.*)_v[0-9]+\.[0-9]+\.[0-9]+(\.exe)?/\1\2/g')
-mv $BRICKS_DIR/$BRICKS_BINARY $BRICKS_TARGET_NAME
+mv $BRICKS_DIR/bricks .
 rm -rf $BRICKS_DIR

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

@@ -2,6 +2,7 @@ import {Cluster, Repo} from "@databricks/databricks-sdk";
 import {homedir} from "node:os";
 import {
     Disposable,
+    FileSystemError,
     QuickPickItem,
     QuickPickItemKind,
     ThemeIcon,
@@ -70,9 +71,19 @@ export class ConnectionCommands implements Disposable {
 
     openDatabricksConfigFileCommand() {
         return async () => {
-            const doc = await workspace.openTextDocument(
-                Uri.joinPath(Uri.file(homedir()), ".databrickscfg")
-            );
+            const uri = Uri.joinPath(Uri.file(homedir()), ".databrickscfg");
+
+            try {
+                await workspace.fs.stat(uri);
+            } catch (e) {
+                if (e instanceof FileSystemError && e.code === "FileNotFound") {
+                    await workspace.fs.writeFile(uri, Buffer.from(""));
+                } else {
+                    throw e;
+                }
+            }
+
+            const doc = await workspace.openTextDocument(uri);
             await window.showTextDocument(doc);
         };
     }

packages/databricks-vscode/src/configuration/auth/AuthProvider.ts

@@ -12,12 +12,7 @@ const extensionVersion = require("../../../package.json")
 
 import {AzureCliCheck} from "../AzureCliCheck";
 
-export type AuthType =
-    | "azure-cli"
-    | "google-id"
-    | "oauth-u2m"
-    | "profile"
-    | "pat";
+export type AuthType = "azure-cli" | "google-id" | "oauth-u2m" | "profile";
 
 export abstract class AuthProvider {
     constructor(
@@ -79,53 +74,12 @@ export abstract class AuthProvider {
                 }
                 return new ProfileAuthProvider(host, json.profile);
 
-            case "pat":
-                if (!json.token) {
-                    throw new Error("Missing token");
-                }
-                return new TokenAuthProvider(host, json.token);
-
             default:
                 throw new Error(`Unknown auth type: ${json.authType}`);
         }
     }
 }
 
-export class TokenAuthProvider extends AuthProvider {
-    constructor(host: URL, private readonly token: string) {
-        super(host, "pat");
-    }
-
-    describe(): string {
-        return "Personal Access Token";
-    }
-
-    toJSON(): Record<string, unknown> {
-        return {
-            host: this.host.toString(),
-            authType: this.authType,
-            token: this.token,
-        };
-    }
-
-    getEnvVars(): Record<string, string | undefined> {
-        return {
-            DATABRICKS_HOST: this.host.toString(),
-            DATABRICKS_AUTH_TYPE: this.authType,
-            DATABRICKS_TOKEN: this.token,
-        };
-    }
-
-    getSdkConfig(): Config {
-        return new Config({
-            authType: "pat",
-            token: this.token,
-            host: this.host.toString(),
-            env: {},
-        });
-    }
-}
-
 export class ProfileAuthProvider extends AuthProvider {
     constructor(host: URL, private readonly profile: string) {
         super(host, "profile");

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

@@ -70,21 +70,6 @@ export async function configureWorkspaceWizard(
                     });
                     break;
 
-                // Disabled PAT until we can figure out how we want to deal with the secret on disk
-                // case "pat":
-                //     items.push({
-                //         label: "PAT",
-                //         kind: QuickPickItemKind.Separator,
-                //         authType: "none",
-                //     });
-
-                //     items.push({
-                //         label: "Personal Access Token",
-                //         detail: "Authenticate using a personal access token",
-                //         authType: "pat",
-                //     });
-                //     break;
-
                 case "profile":
                     items.push({
                         label: "Databricks CLI Profiles",
@@ -154,10 +139,6 @@ export async function configureWorkspaceWizard(
                 state.authType = pick.authType;
                 break;
 
-            case "pat":
-                state.authType = pick.authType;
-                return (input: MultiStepInput) => inputToken(input, state);
-
             case "profile":
                 state.authType = pick.authType;
                 state.profile = pick.profile;
@@ -170,26 +151,6 @@ export async function configureWorkspaceWizard(
         }
     }
 
-    async function inputToken(input: MultiStepInput, state: Partial<State>) {
-        state.token = await input.showInputBox({
-            title,
-            step: 4,
-            totalSteps: 4,
-            value: typeof state.token === "string" ? state.token : "",
-            prompt: "Databricks personal access token (PAT)",
-            validate: async (s) => {
-                if (!s.length) {
-                    return "Invalid access token";
-                }
-            },
-            shouldResume: shouldResume,
-        });
-    }
-    async function shouldResume(): Promise<boolean> {
-        // Could show a notification with the option to resume.
-        return true;
-    }
-
     const state = await collectInputs();
     if (!state.host || !state.authType) {
         return;
@@ -212,16 +173,16 @@ async function validateDatabricksHost(
 
 function authMethodsForHostname(host: URL): Array<AuthType> {
     if (host.hostname.endsWith(".azuredatabricks.net")) {
-        return ["azure-cli", "pat", "profile"];
+        return ["azure-cli", "profile"];
     }
 
     if (host.hostname.endsWith(".gcp.databricks.com")) {
-        return ["google-id", "pat", "profile"];
+        return ["google-id", "profile"];
     }
 
     if (host.hostname.endsWith(".cloud.databricks.com")) {
-        return ["oauth-u2m", "pat", "profile"];
+        return ["oauth-u2m", "profile"];
     }
 
-    return ["pat", "profile"];
+    return ["profile"];
 }