Integrate `jupyterlab-lsp` into `jupyterlab` #12534

trungleduc · 2022-05-05T09:42:05Z

References

This PR improves the LSP integration in the JupyterLab frontend to make LSP features available to other extensions. It will lay the infrastructure for handling and communicating with language servers.

This PR does not contain any frontend features like code completion, code refactoring, or jump to..., it will be the subject of future work. An example of an LSP code completion provider is available here

JupyterLab will not come with any language servers, users still need to install language servers manually.

Code changes

On the frontend, the core elements of the jupyterlab-lsp extension that handles the language server initialization and communication are moved into the lsp package of JupyterLab.

Diagram of components taken into JupyterLab

lsp-extension package is created to provide tokens that allow other extensions to interact with the language servers:
- ILSPDocumentConnectionManager: the token used to manage the connection to language servers for the notebook and file editor.
- ILSPFeatureManager: the token used to register features with language servers.
- ILSPCodeExtractorsManager: the token used to manage the code extractors, this will allow the creation of multiple language server connections on one notebook.
The backend parts, for now, are provided by jupyter-lsp package.

User-facing changes

Running language server panel

A new language server section is added to the running panel. If the language server for the language of the opened notebook is available, JupyterLab will create a connection to this server for the notebook. The language server section will show the running server and allow users to terminate these servers.

Setting interface for the language server

JupyterLab will detect automatically the installed language servers and will propose the settings for these servers in the settings UI.

Remaining tasks

Migration direction for the backend component Add Language Server Protocol handler to JupyterLab jupyterlab_server#240
Move lsp-ws-connection into JupyterLab
Handle the json schema <-> typescript interface generation.
~~Documentation for language servers installation and configuration.~~
~~Guide for creating LSP extension.~~

I will address the last 2 tasks in the follow-up PR.

Backwards-incompatible changes

N/A

cc @krassowski @bollwyvl

Refactor how the notebook changes are picked up, events bound and unbound

…finition Refactor jump-to functionality, remove unused code

before sending one.

…g mode

…lab-lsp into auto-clear-highlights

…-lsp into martinRenou-jupyterlab3

which were not correctly scoped by path by switching away from id_path which was refactored to not contain the actual file name to uri which does contain the file name and path

trungleduc · 2022-07-26T10:03:33Z

@krassowski, we a finalizing this PR and the remaining discussion is the scope of unstable APIs. I tagged all newly added tokens and APIs as alpha (783056f). Do we need to aware of any old APIs coming from the extension?

krassowski

Excited to see this so close to the finish line. Leaving some feedback in answer to the question about old interfaces: basically lsp-ws-connection has a lot of deprecated stuff which we should cut to avoid bringing useless dependencies (like events) and dev dependencies.

Also, I noticed that standard copyright headers are missing:

// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.

and sometimes there are headers in another format. I would suggest to use the standard lab format for consitency, it will be easier for us if we decide to grep-change them later.

packages/fileeditor/src/fileeditorlspadapter.ts

packages/lsp-extension/schema/plugin.json

packages/lsp/src/connection.ts

krassowski · 2022-07-26T22:44:16Z

packages/lsp/package.json

+    "@lumino/signaling": "^1.10.1",
+    "codemirror": "~5.61.0",
+    "lodash.mergewith": "^4.6.1",
+    "lsp-ws-connection": "~0.7.0",


I think we should remove this dependency, it was getting axed anyways (I think this is incorrectly ticked as done in the PR description). It only provides registerServerCapability and unregisterServerCapability and LspWsConnection; let's merge LspWsConnection into LSPConnection removing @deprecated methods (everything which uses events.EventEmitter or old get/send API).

fcollonval · 2022-07-27T08:39:52Z

Regarding the license header, I'll try to add an GitHub action to reach homogeneity. I found the promising: https://github.com/marketplace/actions/license-eye-header

for more information, see https://pre-commit.ci

trungleduc · 2022-07-28T09:56:10Z

Thank @krassowski for your review, I removed lsp-ws-connection in 1ccb751. I did not merge LspWsConnection into LSPConnection since I want to separate vendor codes.

fcollonval

Only two minor comments otherwise the code looks good.

packages/lsp/src/tokens.ts

krassowski

Some quick coffee-break comments, will take another look later.

packages/lsp/src/ws-connection/types.ts

SylvainCorlay · 2022-07-31T06:42:14Z

Hey @krassowski let us know if we could address more things in follow up PRs. It would be really nice to get this in (in a pre-release) so that we could start working on the follow-up changes in the extension. We will most certainly find more things to fix as we adapt jupyterlab-lsp to use this code, and codemirror 6.

krassowski

I'm happy for it to be merged and iterated on later (though let's address the two minor things from my previous review so that they are not lost once we merge).

SylvainCorlay · 2022-07-31T20:33:40Z

Thanks ! Lets fix these up an iterate!

fcollonval

Thanks a lot @trungleduc

krassowski and others added 30 commits December 12, 2020 19:30

Import jumpers from index, update yarn

ca94bb1

Do not attach "jump back" command to context menu

0c5c172

Flip the jump back icon in palette, remove debug log

3140b9e

Implement Accel and use it as default to support ⌘ on Mac

0418b36

Merge pull request jupyterlab#421 from krassowski/fix-editor-removal

4aacbce

Refactor how the notebook changes are picked up, events bound and unbound

Merge pull request jupyterlab#423 from krassowski/refactor-jump-to-de…

697361d

…finition Refactor jump-to functionality, remove unused code

