Remove bundle source (#1005)

## Changes
* Remove config source tag. It was being used only for clusterId any and
we can figure that out by diffing with the `validatedConfig`.
* Expose `validateConfig` and `preValidateConfig` from the config model.
* Hide configModel submodels.
## Tests
<!-- How is this tested? -->

Author: kartikgupta-db

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

@@ -200,7 +200,7 @@ export class ConnectionCommands implements Disposable {
     }
 
     async selectTarget() {
-        const targets = await this.configModel.bundlePreValidateModel.targets;
+        const targets = await this.configModel.targets;
         const currentTarget = this.configModel.target;
         if (targets === undefined) {
             return;

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

@@ -171,9 +171,8 @@ export class ConnectionManager implements Disposable {
         }
 
         // Try to load a profile user had previously selected for this target
-        const savedProfile = (
-            await this.configModel.overrideableConfigModel.load()
-        ).authProfile;
+        const savedProfile = (await this.configModel.get("overrides"))
+            ?.authProfile;
         if (savedProfile !== undefined) {
             const authProvider = new ProfileAuthProvider(host, savedProfile);
             if (await authProvider.check()) {
@@ -183,8 +182,8 @@ export class ConnectionManager implements Disposable {
 
         // Try to load any parameters that are hard coded in the bundle
         const bundleAuthParams =
-            await this.configModel.bundlePreValidateModel.load();
-        if (bundleAuthParams.authParams !== undefined) {
+            await this.configModel.get("preValidateConfig");
+        if (bundleAuthParams?.authParams !== undefined) {
             throw new Error("Bundle auth params not implemented");
         }
 

packages/databricks-vscode/src/configuration/models/ConfigModel.ts

@@ -23,36 +23,37 @@ const defaults: ConfigState = {
     mode: "development",
 };
 
-const SELECTED_BUNDLE_VALIDATE_CONFIG_KEYS = [
-    "clusterId",
-    "remoteRootPath",
-] as const;
+const TOP_LEVEL_VALIDATE_CONFIG_KEYS = ["clusterId", "remoteRootPath"] as const;
 
-const SELECTED_BUNDLE_PRE_VALIDATE_CONFIG_KEYS = [
+const TOP_LEVEL_PRE_VALIDATE_CONFIG_KEYS = [
     "host",
     "mode",
     "authParams",
 ] as const;
 
 type ConfigState = Pick<
     BundleValidateState,
-    (typeof SELECTED_BUNDLE_VALIDATE_CONFIG_KEYS)[number]
+    (typeof TOP_LEVEL_VALIDATE_CONFIG_KEYS)[number]
 > &
     Pick<
         BundlePreValidateState,
-        (typeof SELECTED_BUNDLE_PRE_VALIDATE_CONFIG_KEYS)[number]
+        (typeof TOP_LEVEL_PRE_VALIDATE_CONFIG_KEYS)[number]
     > &
-    OverrideableConfigState;
-
-export type ConfigSource = "bundle" | "override" | "default";
-
-type ConfigSourceMap = {
-    [K in keyof ConfigState]: {
-        config: ConfigState[K];
-        source: ConfigSource;
+    OverrideableConfigState & {
+        preValidateConfig?: BundlePreValidateState;
+        validateConfig?: BundleValidateState;
+        overrides?: OverrideableConfigState;
     };
-};
 
+function selectTopLevelKeys(
+    obj: any,
+    keys: readonly string[]
+): Record<string, any> {
+    return keys.reduce((prev: any, key) => {
+        prev[key] = obj[key];
+        return prev;
+    }, {});
+}
 /**
  * In memory view of the databricks configs loaded from overrides and bundle.
  */
@@ -64,43 +65,36 @@ export class ConfigModel implements Disposable {
      * after configsMutex to avoid deadlocks.
      */
     private readonly readStateMutex = new Mutex();
-    private readonly configCache = new CachedValue<ConfigSourceMap>(
+    private readonly configCache = new CachedValue<ConfigState>(
         this.readState.bind(this)
     );
 
     @Mutex.synchronise("readStateMutex")
     async readState() {
         if (this.target === undefined) {
-            return {config: {}, source: {}};
+            return {};
         }
-        const bundleValidateConfig = await this.bundleValidateModel.load([
-            ...SELECTED_BUNDLE_VALIDATE_CONFIG_KEYS,
-        ]);
+        const bundleValidateConfig = await this.bundleValidateModel.load();
         const overrides = await this.overrideableConfigModel.load();
-        const bundleConfigs = await this.bundlePreValidateModel.load([
-            ...SELECTED_BUNDLE_PRE_VALIDATE_CONFIG_KEYS,
-        ]);
-        const newConfigs = {
-            ...bundleConfigs,
-            ...bundleValidateConfig,
+        const bundlePreValidateConfig =
+            await this.bundlePreValidateModel.load();
+
+        return {
+            ...selectTopLevelKeys(
+                bundlePreValidateConfig,
+                TOP_LEVEL_PRE_VALIDATE_CONFIG_KEYS
+            ),
+            ...selectTopLevelKeys(
+                bundleValidateConfig,
+                TOP_LEVEL_VALIDATE_CONFIG_KEYS
+            ),
             ...overrides,
+            preValidateConfig: bundlePreValidateConfig,
+            validateConfig: bundleValidateConfig,
+            overrides,
         };
-
-        const newValue: any = {};
-        (Object.keys(newConfigs) as (keyof typeof newConfigs)[]).forEach(
-            (key) => {
-                newValue[key] = {
-                    config: newConfigs[key],
-                    source:
-                        overrides !== undefined && key in overrides
-                            ? "override"
-                            : "bundle",
-                };
-            }
-        );
-
-        return newValue;
     }
+
     public onDidChange = this.configCache.onDidChange.bind(this.configCache);
     public onDidChangeKey = this.configCache.onDidChangeKey.bind(
         this.configCache
@@ -117,9 +111,9 @@ export class ConfigModel implements Disposable {
     private _authProvider: AuthProvider | undefined;
 
     constructor(
-        public readonly bundleValidateModel: BundleValidateModel,
-        public readonly overrideableConfigModel: OverrideableConfigModel,
-        public readonly bundlePreValidateModel: BundlePreValidateModel,
+        private readonly bundleValidateModel: BundleValidateModel,
+        private readonly overrideableConfigModel: OverrideableConfigModel,
+        private readonly bundlePreValidateModel: BundlePreValidateModel,
         private readonly vscodeWhenContext: CustomWhenContext,
         private readonly stateStorage: StateStorage
     ) {
@@ -133,7 +127,7 @@ export class ConfigModel implements Disposable {
                 //refresh cache to trigger onDidChange event
                 await this.configCache.refresh();
             }),
-            ...SELECTED_BUNDLE_VALIDATE_CONFIG_KEYS.map((key) =>
+            ...TOP_LEVEL_VALIDATE_CONFIG_KEYS.map((key) =>
                 this.bundleValidateModel.onDidChangeKey(key)(async () => {
                     //refresh cache to trigger onDidChange event
                     this.configCache.refresh();
@@ -147,6 +141,9 @@ export class ConfigModel implements Disposable {
         await this.readTarget();
     }
 
+    get targets() {
+        return this.bundlePreValidateModel.targets;
+    }
     /**
      * Try to read target from bundle config.
      * If not found, try to read from state storage.
@@ -226,24 +223,7 @@ export class ConfigModel implements Disposable {
     public async get<T extends keyof ConfigState>(
         key: T
     ): Promise<ConfigState[T] | undefined> {
-        return (await this.configCache.value)[key]?.config ?? defaults[key];
-    }
-
-    /**
-     * Return config value along with source of the config.
-     * Refer to {@link DatabricksConfigSource} for possible values.
-     */
-    @Mutex.synchronise("configsMutex")
-    public async getS<T extends keyof ConfigState>(
-        key: T
-    ): Promise<ConfigSourceMap[T] | undefined> {
-        const config = (await this.configCache.value)[key];
-        return config
-            ? ({
-                  config: config.config ?? defaults[key],
-                  source: config.source ?? "default",
-              } as ConfigSourceMap[T])
-            : undefined;
+        return (await this.configCache.value)[key] ?? defaults[key];
     }
 
     @Mutex.synchronise("configsMutex")

packages/databricks-vscode/src/configuration/ui/AuthTypeComponent.ts

@@ -55,8 +55,8 @@ export class AuthTypeComponent extends BaseComponent {
         }
 
         const config =
-            (await this.configModel.getS("authProfile")) ??
-            (await this.configModel.getS("authParams"));
+            (await this.configModel.get("authProfile")) ??
+            (await this.configModel.get("authParams"));
         if (config === undefined) {
             // This case can never happen. This is just to make ts happy.
             return [];
@@ -72,7 +72,6 @@ export class AuthTypeComponent extends BaseComponent {
                 description: authProvider.describe(),
                 contextValue: getContextValue(authProvider.authType),
                 id: TREE_ICON_ID,
-                source: config.source,
             },
         ];
     }

packages/databricks-vscode/src/configuration/ui/ClusterComponent.ts

@@ -85,9 +85,9 @@ export class ClusterComponent extends BaseComponent {
 
     @onError({popup: true})
     private async getRoot(): Promise<ConfigurationTreeItem[]> {
-        const config = await this.configModel.getS("clusterId");
+        const config = await this.configModel.get("clusterId");
 
-        if (config?.config === undefined) {
+        if (config === undefined) {
             // Cluster is not set in bundle and override
             // We are logged in -> Select cluster prompt
             const label = "Select a cluster";
@@ -124,7 +124,6 @@ export class ClusterComponent extends BaseComponent {
                 collapsibleState: TreeItemCollapsibleState.Expanded,
                 contextValue: contextValue,
                 iconPath: icon,
-                source: config.source,
                 id: TREE_ICON_ID,
             },
         ];

packages/databricks-vscode/src/configuration/ui/ConfigurationDataProvider.ts

@@ -4,8 +4,6 @@ import {
     EventEmitter,
     TreeDataProvider,
     TreeItem,
-    ThemeIcon,
-    ThemeColor,
 } from "vscode";
 
 import {ConnectionManager} from "../ConnectionManager";
@@ -79,47 +77,8 @@ export class ConfigurationDataProvider
                 break;
         }
 
-        const configSourceTooltip = {
-            bundle: "This configuration is loaded from a Databricks Asset Bundle.",
-            override: "This configuration is a workspace only override.",
-        };
-
         return (
             await Promise.all(this.components.map((c) => c.getChildren(parent)))
-        )
-            .map((items) => {
-                // Add config source item to expanded view, if the parent config is not a default
-                if (
-                    parent?.source === undefined ||
-                    parent.source === "default" ||
-                    items.length === 0
-                ) {
-                    return items;
-                }
-
-                const tooltip = configSourceTooltip[parent.source];
-                return [
-                    {
-                        label: "Source",
-                        description: parent.source,
-                        iconPath: new ThemeIcon("info", new ThemeColor("info")),
-                        tooltip,
-                    },
-                    ...items,
-                ];
-            })
-            .flat()
-            .map((item) => {
-                // Add config source tooltip to the config root item, if the  config is not a default
-                // and parent is undefined.
-                if (item.source === undefined || item.source === "default") {
-                    return item;
-                }
-                const tooltip = configSourceTooltip[item.source];
-                return {
-                    ...item,
-                    tooltip,
-                };
-            });
+        ).flat();
     }
 }

packages/databricks-vscode/src/configuration/ui/types.ts

@@ -1,7 +1,5 @@
 import {TreeItem} from "vscode";
-import {ConfigSource} from "../models/ConfigModel";
 
 export interface ConfigurationTreeItem extends TreeItem {
-    source?: ConfigSource;
     url?: string;
 }