How to guide to create a client and server using a Service endpoint

[cmoulliard]

It would be great to have a fully working guide based on this one https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md in order to easily figure out how to create a service + endpoint and test it using a client and language server as the snippets provided within the guide are not enough and should be completed with a java main or java test class.

The guide should also better document how to generate the code for the xtend files: https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md#lsp4j-json-rpc-generator

Remark: The guide is not up to date anymore as this method documented don't exist anymore MyService proxy = ServiceEndpoints.toProxy(endpoint, MyService.class);

[mickaelistria]

You can take LeMminX as example:

• The service interface for extra endpoints: https://github.com/eclipse-lemminx/lemminx/blob/main/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/XMLLanguageServerAPI.java
• Some example of custom data types used by such extra endpoints with custom JSon Serialization info: https://github.com/eclipse-lemminx/lemminx/blob/main/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/ActionableNotification.java

[angelozerr]

@cmoulliard it seems you are developing a project based on JDT LS https://github.com/konveyor/java-analyzer-bundle
and you are using org.eclipse.jdt.ls.core.delegateCommandHandler, right?

In this case you need to create a mock LSP client which connects to JDT LS server and consume the standard workspace/executeCommand LSP request.

[pisv]

@cmoulliard Thank you for the feedback on the project's documentation! There is certainly room for improvement in this area.

It would be great to have a fully working guide based on this one https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md in order to easily figure out how to create a service + endpoint and test it using a client and language server as the snippets provided within the guide are not enough and should be completed with a java main or java test class.

Sounds like this might be what you are looking for: Implementing a JSON-RPC protocol with Eclipse LSP4J.

The guide should also better document how to generate the code for the xtend files: https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md#lsp4j-json-rpc-generator

Do you have any specific suggestions to this end? Maybe it would be worth creating an issue with more details or even a PR with proposed changes?

Remark: The guide is not up to date anymore as this method documented don't exist anymore MyService proxy = ServiceEndpoints.toProxy(endpoint, MyService.class);

Good catch. It should have been toServiceObject, of course. Looks like there was never toProxy method in ServiceEndpoints, but this typo was present from the very beginning. Could you consider creating a PR with the fix? (If not, no worries, I'll take care of it a bit later.)

[cmoulliard]

PR created: #913

[cmoulliard]

Sounds like this might be what you are looking for: Implementing a JSON-RPC protocol with Eclipse LSP4J.

This is a good example even if the gradle build dependencies is not accurate anymore and folks will not been able to use or tun the project.

[cmoulliard]

Do you have any specific suggestions to this end?

I created an issue: #914

[pisv]

Sounds like this might be what you are looking for: Implementing a JSON-RPC protocol with Eclipse LSP4J.

This is a good example even if the gradle build dependencies is not accurate anymore and folks will not been able to use or tun the project.

Yes, the article dates back to 2017, but still holds much of its value, although the associated source code repository has, of course, become stale.