JupyterLab 3 support v2

.github/ISSUE_TEMPLATE/language_server_byo.md

@@ -46,7 +46,7 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
 - Language Server Spec
 
 ```python
-# jupyter_notebook_config.json
+# jupyter_server_config.json
 {
   "LanguageServerManager": {
     "language_servers": {

.github/workflows/job.lint.yml

@@ -19,7 +19,7 @@ jobs:
         os: [ubuntu-16.04]
         python: [3.8]
         nodejs: ['>=12,<13.0.0a0']
-        lab: ['>=2,<3.0.0a0']
+        lab: ['>=3.0.0,<4.0.0a0']
     steps:
       - uses: actions/checkout@v2
 

.github/workflows/job.test.yml

@@ -13,8 +13,8 @@ defaults:
 
 env:
   # TODO extract these from files instead
-  PY_JLSP_VERSION: 0.9.3
-  JS_JLLSP_VERSION: 2.1.2
+  PY_JLSP_VERSION: 1.0.0
+  JS_JLLSP_VERSION: 3.0.0
   JS_JLG2D_VERSION: 1.0.0
 
   PYTHONUNBUFFERED: 1
@@ -37,7 +37,7 @@ jobs:
       matrix:
         os: [ubuntu, macos, windows]
         python: [3.6, 3.7, 3.8]
-        lab: ['>=2.2.0,<3.0.0a0']
+        lab: ['>=3.0.0,<4.0.0a0']
         include:
           # if using 3.6, use an old node
           - python: 3.6
@@ -108,14 +108,23 @@ jobs:
       - name: Build the extension
         run: jlpm build
 
-      - name: Build python distributions
-        run: python setup.py sdist bdist_wheel
+      - name: Build server extension (jupyter_lsp) distribution
+        run: cd python_packages/jupyter_lsp && python setup.py sdist bdist_wheel
 
-      - name: Build npm bundles
-        run: jlpm lerna run bundle
+      - name: Install server extension (jupyter_lsp) wheel
+        run: cd python_packages/jupyter_lsp/dist && python -m pip install jupyter_lsp-${{ env.PY_JLSP_VERSION }}-py3-none-any.whl --no-deps
 
-      - name: Install python wheel
-        run: cd dist && python -m pip install jupyter_lsp-${{ env.PY_JLSP_VERSION }}-py3-none-any.whl --no-deps
+      - name: List server extensions
+        run: jupyter server extension list
+
+      - name: Build frontend extension (jupyterlab_lsp) distribution
+        run: cd python_packages/jupyterlab_lsp && python setup.py sdist bdist_wheel
+
+      - name: Install frontend extension (jupyterlab_lsp) wheel
+        run: cd python_packages/jupyterlab_lsp/dist && python -m pip install jupyterlab_lsp-${{ env.JS_JLLSP_VERSION }}-py3-none-any.whl --no-deps
+
+      - name: List frontend extensions
+        run: jupyter labextension list
 
       - name: Find out jedi cache location
         id: jedi-cache
@@ -167,27 +176,9 @@ jobs:
       #        summaryFileLocation: 'packages/${{ js_package }}/coverage/cobertura-coverage.xml'
       #      condition: always()
 
-      - name: List server extensions
-        run: jupyter serverextension list
-
       - name: Run python tests
         run: python scripts/utest.py
 
-      - name: Install support packages
-        run: jupyter labextension link --debug --no-build ${{ env.LINKED_EXTENSIONS }}
-
-      - name: Install labextensions
-        run: jupyter labextension install --debug --no-build packages/jupyterlab-lsp/krassowski-jupyterlab-lsp-${{ env.JS_JLLSP_VERSION }}.tgz
-
-      - name: List labextensions before build
-        run: jupyter labextension list
-
-      - name: Build lab
-        run: jupyter lab build --debug --dev-build=False --minimize=True
-
-      - name: List labextensions after build
-        run: jupyter labextension list
-
       - name: Run browser tests
         run: python scripts/atest.py --exclude expect:fail
 

.gitignore

@@ -116,3 +116,6 @@ coverage/
 _*.d.ts
 _build
 .virtual_documents/
+
+# Built labextensions
+python_packages/jupyterlab_lsp/labextensions/

.prettierignore

@@ -2,6 +2,7 @@
 .mypy_cache
 .pytest_cache
 .yarn-packages
+**/_*.d.ts
 **/.ipynb_checkpoints
 **/*.egg-info
 **/build

CHANGELOG.md

@@ -1,5 +1,20 @@
 ## CHANGELOG
 
+### `@krassowski/jupyterlab-lsp 3.0.0` (2021-01-XX)
+
+- features
+
+  - support for JupyterLab 3.0 ([#452], [#402])
+
+### `jupyter-lsp 1.0.0` (2021-XX-XX)
+
+- features
+
+  - support for JupyterLab 3.0 ([#452], [#402])
+
+[#402]: https://github.com/krassowski/jupyterlab-lsp/issues/402
+[#452]: https://github.com/krassowski/jupyterlab-lsp/issues/452
+
 ### `@krassowski/jupyterlab-lsp 2.1.2` (2021-01-02)
 
 - features

CONTRIBUTING.md

@@ -29,11 +29,11 @@ You can contribute to the project through:
 
 Development requires, at a minimum:
 
-- `nodejs >=10.12,<15`
+- `nodejs >=12,<15`
 - `python >=3.6,<3.9.0a0`
-  - Python 3.6 and 3.8 are also tested on CI
+  - Python 3.7 and 3.8 are also tested on CI
   - Python 3.6 has issues on Windows
-- `jupyterlab >=2.2.0,<3.0.0a0`
+- `jupyterlab >=3.0.0,<4.0.0a0`
 
 It is recommended to use a virtual environment (e.g. `virtualenv` or `conda env`)
 for development.
@@ -67,7 +67,7 @@ This performs all of the basic setup steps, and is used for the binder demo.
 Install `jupyter-lsp` from source in your virtual environment:
 
 ```bash
