Merge pull request #204 from bollwyvl/add-lab2

Support JupyterLab 2, add jupyterlab-go-to-definition to monorepo

Author: krassowski

.travis.yml

@@ -6,17 +6,26 @@ cache:
     - $HOME/.cache/yarn
     - $HOME/.cache/pip
 
+env:
+  global:
+    - TRAVIS_NVM_VERSION=0.35.2
+
 matrix:
   include:
     - python: '3.5'
-    - python: '3.6'
-    - python: '3.7'
+      env: TRAVIS_NODE_VERSION=10
     - python: '3.8'
+      env: TRAVIS_NODE_VERSION=12
+    - python: '3.9-dev'
+      env: TRAVIS_NODE_VERSION=13
     - os: osx
+      env: TRAVIS_NODE_VERSION=12
       osx_image: xcode11
       language: shell
 
 before_install:
+  - wget -qO- https://raw.githubusercontent.com/creationix/nvm/v${TRAVIS_NVM_VERSION}/install.sh | bash
+  - source ~/.nvm/nvm.sh && nvm install $TRAVIS_NODE_VERSION
   - python3 -m pip install -r requirements/utest.txt
   - python3 -m pip freeze
   - python3 setup.py sdist
@@ -34,8 +43,3 @@ script:
   - python3 -m jupyter serverextension list
   - python3 -m jupyter serverextension list | grep jupyter_lsp
   - python3 scripts/utest.py
-
-addons:
-  apt:
-    packages:
-      - nodejs

CHANGELOG.md

@@ -1,5 +1,17 @@
 ## CHANGELOG
 
+### `@krassowski/jupyterlab-lsp 1.0.0` (unreleased)
+
+- features
+
+  - supports JupyterLab 2.0
+
+### `@krassowski/jupyterlab_go_to_definition 1.0.0` (unreleased)
+
+- features
+
+  - supports JupyterLab 2.0
+
 ### `@krassowski/jupyterlab-lsp 0.8.0` (2020-03-12)
 
 - features

CONTRIBUTING.md

@@ -29,9 +29,9 @@ You can contribute to the project through:
 
 Development requires:
 
-- `nodejs` 8 or later
+- `nodejs` 10+
 - `python` 3.5+
-- `jupyterlab` 1.1
+- `jupyterlab` 2
 
 It is recommended to use a virtual environment (e.g. `virtualenv` or `conda env`)
 for development.

README.md

@@ -76,13 +76,12 @@ Open it searching for "Show diagnostics panel" in JupyterLab commands palette or
 
 Either:
 
-- JupyterLab >=1.1.4,<1.2
-- JupyterLab >=1.2.4,<1.3.0a0
+- JupyterLab >=2,<2.1
 
 And:
 
 - Python 3.5+
-- nodejs 8+
+- nodejs 10+
 
 ## Installation
 
@@ -95,16 +94,14 @@ Use of a python `virtualenv` or a conda env is also recommended.
 
    ```bash
    conda install -c conda-forge python=3
-   # or
-   conda install -c conda-forge jupyterlab=1.2
    ```
 
 1. install JupyterLab
 
    ```bash
-   conda install -c conda-forge jupyterlab=1.2
+   conda install -c conda-forge 'jupyterlab>=2,<2.1.0a0'
    # or
-   pip install jupyterlab=1.2
+   pip install 'jupyterlab>=2,<2.1.0a0'
    ```
 
 1. install the server extension:

atest/00_Smoke.robot

@@ -9,3 +9,8 @@ Lab Version
 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}
+    Should Be Equal    ${PAGE CONFIG["buildAvailable"]}    ${false}

atest/01_Editor.robot

@@ -4,8 +4,8 @@ Force Tags        ui:editor
 Resource          Keywords.robot
 
 *** Variables ***
-${MENU EDITOR}    xpath://div[contains(@class, 'p-Menu-itemLabel')][contains(., "Editor")]
-${MENU JUMP}      xpath://div[contains(@class, 'p-Menu-itemLabel')][contains(text(), "Jump to definition")]
+${MENU EDITOR}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(., "Editor")]
+${MENU JUMP}      xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Jump to definition")]
 ${CM CURSOR}      css:.CodeMirror-cursor
 ${CM CURSORS}     css:.CodeMirror-cursors:not([style='visibility: hidden'])
 

atest/Keywords.robot

@@ -18,13 +18,11 @@ Setup Server and Browser
     ${home} =    Set Variable    ${OUTPUT DIR}${/}home
     ${root} =    Normalize Path    ${OUTPUT DIR}${/}..${/}..${/}..
     Create Directory    ${home}
