Fix .databrickscfg parsing for DEFAULT section (#112)

Fixes #106

Author: kartikgupta-db

packages/databricks-sdk-js/src/auth/configFile.test.ts

@@ -31,7 +31,37 @@ describe(__filename, () => {
         );
     });
 
-    it("should parse a config file", async () => {
+    it("should parse a config file w/o DEFAULT header", async () => {
+        await withFile(async ({path}) => {
+            await writeFile(
+                path,
+                `
+host = https://cloud.databricks.com/
+token = dapitest1234
+
+[STAGING]
+host = https://staging.cloud.databricks.com/
+token = dapitest54321
+`
+            );
+
+            const profiles = await loadConfigFile(path);
+
+            assert.equal(Object.keys(profiles).length, 2);
+            assert.equal(
+                profiles.DEFAULT.host.href,
+                "https://cloud.databricks.com/"
+            );
+            assert.equal(profiles.DEFAULT.token, "dapitest1234");
+            assert.equal(
+                profiles.STAGING.host.href,
+                "https://staging.cloud.databricks.com/"
+            );
+            assert.equal(profiles.STAGING.token, "dapitest54321");
+        });
+    });
+
+    it("should parse a config file with DEFAULT header", async () => {
         await withFile(async ({path}) => {
             await writeFile(
                 path,
@@ -41,7 +71,8 @@ token = dapitest1234
 
 [STAGING]
 host = https://staging.cloud.databricks.com/
-token = dapitest54321`
+token = dapitest54321
+`
             );
 
             const profiles = await loadConfigFile(path);

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

@@ -38,12 +38,35 @@ export async function loadConfigFile(filePath?: string): Promise<Profiles> {
 
     let config: any;
     let profiles: Profiles = {};
+    let defaultSection: Record<string, any> = {};
+    let defaultSectionFound = false;
     try {
         config = parse(fileContents);
-        for (let profile in config) {
-            profiles[profile] = {
-                host: new URL(config[profile].host),
-                token: config[profile].token,
+        for (let key in config) {
+            if (key === "DEFAULT") {
+                for (let defaultSectionKey in config[key]) {
+                    defaultSection[defaultSectionKey] =
+                        config[key][defaultSectionKey];
+                }
+                defaultSectionFound = true;
+                continue;
+            }
+            // for global values without a section header
+            // put them in the default sections
+            if (typeof config[key] === "string") {
+                defaultSection[key] = config[key];
+                defaultSectionFound = true;
+                continue;
+            }
+            profiles[key] = {
+                host: new URL(config[key].host),
+                token: config[key].token,
+            };
+        }
+        if (defaultSectionFound) {
+            profiles["DEFAULT"] = {
+                host: new URL(defaultSection.host),
+                token: defaultSection.token,
             };
         }
     } catch (e: unknown) {
@@ -53,7 +76,7 @@ export async function loadConfigFile(filePath?: string): Promise<Profiles> {
         } else {
             message = e;
         }
-        throw new ConfigFileError(`Can't parse ${filePath}: ${message}`);
+        throw new ConfigFileError(`${message}`);
     }
 
     return profiles;

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

@@ -4,8 +4,16 @@ import {
     Profiles,
     resolveConfigFilePath,
 } from "@databricks/databricks-sdk";
-import {stat, unlink} from "fs/promises";
-import {QuickPickItem, QuickPickItemKind, window} from "vscode";
+import {copyFile, stat, unlink} from "fs/promises";
+import path from "path";
+import {
+    commands,
+    QuickPickItem,
+    QuickPickItemKind,
+    Uri,
+    window,
+    workspace,
+} from "vscode";
 import {CliWrapper} from "../cli/CliWrapper";
 import {MultiStepInput} from "../ui/wizard";
 
@@ -37,23 +45,49 @@ export async function selectProfile(
             if (!(e instanceof ConfigFileError)) {
                 throw e;
             }
-            const path = resolveConfigFilePath();
+            const confPath = resolveConfigFilePath();
             let stats;
             try {
-                stats = await stat(path);
+                stats = await stat(confPath);
             } catch (e) {
                 /*file doesn't exist*/
             }
             if (stats?.isFile()) {
                 const option = await window.showErrorMessage(
-                    e.message,
-                    "Overwrite",
-                    "Cancel"
+                    `Can't parse config file`,
+                    {
+                        detail: e.message,
+                    },
+                    "Open Config File",
+                    "Backup and Overwrite Config File"
                 );
-                if (option === "Cancel") {
+                if (option === undefined) {
+                    return;
+                }
+                if (option === "Open Config File") {
+                    await commands.executeCommand(
+                        "databricks.connection.openDatabricksConfigFile"
+                    );
                     return;
                 }
-                await unlink(path);
+                const backupPath = path.join(
+                    path.dirname(confPath),
+                    `${path.basename(confPath)}.${Date.now()}.bak`
+                );
+                await copyFile(confPath, backupPath);
+
+                const openBackup = await window.showErrorMessage(
+                    `Config file backed up at "${backupPath}"`,
+                    "Open Backup File",
+                    "Continue Without Opening"
+                );
+                if (openBackup === "Open Backup File") {
+                    const doc = await workspace.openTextDocument(
+                        Uri.file(backupPath)
+                    );
+                    await window.showTextDocument(doc);
+                }
+                await unlink(confPath);
             }
         }