-python -m pip install -e .
+python -m pip install -e . --ignore-installed --no-deps -vv
 ```
 
 Enable the server extension:
@@ -80,9 +80,8 @@ Install `npm` dependencies, build TypeScript packages, and link
 to JupyterLab for development:
 
 ```bash
-jlpm
-jlpm build
-jlpm lab:link
+jlpm bootstrap
+pip install .
 ```
 
 ### Frontend Development
@@ -328,8 +327,8 @@ server it will always win vs an auto-configured one.
 
 > See the built-in [specs][] for implementations and some [helpers][].
 
-[specs]: https://github.com/krassowski/jupyterlab-lsp/tree/master/py_src/jupyter_lsp/specs
-[helpers]: https://github.com/krassowski/jupyterlab-lsp/blob/master/py_src/jupyter_lsp/specs/utils.py
+[specs]: https://github.com/krassowski/jupyterlab-lsp/tree/master/python_packages/jupyter_lsp/src/specs
+[helpers]: https://github.com/krassowski/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/src/specs/utils.py
 
 A spec is a python function that accepts a single argument, the
 `LanguageServerManager`, and returns a dictionary of the form:
@@ -349,7 +348,7 @@ the server) and `languages` (which languages to respond to), but many number of
 other options to enrich the user experience are available in the
 [schema][] and are exercised by the current `entry_points`-based [specs][].
 
-[schema]: https://github.com/krassowski/jupyterlab-lsp/blob/master/py_src/jupyter_lsp/schema/schema.json
+[schema]: https://github.com/krassowski/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/src/schema/schema.json
 
 The spec should only be advertised if the command _could actually_ be run:
 
@@ -368,7 +367,7 @@ The spec should only be advertised if the command _could actually_ be run:
   - use a helper script to encapsulate some complexity.
     - See the [r spec][] for an example
 
-[r spec]: https://github.com/krassowski/jupyterlab-lsp/blob/master/py_src/jupyter_lsp/specs/r_languageserver.py
+[r spec]: https://github.com/krassowski/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/src/specs/r_languageserver.py
 
 ##### Example: making a pip-installable `cool-language-server` spec
 

README.md

@@ -77,9 +77,12 @@ Use context menu on rows in the panel to filter out diagnostics or copy their me
 
 You will need to have all of the following installed:
 
-- JupyterLab >=2.2.0,<3.0.0a0
+- JupyterLab >=3.0.0,<4.0.0a0
 - Python 3.6+
-- nodejs 10.12+
+
+In addition, if you wish to use javascript, html, markdown or any other NodeJS-based language server you will need to have appropriate NodeJS version installed.
+
+> Note: Installation for JupyterLab 2.x requires a different procedure, please consult the documentation for the extension [version 2.x][version 2.x docs].
 
 ## Installation
 
@@ -94,36 +97,19 @@ Use of a python `virtualenv` or a conda env is also recommended.
    conda install -c conda-forge python=3
    ```
 