Add highlights debouncer and check if highlights request is needed

94452c5

before sending one.

Clear last_token after clearing highlights

d84c12f

Ensure that trigger characters auto-invoke works in continuous hintin…

7559fda

…g mode

Add highlights test and fix jupyterlab#431

e9438bc

Allow to clear highlights on blur

677d523

Merge branch 'master' into fix-autoinvoke-on-dot

eeb32bd

Merge branch 'auto-clear-highlights' of github.com:krassowski/jupyter…

3012930

…lab-lsp into auto-clear-highlights

Merge branch 'jupyterlab3' of ssh://github.com/martinRenou/jupyterlab…

1a19803

…-lsp into martinRenou-jupyterlab3

Set promise type to void

0c08348

Fix syntax highlighting (needs import of cm/mode/meta)

b3abd44

Try to fix R double colon completion issue

1412e4e

Fix test and lint; add changelog

ff79bad

Add support for jupyterlab-classic

40ea7e0

Make the status item work with classic on toolbar

85296bd

Fix highlight of status icon when selected

641bc4c

Use new icons and no text on toolbar when status bar not available

382eef2

Disable diagnostics panel command in Classic

9593c7b

Update yarn.lock, lint

5f2a2e7

Fix connection manager loosing track of notebooks

cd7a2b8

which were not correctly scoped by path by switching away from id_path which was refactored to not contain the actual file name to uri which does contain the file name and path

Add new status "no server extension"

0a9b6b5

Fix handling of kernel change and restart

35cb93f

Retry connection for 5.5 minutes total rather than 40 seconds

ad89f9d

Only claim that servers are missing if they really are

be2c76f

Rewire all logs to go through a thin scoped wrapper

0adb141

Lint code

2fc5419

fcollonval mentioned this pull request Jul 25, 2022

Add jupyter-lsp to dependencies list jupyterlab/jupyterlab_server#282

Closed

trungleduc added 3 commits July 25, 2022 13:24

Tag new APIs as alpha

783056f

Merge branch 'master' into lsp

d0329d0

Rename initialized to ready

646586e

krassowski requested changes Jul 26, 2022

View reviewed changes

trungleduc and others added 6 commits July 27, 2022 12:11

Add missing header and update setting schema

6d0d544

Remove lsp-ws-connection dependency

1ccb751

Fix header

4ee3bbc

Remove codemirror dependency

ef82e65

[pre-commit.ci] auto fixes from pre-commit.com hooks

ef27bc1

for more information, see https://pre-commit.ci

Fix lint

50b3d70

This was referenced Jul 28, 2022

Weekly Team Meetings: Jul-Dec 2022 jupyterlab/frontends-team-compass#152

Closed

Add license header fix job #12872

Merged

fcollonval reviewed Jul 29, 2022

View reviewed changes

packages/lsp/src/tokens.ts Show resolved Hide resolved

packages/lsp/src/tokens.ts Show resolved Hide resolved

krassowski reviewed Jul 29, 2022

View reviewed changes

packages/lsp/src/ws-connection/types.ts Outdated Show resolved Hide resolved

packages/lsp/src/ws-connection/types.ts Outdated Show resolved Hide resolved

krassowski approved these changes Jul 31, 2022

View reviewed changes

Apply reviewer's suggestion

e4f8404

fcollonval approved these changes Aug 1, 2022

View reviewed changes

fcollonval merged commit a650dd8 into jupyterlab:master Aug 1, 2022

trungleduc mentioned this pull request Aug 4, 2022

LSP follow-up #12899

Merged

4 tasks

This was referenced Sep 30, 2022

Update to Lumino 2 and JupyterLab 4.0.0a29 jupyter/notebook#6539

Merged

Dev tools console error: TypeError: Cannot read properties of null (reading 'model') #13164

Closed

krassowski mentioned this pull request Oct 14, 2022

LSP on 4.0.0a30 #13245

Open

github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate `jupyterlab-lsp` into `jupyterlab` #12534

Integrate `jupyterlab-lsp` into `jupyterlab` #12534

trungleduc commented May 5, 2022 •

edited

trungleduc commented Jul 26, 2022

krassowski left a comment

krassowski Jul 26, 2022

fcollonval commented Jul 27, 2022

trungleduc commented Jul 28, 2022

fcollonval left a comment

krassowski left a comment

SylvainCorlay commented Jul 31, 2022

krassowski left a comment

SylvainCorlay commented Jul 31, 2022

fcollonval left a comment

Integrate jupyterlab-lsp into jupyterlab #12534

Integrate jupyterlab-lsp into jupyterlab #12534

Conversation

trungleduc commented May 5, 2022 • edited

References

Code changes

User-facing changes

Running language server panel

Setting interface for the language server

Remaining tasks

Backwards-incompatible changes

trungleduc commented Jul 26, 2022

krassowski left a comment

Choose a reason for hiding this comment

krassowski Jul 26, 2022

Choose a reason for hiding this comment

fcollonval commented Jul 27, 2022

trungleduc commented Jul 28, 2022

fcollonval left a comment

Choose a reason for hiding this comment

krassowski left a comment

Choose a reason for hiding this comment

SylvainCorlay commented Jul 31, 2022

krassowski left a comment

Choose a reason for hiding this comment

SylvainCorlay commented Jul 31, 2022

fcollonval left a comment

Choose a reason for hiding this comment

Integrate `jupyterlab-lsp` into `jupyterlab` #12534

Integrate `jupyterlab-lsp` into `jupyterlab` #12534

trungleduc commented May 5, 2022 •

edited