Update metadata url before emitting connection change events (#992)

## Changes
This prevents race-condition when we attempt to save environments
variables to a file and terminals before the metadata url is actually
updated.

Should help with avoiding problems like this:
#980

## Tests
Manually and existing unit tests

Co-authored-by: Kartik Gupta <[email protected]>

Author: ilia-db

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

@@ -24,7 +24,7 @@ import {DatabricksWorkspace} from "./DatabricksWorkspace";
 import {Loggers} from "../logger";
 import {CustomWhenContext} from "../vscode-objs/CustomWhenContext";
 import {workspaceConfigs} from "../vscode-objs/WorkspaceConfigs";
-import {StateStorage} from "../vscode-objs/StateStorage";
+import {MetadataService} from "./auth/MetadataService";
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const {NamedLogger} = logging;
@@ -43,6 +43,7 @@ export class ConnectionManager {
     private _projectConfigFile?: ProjectConfigFile;
     private _clusterManager?: ClusterManager;
     private _databricksWorkspace?: DatabricksWorkspace;
+    private _metadataService: MetadataService;
 
     private readonly onDidChangeStateEmitter: EventEmitter<ConnectionState> =
         new EventEmitter();
@@ -58,12 +59,16 @@ export class ConnectionManager {
     public readonly onDidChangeSyncDestination =
         this.onDidChangeSyncDestinationEmitter.event;
 
-    public metadataServiceUrl?: string;
+    constructor(private cli: CliWrapper) {
+        this._metadataService = new MetadataService(
+            undefined,
+            NamedLogger.getOrCreate("Extension")
+        );
+    }
 
-    constructor(
-        private cli: CliWrapper,
-        private stateStorage: StateStorage
-    ) {}
+    get metadataServiceUrl() {
+        return this._metadataService.url;
+    }
 
     get state(): ConnectionState {
         return this._state;
@@ -201,6 +206,8 @@ export class ConnectionManager {
         this._workspaceClient = workspaceClient;
         this._projectConfigFile = projectConfigFile;
 
+        await this._metadataService.setApiClient(workspaceClient?.apiClient);
+
         if (projectConfigFile.clusterId) {
             await this.attachCluster(projectConfigFile.clusterId, true);
         } else {
@@ -525,6 +532,11 @@ export class ConnectionManager {
         });
     }
 
+    async startMetadataService() {
+        await this._metadataService.listen();
+        return this._metadataService;
+    }
+
     async waitForConnect(): Promise<void> {
         if (this._state !== "CONNECTED") {
             return await new Promise((resolve) => {

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

@@ -36,7 +36,6 @@ import {generateBundleSchema} from "./bundle/GenerateBundle";
 import {CustomWhenContext} from "./vscode-objs/CustomWhenContext";
 import {StateStorage} from "./vscode-objs/StateStorage";
 import path from "node:path";
-import {MetadataServiceManager} from "./configuration/auth/MetadataServiceManager";
 import {FeatureId, FeatureManager} from "./feature-manager/FeatureManager";
 import {DbConnectAccessVerifier} from "./language/DbConnectAccessVerifier";
 import {MsPythonExtensionWrapper} from "./language/MsPythonExtensionWrapper";
@@ -154,7 +153,7 @@ export async function activate(
         );
     }
     const cli = new CliWrapper(context, cliLogFilePath);
-    const connectionManager = new ConnectionManager(cli, stateStorage);
+    const connectionManager = new ConnectionManager(cli);
     context.subscriptions.push(
         connectionManager.onDidChangeState(async (state) => {
             telemetry.setMetadata(
@@ -171,10 +170,9 @@ export async function activate(
             }
         })
     );
-    const metadataServiceManager = new MetadataServiceManager(
-        connectionManager
-    );
-    await metadataServiceManager.listen();
+
+    const metadataService = await connectionManager.startMetadataService();
+    context.subscriptions.push(metadataService);
 
     const workspaceFsDataProvider = new WorkspaceFsDataProvider(
         connectionManager
@@ -187,7 +185,6 @@ export async function activate(
     );
 
     context.subscriptions.push(
-        metadataServiceManager,
         window.registerTreeDataProvider(
             "workspaceFsView",
             workspaceFsDataProvider