Merge branch 'master' into krassowski-update-docs-versions

Author: krassowski

.prettierignore

@@ -24,6 +24,7 @@ envs
 examples/app/build
 examples/app/schemas
 examples/app/themes
+htmlcov
 jupyterlab/geckodriver
 jupyterlab/schemas
 jupyterlab/staging/index.js

CHANGELOG.md

@@ -7,9 +7,11 @@
   - fixes currently-highlighted token in dark editor themes against light lab theme
     (and vice versa) ([#195][])
   - restores sorting order-indicating caret icons in diagnostics panel table ([#261][])
+  - handles document open and change operation ordering more predictably ([#284][])
 
 [#195]: https://github.com/krassowski/jupyterlab-lsp/issues/195
 [#261]: https://github.com/krassowski/jupyterlab-lsp/issues/261
+[#284]: https://github.com/krassowski/jupyterlab-lsp/pull/284
 
 ### `@krassowski/jupyterlab-lsp 1.0.0` (2020-03-14)
 

README.md

@@ -194,11 +194,57 @@ jupyter labextension install @krassowski/[email protected]
 
 ### Configuring the servers
 
-We plan to provide a configuration GUI at some time ([#25](https://github.com/krassowski/jupyterlab-lsp/issues/25)), but in the meantime, you can use the instructions for the specific servers as described on their websites (see the [table of language servers][language-servers] for links).
+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:
+
+```json
+{
+  "language_servers": {
+    "pyls": {
+      "serverSettings": {
+        "pyls.plugins.pydocstyle.enabled": true,
+        "pyls.plugins.pyflakes.enabled": false,
+        "pyls.plugins.flake8.enabled": true
+      }
+    },
+    "r-languageserver": {
+      "serverSettings": {
+        "r.lsp.debug": false,
+        "r.lsp.diagnostics": false
+      }
+    }
+  }
+}
+```
+
+The `serverSettings` key specifies the configurations sent to the language servers. These can be written using stringified dot accessors like above (in the VSCode style), or as nested JSON objects, e.g.:
+
+```json
+{
+  "language_servers": {
+    "pyls": {
+      "serverSettings": {
+        "pyls": {
+          "plugins": {
+            "pydocstyle": {
+              "enabled": true
+            },
+            "pyflakes": {
+              "enabled": false
+            },
+            "flake8": {
+              "enabled": true
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
 
-#### I want to hide specific diagnostics/inspections/warnings
+#### Other configuration methods
 
-For example, the Python server that we support by default ([pyls](https://github.com/palantir/python-language-server)) has a [configuration section](https://github.com/palantir/python-language-server#configuration) in their documentation which refers to the providers of specific features, including `pycodestyle` for inspections/diagnostics.
+Some language servers, such as `pyls`, provide other configuration methods _in addition_ to language-server configuration messages (accessed using the Advanced Settings Editor). For example, `pyls` allows users to configure the server using a local configuration file. You can change the inspection/diagnostics for server plugins like `pycodestyle` there.
 
 The exact configuration details will vary between operating systems (please see the [configuration section of pycodestyle documentation](https://pycodestyle.readthedocs.io/en/latest/intro.html#configuration)), but as an example, on Linux you would simply need to create a file called `~/.config/pycodestyle`, which may look like that:
 

atest/01_Editor.robot

@@ -32,6 +32,9 @@ Less
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable-2')][contains(text(), '@width')])[last()]
     Editor Shows Features for Language    Less    example.less    Diagnostics=Do not use empty rulesets    Jump to Definition=${def}
 
+Markdown
+    Editor Shows Features for Language    Markdown    example.md    Diagnostics=`Color` is misspelt
+
 Python
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), 'fib')])[last()]
     Editor Shows Features for Language    Python    example.py    Diagnostics=multiple spaces after keyword    Jump to Definition=${def}    Rename=${def}
@@ -58,12 +61,7 @@ YAML
 *** Keywords ***
 Editor Shows Features for Language
     [Arguments]    ${Language}    ${file}    &{features}
-    Set Tags    language:${Language.lower()}
-    Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots${/}editor${/}${Language.lower()}
-    Copy File    examples${/}${file}    ${OUTPUT DIR}${/}home${/}${file}
-    Try to Close All Tabs
-    Open ${file} in ${MENU EDITOR}
-    Capture Page Screenshot    00-opened.png
+    Prepare File for Editing    ${Language}    editor    ${file}
     FOR    ${f}    IN    @{features}
         Run Keyword If    "${f}" == "Diagnostics"    Editor Should Show Diagnostics    ${features["${f}"]}
         ...    ELSE IF    "${f}" == "Jump to Definition"    Editor Should Jump To Definition    ${features["${f}"]}
@@ -106,10 +104,6 @@ Measure Cursor Position
     ${position} =    Wait Until Keyword Succeeds    20 x    0.05s    Get Vertical Position    ${CM CURSOR}
     [Return]    ${position}
 
-Get Editor Content
-    ${content}    Execute JavaScript    return document.querySelector('.CodeMirror').CodeMirror.getValue()
-    [Return]    ${content}
-
 Editor Content Changed
     [Arguments]    ${old_content}
     ${new_content}    Get Editor Content

atest/02_Settings.robot

@@ -4,11 +4,5 @@ Resource          Keywords.robot
 
 *** Test Cases ***
 Settings
-    [Setup]    Reset Application State
-    Lab Command    Advanced Settings Editor
-    Capture Page Screenshot    01-settings-all.png
-    ${sel} =    Set Variable    css:[data-id="@krassowski/jupyterlab-lsp:plugin"]
-    Wait Until Page Contains Element    ${sel}
-    Click Element    ${sel}
-    Wait Until Page Contains    System Defaults
-    Capture Page Screenshot    02-settings-lsp.png
+    Open in Advanced Settings    ${LSP PLUGIN ID}
+    Capture Page Screenshot    01-settings-lsp.png

atest/04_Interface/DiagnosticsPanel.robot

@@ -1,6 +1,7 @@
 *** Settings ***
 Suite Setup       Setup Suite For Screenshots    diagnostics_panel
 Resource          ../Keywords.robot
+Test Setup        Gently Reset Workspace
 
 *** Variables ***
 ${EXPECTED_COUNT}    1
@@ -11,15 +12,13 @@ ${MENU COLUMN MESSAGE}    xpath://div[contains(@class, 'p-Menu-itemLabel')][cont
 
 *** Test Cases ***
 Diagnostics Panel Opens
-    [Setup]    Gently Reset Workspace
     Open Notebook And Panel    Panel.ipynb
     Capture Page Screenshot    03-panel-opens.png
     Wait Until Keyword Succeeds    10 x    1s    Should Have Expected Rows Count
     [Teardown]    Clean Up After Working With File    Panel.ipynb
 
 Diagnostics Panel Works After Rename
     [Documentation]    Test for #141 bug (diagnostics were not cleared after rename)
-    [Setup]    Gently Reset Workspace
     Open Notebook And Panel    Panel.ipynb
     Rename Jupyter File    Panel.ipynb    PanelRenamed.ipynb
     Close Diagnostics Panel
@@ -32,15 +31,13 @@ Diagnostics Panel Works After Rename
     [Teardown]    Clean Up After Working With File    Panel.ipynb
 
 Diagnostics Panel Can Be Restored
-    [Setup]    Gently Reset Workspace
     Open Notebook And Panel    Panel.ipynb
     Close Diagnostics Panel
     Open Diagnostics Panel
     Wait Until Keyword Succeeds    10 x    1s    Should Have Expected Rows Count
     [Teardown]    Clean Up After Working With File    Panel.ipynb
 
 Columns Can Be Hidden
-    [Setup]    Gently Reset Workspace
     Open Notebook And Panel    Panel.ipynb
     Wait Until Keyword Succeeds    10 x    1s    Element Should Contain    ${DIAGNOSTICS PANEL}    ${DIAGNOSTIC MESSAGE}
     Open Context Menu Over    css:.lsp-diagnostics-listing th

atest/05_Features/Completion.robot

@@ -1,6 +1,6 @@
 *** Settings ***
 Suite Setup       Setup Suite For Screenshots    completion
-Test Setup        Setup Notebook    Python    Completion.ipynb
+Test Setup        Setup Completion Test
 Test Teardown     Clean Up After Working With File    Completion.ipynb
 Force Tags        feature:completion
 Resource          ../Keywords.robot
@@ -92,6 +92,9 @@ Triggers Completer On Dot
     Completer Should Suggest    append
 
 *** Keywords ***
+Setup Completion Test
+    Setup Notebook    Python    Completion.ipynb
+
 Get Cell Editor Content
     [Arguments]    ${cell_nr}
     ${content}    Execute JavaScript    return document.querySelector('.jp-Cell:nth-child(${cell_nr}) .CodeMirror').CodeMirror.getValue()

atest/07_Configuration.robot

@@ -0,0 +1,62 @@
+*** Settings ***
+Documentation     Configuration of language servers
+Suite Setup       Setup Suite For Screenshots    config
+Force Tags        feature:config
+Resource          ./Keywords.robot
+
+*** Test Cases ***
+Python
+    [Documentation]    pyflakes is enabled by default, but flake8 is not
+    Settings Should Change Editor Diagnostics    Python    style.py    pyls
+    ...    {"pyls": {"plugins": {"flake8": {"enabled": true},"pyflakes": {"enabled": false}}}}
+    ...    undefined name 'foo' (pyflakes)
+    ...    undefined name 'foo' (flake8)
+
+YAML
+    [Documentation]    EXPECT FAIL Composer YAML files don't allow a "greetings" key
+    Settings Should Change Editor Diagnostics    YAML    example.yaml    yaml-language-server
+    ...    {"yaml.schemas": {"http://json.schemastore.org/composer": "*"}}
+    ...    duplicate key
+    ...    Property greetings is not allowed.
+
+Markdown
+    [Documentation]    different englishes spell colou?r differently
+    Settings Should Change Editor Diagnostics    Markdown    example.md    unified-language-server
+    ...    {"unified-language-server":{"remark-parse":{"plugins":[["#remark-retext","#parse-latin"],["#retext-spell","#dictionary-en"]]}}}
+    ...    `Color` is misspelt
+    ...    `Colour` is misspelt
+
+*** Keywords ***
+Clean Up After Working with File and Settings
+    [Arguments]    ${file}
+    Clean Up After Working With File    ${file}
+    Reset Plugin Settings
+
+Settings Should Change Editor Diagnostics
+    [Arguments]    ${language}    ${file}    ${server}    ${settings}    ${before}    ${after}
+    ${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}')]
+    ${close icon} =    Set Variable    *[contains(@class, 'm-TabBar-tabCloseIcon')]
+    Prepare File for Editing    ${language}    config    ${file}
+    Open in Advanced Settings    ${LSP PLUGIN ID}
+    Drag and Drop By Offset    ${tab}    0    100
+    Wait Until Fully Initialized
+    Open Diagnostics Panel
+    Drag and Drop By Offset    ${JLAB XP DOCK TAB}\[contains(., 'Diagnostics Panel')]    600    -200
+    Click Element    ${JLAB XP DOCK TAB}\[contains(., 'Launcher')]/${close icon}
+    Wait Until Page Contains Element    ${before diagnostic}    timeout=30s
+    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}
+    Wait Until Page Contains    No errors found
+    Capture Page Screenshot    01-default-diagnostics-and-settings.png
+    Click Element    css:button[title\='Save User Settings']
+    Click Element    ${JLAB XP DOCK TAB}\[contains(., 'Settings')]/${close icon}
+    Drag and Drop By Offset    ${tab}    0    100
+    Lab Command    Save ${language} File
+    Ensure Sidebar Is Closed
+    Capture Page Screenshot    02-settings-changed.png
+    Wait Until Page Contains Element    ${after diagnostic}    timeout=30s
+    Capture Page Screenshot    03-configured-diagnostic-found.png
+    [Teardown]    Clean Up After Working with File and Settings    ${file}

atest/Keywords.robot

@@ -22,7 +22,9 @@ Setup Server and Browser
     Initialize User Settings
     ${cmd} =    Create Lab Launch Command    ${root}
     Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots
-    ${server} =    Start Process    ${cmd}    shell=yes    env:HOME=${home}    cwd=${home}    stdout=${OUTPUT DIR}${/}lab.log
+    Set Global Variable    ${LAB LOG}    ${OUTPUT DIR}${/}lab.log
+    Set Global Variable    ${PREVIOUS LAB LOG LENGTH}    0
+    ${server} =    Start Process    ${cmd}    shell=yes    env:HOME=${home}    cwd=${home}    stdout=${LAB LOG}
     ...    stderr=STDOUT
     Set Global Variable    ${SERVER}    ${server}
     Open JupyterLab
@@ -55,26 +57,37 @@ Initialize User Settings
     Set Suite Variable    ${SETTINGS DIR}    ${OUTPUT DIR}${/}user-settings    children=${True}
     Create File    ${SETTINGS DIR}${/}@jupyterlab${/}codemirror-extension${/}commands.jupyterlab-settings    {"styleActiveLine": true}
 
+Reset Plugin Settings
+    Create File    ${SETTINGS DIR}${/}${LSP PLUGIN SETTINGS FILE}    {}
+
 Tear Down Everything
     Close All Browsers
     Evaluate    __import__("urllib.request").request.urlopen("${URL}api/shutdown?token=${TOKEN}", data=[])
     Wait For Process    ${SERVER}    timeout=30s
     Terminate All Processes
     Terminate All Processes    kill=${True}
 
+Lab Log Should Not Contain Known Error Messages
+    ${log} =    Get File    ${LAB LOG}
+    ${test log} =    Set Variable    ${log[${PREVIOUS LAB LOG LENGTH}:]}
+    ${length} =    Get Length    ${log}
+    Set Global Variable    ${PREVIOUS LAB LOG LENGTH}    ${length}
+    Run Keyword If    ("${OS}", "${PY}") !\= ("Windows", "36")
+    ...    Should Not Contain Any    ${test log}    @{KNOWN BAD ERRORS}
+
 Wait For Splash
-    Wait Until Page Contains Element    ${SPLASH}    timeout=180s
-    Wait Until Page Does Not Contain Element    ${SPLASH}    timeout=180s
+    Go To    ${URL}lab?reset&token=${TOKEN}
+    Set Window Size    1024    768
+    Wait Until Page Contains Element    ${SPLASH}    timeout=30s
+    Wait Until Page Does Not Contain Element    ${SPLASH}    timeout=10s
     Execute Javascript    window.onbeforeunload \= function (){}
 
 Open JupyterLab
     Set Environment Variable    MOZ_HEADLESS    ${HEADLESS}
     ${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?reset&token=${TOKEN}
-    Set Window Size    1024    768
-    Wait For Splash
+    Wait Until Keyword Succeeds    3x    5s    Wait For Splash
 
 Close JupyterLab
     Close All Browsers
@@ -92,7 +105,7 @@ Reset Application State
     Accept Default Dialog Option
     Ensure All Kernels Are Shut Down
     Lab Command    Reset Application State
-    Wait For Splash
+    Wait Until Keyword Succeeds    3x    5s    Wait For Splash
 
 Accept Default Dialog Option
     [Documentation]    Accept a dialog, if it exists
@@ -198,6 +211,7 @@ Clean Up After Working With File
     [Arguments]    ${file}
     Remove File    ${OUTPUT DIR}${/}home${/}${file}
     Reset Application State
+    Lab Log Should Not Contain Known Error Messages
 
 Setup Notebook
     [Arguments]    ${Language}    ${file}    ${isolated}=${True}
@@ -246,3 +260,29 @@ Open Context Menu Over
     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}
+
+Prepare File for Editing
+    [Arguments]    ${Language}    ${Screenshots}    ${file}
+    Set Tags    language:${Language.lower()}
+    Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots${/}${Screenshots}${/}${Language.lower()}
+    Copy File    examples${/}${file}    ${OUTPUT DIR}${/}home${/}${file}
+    Try to Close All Tabs
+    Open ${file} in ${MENU EDITOR}
+    Capture Page Screenshot    00-opened.png
+
+Open in Advanced Settings
+    [Arguments]    ${plugin id}
+    Lab Command    Advanced Settings Editor
+    ${sel} =    Set Variable    css:[data-id="${plugin id}"]
+    Wait Until Page Contains Element    ${sel}
+    Click Element    ${sel}
+    Wait Until Page Contains    System Defaults
+
+Set Editor Content
+    [Arguments]    ${text}    ${css}=${EMPTY}
+    Execute JavaScript    return document.querySelector('${css} .CodeMirror').CodeMirror.setValue(`${text}`)
+
+Get Editor Content
+    [Arguments]    ${css}=${EMPTY}
+    ${content} =    Execute JavaScript    return document.querySelector('${css} .CodeMirror').CodeMirror.getValue()
+    [Return]    ${content}

atest/Variables.robot

@@ -31,3 +31,13 @@ ${MENU SETTINGS}    xpath://div[contains(@class, 'lm-MenuBar-itemLabel')][contai
 ${MENU EDITOR THEME}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Text Editor Theme")]
 ${CM CURSOR}      css:.CodeMirror-cursor
 ${CM CURSORS}     css:.CodeMirror-cursors:not([style='visibility: hidden'])
+# settings
+${LSP PLUGIN ID}    @krassowski/jupyterlab-lsp:plugin
+${LSP PLUGIN SETTINGS FILE}    @krassowski${/}jupyterlab-lsp${/}plugin.jupyterlab-settings
+${CSS USER SETTINGS}    .jp-SettingsRawEditor-user
+# diagnostics
+${CSS DIAGNOSTIC}    css:.cm-lsp-diagnostic
+# log messages
+@{KNOWN BAD ERRORS}
+...               pyls_jsonrpc.endpoint - Failed to handle notification
+...               pyls_jsonrpc.endpoint - Failed to handle request