Merge branch 'krassowski:master' into master

Author: FlyingSamson

.github/workflows/job.test.yml

@@ -185,6 +185,8 @@ jobs:
           python setup.py sdist bdist_wheel
           cd ../jupyterlab_lsp
           python setup.py sdist bdist_wheel
+          cd ../klingon_ls_specification
+          python setup.py sdist bdist_wheel
 
       - name: Collect distributions
         run: |
@@ -298,8 +300,13 @@ jobs:
       - name: Install python packages
         run: python -m pip install --find-links=dist --no-index --ignore-installed --no-deps jupyter_lsp jupyterlab_lsp
 
+      - name: Install Klingon file type extension and server specification (for testing languages without language servers)
+        run: python -m pip install --find-links=dist --no-index --ignore-installed --no-deps klingon_ls_specification
+
       - name: Pip check
-        run: python -m pip check
+        run: |
+          python -m pip check
+          python -m pip list | grep -ie klingon-ls-specification
 
       - name: List server extensions
         run: |
@@ -312,7 +319,10 @@ jobs:
           jupyter serverextension list 2>&1 | grep -ie "jupyter_lsp.*enabled" -
 
       - name: List frontend extensions
-        run: jupyter labextension list
+        run: |
+          jupyter labextension list
+          jupyter labextension list 2>&1 | grep -ie "jupyterlab-lsp.*enabled" -
+          jupyter labextension list 2>&1 | grep -ie "jupyterlab-lsp-klingon-integration.*enabled" -
 
       - name: install node-based language servers
         if: steps.cache-node-modules.outputs.cache-hit != 'true'

CHANGELOG.md

@@ -1,10 +1,12 @@
 ## Changelog
 
