Merge pull request #856 from krassowski/set-workspace-config-in-schema

Allow to pass default workspace config (`serverSettings`) in specs

Author: krassowski

atest/07_Configuration.robot

@@ -16,6 +16,15 @@ Python
     ...    undefined name 'foo' (pyflakes)
     ...    undefined name 'foo' (flake8)
 
+Python (programmatically)
+    [Documentation]    same as "Python" but changing the defaults in server specification via `workspace_configuration`
+    Settings Should Change Editor Diagnostics    Python    style.py    pylsp-with-config-override
+    ...    settings=100
+    ...    before=undefined name 'foo' (pyflakes)
+    ...    after=undefined name 'foo' (flake8)
+    ...    setting_key=priority
+    ...    needs reload=${True}
+
 YAML
     [Documentation]    Composer YAML files don't allow a "greetings" key
     Settings Should Change Editor Diagnostics    YAML    example.yaml    yaml-language-server
@@ -47,7 +56,7 @@ LaTeX
 
 *** Keywords ***
 Settings Should Change Editor Diagnostics
-    [Arguments]    ${language}    ${file}    ${server}    ${settings}    ${before}    ${after}    ${save command}=${EMPTY}    ${needs reload}=${False}
+    [Arguments]    ${language}    ${file}    ${server}    ${settings}    ${before}    ${after}    ${save command}=${EMPTY}    ${needs reload}=${False}    ${setting_key}=serverSettings
     ${before diagnostic} =    Set Variable    ${CSS DIAGNOSTIC}\[title*="${before}"]
     ${after diagnostic} =    Set Variable    ${CSS DIAGNOSTIC}\[title*="${after}"]
     ${tab} =    Set Variable    ${JLAB XP DOCK TAB}\[contains(., '${file}')]
@@ -65,7 +74,7 @@ Settings Should Change Editor Diagnostics
     END
     Page Should Not Contain    ${after diagnostic}
     Capture Page Screenshot    01-default-diagnostics-and-settings.png
-    Set Editor Content    {"language_servers": {"${server}": {"serverSettings": ${settings}}}}    ${CSS USER SETTINGS}
+    Set Editor Content    {"language_servers": {"${server}": {"${setting_key}": ${settings}}}}    ${CSS USER SETTINGS}
     Wait Until Page Contains    No errors found
     Capture Page Screenshot    02-default-diagnostics-and-unsaved-settings.png
     Click Element    css:button[title^\='Save User Settings']

atest/Keywords.resource

@@ -40,12 +40,14 @@ Initialize Global Variables
 Create Notebok Server Config
     [Documentation]    Copies in notebook server config file and updates accordingly
     [Arguments]    ${server_extension_enabled}=${True}
-    ${conf} =    Set Variable    ${NOTEBOOK DIR}${/}${NBSERVER CONF}
+    ${conf} =    Set Variable    ${NOTEBOOK DIR}${/}${JPSERVER CONF JSON}
     ${extra_node_roots} =    Create List    ${ROOT}
     ${port} =    Get Unused Port
     Set Global Variable    ${PORT}    ${port}
     Set Global Variable    ${URL}    http://localhost:${PORT}${BASE URL}
-    Copy File    ${FIXTURES}${/}${NBSERVER CONF}    ${conf}
+    Copy File    ${FIXTURES}${/}${JPSERVER CONF JSON}    ${conf}
+    Copy File    ${FIXTURES}${/}${JPSERVER CONF PY}    ${NOTEBOOK DIR}${/}${JPSERVER CONF PY}
+    Copy File    ${FIXTURES}${/}overrides.json    ${NOTEBOOK DIR}${/}overrides.json
     Update Jupyter Config    ${conf}    ServerApp
     ...    base_url=${BASE URL}
     ...    port=${PORT}

atest/Variables.resource

@@ -1,6 +1,7 @@
 *** Variables ***
 ${FIXTURES}                     ${CURDIR}${/}fixtures
-${NBSERVER CONF}                jupyter_server_config.json
+${JPSERVER CONF JSON}           jupyter_server_config.json
+${JPSERVER CONF PY}             jupyter_server_config.py
 ${SPLASH}                       id:jupyterlab-splash
 # to help catch hard-coded paths and encoding issues
 ${BASE URL}                     /@est/

atest/fixtures/jupyter_server_config.json

@@ -7,7 +7,10 @@
     "tornado_settings": {
       "page_config_data": {
         "buildCheck": false,
-        "buildAvailable": false
+        "buildAvailable": false,
+        "disabledExtensions": {
+          "jupyterlab-unfold": true
+        }
       }
     }
   }

atest/fixtures/jupyter_server_config.py

@@ -0,0 +1,18 @@
+from jupyter_lsp.specs.python_lsp_server import PythonLSPServer
+from jupyter_lsp.types import LanguageServerManagerAPI
+
+
+manager: LanguageServerManagerAPI = None   # type: ignore
+pylsp_base: dict = PythonLSPServer()(manager)
+
+
+c.LanguageServerManager.language_servers.update({
+    "pylsp-with-config-override": {
+        **pylsp_base["pylsp"],
+        "display_name": "pylsp (with-config-override)",
+        "workspace_configuration": {
+          "pylsp.plugins.flake8.enabled": True,
+          "pylsp.plugins.pyflakes.enabled": False
+        }
+    }
+})

