Fix project.json parsing (#323)

Author: kartikgupta-db

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

@@ -5,6 +5,7 @@ import {
     fromConfigFile,
     fromToken,
 } from "@databricks/databricks-sdk";
+import {normalizeHost} from "../utils/urlUtils";
 
 import {AzureCliCheck} from "./AzureCliCheck";
 
@@ -46,8 +47,11 @@ export abstract class AuthProvider {
     }
 
     static fromJSON(json: Record<string, any>): AuthProvider {
-        const url = json.url instanceof URL ? json.url : new URL(json.host);
-        if (!url) {
+        const host =
+            json.host instanceof URL
+                ? json.host
+                : normalizeHost(json.host as string);
+        if (!host) {
             throw new Error("Missing host");
         }
 
@@ -57,19 +61,19 @@ export abstract class AuthProvider {
 
         switch (json.authType as AuthType) {
             case "azure-cli":
-                return new AzureCliAuthProvider(url);
+                return new AzureCliAuthProvider(host);
 
             case "profile":
                 if (!json.profile) {
                     throw new Error("Missing profile");
                 }
-                return new ProfileAuthProvider(url, json.profile);
+                return new ProfileAuthProvider(host, json.profile);
 
             case "pat":
                 if (!json.token) {
                     throw new Error("Missing token");
                 }
-                return new TokenAuthProvider(url, json.token);
+                return new TokenAuthProvider(host, json.token);
 
             default:
                 throw new Error(`Unknown auth type: ${json.authType}`);

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

@@ -3,6 +3,8 @@ import fs from "node:fs/promises";
 import {AuthProvider, ProfileAuthProvider} from "./AuthProvider";
 import {fromConfigFile} from "@databricks/databricks-sdk";
 import {Uri} from "vscode";
+import {NamedLogger} from "@databricks/databricks-sdk/dist/logging";
+import {Loggers} from "../logger";
 
 export interface ProjectConfig {
     authProvider: AuthProvider;
@@ -51,7 +53,7 @@ export class ProjectConfigFile {
         try {
             const originalConfig = await ProjectConfigFile.load(this.rootPath);
             if (
-                JSON.stringify(originalConfig.config, null, 2) ===
+                JSON.stringify(originalConfig, null, 2) ===
                 JSON.stringify(this, null, 2)
             ) {
                 return;
@@ -103,6 +105,10 @@ export class ProjectConfigFile {
                 authProvider = AuthProvider.fromJSON(config);
             }
         } catch (e) {
+            NamedLogger.getOrCreate(Loggers.Extension).error(
+                "Error parsing project config file",
+                e
+            );
             throw new ConfigFileError("Error parsing project config file");
         }
         return new ProjectConfigFile(

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

@@ -7,6 +7,7 @@ import {
 } from "@databricks/databricks-sdk";
 import {commands, QuickPickItem, QuickPickItemKind} from "vscode";
 import {MultiStepInput} from "../ui/wizard";
+import {normalizeHost} from "../utils/urlUtils";
 import {AuthProvider, AuthType} from "./AuthProvider";
 import {ProjectConfig} from "./ProjectConfigFile";
 
@@ -199,31 +200,6 @@ export async function configureWorkspaceWizard(
     };
 }
 
-function normalizeHost(host: string): URL {
-    let url: URL;
-
-    if (!host.startsWith("http")) {
-        host = `https://${host}`;
-    }
-    try {
-        url = new URL(host);
-    } catch (e) {
-        throw new Error("Invalid host name");
-    }
-    if (url.protocol !== "https:") {
-        throw new Error("Invalid protocol");
-    }
-    if (
-        !url.hostname.match(
-            /(\.azuredatabricks\.net|\.gcp\.databricks\.com|\.cloud\.databricks\.com)$/
-        )
-    ) {
-        throw new Error("Not a Databricks host");
-    }
-
-    return new URL(`https://${url.hostname}`);
-}
-
 async function validateDatabricksHost(
     host: string
 ): Promise<string | undefined> {

packages/databricks-vscode/src/test/e2e/configure.e2e.ts

@@ -151,8 +151,12 @@ describe("Configure Databricks Extension", async function () {
             )
         );
 
+        const expectedHost = new URL(
+            host.startsWith("https") ? host : `https://${host}`
+        ).toString();
+
         assert.deepEqual(projectConfig, {
-            host,
+            host: expectedHost,
             authType: "profile",
             profile: "DEFAULT",
             clusterId,

packages/databricks-vscode/src/utils/urlUtils.ts

@@ -6,3 +6,28 @@ export function addHttpsIfNoProtocol(url: string) {
 export async function openExternal(url: string) {
     await env.openExternal(Uri.parse(addHttpsIfNoProtocol(url), true));
 }
+
+export function normalizeHost(host: string): URL {
+    let url: URL;
+
+    if (!host.startsWith("http")) {
+        host = `https://${host}`;
+    }
+    try {
+        url = new URL(host);
+    } catch (e) {
+        throw new Error("Invalid host name");
+    }
+    if (url.protocol !== "https:") {
+        throw new Error("Invalid protocol");
+    }
+    if (
+        !url.hostname.match(
+            /(\.azuredatabricks\.net|\.gcp\.databricks\.com|\.cloud\.databricks\.com)$/
+        )
+    ) {
+        throw new Error("Not a Databricks host");
+    }
+
+    return new URL(`https://${url.hostname}`);
+}