Give up on transforming in compose step, do it afterwards

in order to avoid transformation timeout

Author: krassowski

packages/jupyterlab-lsp/src/index.ts

@@ -154,6 +154,7 @@ export class LSPExtension implements ILSPExtension {
   connection_manager: DocumentConnectionManager;
   language_server_manager: LanguageServerManager;
   feature_manager: ILSPFeatureManager;
+  private _settingsUI: SettingsUIManager;
 
   constructor(
     public app: JupyterFrontEnd,
@@ -200,15 +201,15 @@ export class LSPExtension implements ILSPExtension {
 
     this.feature_manager = new FeatureManager();
 
-    const settingsUI = new SettingsUIManager({
+    this._settingsUI = new SettingsUIManager({
       settingRegistry: this.setting_registry,
       formRegistry: formRegistry,
       console: this.console.scope('SettingsUIManager'),
       languageServerManager: this.language_server_manager,
       trans: trans,
       restored: app.restored
     });
-    settingsUI
+    this._settingsUI
       .setupSchemaForUI(plugin.id)
       .then(this._activate.bind(this))
       .catch(this._activate.bind(this));
@@ -218,7 +219,9 @@ export class LSPExtension implements ILSPExtension {
     this.setting_registry
       .load(plugin.id)
       .then(settings => {
-        const options = settings.composite as Required<LanguageServer>;
+        const options = this._settingsUI.normalizeSettings(
+          settings.composite as Required<LanguageServer>
+        );
 
         // Store the initial server settings, to be sent asynchronously
         // when the servers are initialized.
@@ -269,7 +272,9 @@ export class LSPExtension implements ILSPExtension {
   }
 
   private updateOptions(settings: ISettingRegistry.ISettings) {
-    const options = settings.composite as Required<LanguageServer>;
+    const options = this._settingsUI.normalizeSettings(
+      settings.composite as Required<LanguageServer>
+    );
 
     const languageServerSettings = (options.language_servers ||
       {}) as TLanguageServerConfigurations;

packages/jupyterlab-lsp/src/settings.ts

@@ -278,58 +278,6 @@ export class SettingsUIManager {
             : this._canonical,
           version: plugin.version
         };
-      },
-      compose: plugin => {
-        // Initial compose: 28 ms
-        // Consecutive compose with cached settings: 1-2ms
-
-        const user = plugin.data.user as Required<LanguageServer>;
-        const composite = JSONExt.deepCopy(user);
-
-        // Cache collapsed settings for speed and to only show dialog once.
-        // Note that JupyterLab attempts to transform in "preload" step (before splash screen end)
-        // and then again for deferred extensions if the initial transform in preload timed out.
-        // We are hitting the timeout in preload step.
-        if (
-          this._lastUserServerSettings === null ||
-          this._lastUserServerSettingsDoted === null ||
-          !JSONExt.deepEqual(
-            this._lastUserServerSettings,
-            user.language_servers
-          )
-        ) {
-          this._lastUserServerSettings = user.language_servers;
-          const collapsed = this._collapseServerSettingsDotted(
-            user.language_servers
-          );
-          user.language_servers = this._collapseServerSettingsDotted(
-            user.language_servers
-          ).settings;
-          this._lastUserServerSettingsDoted = user.language_servers;
-
-          if (Object.keys(collapsed.conflicts).length > 0) {
-            this._warnConflicts(collapsed.conflicts).catch(this.console.warn);
-          }
-        } else {
-          user.language_servers = this._lastUserServerSettingsDoted;
-        }
-        composite.language_servers = user.language_servers;
-
-        // Currently disabled, as it does not provide an obvious benefit:
-        // - we would need to explicitly save the updated settings
-        //   to get a clean version in JSON Setting Editor.
-        // - if default changed on the server side but schema did not get
-        //   updated, server would be using a different value than communicated
-        //   to the user. It would be optimal to filter out defaults from
-        //   user data and always keep them in composite.
-        // user.language_servers = this._filterOutDefaults(user.language_servers);
-
-        plugin.data = {
-          user: user,
-          composite: composite
-        };
-
-        return plugin;
       }
     });
 
@@ -341,6 +289,46 @@ export class SettingsUIManager {
     });
   }
 
+  normalizeSettings(composite: Required<LanguageServer>) {
+    // Cache collapsed settings for speed and to only show dialog once.
+    // Note that JupyterLab attempts to transform in "preload" step (before splash screen end)
+    // and then again for deferred extensions if the initial transform in preload timed out.
+    // We are hitting the timeout in preload step.
+    if (
+      this._lastUserServerSettings === null ||
+      this._lastUserServerSettingsDoted === null ||
+      !JSONExt.deepEqual(
+        this._lastUserServerSettings,
+        composite.language_servers
+      )
+    ) {
+      this._lastUserServerSettings = composite.language_servers;
+      const collapsed = this._collapseServerSettingsDotted(
+        composite.language_servers
+      );
+      composite.language_servers = collapsed.settings;
+      this._lastUserServerSettingsDoted = composite.language_servers;
+
+      if (Object.keys(collapsed.conflicts).length > 0) {
+        this._warnConflicts(collapsed.conflicts).catch(this.console.warn);
+      }
+    } else {
+      composite.language_servers = this._lastUserServerSettingsDoted;
+    }
+
+    // Currently disabled, as it does not provide an obvious benefit:
+    // - we would need to explicitly save the updated settings
+    //   to get a clean version in JSON Setting Editor.
+    // - if default changed on the server side but schema did not get
+    //   updated, server would be using a different value than communicated
+    //   to the user. It would be optimal to filter out defaults from
+    //   user data and always keep them in composite.
+    // composite.language_servers = this._filterOutDefaults(composite.language_servers);
+
+    // TODO: trigger update of settings to ensure that UI uses the same settings as collapsed?
+    return composite;
+  }
+
   private _wasPreviouslyValidated(
     plugin: ISettingRegistry.IPlugin,
     schema: ISettingRegistry.ISchema