Merge pull request #538 from bollwyvl/investigate-conf-d

add extra conf.d config reader for servers, fix conf.d names

Author: krassowski

.github/workflows/job.test.yml

@@ -429,5 +429,7 @@ jobs:
           set -eux
           jupyter labextension list
           jupyter server extension list
+          jupyter serverextension list
           jupyter labextension list 2>&1 | grep -ie "jupyterlab-lsp.*enabled.*ok" -
           jupyter server extension list 2>&1 | grep -ie "jupyter_lsp.*enabled" -
+          jupyter serverextension list 2>&1 | grep -ie "jupyter_lsp.*enabled" -

CHANGELOG.md

@@ -1,5 +1,16 @@
 ## CHANGELOG
 
+### `jupyter-lsp 1.1.4` (unreleased)
+
+- bug fixes:
+
+  - ensures `jupyter*_config.d` paths are searched for `language_servers`
+    as documented in _Configuring_ ([#535])
+  - uses more explicit file name for enabling `jupyter-lsp` in `notebook` and
+    `jupyter_server ([#535])
+
+[#535]: https://github.com/krassowski/jupyterlab-lsp/pull/535
+
 ### `@krassowski/jupyterlab-lsp 3.4.1` (2020-02-16)
 
 - bug fixes:

python_packages/jupyter_lsp/jupyter_lsp/constants.py

@@ -8,3 +8,6 @@
 EP_LISTENER_ALL_V1 = "jupyter_lsp_listener_all_v1"
 EP_LISTENER_CLIENT_V1 = "jupyter_lsp_listener_client_v1"
 EP_LISTENER_SERVER_V1 = "jupyter_lsp_listener_server_v1"
+
+# jupyter*config.d where language_servers can be defined
+APP_CONFIG_D_SECTIONS = ["_", "_notebook_", "_server_"]

python_packages/jupyter_lsp/jupyter_lsp/etc/jupyter_server_config.json renamed to python_packages/jupyter_lsp/jupyter_lsp/etc/jupyter-lsp-jupyter-server.json

@@ -5,6 +5,8 @@
 from typing import Dict, Text, Tuple
 
 import entrypoints
+from jupyter_core.paths import jupyter_config_path
+from jupyter_server.services.config import ConfigManager
 from jupyter_server.transutils import _
 from traitlets import Bool
 from traitlets import Dict as Dict_
@@ -13,6 +15,7 @@
 from traitlets import Unicode, default
 
 from .constants import (
+    APP_CONFIG_D_SECTIONS,
     EP_LISTENER_ALL_V1,
     EP_LISTENER_CLIENT_V1,
     EP_LISTENER_SERVER_V1,
@@ -32,6 +35,11 @@
 class LanguageServerManager(LanguageServerManagerAPI):
     """Manage language servers"""
 
+    conf_d_language_servers = Schema(
+        validator=LANGUAGE_SERVER_SPEC_MAP,
+        help=_("extra language server specs, keyed by implementation, from conf.d"),
+    )  # type: KeyedLanguageServerSpecs
+
     language_servers = Schema(
         validator=LANGUAGE_SERVER_SPEC_MAP,
         help=_("a dict of language server specs, keyed by implementation"),
@@ -72,6 +80,21 @@ def _default_language_servers(self):
     def _default_virtual_documents_dir(self):
         return os.getenv("JP_LSP_VIRTUAL_DIR", ".virtual_documents")
 
+    @default("conf_d_language_servers")
+    def _default_conf_d_language_servers(self):
+        language_servers = {}  # type: KeyedLanguageServerSpecs
+
+        manager = ConfigManager(read_config_path=jupyter_config_path())
+
+        for app in APP_CONFIG_D_SECTIONS:
+            language_servers.update(
+                **manager.get(f"jupyter{app}config")
+                .get(self.__class__.__name__, {})
+                .get("language_servers", {})
+            )
+
+        return language_servers
+
     def __init__(self, **kwargs):
         """Before starting, perform all necessary configuration"""
         super().__init__(**kwargs)
@@ -87,6 +110,7 @@ def init_language_servers(self) -> None:
 
         # copy the language servers before anybody monkeys with them
         language_servers_from_config = dict(self.language_servers)
+        language_servers_from_config.update(self.conf_d_language_servers)
 
         if self.autodetect:
             language_servers.update(self._autodetect_language_servers())

python_packages/jupyter_lsp/jupyter_lsp/etc/jupyter_notebook_config.json renamed to python_packages/jupyter_lsp/jupyter_lsp/etc/jupyter-lsp-notebook.json

@@ -11,9 +11,10 @@
 
 # local imports
 from jupyter_lsp import LanguageServerManager
+from jupyter_lsp.constants import APP_CONFIG_D_SECTIONS
 from jupyter_lsp.handlers import LanguageServersHandler, LanguageServerWebSocketHandler
 
-# these should always be available in a test environment ()
+# these should always be available in a test environment
 KNOWN_SERVERS = [
     "bash-language-server",
     "dockerfile-language-server-nodejs",
@@ -46,6 +47,28 @@ def manager() -> LanguageServerManager:
     return LanguageServerManager()
 
 
+@fixture
+def echo_spec():
+    return {"argv": ["echo", "no server here"], "languages": ["klingon"], "version": 2}
+
+
+@fixture
+def echo_conf_json(echo_spec) -> str:
+    return json.dumps(
+        {"LanguageServerManager": {"language_servers": {"_echo_": echo_spec}}},
+        indent=2,
+        sort_keys=True,
+    )
+
+
+@fixture(params=sorted(APP_CONFIG_D_SECTIONS))
+def app_config_d(request, tmp_path, monkeypatch) -> pathlib.Path:
+    conf_d = tmp_path / f"jupyter{request.param}config.d"
+    conf_d.mkdir()
+    monkeypatch.setenv("JUPYTER_CONFIG_PATH", f"{tmp_path}")
+    return conf_d
+
+
 @fixture(params=sorted(KNOWN_SERVERS))
 def known_server(request):
     return request.param

python_packages/jupyter_lsp/jupyter_lsp/manager.py

@@ -0,0 +1,6 @@
+def test_conf_d_language_servers(echo_conf_json, handlers, app_config_d):
+    (app_config_d / "echo.json").write_text(echo_conf_json)
+    handler, ws_handler = handlers
+    manager = handler.manager
+    manager.initialize()
+    assert "_echo_" in [*manager.language_servers]

python_packages/jupyter_lsp/jupyter_lsp/tests/conftest.py

@@ -15,11 +15,11 @@
     data_files=[
         (
             "etc/jupyter/jupyter_server_config.d",
-            ["jupyter_lsp/etc/jupyter_server_config.json"],
+            ["jupyter_lsp/etc/jupyter-lsp-jupyter-server.json"],
         ),
         (
             "etc/jupyter/jupyter_notebook_config.d",
-            ["jupyter_lsp/etc/jupyter_notebook_config.json"],
+            ["jupyter_lsp/etc/jupyter-lsp-notebook.json"],
         ),
     ],
 )

python_packages/jupyter_lsp/jupyter_lsp/tests/test_conf_d.py

@@ -26,6 +26,7 @@ def run_tests():
         "jupyter_lsp",
         "--cov-report",
         "term-missing:skip-covered",
+        "--no-cov-on-fail",
         "-p",
         "no:warnings",
         "--flake8",