-    ${WORKSPACES DIR} =    Set Variable    ${OUTPUT DIR}${/}workspaces
+    Create Notebok Server Config    ${home}
     Initialize User Settings
-    ${app args} =    Set Variable    --no-browser --debug --NotebookApp.base_url\='${BASE}' --port\=${PORT} --NotebookApp.token\='${token}'
-    ${path args} =    Set Variable    --LabApp.user_settings_dir='${SETTINGS DIR.replace('\\', '\\\\')}' --LabApp.workspaces_dir\='${WORKSPACES DIR.replace('\\', '\\\\')}'
-    ${ext args} =    Set Variable    --LanguageServerManager.extra_node_roots\="['${root.replace('\\', '\\\\')}']"
+    ${cmd} =    Create Lab Launch Command    ${root}
     Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots
-    ${server} =    Start Process    jupyter-lab ${app args} ${path args} ${ext args}    shell=yes    env:HOME=${home}    cwd=${home}    stdout=${OUTPUT DIR}${/}lab.log
+    ${server} =    Start Process    ${cmd}    shell=yes    env:HOME=${home}    cwd=${home}    stdout=${OUTPUT DIR}${/}lab.log
     ...    stderr=STDOUT
     Set Global Variable    ${SERVER}    ${server}
     Open JupyterLab
@@ -33,6 +31,21 @@ Setup Server and Browser
     Set Global Variable    ${PAGE CONFIG}    ${config}
     Set Global Variable    ${LAB VERSION}    ${config["appVersion"]}
 
+Create Lab Launch Command
+    [Arguments]    ${root}
+    [Documentation]    Create a JupyterLab CLI shell string, escaping for traitlets
+    ${WORKSPACES DIR} =    Set Variable    ${OUTPUT DIR}${/}workspaces
+    ${app args} =    Set Variable    --no-browser --debug --NotebookApp.base_url\='${BASE}' --port\=${PORT} --NotebookApp.token\='${TOKEN}'
+    ${path args} =    Set Variable    --LabApp.user_settings_dir='${SETTINGS DIR.replace('\\', '\\\\')}' --LabApp.workspaces_dir\='${WORKSPACES DIR.replace('\\', '\\\\')}'
+    ${ext args} =    Set Variable    --LanguageServerManager.extra_node_roots\="['${root.replace('\\', '\\\\')}']"
+    ${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}
@@ -59,7 +72,7 @@ Open JupyterLab
     ${firefox} =    Which    firefox
     ${geckodriver} =    Which    geckodriver
     Create WebDriver    Firefox    executable_path=${geckodriver}    firefox_binary=${firefox}    service_log_path=${OUTPUT DIR}${/}geckodriver.log
-    Wait Until Keyword Succeeds    20x    3s    Go To    ${URL}lab?token=${TOKEN}
+    Wait Until Keyword Succeeds    20x    3s    Go To    ${URL}lab?reset&token=${TOKEN}
     Set Window Size    1024    768
     Wait For Splash
 
@@ -141,15 +154,21 @@ Open With JupyterLab Menu
     END
 
 Ensure File Browser is Open
-    ${sel} =    Set Variable    css:.p-TabBar-tab[data-id="filebrowser"]:not(.p-mod-current)
+    ${sel} =    Set Variable    css:.lm-TabBar-tab[data-id="filebrowser"]:not(.lm-mod-current)
     ${els} =    Get WebElements    ${sel}
     Run Keyword If    ${els.__len__()}    Click Element    ${sel}
 
-Rename Jupyter File
-    [Arguments]    ${old}    ${new}
+Open Context Menu for File
+    [Arguments]    ${file}
     Ensure File Browser is Open
     Click Element    css:button[title="Refresh File List"]
-    Open Context Menu    //span[@class='jp-DirListing-itemText']\[text() = '${old}']
+    ${selector} =    Set Variable    xpath://span[@class='jp-DirListing-itemText']\[text() = '${file}']
+    Wait Until Page Contains Element    ${selector}
+    Open Context Menu    ${selector}
+
+Rename Jupyter File
+    [Arguments]    ${old}    ${new}
+    Open Context Menu for File    ${old}
     Mouse Over    ${MENU RENAME}
     Click Element    ${MENU RENAME}
     Press Keys    None    CTRL+a
@@ -164,9 +183,7 @@ Input Into Dialog
     Click Element    ${DIALOG ACCEPT}
 
 Open ${file} in ${editor}
