Fix issue with didOpen processed before initial custom browse config

Author: Colengc

Extension/src/LanguageServer/client.ts

@@ -1223,7 +1223,7 @@ export class DefaultClient implements Client {
             // Resume parsing on either resolve or reject, only if parsing was not resumed due to timeout
             let hasCompleted: boolean = false;
             task().then(async config => {
-                await this.sendCustomBrowseConfiguration(config, currentProvider.extensionId);
+                this.sendCustomBrowseConfiguration(config, currentProvider.extensionId);
                 if (!hasCompleted) {
                     hasCompleted = true;
                     if (currentProvider.version >= Version.v2) {
@@ -1243,7 +1243,7 @@ export class DefaultClient implements Client {
             global.setTimeout(async () => {
                 if (!hasCompleted) {
                     hasCompleted = true;
-                    await this.sendCustomBrowseConfiguration(null, null, true);
+                    this.sendCustomBrowseConfiguration(null, null, true);
                     if (currentProvider.version >= Version.v2) {
                         console.warn("Configuration Provider timed out in {0}ms.", configProviderTimeout);
                         this.resumeParsing();
@@ -1340,7 +1340,7 @@ export class DefaultClient implements Client {
             return this.callTaskWithTimeout(provideConfigurationAsync, configProviderTimeout, tokenSource).then(
                 (configs: SourceFileConfigurationItem[]) => {
                     if (configs && configs.length > 0) {
-                        this.sendCustomConfigurations(configs, false);
+                        this.sendCustomConfigurations(configs);
                     }
                     onFinished();
                 },
@@ -1497,16 +1497,12 @@ export class DefaultClient implements Client {
         return this.queueTask(request);
     }
 
-    public notifyWhenReady(notify: () => void, blockingTask?: boolean): Thenable<void> {
+    public notifyWhenReady(notify: () => void): Thenable<void> {
         let task: () => Thenable<void> = () => new Promise(resolve => {
             notify();
             resolve();
         });
-        if (blockingTask) {
-            return this.queueBlockingTask(task);
-        } else {
-            return this.queueTask(task);
-        }
+        return this.queueTask(task);
     }
 
     /**
@@ -1941,30 +1937,27 @@ export class DefaultClient implements Client {
             c.compilerPath = compilerPathAndArgs.compilerPath;
             c.compilerArgs = compilerPathAndArgs.additionalArgs;
         });
-        this.notifyWhenReady(() => {
-            if (!this.doneInitialCustomBrowseConfigurationCheck) {
-                // Send the last custom browse configuration we received from this provider.
-                // This ensures we don't start tag parsing without it, and undo'ing work we have to re-do when the (likely same) browse config arrives
-                // Should only execute on launch, for the initial delivery of configurations
-                let lastCustomBrowseConfigurationProviderId: PersistentFolderState<string> = new PersistentFolderState<string>("CPP.lastCustomBrowseConfigurationProviderId", null, this.RootPath);
-                if (lastCustomBrowseConfigurationProviderId.Value === configurations[params.currentConfiguration].configurationProvider) {
-                    let lastCustomBrowseConfiguration: PersistentFolderState<WorkspaceBrowseConfiguration> = new PersistentFolderState<WorkspaceBrowseConfiguration>("CPP.lastCustomBrowseConfiguration", null, this.RootPath);
-                    if (lastCustomBrowseConfiguration.Value) {
-                        this.sendCustomBrowseConfiguration(lastCustomBrowseConfiguration.Value, lastCustomBrowseConfigurationProviderId.Value);
-                    }
+        if (!this.doneInitialCustomBrowseConfigurationCheck) {
+            // Send the last custom browse configuration we received from this provider.
+            // This ensures we don't start tag parsing without it, and undo'ing work we have to re-do when the (likely same) browse config arrives
+            // Should only execute on launch, for the initial delivery of configurations
+            let lastCustomBrowseConfigurationProviderId: PersistentFolderState<string> = new PersistentFolderState<string>("CPP.lastCustomBrowseConfigurationProviderId", null, this.RootPath);
+            if (isSameProviderExtensionId(lastCustomBrowseConfigurationProviderId.Value, configurations[params.currentConfiguration].configurationProvider)) {
+                let lastCustomBrowseConfiguration: PersistentFolderState<WorkspaceBrowseConfiguration> = new PersistentFolderState<WorkspaceBrowseConfiguration>("CPP.lastCustomBrowseConfiguration", null, this.RootPath);
+                if (lastCustomBrowseConfiguration.Value) {
+                    this.sendCustomBrowseConfiguration(lastCustomBrowseConfiguration.Value, lastCustomBrowseConfigurationProviderId.Value);
                 }
-                this.doneInitialCustomBrowseConfigurationCheck = true;
             }
-            this.languageClient.sendNotification(ChangeFolderSettingsNotification, params);
-            this.model.activeConfigName.Value = configurations[params.currentConfiguration].name;
-        }).then(() => {
-            let newProvider: string = this.configuration.CurrentConfigurationProvider;
-            if (!isSameProviderExtensionId(newProvider, this.configurationProvider)) {
-                this.configurationProvider = newProvider;
-                this.updateCustomBrowseConfiguration();
-                this.updateCustomConfigurations();
-            }
-        });
+            this.doneInitialCustomBrowseConfigurationCheck = true;
+        }
+        this.languageClient.sendNotification(ChangeFolderSettingsNotification, params);
+        this.model.activeConfigName.Value = configurations[params.currentConfiguration].name;
+        let newProvider: string = this.configuration.CurrentConfigurationProvider;
+        if (!isSameProviderExtensionId(newProvider, this.configurationProvider)) {
+            this.configurationProvider = newProvider;
+            this.updateCustomBrowseConfiguration();
+            this.updateCustomConfigurations();
+        }
     }
 
     private onSelectedConfigurationChanged(index: number): void {
@@ -1997,7 +1990,7 @@ export class DefaultClient implements Client {
             util.isOptionalArrayOfString(input.configuration.forcedInclude));
     }
 
-    private sendCustomConfigurations(configs: any, blockingTask?: boolean): void {
+    private sendCustomConfigurations(configs: any): void {
         // configs is marked as 'any' because it is untrusted data coming from a 3rd-party. We need to sanitize it before sending it to the language server.
         if (!configs || !(configs instanceof Array)) {
             console.warn("discarding invalid SourceFileConfigurationItems[]: " + configs);
@@ -2045,16 +2038,10 @@ export class DefaultClient implements Client {
             configurationItems: sanitized
         };
 
-        if (blockingTask) {
-            this.notifyWhenReady(() => {
-                this.languageClient.sendNotification(CustomConfigurationNotification, params);
-            } , blockingTask);
-        } else {
-            this.languageClient.sendNotification(CustomConfigurationNotification, params);
-        }
+        this.languageClient.sendNotification(CustomConfigurationNotification, params);
     }
 
-    private sendCustomBrowseConfiguration(config: any, providerId: string, timeoutOccured?: boolean): Thenable<void> {
+    private sendCustomBrowseConfiguration(config: any, providerId: string, timeoutOccured?: boolean): void {
         let lastCustomBrowseConfiguration: PersistentFolderState<WorkspaceBrowseConfiguration> = new PersistentFolderState<WorkspaceBrowseConfiguration>("CPP.lastCustomBrowseConfiguration", null, this.RootPath);
         let lastCustomBrowseConfigurationProviderId: PersistentFolderState<string> = new PersistentFolderState<string>("CPP.lastCustomBrowseConfigurationProviderId", null, this.RootPath);
         let sanitized: util.Mutable<WorkspaceBrowseConfiguration>;
@@ -2072,7 +2059,7 @@ export class DefaultClient implements Client {
                     break;
                 }
                 console.log("No browse configuration is available.");
-                return Promise.resolve();
+                return;
             }
 
             sanitized = {...<WorkspaceBrowseConfiguration>config};
@@ -2087,7 +2074,7 @@ export class DefaultClient implements Client {
                     console.log("Falling back to last received browse configuration: ", JSON.stringify(sanitized, null, 2));
                     break;
                 }
-                return Promise.resolve();
+                return;
             }
 
             let settings: CppSettings = new CppSettings(this.RootUri);
@@ -2114,7 +2101,7 @@ export class DefaultClient implements Client {
             browseConfiguration: sanitized
         };
 
-        return this.notifyWhenReady(() => this.languageClient.sendNotification(CustomBrowseConfigurationNotification, params));
+        this.languageClient.sendNotification(CustomBrowseConfigurationNotification, params);
     }
 
     private clearCustomConfigurations(): void {