Provide an advanced LSP console

[angelozerr]

I had started an issue at #631 but I create a new one which is focus on LSP console.

I would like to try to convince you that a robust LSP console is really important to have.

I spend so many time to work on LSP console developement for IJ and it help us a lot. You can see the status of the server when it is starting, started, stopping,stopped or crash, see the pid, see the LSP messages, etc

Here a little demo which show the language servers which are available and you can see the status of each language server (when it is starting etc). The demo shows the LSP request / response received when the LSP hover is processed:

The LSP console shows:

• the language servers which are available
• the status of each server. You can pause (stop the process) or stop (disable the language server) with menu context
  
• the pid of the language server
• you can copy/paste the command which starts the language server
• the LSP request / response messages are formatted correctly and there is folding
  
• there is a search field:
  

I know it is a long task, but IMHO LSP4E should provide this kind of LSP console which are very helpfull for 3 profiles:

• the LSP4E developer who develop LSP client. You will understand more what it happens and you should discover some bugs that you have not though. In my case I have ported LSP4E on IJ and I discover some bugs where the server was restarted although it should not (ex : when I closed a workspace). It will be very helpfull to implement new features like cancel support; You could check with the search field that $cancel request will be send correctly for instance. The current console is very hard to use it, since the LSP messages is not formatted. The LSP message format should follow the spec and have the same format than vscode.

• the LSP language server developer: when you develop a language server, you need to understand which data you send and check that you don't send too many response and when there is a bug, LSP console is your friend, you understand more what it happens.

• the Users who use a language server: we spend so many time to assist user with problems and spend so many times to explain the process "please activate your log with this settings etc". With LSP console you don't need to explain that for assisting user, with LSP console it is very easy to have an overview (the server is started? the LSP messages appears correctly?).

• the Copy Start command can help if the language server cannot be started:

A good sample of issue which is a nightmare is jbosstools/jbosstools-quarkus#235

java.util.concurrent.ExecutionException: org.eclipse.lsp4j.jsonrpc.JsonRpcException: java.io.IOException: Stream closed at java.base/java.util.concurrent.CompletableFuture.reportGet(CompletableFuture.java:396) at

We don't know if the problem comes from the start command or if the language server can be started, but fails after. We have no overview of what it happens.

I know it is a long task to implement this kind of LSP console, but IMHO it is a requirement for LSP client developpers, LSP server developers and Users.

[mickaelistria]

There is now #519 which gives some access to running LS instances. Log could be incorporated here. I still think the "stream" log can be useful as it can happen that some LS have transport bugs that cannot be detected without looking at the actual IO. Adding a message-level log (with formatting and so on) would be good as well.

[angelozerr]

When language server cannot start, it is a real nightmare to understand the problem:

1. You don't know that language server cannot be started
2. You have so many freeze, because it tries to start again and again the language server.

In LSP4IJ, I have managed that redhat-developer/intellij-quarkus#1051 (comment)

• when language server cannot be started, you can see error in the LSP console
• after 50 attempt, the language server is disabled.

Here a demo when language server cannot be started:

IMHO, LSP4E should provide this feature. Here a very good sample of kind of issues that you can have in a language server project:

• Code navigation is slow when running on 2023-06 jbosstools/jbosstools-quarkus#235
• application.properties autocomplete is not working jbosstools/jbosstools-quarkus#213
• QuarkusLanguageServer does not work on windows jbosstools/jbosstools-quarkus#187

which are totally different but the main problem is because the language server cannot be started.