Better fix for settings UI not getting updated. (#7656)

* Better fix for settings UI not getting updated.

Author: sean-mcmanus

Extension/src/LanguageServer/configurations.ts

@@ -975,7 +975,11 @@ export class CppProperties {
             const settings: CppSettings = new CppSettings(this.rootUri);
             this.settingsPanel = new SettingsPanel();
             this.settingsPanel.setKnownCompilers(this.knownCompilers, settings.preferredPathSeparator);
-            this.settingsPanel.SettingsPanelActivated(() => this.onSettingsPanelActivated());
+            this.settingsPanel.SettingsPanelActivated(() => {
+                if (this.settingsPanel?.initialized) {
+                    this.onSettingsPanelActivated();
+                }
+            });
             this.settingsPanel.ConfigValuesChanged(() => this.saveConfigurationUI());
             this.settingsPanel.ConfigSelectionChanged(() => this.onConfigSelectionChanged());
             this.settingsPanel.AddConfigRequested((e) => this.onAddConfigRequested(e));
@@ -1025,21 +1029,9 @@ export class CppProperties {
                         if (this.settingsPanel.selectedConfigIndex >= this.configurationJson.configurations.length) {
                             this.settingsPanel.selectedConfigIndex = this.CurrentConfigurationIndex;
                         }
-                        const tryUpdate = () => {
-                            if (!this.settingsPanel || !this.configurationJson || this.settingsPanel.firstUpdateReceived) {
-                                return;
-                            }
-                            this.settingsPanel.updateConfigUI(configNames,
-                                this.configurationJson.configurations[this.settingsPanel.selectedConfigIndex],
-                                this.getErrorsForConfigUI(this.settingsPanel.selectedConfigIndex));
-
-                            // Need to queue another update due to a VS Code regression bug which may drop the initial update.
-                            // It repros with a higher probability in cases that cause a slower load, such as after
-                            // switching to a Chinese langauge pack or in the remote scenario.
-                            setTimeout(tryUpdate, 500);
-                        };
-                        this.settingsPanel.firstUpdateReceived = false;
-                        tryUpdate();
+                        this.settingsPanel.updateConfigUI(configNames,
+                            this.configurationJson.configurations[this.settingsPanel.selectedConfigIndex],
+                            this.getErrorsForConfigUI(this.settingsPanel.selectedConfigIndex));
                     } else {
                         // Parse failed, open json file
                         vscode.workspace.openTextDocument(this.propertiesFile);

Extension/src/LanguageServer/settingsPanel.ts

@@ -73,8 +73,11 @@ export class SettingsPanel {
     private static readonly viewType: string = 'settingsPanel';
     private static readonly title: string = 'C/C++ Configurations';
 
-    // Used to workaround a VS Code bug in which webviewPanel.postMessage calls sometimes get dropped.
-    public firstUpdateReceived: boolean = false;
+    // Used to workaround a VS Code 1.56 regression in which webViewPanel.onDidChangeViewState
+    // gets called before the SettingsApp constructor is finished running.
+    // It repros with a higher probability in cases that cause a slower load,
+    // such as after switching to a Chinese language pack or in the remote scenario.
+    public initialized: boolean = false;
 
     constructor() {
         this.disposable = vscode.Disposable.from(
@@ -94,6 +97,8 @@ export class SettingsPanel {
             return;
         }
 
+        this.initialized = false;
+
         // Create new panel
         this.panel = vscode.window.createWebviewPanel(
             SettingsPanel.viewType,
@@ -111,8 +116,6 @@ export class SettingsPanel {
             }
         );
 
-        this.firstUpdateReceived = false;
-
         this.panel.iconPath = vscode.Uri.file(util.getExtensionFilePath("LanguageCCPP_color_128x.png"));
 
         this.disposablesPanel = vscode.Disposable.from(
@@ -216,7 +219,7 @@ export class SettingsPanel {
     private updateWebview(configSelection: string[], configuration: config.Configuration, errors: config.ConfigurationErrors | null): void {
         this.configValues = {...configuration}; // Copy configuration values
         this.isIntelliSenseModeDefined = (this.configValues.intelliSenseMode !== undefined);
-        if (this.panel) {
+        if (this.panel && this.initialized) {
             this.panel.webview.postMessage({ command: 'setKnownCompilers', compilers: this.compilerPaths });
             this.panel.webview.postMessage({ command: 'updateConfigSelection', selections: configSelection, selectedIndex: this.configIndexSelected });
             this.panel.webview.postMessage({ command: 'updateConfig', config: this.configValues });
@@ -255,8 +258,9 @@ export class SettingsPanel {
             case 'knownCompilerSelect':
                 this.knownCompilerSelect();
                 break;
-            case 'firstUpdateReceived':
-                this.firstUpdateReceived = true;
+            case "initialized":
+                this.initialized = true;
+                this.settingsPanelActivated.fire();
                 break;
         }
     }

Extension/ui/settings.ts

@@ -64,9 +64,6 @@ class SettingsApp {
     private readonly vsCodeApi: VsCodeApi;
     private updating: boolean = false;
 
-    // Used to workaround a VS Code bug in which webviewPanel.postMessage calls sometimes get dropped.
-    private firstUpdateReceived: boolean = false;
-
     constructor() {
         this.vsCodeApi = acquireVsCodeApi();
 
@@ -84,6 +81,9 @@ class SettingsApp {
         document.getElementById(elementId.advancedSection).style.display = advancedShown ? "block" : "none";
         document.getElementById(elementId.showAdvanced).classList.toggle(advancedShown ? "collapse" : "expand", true);
         document.getElementById(elementId.showAdvanced).addEventListener("click", this.onShowAdvanced.bind(this));
+        this.vsCodeApi.postMessage({
+            command: "initialized"
+        });
     }
 
     private addEventsToInputValues(): void {
@@ -235,12 +235,6 @@ class SettingsApp {
         switch (message.command) {
             case 'updateConfig':
                 this.updateConfig(message.config);
-
-                if (!this.firstUpdateReceived) {
-                    this.vsCodeApi.postMessage({
-                        command: "firstUpdateReceived"
-                    });
-                }
                 break;
             case 'updateErrors':
                 this.updateErrors(message.errors);