-1. install JupyterLab and the server extension
+1. install JupyterLab and the extensions
 
    ```bash
-   conda install -c conda-forge 'jupyterlab>=2.2,<3.0.0a0' jupyter-lsp
+   conda install -c conda-forge 'jupyterlab>=3.0.0,<4.0.0a0' jupyterlab-lsp
    # or
-   pip install 'jupyterlab>=2.2,<3.0.0a0' jupyter-lsp
+   pip install 'jupyterlab>=3.0.0,<4.0.0a0' jupyterlab-lsp
    ```
 
+   > Note: `jupyterlab-lsp` provides both the server extension and the lab extension.
+
    > Note: With conda, you could take advantage of the bundles: `jupyter-lsp-python`
    > or `jupyter-lsp-r` to install both the server extension and the language server.
 
-1. install `nodejs`
-
-   ```bash
-   conda install -c conda-forge nodejs
-   # or one of the following, as an administrator
-   choco install nodejs            # Windows with Chocolatey
-   sudo apt-get install nodejs     # Debian/Ubuntu
-   sudo brew install nodejs        # MacOS with Homebrew
-   sudo dnf install nodejs         # Fedora
-   sudo yum install nodejs         # RHEL/CentOS
-   ```
-
-1. install the frontend extension:
-
-   ```bash
-   jupyter labextension install @krassowski/jupyterlab-lsp           # for JupyterLab 2.x
-   # jupyter labextension install @krassowski/[email protected]   # for JupyterLab 1.x
-   ```
-
 1. install LSP servers for languages of your choice; for example, for Python
    ([pyls](https://github.com/palantir/python-language-server)) and
    R ([languageserver](https://github.com/REditorSupport/languageserver)) servers:
@@ -165,27 +151,6 @@ Use of a python `virtualenv` or a conda env is also recommended.
    (written for a related jupyterlab-go-to-definition extension) is available
    [here](https://github.com/krassowski/jupyterlab-go-to-definition/blob/master/README.md#which-directories-to-symlink).
 
-### Updating
-
-To update previously installed extensions:
-
-```bash
-conda update jupyter-lsp
-jupyter labextension update @krassowski/jupyterlab-lsp
-# or
-pip install -U jupyter-lsp
-jupyter labextension update @krassowski/jupyterlab-lsp
-```
-
-### Getting the latest alpha/beta/RC version
-
-Use `install` command (update does not seem to work) appending `@<0.x.y.rc-z>` to the
-extension name, like this:
-
-```bash
-jupyter labextension install @krassowski/[email protected]
-```
-
 ### Configuring the servers
 
 Server configurations can be edited using the Advanced Settings editor in JupyterLab (_Settings > Advanced Settings Editor_). For settings specific to each server, please see the [table of language servers][language-servers]. Example settings might include:
@@ -265,3 +230,4 @@ This would not be possible without the fantastic initial work at
 
 [language-servers]: https://jupyterlab-lsp.readthedocs.io/en/latest/Language%20Servers.html
 [installation-documentation]: https://jupyterlab-lsp.readthedocs.io/en/latest/Installation.html
+[version 2.x docs]: https://jupyterlab-lsp.readthedocs.io/en/2.x/Installation.html

atest/05_Features/Completion.robot

@@ -154,7 +154,7 @@ VSCode Theme Works
 
 VSCode Dark Theme Works
     ${file} =    Set Variable    Completion.ipynb
-    Lab Command    Use JupyterLab Dark Theme
+    Lab Command    Use Theme: JupyterLab Dark
     Wait For Splash
     Capture Page Screenshot    00-theme-changed.png
     Configure JupyterLab Plugin    {"theme": "vscode"}    plugin id=${COMPLETION PLUGIN ID}
@@ -166,7 +166,7 @@ VSCode Dark Theme Works
     Capture Page Screenshot    02-completions-shown.png
     Completer Should Suggest    TabError
     Completer Should Include Icon    lsp:vscode-class-dark
-    Lab Command    Use JupyterLab Light Theme
+    Lab Command    Use Theme: JupyterLab Light
     Wait For Splash
 
 Works Without A Theme

atest/05_Features/Hover.robot

@@ -53,6 +53,7 @@ Last Occurrence
 Trigger Via Hover With Modifier
     [Arguments]    ${sel}
     # bring the cursor to the element
+    Wokraround Visibility Problem    ${sel}
     Mouse Over    ${sel}
     # move it back and forth (wiggle) while hodling the ctrl modifier
     Mouse Over With Control    ${sel}    x_wiggle=5
@@ -62,6 +63,7 @@ Trigger Via Hover With Modifier
 Trigger Via Modifier Key Press
     [Arguments]    ${sel}
     # bring the cursor to the element
+    Wokraround Visibility Problem    ${sel}
     Mouse Over    ${sel}
     Wait Until Page Contains Element    ${HOVER_SIGNAL}    timeout=10s
     Mouse Over And Wiggle    ${sel}    5
@@ -76,3 +78,8 @@ Trigger Tooltip
 
 Setup Hover Test
     Setup Notebook    Python    Hover.ipynb
+
+Wokraround Visibility Problem
+    [Arguments]    ${sel}
+    ${width}    ${height} =    Get Element Size    ${sel}
+    Run Keyword If    ${width} == 0    Cover Element    ${sel}    # don't know why but otherwise it raises Message: TypeError: rect is undefined

atest/06_Style.robot

@@ -23,7 +23,7 @@ Screenshot Editor Themes with Lab Theme
     Set Screenshot Directory    ${SCREENSHOTS DIR}${/}style${/}${norm lab theme}
     Copy File    examples${/}${file}    ${NOTEBOOK DIR}${/}${file}
     Run Keyword If    "${THEME NAMES}" == ""    Wait Until Keyword Succeeds    3x    1s    Get Theme Names
-    Lab Command    Use ${lab theme} Theme
+    Lab Command    Use Theme: ${lab theme}
     Try to Close All Tabs
     Setup Notebook    python    ${notebook}    isolated=${False}
     Open ${file} in ${MENU EDITOR}

atest/Keywords.robot

@@ -65,6 +65,9 @@ Initialize User Settings
     Create File
     ...    ${SETTINGS DIR}${/}@jupyterlab${/}codemirror-extension${/}commands.jupyterlab-settings
     ...    {"styleActiveLine": true}
+    Create File
+    ...    ${SETTINGS DIR}${/}@jupyterlab${/}apputils-extension${/}palette.jupyterlab-settings
+    ...    {"modal": false}
 
 Reset Plugin Settings
     [Arguments]    ${package}=jupyterlab-lsp    ${plugin}=plugin
@@ -200,7 +203,7 @@ Open Context Menu for File
     [Arguments]    ${file}
     Ensure File Browser is Open
     Click Element    ${JLAB CSS REFRESH FILES}
-    ${selector} =    Set Variable    xpath://span[@class='jp-DirListing-itemText']\[text() = '${file}']
+    ${selector} =    Set Variable    xpath://span[@class='jp-DirListing-itemText']/span\[text() = '${file}']
     Wait Until Page Contains Element    ${selector}    timeout=10s
     Open Context Menu    ${selector}
 

atest/Variables.robot

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

atest/config.py

@@ -7,7 +7,7 @@
 
 
 def update_jupyter_config(path, has_traits, **key_values):
-    """update an existing jupyter_notebook_config.json"""
+    """update an existing jupyter_server_config.json"""
     p = Path(path)
     conf = json.loads(p.read_text(**ENC))
 

binder/environment.yml

@@ -7,10 +7,10 @@ channels:
 dependencies:
   # runtime dependencies
   - python >=3.6,<3.9.0a0
-  - jupyterlab >=2.2.0,<3.0.0a0
-  - notebook >=4.3.1
+  - jupyterlab >=3.0.0,<4.0.0a0
+  - jupyter_server >=1.1.2
   # build dependencies
-  - nodejs >=10.12,<15
+  - nodejs >=12,<15
   # for python language server (and development)
   - flake8 >=3.5
   - pip