-### `@krassowski/jupyterlab-lsp 3.7.1` (unreleased)
+### `@krassowski/jupyterlab-lsp 3.8.0` (2021-07-04)
 
 - improvements:
 
   - add a note on manually enabling backend extension ([#621], thanks @icankeep)
+  - in-app troubleshooting/installation help is now offered for servers which are needed but could not be detected
+    (if auto-detection specification for those is present) ([#634])
 
 - bug fixes:
   - fix rename shortcut registration in file editor ([#614])
@@ -15,6 +17,26 @@
 [#621]: https://github.com/krassowski/jupyterlab-lsp/pull/621
 [#625]: https://github.com/krassowski/jupyterlab-lsp/pull/625
 [#630]: https://github.com/krassowski/jupyterlab-lsp/pull/630
+[#634]: https://github.com/krassowski/jupyterlab-lsp/pull/634
+
+### `jupyter-lsp 1.4.0` (2021-07-04)
+
+- features:
+
+  - `troubleshoot` property was added to the language server spec, allowing to describe auto-detection troubleshooting
+    ([#634])
+  - new endpoint `specs` will list all language server specifications known to `jupyter-lsp` allowing frontends
+    to suggest installation of specific language servers ([#634])
+
+- changes:
+  - `ShellSpec.is_installed()` signature changed; it now accepts the `LanguageServerManagerAPI` rather than the resolved
+    command location (of `str` type); the specs using only `is_installed_args` are not affected; as this method was only
+    used by internally by the `__call__` implementation (which was adjusted accordingly) this change should not break
+    existing specs unless any of these methods were overridden in sub-classes.
+  - `SpecBase` was moved to `types.py`; it can still be imported from `utils`, but doing so is discouraged
+  - `ShellSpec.solve()` was added to facilitate discovery of command location
+
+[#634]: https://github.com/krassowski/jupyterlab-lsp/pull/634
 
 ### `jupyter-lsp 1.3.0` (2021-06-02)
 

CONTRIBUTING.md

@@ -84,7 +84,9 @@ to JupyterLab for development:
 ```bash
 jlpm bootstrap
 # if you installed `jupyterlab_lsp` before uninstall it before running the next line
-jupyter labextension develop python_packages/jupyterlab_lsp/ --overwrite
+jupyter labextension develop python_packages/jupyterlab_lsp/jupyterlab_lsp/ --overwrite
+# optional, only needed for running a few tests for behaviour with missing language servers
+jupyter labextension develop python_packages/klingon_ls_specification/ --overwrite
 ```
 
 > Note: on Windows you may need to enable Developer Mode first, as discussed in [jupyterlab#9564](https://github.com/jupyterlab/jupyterlab/issues/9564)

atest/04_Interface/Statusbar.robot

@@ -6,6 +6,7 @@ Resource          ../Keywords.robot
 ${STATUSBAR}      css:div.lsp-statusbar-item
 ${DIAGNOSTIC}     W291 trailing whitespace (pycodestyle)
 ${POPOVER}        css:.lsp-popover
+${HELP_BUTTON}    css:.lsp-popover .lsp-help-button
 
 *** Test Cases ***
 Statusbar Popup Opens
@@ -19,6 +20,29 @@ Statusbar Popup Opens
     Element Should Contain    ${POPOVER}    initialized
     [Teardown]    Clean Up After Working With File    Python.ipynb
 
+Troubleshooting And Help Is Offered For Known Non-Installed Servers
+    [Documentation]    When specification of a language server has been configured or provided, but the server is not installed (or detected) the user should get help on installation and/or troubleshooting
+    Prepare File for Editing    Python    status    example.klingon
+    Wait Until Element Contains    ${STATUSBAR}    Initialized (additional servers needed)    timeout=60s
+    Click Element    ${STATUSBAR}
+    Wait Until Page Contains Element    ${POPOVER}    timeout=10s
+    Page Should Contain Element    ${HELP_BUTTON}
+    # sanity check
+    Page Should Not Contain    run-klingon-language-server not found.
+    Click Element    ${HELP_BUTTON}
+    Wait For Dialog
+    # info message should get generated
+    Page Should Contain    There is 1 language server you can easily install that supports klingon.
+    # provided links should be shown
+    Page Should Contain    https://en.wikipedia.org/wiki/Klingon_language
+    # automated shellspec troubleshooting should get generates
+    Page Should Contain    run-klingon-language-server not found.
+    # specification-provided troubeshooting should be shown too
+    Page Should Contain    This is just a test language server.
+    # installation command should be shown
+    Page Should Contain    echo "This language server cannot be installed."
+    [Teardown]    Clean Up After Working With File    example.klingon
+
 Status Changes Between Notebooks
     Setup Notebook    Python    Python.ipynb
     Wait Until Fully Initialized

atest/Keywords.robot

@@ -113,6 +113,7 @@ Open JupyterLab
     Set Environment Variable    MOZ_HEADLESS    ${HEADLESS}
     ${firefox} =    Get Firefox Binary
     ${geckodriver} =    Which    geckodriver
+    Should Not Be Equal As Strings    ${geckodriver}    None    geckodriver not found, do you need to install firefox-geckodriver?
     ${service args} =    Create List    --log    debug
     Create WebDriver    Firefox
     ...    executable_path=${geckodriver}

atest/examples/example.ancient_klingon

@@ -16,9 +16,12 @@ dependencies:
   - flake8 >=3.5
   - pip
   - pylint
-  - pyls-black
-  - pyls-isort
-  - pyls-mypy
+  # pyls-black was not migrated to pylsp yet
+  # - pyls-black
+  # pyls-isort already migrated to pylsp but there is no point enabling
+  # it right now as we do not support actions support yet (PRs welcome)
+  # - pyls-isort
+  - pylsp-mypy
   - python-lsp-server
   - ruamel_yaml
   # for R language server and kernel

atest/examples/example.klingon

@@ -74,7 +74,12 @@
     "    element of [kernel_info][] response (with fallback on to cell metadata if\n",
     "    missing from kernel response)\n",
     "  - for files the implementation is frontend-specific; in JupyterLab the MIME\n",
-    "    type is obtained from the MIME type registry.\n",
+    "    type is obtained from: a) the code editor MIME type registry, which is by\n",
+    "    default using the CodeMirror mode as for JupyterLab 3.x, or if no specific\n",
+    "    MIME type is found there, then b) from the `DocumentRegistry` file type by\n",
+    "    matching the `contentsModel` against the registered file types using\n",
+    "    `getFileTypeForModel()` method (if multiple MIME types are present, the\n",
+    "    first one will be used).\n",
     "\n",
     "```python\n",
     "# ./jupyter_server_config.json                   ---------- unique! -----------\n",
@@ -315,7 +320,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },

binder/environment.yml

@@ -160,7 +160,7 @@
     "    \"jedi-language-server\",\n",
     "]\n",
     "lang_server_table(\n",
-    "    {key: spec for key, spec in mgr.language_servers.items() if key in nb_langs}\n",
+    "    {key: spec for key, spec in mgr.all_language_servers.items() if key in nb_langs}\n",
     ")"
    ]
   },
@@ -206,7 +206,7 @@
     "lang_server_table(\n",
     "    {\n",
     "        key: spec\n",
-    "        for key, spec in mgr.language_servers.items()\n",
+    "        for key, spec in mgr.all_language_servers.items()\n",
     "        if \"npm\" in spec[\"install\"]\n",
     "    }\n",
     ")"
@@ -287,7 +287,7 @@
    "source": [
     "sci_langs = [\"texlab\"]\n",
     "lang_server_table(\n",
-    "    {key: spec for key, spec in mgr.language_servers.items() if key in sci_langs}\n",
+    "    {key: spec for key, spec in mgr.all_language_servers.items() if key in sci_langs}\n",
     ")"
    ]
   },
@@ -309,11 +309,53 @@
     "  reference navigation\n",
     "- `chktex`, a `.tex` style checker"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Troubleshooting"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "remove-input",
+     "wide-table"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "troubleshooting_data = {\n",
+    "    key: spec\n",
+    "    for key, spec in mgr.all_language_servers.items()\n",
+    "    if (\n",
+    "        \"troubleshoot\" in spec\n",
+    "        # ignore trivial Node.js advice if only this is present\n",
+    "        and spec[\"troubleshoot\"] != \"Node.js is required to install this server.\"\n",
+    "        # ignore trivial shell advice if only this is present\n",
+    "        and spec[\"troubleshoot\"] != f\"{spec['argv'][0]} not found.\"\n",
+    "    )\n",
+    "}\n",
+    "\n",
+    "IPython.display.HTML(\n",
+    "    Template(\n",
+    "        \"\"\"\n",
+    "    {% for key, spec in specs.items() %}\n",
+    "    <h4>{{ key }}</h4>\n",
+    "    <p style=\"white-space: pre-wrap\">{{ spec.troubleshoot }}</p>\n",
+    "    {% endfor %}\n",
+    "    \"\"\"\n",
+    "    ).render(specs=troubleshooting_data)\n",
+    ")"
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },