Language Server Protocol client #629

jlahoda · 2018-07-08T05:31:14Z

This is a crude prototype of a Language Server Protocol client for NetBeans.

It currently supports:
-diagnostics from the server
-go-to-declaration
-code completion

It uses the Eclipse LSP4J (https://github.com/eclipse/lsp4j) to handle the protocol and to provide the model for the messages (I used to have a custom implementation of the protocol, but it seemed wasteful to maintain that).

There are currently two ways to use a server from the IDE:
-a module provides bindings for a particular language, starts and registers a LS. I have a crude prototype of such a module using KotlinLanguageServer, but not good enough to that publish, yet.
-the user starts the LS manually somehow, and then binds the IDE to the running LS.

To see the client in action using the latter approach, the following can be used:
-clone https://github.com/fwcd/KotlinLanguageServer
--build it (gradle install)
--unpack build/distributions/kotlin-language-server-0.1.1.zip somewhere
-clone https://github.com/jlahoda/nb-lsp-helpers
--build it (ant jar in run-lsp)
--go to run-lsp/dist and run: "java -jar run-lsp.jar /bin/kotlin-language-server"
-run NetBeans, be sure there are no files opened in the editor, use the search feature in the top right corner, type "Connect", select "Connect to Language Server" action. Fill in your project's root (e.g. the path to the checked-out KotlinLanguageServer), port is 9965, extensions "kt". In a while the IDE should connect to a the LS. Then open a kt file (from the specified project), and the above features should work.

Chris2011 · 2018-07-09T06:51:26Z

Only to let you know: https://issues.apache.org/jira/browse/NETBEANS-180 So this PR will resolve, more or less, this ticket.

jtulach

Consider importing Eclipse OSGi bundles as OSGi bundles.

jtulach · 2018-07-18T04:33:50Z

libs.lsp/nbproject/project.properties

+release.external/guava-21.0.jar=modules/ext/guava-21.0.jar
+release.external/org.eclipse.lsp4j-0.4.1.jar=modules/ext/org.eclipse.lsp4j-0.4.1.jar
+release.external/org.eclipse.lsp4j.generator-0.4.1.jar=modules/ext/org.eclipse.lsp4j.generator-0.4.1.jar
+release.external/org.eclipse.lsp4j.jsonrpc-0.4.1.jar=modules/ext/org.eclipse.lsp4j.jsonrpc-0.4.1.jar


I assume these libraries are themselves OSGi bundles. If so, I prefer to package them and consume them like OSGi bundles. Just like Mylyn does with its OSGi bundles.

Here, I guess a question here is if we want to export this APIs, and be liable for it. The advantage of wrapping the jars is that we can limit the exposure of the API.

In the context of friend dependencies discussion (raging on in parallel), I see an attempt to bring private only copy of popular libraries like gson or guava going the exactly opposite way. Attitude like this brought NetBeans to the "overuse of friend deps" which leads to hacks and tricks to workaround it.

I prefer exposing popular 3rd party libraries (especially those packaged as OSGi bundles) as reusable components.

I think there's a significant difference between e.g. html.editor and guava. It is not reasonably possible to have multiple copies of html.editor in the IDE, while the side-effects of having multiple copies of guava should be fairly limited. I.e. if some other module needs guava, there's no need to do "hacks and tricks", it can have its own copy.

I wonder if there may be multiple versions of an OSGi module under the NB-OSGi combined module system, and if it will select the proper one based on dependencies.

If not, then with too much reusing, we may putting ourselves into a corner where upgrading various libraries will lead to significant amount of time spent ensuring things still work after the upgrade. And the time, I think, might be better spent on actual features and bugfixes of this project.

jtulach · 2018-07-18T04:37:35Z

lsp.client/src/org/netbeans/modules/lsp/client/ConnectToLanguageServer.java

+@ActionRegistration(
+        displayName = "#CTL_ConnectToLanguageServer"
+)
+@Messages("CTL_ConnectToLanguageServer=Connect to Language Server")


I think a natural place for this action could be a pop-up menu on the non-recognized data objects. E.g. if the IDE doesn't know a .kt file it's popup menu would suggest to connect to a language server.

timfel · 2018-07-25T11:19:31Z

A few observations:

Go to symbol seems not to be implemented with the documentSymbol message
Custom lsp actions are not implemented, e.g. the codeLens or codeAction LSP messages

…to lsp-client

geertjanw

Sounds great, what needs to be done for a first release of this feature?

JaroslavTulach

OSGi bundles would better be used as OSGi bundles, not as a wrapped JARs. Edit: turns out that except missing ide/c.google.gson/build.xml, it is already prepared as OSGi bundle.

JaroslavTulach · 2018-08-10T07:18:46Z

spi.navigator/src/org/netbeans/spi/navigator/NavigatorPanel.java

+         * @return a collection of {@code NavigatorPanel}s for the given file
+         *         null is allowed
+         */
+        public @CheckForNull Collection<? extends NavigatorPanel> panelsFor(@NonNull FileObject file);


This is the first place in the spi.navigator API where FileObject is exposed. Until now the navigator API (not implementation) was FileSystem API free.

JaroslavTulach · 2018-08-10T07:23:22Z

lsp.client/nbproject/project.xml

+                </dependency>
+            </module-dependencies>
+            <friend-packages>
+                <friend>org.netbeans.modules.kotlin.support</friend>


Clearly this module shall serve as an API for many projects to hook in. It is not only for few "friends" - expose the API in a regular way. Use arch.xml to specify the stability category (under development, I assume). Provide some documentation and initial version of apichanges.xml. Let the module be visible in the overall Javadoc (e.g. change nbbuild/build.properties).

JaroslavTulach · 2018-08-10T07:24:57Z

spi.navigator/test/unit/src/org/netbeans/modules/navigator/ProviderRegistryTest.java

@@ -46,13 +46,13 @@ public void testGetProviders () throws Exception {
        ProviderRegistry providerReg = ProviderRegistry.getInstance();

        System.out.println("Asking for non-existent type...");
-        assertEquals(0, providerReg.getProviders("image/non_existent_type").size());
+        assertEquals(0, providerReg.getProviders("image/non_existent_type", null).size());


Not only existing tests shall be fixed, but new one(s) covering the DynamicRegistration shall be added.

…ion, as noted by jtulach.

Chris2011 · 2018-10-10T19:48:02Z

How will syntax highlighting work? I mean how to get it from the LS @jlahoda?

geertjanw · 2018-10-10T19:53:46Z

Not supported yet by LSP: microsoft/vscode-languageserver-node#367

jlahoda · 2018-10-10T19:55:25Z

The simple answer is that the LSP does not support highlighting at this point. So no highlighting through the LSP. See for example:
eclipse-lsp4j/lsp4j#40

This may get into the protocol eventually, see:
microsoft/vscode-languageserver-node#367

Chris2011 · 2018-10-10T20:00:13Z

Ok, thx.

rkraneis · 2019-01-28T10:59:40Z

Great work! FWIW, for all on a sensible OS, there is no need to clone and build nb-lsp-helpers, as it more or less just replicates socat -v tcp-listen:9965,reuseaddr exec:/bin/kotlin-language-server. LSP with NetBeans is already quite nice to use as the Connect dialog remembers connection settings 👍

jlahoda · 2019-01-28T20:43:00Z

@rkraneis - thanks for the pointer, didn't know about the tool! Thanks!

devMls · 2020-01-04T21:40:45Z

Hi

This feature can will be used ti support freemarker like eclipse do? Jbosstools use lsp ti support freemarker and NetBeans freemarker plugin is outdated and with dime bugs

jlahoda added 3 commits July 6, 2018 07:30

First sketch of a client for language server protocol.

9d60fb1

Fixing default action for LSP completion item.

5c90b29

Adding ability to connect toan already running server.

1eb8fc3

jlahoda added the work-in-progress label Jul 8, 2018

jlahoda requested a review from geertjanw July 8, 2018 05:31

jtulach approved these changes Jul 18, 2018

View reviewed changes

CompletionItem.getKind() is optional, adjusting to that.

316cdb3

jlahoda and others added 9 commits July 28, 2018 09:42

Adding some support for code actions.

daf1e61

First sketch of navigagor implemented using textDocument/documentSymbol.

93d8972

Correcting apichanges.xml

e159cbb

Fixing apichanges.xml.

22878b2

Do not bind background tasks to diagnostics, but run them actively.

c272ea0

Merge branch 'lsp-client' of github.com:jlahoda/incubator-netbeans in…

1237bbb

…to lsp-client

Merge branch 'master' into lsp-client

91fbbc6

Merging the master branch into the lsp-client branch.

0c29274

Correcting paths.

a53c4ec

geertjanw approved these changes Sep 4, 2018

View reviewed changes

Making Gson a separate library, reusing existing Guava.

0733bfa

JaroslavTulach reviewed Sep 11, 2018

View reviewed changes

JaroslavTulach approved these changes Sep 11, 2018

View reviewed changes

jlahoda added 6 commits September 11, 2018 20:54

Adding forgotten build.xml, and removing extraneous class path extens…

345cd76

…ion, as noted by jtulach.

Avoid libs.lsp, avoid using lsp4j in SPI, adding test for navigator.

4ba531e

Marking the SPI as under development, adding javadoc and arch.xml.

79ec87c

Merge branch 'master' into lsp-client

c9cf6df

Merge branch 'master' into lsp-client

bcd0f04

Adding licence header to arch.xml.

c4fa502

jlahoda added enhancement and removed work-in-progress labels Sep 13, 2018

jlahoda added the API Change [ci] enable extra API related tests label Sep 13, 2018

JaroslavTulach merged commit f2b7bd0 into apache:master Sep 13, 2018

AlexFalappa mentioned this pull request Mar 5, 2019

Developer documentation on language server spring-projects/spring-tools#209

Closed

This was referenced Aug 4, 2019

Kotlin Plugin Donation #1398

Merged

Support TCP transport fwcd/kotlin-language-server#137

Closed

Language Server Protocol client #629

Language Server Protocol client #629

Uh oh!

Conversation

jlahoda commented Jul 8, 2018

Uh oh!

Chris2011 commented Jul 9, 2018

Uh oh!

jtulach left a comment

Choose a reason for hiding this comment

Uh oh!

jtulach Jul 18, 2018

Choose a reason for hiding this comment

Uh oh!

jlahoda Jul 18, 2018

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach Aug 10, 2018

Choose a reason for hiding this comment

Uh oh!

jlahoda Aug 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jtulach Jul 18, 2018

Choose a reason for hiding this comment

Uh oh!

timfel commented Jul 25, 2018

Uh oh!

geertjanw left a comment

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach Aug 10, 2018

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach Aug 10, 2018

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach Aug 10, 2018

Choose a reason for hiding this comment

Uh oh!

Chris2011 commented Oct 10, 2018

Uh oh!

geertjanw commented Oct 10, 2018

Uh oh!

jlahoda commented Oct 10, 2018

Uh oh!

Chris2011 commented Oct 10, 2018

Uh oh!

rkraneis commented Jan 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jlahoda commented Jan 28, 2019

Uh oh!

devMls commented Jan 4, 2020

Uh oh!

Uh oh!

jlahoda Aug 10, 2018 •

edited

Loading

JaroslavTulach left a comment •

edited

Loading

rkraneis commented Jan 28, 2019 •

edited

Loading