[wip] Add Language Server Proxy Kernel

.github/ISSUE_TEMPLATE/bug_report.md

@@ -38,9 +38,9 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
 - Browser and version:
 - JupyterLab version:
 
-<details><summary>Required: installed server extensions</summary>
+<details><summary>Required: installed Kernel</summary>
 <pre>
-Paste the output from running `jupyter serverextension list` from the command line here.
+Paste the output from running `jupyter kernelspec list` from the command line here.
 You may want to sanitize the paths in the output.
 </pre>
 </details>

.travis.yml

@@ -42,6 +42,7 @@ before_script:
 
 script:
   - jlpm test
-  - python3 -m jupyter serverextension list
-  - python3 -m jupyter serverextension list | grep jupyter_lsp
   - python3 scripts/utest.py
+  - python3 -m jupyter kernelspec list
+  - python3 -m jupyter lsp kernelspec install
+  - python3 -m jupyter kernelspec list | grep jupyter-lsp-kernel

CHANGELOG.md

@@ -1,5 +1,33 @@
 ## CHANGELOG
 
+### `@krassowski/jupyterlab-lsp 2.0.0` (unreleased)
+
+- features
+
+  - replaces use of custom WebSockets and REST API with Jupyter Kernel Comms
+  - substantially reduced total install size (1.5mb -> ???kb)
+
+- dependencies
+
+  - removes run-time dependencies
+    - `krassowski/lsp-ws-connection`
+    - `event-emitter`
+    - `vscode-language-server-protocol` and friends
+
+### `jupyter-lsp 1.0.0` (unreleased)
+
+- features
+
+  - replaces the former server extension with a Language Server Kernel
+  - adds `jupyter lsp` CLI target for
+    - installing the kernelspec
+
+### `@krassowski/jupyterlab_go_to_definition 2.0.0` (unreleased)
+
+- dependencies
+
+  - supports JupyterLab 2.0
+
 ### `@krassowski/jupyterlab-lsp 1.0.1` (unreleased)
 
 - bug fixes

CONTRIBUTING.md

@@ -62,10 +62,10 @@ Install `jupyter-lsp` from source in your virtual environment:
 python -m pip install -e .
 ```
 
-Enable the server extension:
+Install the Language Server Kernel spec:
 
 ```bash
-jupyter serverextension enable --sys-prefix --py jupyter_lsp
+jupyter lsp kernselspec install --sys-prefix
 ```
 
 Install `npm` dependencies, build TypeScript packages, and link

README.md

@@ -76,7 +76,7 @@ Open it searching for "Show diagnostics panel" in JupyterLab commands palette or
 
 Either:
 
-- JupyterLab >=2.1.0,<3.0.0a0
+- JupyterLab >=2.2.0,<3.0.0a0
 
 And:
 
@@ -104,12 +104,18 @@ Use of a python `virtualenv` or a conda env is also recommended.
    pip install 'jupyterlab>=2.1,<3.0.0a0'
    ```
 
-1. install the server extension:
+1. install the kernel:
 
    ```bash
    pip install jupyter-lsp
    ```
 