-    Ensure File Browser is Open
-    Click Element    css:button[title="Refresh File List"]
-    Open Context Menu    css:.jp-DirListing-item[title="${file}"]
+    Open Context Menu for File    ${file}
     Mouse Over    ${MENU OPEN WITH}
     Wait Until Page Contains Element    ${editor}
     Mouse Over    ${editor}

atest/Variables.robot

@@ -1,23 +1,25 @@
 *** Variables ***
+${FIXTURES}       ${CURDIR}${/}fixtures
+${NBSERVER CONF}    jupyter_notebook_config.json
 ${SPLASH}         id:jupyterlab-splash
 # to help catch hard-coded paths
 ${BASE}           /@est/
 # override with `python scripts/atest.py --variable HEADLESS:0`
 ${HEADLESS}       1
-${CMD PALETTE INPUT}    css:#command-palette .p-CommandPalette-input
-${CMD PALETTE ITEM ACTIVE}    css:#command-palette .p-CommandPalette-item.p-mod-active
+${CMD PALETTE INPUT}    css:#command-palette .lm-CommandPalette-input
+${CMD PALETTE ITEM ACTIVE}    css:#command-palette .lm-CommandPalette-item.lm-mod-active
 ${JLAB XP TOP}    //div[@id='jp-top-panel']
-${JLAB XP MENU ITEM LABEL}    //div[@class='p-Menu-itemLabel']
-${JLAB XP MENU LABEL}    //div[@class='p-MenuBar-itemLabel']
+${JLAB XP MENU ITEM LABEL}    //div[@class='lm-Menu-itemLabel']
+${JLAB XP MENU LABEL}    //div[@class='lm-MenuBar-itemLabel']
 ${JLAB CSS VERSION}    css:.jp-About-version
 ${CSS DIALOG OK}    css:.jp-Dialog .jp-mod-accept
-${MENU OPEN WITH}    xpath://div[contains(@class, 'p-Menu-itemLabel')][contains(text(), "Open With")]
+${MENU OPEN WITH}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Open With")]
 # R is missing on purpose (may need to use .)
-${MENU RENAME}    xpath://div[contains(@class, 'p-Menu-itemLabel')][contains(., "ename")]
+${MENU RENAME}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(., "ename")]
 # N is missing on purpose
-${MENU NOTEBOOK}    xpath://div[contains(@class, 'p-Menu-itemLabel')][contains(., "otebook")]
+${MENU NOTEBOOK}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(., "otebook")]
 ${DIAGNOSTICS PANEL}    id:lsp-diagnostics-panel
-${DIAGNOSTIC PANEL CLOSE}    css:.p-DockPanel-tabBar .p-TabBar-tab[data-id="lsp-diagnostics-panel"] .p-TabBar-tabCloseIcon
+${DIAGNOSTIC PANEL CLOSE}    css:.lm-DockPanel-tabBar .lm-TabBar-tab[data-id="lsp-diagnostics-panel"] .lm-TabBar-tabCloseIcon
 ${DIALOG WINDOW}    css:.jp-Dialog
 ${DIALOG INPUT}    css:.jp-Input-Dialog input
 ${DIALOG ACCEPT}    css:button.jp-Dialog-button.jp-mod-accept

atest/fixtures/jupyter_notebook_config.json

@@ -0,0 +1,10 @@
+{
+  "LabApp": {
+    "tornado_settings": {
+      "page_config_data": {
+        "buildCheck": false,
+        "buildAvailable": false
+      }
+    }
+  }
+}

azure-pipelines.yml

@@ -14,16 +14,15 @@ variables:
   YARN_CACHE_FOLDER: $(Pipeline.Workspace)/.yarn
 
   PY_JLSP_VERSION: 0.8.0
-  JS_JLLSP_VERSION: 0.8.0
+  JS_JLLSP_VERSION: 1.0.0
+  JS_JLG2D_VERSION: 1.0.0
 
   FIRST_PARTY_LABEXTENSIONS: >-
     packages/jupyterlab-lsp/krassowski-jupyterlab-lsp-$(JS_JLLSP_VERSION).tgz
 
-  THIRD_PARTY_LABEXTENSIONS: >-
-    @krassowski/jupyterlab_go_to_definition
-
   LINKED_EXTENSIONS: >-
     packages/lsp-ws-connection
+    packages/jupyterlab-go-to-definition
 
 jobs:
   - template: ci/job.lint.yml