Skip to content

Commit f61dc2c

Browse files
ericdalloericdallo
committed
docs
1 parent 3f5ae8f commit f61dc2c

File tree

1 file changed

+1
-188
lines changed

1 file changed

+1
-188
lines changed

‎README.md‎

Lines changed: 1 addition & 188 deletions
Original file line numberDiff line numberDiff line change
@@ -4,194 +4,7 @@ A [Language Server Protocol](https://microsoft.github.io/language-server-protoco
44

55
[![Clojars Project](https://img.shields.io/clojars/v/com.github.clojure-lsp/lsp4clj.svg)](https://clojars.org/com.github.clojure-lsp/lsp4clj)
66

7-
lsp4clj reads and writes from io streams, parsing JSON-RPC according to the LSP spec. It provides tools to allow server implementors to receive, process, and respond to any of the methods defined in the LSP spec, and to send their own requests and notifications to clients.
8-
9-
## Usage
10-
11-
### Create a server
12-
13-
To initialize a server that will read from stdin and write to stdout:
14-
15-
```clojure
16-
(lsp4clj.io-server/stdio-server)
17-
```
18-
19-
The returned server will have a core.async `:log-ch`, from which you can read server logs (vectors beginning with a log level).
20-
21-
```clojure
22-
(async/go-loop []
23-
(when-let [[level & args] (async/<! (:log-ch server))]
24-
(apply logger/log level args)
25-
(recur)))
26-
```
27-
28-
### Receive messages
29-
30-
To receive messages from a client, lsp4clj defines a pair of multimethods, `lsp4clj.server/receive-notification` and `lsp4clj.server/receive-request` that dispatch on the method name (as defined by the LSP spec) of an incoming JSON-RPC message.
31-
32-
Server implementors should create `defmethod`s for the messages they want to process. (Other methods will be logged and responded to with a generic "Method not found" response.)
33-
34-
These `defmethod`s receive 3 arguments, the method name, a "context", and the `params` of the [JSON-RPC request or notification object](https://www.jsonrpc.org/specification#request_object). The keys of the params will have been converted (recursively) to kebab-case keywords. Read on for an explanation of what a "context" is and how to set it.
35-
36-
```clojure
37-
;; a notification; return value is ignored
38-
(defmethod lsp4clj.server/receive-notification "textDocument/didOpen"
39-
[_ context {:keys [text-document]}]
40-
(handler/did-open context (:uri text-document) (:text text-document))
41-
42-
;; a request; return value is converted to a response
43-
(defmethod lsp4clj.server/receive-request "textDocument/definition"
44-
[_ context params]
45-
(->> params
46-
(handler/definition context)
47-
(conform-or-log ::coercer/location)))
48-
```
49-
50-
The return value of requests will be converted to camelCase json and returned to the client. If the return value looks like `{:error ...}`, it is assumed to indicate an error response, and the `...` part will be set as the `error` of a [JSON-RPC error object](https://www.jsonrpc.org/specification#error_object). It is up to you to conform the `...` object (by giving it a `code`, `message`, and `data`.) Otherwise, the entire return value will be set as the `result` of a [JSON-RPC response object](https://www.jsonrpc.org/specification#response_object). (Message ids are handled internally by lsp4clj.)
51-
52-
### Async requests
53-
54-
lsp4clj passes the language server the client's messages one at a time. It won't provide another message until it receives a result from the multimethods. Therefore, by default, requests and notifications are processed in series.
55-
56-
However, it's possible to calculate requests in parallel (though not notifications). If the language server wants a request to be calculated in parallel with others, it should return a `java.util.concurrent.CompletableFuture`, possibly created with `promesa.core/future`, from `lsp4clj.server/receive-request`. lsp4clj will arrange for the result of this future to be returned to the client when it resolves. In the meantime, lsp4clj will continue passing the client's messages to the language server. The language server can control the number of simultaneous messages by setting the parallelism of the CompletableFutures' executor.
57-
58-
### Cancelled inbound requests
59-
60-
Clients sometimes send `$/cancelRequest` notifications to indicate they're no longer interested in a request. If the request is being calculated in series, lsp4clj won't see the cancellation notification until after the response is already generated, so it's not possible to cancel requests that are processed in series.
61-
62-
But clients can cancel requests that are processed in parallel. In these cases lsp4clj will cancel the future and return a message to the client acknowledging the cancellation. Because of the design of CompletableFuture, cancellation can mean one of two things. If the executor hasn't started the thread that is calculating the value of the future (perhaps because the executor's thread pool is full), it won't be started. But if there is already a thread calculating the value, the thread won't be interupted. See the documentation for CompletableFuture for an explanation of why this is so.
63-
64-
Nevertheless, lsp4clj gives language servers a tool to abort cancelled requests. In the request's `context`, there will be a key `:lsp4clj.server/req-cancelled?` that can be dereffed to check if the request has been cancelled. If it has, then the language server can abort whatever it is doing. If it fails to abort, there are no consequences except that it will do more work than necessary.
65-
66-
```clojure
67-
(defmethod lsp4clj.server/receive-request "textDocument/semanticTokens/full"
68-
[_ {:keys [:lsp4clj.server/req-cancelled?] :as context} params]
69-
(promesa.core/future
70-
;; client may cancel request while we are waiting for analysis
71-
(wait-for-analysis context)
72-
(when-not @req-cancelled?
73-
(handler/semantic-tokens-full context params))))
74-
```
75-
76-
### Send messages
77-
78-
Servers also send their own requests and notifications to a client. To send a notification, call `lsp4clj.server/send-notification`.
79-
80-
```clojure
81-
(->> {:message message
82-
:type type
83-
:extra extra}
84-
(conform-or-log ::coercer/show-message)
85-
(lsp4clj.server/send-notification server "window/showMessage"))
86-
```
87-
88-
Sending a request is similar, with `lsp4clj.server/send-request`. This method returns a request object which may be dereffed to get the client's response. Most of the time you will want to call `lsp4clj.server/deref-or-cancel`, which will send a `$/cancelRequest` to the client if a timeout is reached before the client responds.
89-
90-
```clojure
91-
(let [request (->> {:edit edit}
92-
(conform-or-log ::coercer/workspace-edit-params)
93-
(lsp4clj.server/send-request server "workspace/applyEdit"))
94-
response (lsp4clj.server/deref-or-cancel request 10e3 ::timeout)]
95-
(if (= ::timeout response)
96-
(logger/error "No reponse from client after 10 seconds.")
97-
response))
98-
```
99-
100-
The request object presents the same interface as `future`. It responds to `realized?`, `future?`, `future-done?` and `future-cancelled?`.
101-
102-
If you call `future-cancel` on the request object, the server will send the client a `$/cancelRequest`. `$/cancelRequest` is sent only once, although `lsp4clj.server/deref-or-cancel` or `future-cancel` can be called multiple times. After a request is cancelled, later invocations of `deref` will return `:lsp4clj.server/cancelled`.
103-
104-
Alternatively, you can convert the request to a promesa promise, and handle it using that library's tools:
105-
106-
```clojure
107-
(let [request (lsp4clj.server/send-request server "..." params)]
108-
(-> request
109-
(promesa/promise)
110-
(promesa/then (fn [response] {:result :client-success
111-
:value 1
112-
:resp response}))
113-
(promesa/catch (fn [ex-response] {:result :client-error
114-
:value 10
115-
:resp (ex-data ex-response)}))
116-
(promesa/timeout 10000 {:result :timeout
117-
:value 100})
118-
(promesa/then #(update % :value inc))))
119-
```
120-
121-
In this case `(promesa/cancel! request)` will send `$/cancelRequest`.
122-
123-
Response promises are completed on Promesa's `:default` executor. You
124-
can specify your own executor by passing the `:response-executor` option
125-
when creating your server instance.
126-
127-
### Start and stop a server
128-
129-
The last step is to start the server you created earlier. Use `lsp4clj.server/start`. This method accepts two arguments, the server and a "context".
130-
131-
The context should be `associative?`. Whatever you provide in the context will be passed as the second argument to the notification and request `defmethod`s you defined earlier. This is a convenient way to make components of your system available to those methods without definining global constants. Often the context will include the server itself so that you can initiate outbound requests and notifications in reaction to inbound messages. lsp4clj reserves the right to add its own data to the context, using keys namespaced with `:lsp4clj.server/...`.
132-
133-
```clojure
134-
(lsp4clj.server/start server {:custom-settings custom-settings, :logger logger})
135-
```
136-
137-
The return of `start` is a promise that will resolve to `:done` when the server shuts down, which can happen in a few ways.
138-
139-
First, if the server's input is closed, it will shut down too. Second, if you call `lsp4clj.server/shutdown` on it, it will shut down.
140-
141-
When a server shuts down it stops reading input, finishes processing the messages it has in flight, and then closes is output. Finally it closes its `:log-ch` and `:trace-ch`. As such, it should probably not be shut down until the LSP `exit` notification (as opposed to the `shutdown` request) to ensure all messages are received. `lsp4clj.server/shutdown` will not return until all messages have been processed, or until 10 seconds have passed, whichever happens sooner. It will return `:done` in the first case and `:timeout` in the second.
142-
143-
## Other types of servers
144-
145-
So far the examples have focused on `lsp4clj.io-server/stdio-server`, because many clients communicate over stdio by default. The client opens a subprocess for the LSP server, then starts sending messages to the process via the process's stdin and reading messages from it on its stdout.
146-
147-
Many clients can also communicate over a socket. Typically the client starts a socket server, then passes a command-line argument to the LSP subprocess, telling it what port to connect to. The server is expected to connect to that port and use it to send and receive messages. In lsp4clj, that can be accomplished with `lsp4clj.io-server/server`:
148-
149-
```clojure
150-
(defn socket-server [{:keys [host port]}]
151-
{:pre [(or (nil? host) (string? host))
152-
(and (int? port) (<= 1024 port 65535))]}
153-
(let [addr (java.net.InetAddress/getByName host) ;; nil host == loopback
154-
sock (java.net.Socket. ^java.net.InetAddress addr ^int port)]
155-
(lsp4clj.io-server/server {:in sock
156-
:out sock})))
157-
```
158-
159-
`lsp4clj.io-server/server` accepts a pair of options `:in` and `:out`. These will be coerced to a `java.io.InputStream` and `java.io.OutputStream` via `clojure.java.io/input-stream` and `clojure.java.io/output-stream`, respectively. The example above works because a `java.net.Socket` can be coerced to both an input and output stream via this mechanism.
160-
161-
A similar approach can be used to connect over pipes.
162-
163-
## Development details
164-
165-
### Tracing
166-
167-
As you are implementing, you may want to trace incoming and outgoing messages. Initialize the server with `:trace-level "verbose"` and then read traces (two element vectors, beginning with the log level `:debug` and ending with a string, the trace itself) off its `:trace-ch`.
168-
169-
```clojure
170-
(let [server (lsp4clj.io-server/stdio-server {:trace-level "verbose"})]
171-
(async/go-loop []
172-
(when-let [[level trace] (async/<! (:trace-ch server))]
173-
(logger/log level trace)
174-
(recur)))
175-
(lsp4clj.server/start server context))
176-
```
177-
178-
`:trace-level` can be set to `"off"` (no tracing), `"messages"` (to show just the message time, method, id and direction), or `"verbose"` (to also show details of the message body).
179-
180-
The trace level can be changed during the life of a server by calling, for example, `(ls4clj.server/set-trace-level server "messages")`. This can be used to respect a trace level received at runtime, either in an [initialize](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initializeParams) request or a [$/setTrace](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#setTrace) notification.
181-
182-
### Testing
183-
184-
A client is in many ways like a server—it also sends and receives requests and notifications and receives responses. That is, LSP uses JSON-RPC as a bi-directional protocol. As such, you may be able to use some of lsp4clj's tools to build a mock client for testing. See `integration.client` in `clojure-lsp` for one such example.
185-
186-
You may also find `lsp4clj.server/chan-server` a useful alternative to `stdio-server`. This server reads and writes off channels, instead of stdio streams. See `lsp4clj.server-test` for many examples of interacting with such a server.
187-
188-
## Caveats
189-
190-
You must not print to stdout while a `stdio-server` is running. This will corrupt its output stream. Clients will receive malformed messages, and either throw errors or stop responding.
191-
192-
From experience, it's dismayingly easy to leave in an errant `prn` or `time` and end up with a non-responsive client. For this reason, we highly recommend supporting communication over sockets (see [other types of servers](#other-types-of-servers)) which are immune to this problem. However, since the choice of whether to use sockets or stdio is ultimately up to the client, you may have no choice but to support both.
193-
194-
lsp4clj provides one tool to avoid accidental writes to stdout (or rather to `*out*`, which is usually the same as `System.out`). To protect a block of code from writing to `*out*`, wrap it with `lsp4clj.server/discarding-stdout`. The `receive-notification` and `receive-request` multimethods are already protected this way, but tasks started outside of these multimethods or that run in separate threads need this protection added.
7+
Currently lsp4clj is just a wrapper for [jsonrpc4clj](https://github.com/clojure-lsp/jsonrpc4clj) adding some LSP schemas, for more details how to use it check that lib.
1958

1969
## Known lsp4clj users
19710

0 commit comments

Comments
 (0)