+1. enable the kernelspec
+
+   ```bash
+   jupyter lsp kernelspec install
+   ```
+
 1. install `nodejs`
 
    ```bash

atest/00_Smoke.robot

@@ -6,10 +6,6 @@ Resource          Keywords.robot
 Lab Version
     Capture Page Screenshot    00-smoke.png
 
-Root URI
-    [Documentation]    the rootUri should be set in the page config
-    Should Not Be Empty    ${PAGE CONFIG["rootUri"]}
-
 Build Skipped
     [Documentation]    Pre-flight the page config
     Should Be Equal    ${PAGE CONFIG["buildCheck"]}    ${False}

atest/05_Features/Completion.robot

@@ -27,7 +27,7 @@ Works With Kernel Running
     Should Contain    ${content}    TabError
 
 Works When Kernel Is Shut Down
-    Lab Command    Shut Down All Kernels…
+    Switch Kernel    No Kernel
     Capture Page Screenshot    01-shutting-kernels.png
     Accept Default Dialog Option
     Capture Page Screenshot    02-kernels-shut.png

atest/Keywords.robot

@@ -4,7 +4,9 @@ Library           SeleniumLibrary
 Library           OperatingSystem
 Library           Process
 Library           String
+Library           Collections
 Library           ./ports.py
+Library           ./config.py
 
 *** Keywords ***
 Setup Server and Browser
@@ -18,7 +20,7 @@ Setup Server and Browser
     ${home} =    Set Variable    ${OUTPUT DIR}${/}home
     ${root} =    Normalize Path    ${OUTPUT DIR}${/}..${/}..${/}..
     Create Directory    ${home}
-    Create Notebok Server Config    ${home}
+    Initialize Server Config    ${home}    ${root}
     Initialize User Settings
     ${cmd} =    Create Lab Launch Command    ${root}
     Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots
@@ -43,11 +45,6 @@ Create Lab Launch Command
     ${cmd} =    Set Variable    jupyter-lab ${app args} ${path args} ${ext args}
     [Return]    ${cmd}
 
-Create Notebok Server Config
-    [Arguments]    ${home}
-    [Documentation]    Copies in notebook server config file to disables npm/build checks
-    Copy File    ${FIXTURES}${/}${NBSERVER CONF}    ${home}${/}${NBSERVER CONF}
-
 Setup Suite For Screenshots
     [Arguments]    ${folder}
     Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots${/}${folder}
@@ -253,14 +250,20 @@ Place Cursor In Cell Editor At
     Execute JavaScript    return document.querySelector('.jp-Cell:nth-child(${cell_nr}) .CodeMirror').CodeMirror.setCursor({line: ${line} - 1, ch: ${character}})
 
 Wait Until Fully Initialized
-    Wait Until Element Contains    ${STATUSBAR}    Fully initialized    timeout=60s
+    Wait Until Element Contains    ${STATUSBAR}    Fully initialized    timeout=30s
 
 Open Context Menu Over
     [Arguments]    ${sel}
     Wait Until Keyword Succeeds    10 x    0.1 s    Mouse Over    ${sel}
     Wait Until Keyword Succeeds    10 x    0.1 s    Click Element    ${sel}
     Wait Until Keyword Succeeds    10 x    0.1 s    Open Context Menu    ${sel}
 
+Switch Kernel
+    [Arguments]    ${kernel name}
+    Click Element    css:.jp-Toolbar-kernelName
+    Select From List By Label    css:.jp-Dialog select    ${kernel name}
+    Click Element    css:.jp-mod-accept
+
 Prepare File for Editing
     [Arguments]    ${Language}    ${Screenshots}    ${file}
     Set Tags    language:${Language.lower()}

atest/Variables.robot

@@ -1,6 +1,6 @@
 *** Variables ***
 ${FIXTURES}       ${CURDIR}${/}fixtures
-${NBSERVER CONF}    jupyter_notebook_config.json
+${ROOT}           ${CURDIR}${/}..
 ${SPLASH}         id:jupyterlab-splash
 # to help catch hard-coded paths
 ${BASE}           /@est/

atest/config.py

@@ -0,0 +1,22 @@
+""" handle jupyter config
+"""
+import json
+from pathlib import Path
+
+NO_BUILD = {
+    "LabApp": {
+        "tornado_settings": {
+            "page_config_data": {"buildCheck": False, "buildAvailable": False}
+        }
+    }
+}
+
+
+def initialize_server_config(home, root):
+    """ make a notebook server config file
+    """
+    config = dict(LanguageServerManager=dict(extra_node_roots=[root]), **NO_BUILD)
+
+    (Path(home) / "jupyter_notebook_config.json").write_text(
+        json.dumps(config, indent=2, sort_keys=True)
+    )

azure-pipelines.yml

@@ -13,18 +13,16 @@ variables:
   ATEST_RETRIES: 3
   YARN_CACHE_FOLDER: $(Pipeline.Workspace)/.yarn
 
-  PY_JLSP_VERSION: 0.8.0
-  JS_JLLSP_VERSION: 1.0.0
-  JS_JLG2D_VERSION: 1.0.0
+  PY_JLSP_VERSION: 1.0.0
+  JS_JLLSP_VERSION: 2.0.0
+  JS_JLG2D_VERSION: 2.0.0
 
   FIRST_PARTY_LABEXTENSIONS: >-
     packages/jupyterlab-lsp/krassowski-jupyterlab-lsp-$(JS_JLLSP_VERSION).tgz
 
   LINKED_EXTENSIONS: >-
-    packages/lsp-ws-connection
     packages/jupyterlab-go-to-definition
 
 jobs:
   - template: ci/job.lint.yml
   - template: ci/job.test.yml
-  - template: ci/job.docs.yml

binder/environment.yml

@@ -7,7 +7,7 @@ channels:
 dependencies:
   # runtime dependencies
   - python >=3.7,<3.8.0a0
-  - jupyterlab >=2.1.0,<3.0.0a0
+  - jupyterlab >=2.2.0,<3.0.0a0
   - notebook >=4.3.1
   # build dependencies
   - nodejs >=10,<14

binder/postBuild

@@ -2,7 +2,7 @@
 set -eux
 # do a dev install of the server side
 python -m pip install -e . --ignore-installed --no-deps -vv
-jupyter serverextension enable --sys-prefix --py jupyter_lsp
+jupyter lsp kernelspec install
 
 # should have no extensions
 jupyter labextension list
@@ -11,7 +11,7 @@ jupyter labextension list
 jlpm bootstrap
 
 # link all pieces to lab (no build)
-jlpm lab:link && jupyter labextension list
+jlpm lab:link
 
 # list extensions before build
 jupyter labextension list

ci/env-test.yml.in

@@ -10,6 +10,7 @@ dependencies:
   - jupyterlab {lab}
   # build dependencies
   - nodejs {nodejs}
+  - python-libarchive-c
   # for python language server (and development)
   - flake8 >=3.5
   - python-language-server

ci/job.docs.yml

@@ -6,7 +6,7 @@ parameters:
   pythons:
     - name: ThreeSeven
       spec: '>=3.7,<3.8.0a0'
-      lab: '>=2,<3.0.0a0'
+      lab: '>=2.2.0,<3.0.0a0'
       nodejs: '>=12,<13.0.0a0'
   env_update: conda env update -n jupyterlab-lsp --file env-test.yml --quiet
   env_docs: conda env update -n jupyterlab-lsp --file requirements/docs.yml --quiet

ci/job.lint.yml

@@ -6,7 +6,7 @@ parameters:
   pythons:
     - name: ThreeSeven
       spec: '>=3.7,<3.8.0a0'
-      lab: '>=2,<3.0.0a0'
+      lab: '>=2.2.0,<3.0.0a0'
       nodejs: '>=12,<13.0.0a0'
   env_update: conda env update -n jupyterlab-lsp --file env-test.yml --quiet
   env_lint: conda env update -n jupyterlab-lsp --file requirements/lint.yml --quiet

ci/job.test.yml

@@ -12,15 +12,15 @@ parameters:
   pythons:
     - name: ThreeSix
       spec: '=3.6'
-      lab: '>=2.1.0,<3.0.0a0'
+      lab: '>=2.2.0,<3.0.0a0'
       nodejs: '>=10,<11.0.0.a0'
     - name: ThreeSeven
       spec: '=3.7'
-      lab: '>=2.1.0,<3.0.0a0'
+      lab: '>=2.2.0,<3.0.0a0'
       nodejs: '>=12,<13.0.0a0'
     - name: ThreeEight
       spec: '=3.8'
-      lab: '>=2.1.0,<3.0.0a0'
+      lab: '>=2.2.0,<3.0.0a0'
       nodejs: '>=13,<14.0.0a0'
   js_cov_packages:
     - jupyterlab-go-to-definition
@@ -88,8 +88,14 @@ jobs:
                       summaryFileLocation: 'packages/${{ js_package }}/coverage/cobertura-coverage.xml'
                     condition: always()
 
-              - script: ${{ platform.activate }} && jupyter serverextension list
-                displayName: list server extensions
+              - script: ${{ platform.activate }} && jupyter kernelspec list
+                displayName: list kernels
+
+              - script: ${{ platform.activate }} && jupyter lsp kernelspec install
+                displayName: install kernel
+
+              - script: ${{ platform.activate }} && jupyter kernelspec list
+                displayName: list kernels (again)
 
               - script: ${{ platform.activate }} && python scripts/utest.py --test-run-title="Pytest ${{ platform.name }}${{ python.name }}"
                 displayName: run python tests

docs/Architecture.ipynb

@@ -165,7 +165,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.5"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,