Initialize servers with saved settings

Author: trajamsmith

README.md

@@ -198,52 +198,54 @@ Server configurations can be edited using the Advanced Settings editor in Jupyte
 
 ```json
 {
-    "language_servers": {
-        "pyls": {
-            "serverSettings": {
-                "pyls.plugins.pydocstyle.enabled": true,
-                "pyls.plugins.pyflakes.enabled": false,
-                "pyls.plugins.flake8.enabled": true
-            }
-        },
-        "r-languageserver": {
-            "serverSettings": {
-                "r.lsp.debug": false,
-                "r.lsp.diagnostics": false
-            }
-        },
-        "yaml-language-server": {
-            "serverSettings": {
-                "yaml.schemas": {
-                    "http://json.schemastore.org/composer": "/*"
-                }
-            }
-        }
+  "language_servers": {
+    "pyls": {
+      "serverSettings": {
+        "pyls.plugins.pydocstyle.enabled": true,
+        "pyls.plugins.pyflakes.enabled": false,
+        "pyls.plugins.flake8.enabled": true
+      }
+    },
+    "r-languageserver": {
+      "serverSettings": {
+        "r.lsp.debug": false,
+        "r.lsp.diagnostics": false
+      }
     },
+    "yaml-language-server": {
+      "serverSettings": {
+        "yaml.schemas": {
+          "http://json.schemastore.org/composer": "/*"
+        }
+      }
+    }
+  }
 }
 ```
+
 The `serverSettings` key specifies the configurations sent to the language servers. These can be written using stringified dot accessors like above (in the VSCode style), or as nested JSON objects, e.g.:
+
 ```json
 {
-   "language_servers": {
-      "pyls": {
-         "serverSettings": {
-            "pyls": {
-               "plugins": {
-                  "pydocstyle": {
-                     "enabled": true
-                  },
-                  "pyflakes": {
-                     "enabled": false
-                  },
-                  "flake8": {
-                     "enabled": true
-                  }
-               }
+  "language_servers": {
+    "pyls": {
+      "serverSettings": {
+        "pyls": {
+          "plugins": {
+            "pydocstyle": {
+              "enabled": true
+            },
+            "pyflakes": {
+              "enabled": false
+            },
+            "flake8": {
+              "enabled": true
             }
-         }
+          }
+        }
       }
-   }
+    }
+  }
 }
 ```
 

packages/jupyterlab-lsp/src/connection_manager.ts

@@ -10,7 +10,8 @@ import * as ConnectionModuleType from './connection';
 import {
   TLanguageServerId,
   ILanguageServerManager,
-  ILanguageServerConfiguration
+  ILanguageServerConfiguration,
+  TLanguageServerConfigurations
 } from './tokens';
 
 export interface IDocumentConnectionData {
@@ -55,6 +56,7 @@ export class DocumentConnectionManager {
     Map<VirtualDocument.id_path, VirtualDocument>
   >;
   language_server_manager: ILanguageServerManager;
+  initial_configurations: TLanguageServerConfigurations;
   private ignored_languages: Set<string>;
 
   constructor(options: DocumentConnectionManager.IOptions) {
@@ -206,6 +208,9 @@ export class DocumentConnectionManager {
         // TODO: is this still neccessary, e.g. for status bar to update responsively?
         this.initialized.emit({ connection, virtual_document });
       });
+
+      // Initialize using settings stored in the SettingRegistry
+      this.updateServerConfigurations(this.initial_configurations);
     });
 
     connection.on('close', closed_manually => {

packages/jupyterlab-lsp/src/index.ts

@@ -40,6 +40,7 @@ import {
   DocumentRegistry
 } from '@jupyterlab/docregistry/lib/registry';
 import { DocumentConnectionManager } from './connection_manager';
+import { TLanguageServerConfigurations } from './tokens';
 
 const lsp_commands: Array<IFeatureCommand> = [].concat(
   ...lsp_features.map(feature => feature.commands)
@@ -244,14 +245,19 @@ const plugin: JupyterFrontEndPlugin<void> = {
       //  }
       // });
 
-      const languageServerSettings = options.language_servers || {};
+      const languageServerSettings = (options.language_servers ||
+        {}) as TLanguageServerConfigurations;
       connection_manager.updateServerConfigurations(languageServerSettings);
     }
 
     settingRegistry
       .load(plugin.id)
       .then(settings => {
-        updateOptions(settings);
+        // Store the initial server settings, to be sent asynchronously
+        // when the servers are initialized.
+        connection_manager.initial_configurations = (settings.composite
+          .language_servers || {}) as TLanguageServerConfigurations;
+
         settings.changed.connect(() => {
           updateOptions(settings);
         });

packages/jupyterlab-lsp/src/tokens.ts

@@ -8,6 +8,27 @@ export type TLanguageId = string;
 
 export type TSessionMap = Map<TLanguageServerId, SCHEMA.LanguageServerSession>;
 
+/**
+ * TODO: Should this support custom server keys?
+ */
+export type TServerKeys =
+  | 'pyls'
+  | 'bash-language-server'
+  | 'dockerfile-language-server-nodejs'
+  | 'javascript-typescript-langserver'
+  | 'unified-language-server'
+  | 'vscode-css-languageserver-bin'
+  | 'vscode-html-languageserver-bin'
+  | 'vscode-json-languageserver-bin'
+  | 'yaml-language-server'
+  | 'r-languageserver';
+
+export type TLanguageServerConfigurations = {
+  [k in TServerKeys]: {
+    serverSettings: any;
+  };
+};
+
 export interface ILanguageServerManager {
   sessionsChanged: ISignal<ILanguageServerManager, void>;
   sessions: TSessionMap;