atest/fixtures/overrides.json

@@ -0,0 +1,5 @@
+{
+    "@jupyterlab/statusbar-extension:plugin": {
+        "visible": true
+    }
+}

packages/jupyterlab-lsp/src/components/serverSettings.tsx

@@ -210,12 +210,22 @@ const TabbedObjectTemplateFactory = (options: {
       );
     };
     const renderServerMetadata = (spec: TLanguageServerSpec) => {
+      const workspaceConfig = spec.workspace_configuration as Record<
+        string,
+        any
+      >;
       return (
         <div>
           <h4 className={'lsp-ServerSettings-content-name'}>
             {spec.display_name}
           </h4>
           <ServerLinksList specification={spec} />
+          {workspaceConfig ? (
+            <p className={'lsp-ServerSettings-content-specOverrides'}>
+              {trans.__('Default values set programatically for: ') +
+                Object.keys(workspaceConfig).join(', ')}
+            </p>
+          ) : null}
         </div>
       );
     };

packages/jupyterlab-lsp/src/index.ts

@@ -49,7 +49,7 @@ import {
   ICodeOverridesRegistry,
   ILSPCodeOverridesManager
 } from './overrides/tokens';
-import { SettingsUIManager } from './settings';
+import { SettingsUIManager, SettingsSchemaManager } from './settings';
 import {
   IAdapterTypeOptions,
   ILSPAdapterManager,
@@ -154,7 +154,7 @@ export class LSPExtension implements ILSPExtension {
   connection_manager: DocumentConnectionManager;
   language_server_manager: LanguageServerManager;
   feature_manager: ILSPFeatureManager;
-  private _settingsUI: SettingsUIManager;
+  private _settingsSchemaManager: SettingsSchemaManager;
 
   constructor(
     public app: JupyterFrontEnd,
@@ -201,42 +201,42 @@ export class LSPExtension implements ILSPExtension {
 
     this.feature_manager = new FeatureManager();
 
-    this._settingsUI = new SettingsUIManager({
+    this._settingsSchemaManager = new SettingsSchemaManager({
       settingRegistry: this.setting_registry,
-      formRegistry: formRegistry,
-      console: this.console.scope('SettingsUIManager'),
       languageServerManager: this.language_server_manager,
       trans: trans,
+      console: this.console.scope('SettingsSchemaManager'),
       restored: app.restored
     });
-    this._settingsUI
-      .setupSchemaForUI(plugin.id)
+
+    if (formRegistry != null) {
+      const settingsUI = new SettingsUIManager({
+        settingRegistry: this.setting_registry,
+        console: this.console.scope('SettingsUIManager'),
+        languageServerManager: this.language_server_manager,
+        trans: trans,
+        schemaValidated: this._settingsSchemaManager.schemaValidated
+      });
+      // register custom UI field for `language_servers` property
+      formRegistry.addRenderer(
+        'language_servers',
+        settingsUI.renderForm.bind(settingsUI)
+      );
+    }
+
+    this._settingsSchemaManager
+      .setupSchemaTransform(plugin.id)
       .then(this._activate.bind(this))
       .catch(this._activate.bind(this));
   }
 
   private _activate(): void {
     this.setting_registry
       .load(plugin.id)
-      .then(settings => {
-        const options = this._settingsUI.normalizeSettings(
-          settings.composite as Required<LanguageServer>
-        );
-
-        // Store the initial server settings, to be sent asynchronously
-        // when the servers are initialized.
-        const initial_configuration = (options.language_servers ||
-          {}) as TLanguageServerConfigurations;
-        this.connection_manager.initial_configurations = initial_configuration;
-        // update the server-independent part of configuration immediately
-        this.connection_manager.updateConfiguration(initial_configuration);
-        this.connection_manager.updateLogging(
-          options.logAllCommunication,
-          options.setTrace
-        );
-
-        settings.changed.connect(() => {
-          this.updateOptions(settings);
+      .then(async settings => {
+        await this._updateOptions(settings, false);
+        settings.changed.connect(async () => {
+          await this._updateOptions(settings, true);
         });
       })
       .catch((reason: Error) => {
@@ -271,18 +271,28 @@ export class LSPExtension implements ILSPExtension {
     return this.code_overrides_manager.registry;
   }
 
-  private updateOptions(settings: ISettingRegistry.ISettings) {
-    const options = this._settingsUI.normalizeSettings(
+  private async _updateOptions(
+    settings: ISettingRegistry.ISettings,
+    afterInitialization = false
+  ) {
+    const options = await this._settingsSchemaManager.normalizeSettings(
       settings.composite as Required<LanguageServer>
     );
-
+    // Store the initial server settings, to be sent asynchronously
+    // when the servers are initialized.
     const languageServerSettings = (options.language_servers ||
       {}) as TLanguageServerConfigurations;
 
     this.connection_manager.initial_configurations = languageServerSettings;
     // TODO: if priorities changed reset connections
+
+    // update the server-independent part of configuration immediately
     this.connection_manager.updateConfiguration(languageServerSettings);
-    this.connection_manager.updateServerConfigurations(languageServerSettings);
+    if (afterInitialization) {
+      this.connection_manager.updateServerConfigurations(
+        languageServerSettings
+      );
+    }
     this.connection_manager.updateLogging(
       options.logAllCommunication,
       options.setTrace