prepare for 0.11

Allow request handlers to return Response.Errors

.github/workflows/format.yml

@@ -0,0 +1,17 @@
+name: format
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  format:
+    name: format
+    runs-on: ubuntu-latest
+    container: ghcr.io/c-cube/c-cube-commmon/ci-4.14:latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - run: opam exec -- make format-check

.github/workflows/gh-pages.yml

@@ -8,18 +8,13 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    container: ghcr.io/c-cube/c-cube-commmon/ci-doc-5.3:latest
+
     steps:
-      - uses: actions/checkout@main
-        with:
-          submodules: 'recursive'
-      - uses: ocaml/setup-ocaml@v3
-        with:
-          ocaml-compiler: '5.2'
-          dune-cache: true
-          allow-prerelease-opam: true
+      - uses: actions/checkout@v6
 
       - name: Deps
-        run: opam install odig linol linol-lwt
+        run: opam install linol linol-lwt
 
       - name: Build
         run: opam exec -- odig odoc --cache-dir=_doc/ linol linol-lwt || (odig log -e ; exit 1)

.github/workflows/main.yml

@@ -6,52 +6,25 @@ on:
   pull_request:
 jobs:
   build4:
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-        ocaml-compiler:
-          - 4.14.x
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
+    container: ghcr.io/c-cube/c-cube-commmon/ci-4.14:latest
     steps:
-    - uses: actions/checkout@main
+    - uses: actions/checkout@v6
       with:
         submodules: 'recursive'
-    - uses: ocaml/setup-ocaml@v3
-      with:
-        ocaml-compiler: ${{ matrix.ocaml-compiler }}
-        dune-cache: true
-        allow-prerelease-opam: true
     - run: opam pin -n .
-    - run: opam depext -yt linol linol-lwt
     - run: opam install linol linol-lwt --deps-only -t
     - run: opam exec -- dune build -p linol,linol-lwt
     - run: opam exec -- dune runtest -p linol,linol-lwt
-      if: ${{ matrix.os == 'ubuntu-latest'  }}
+
   build5:
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          #- macos-latest
-          #- windows-latest
-        ocaml-compiler:
-          - 5.1.x
-          - 5.2.x
-          - 5.3.x
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
+    container: ghcr.io/c-cube/c-cube-commmon/ci-5.4:latest
     steps:
-    - uses: actions/checkout@main
+    - uses: actions/checkout@v6
       with:
-          submodules: 'recursive'
-    - uses: ocaml/setup-ocaml@v3
-      with:
-        ocaml-compiler: ${{ matrix.ocaml-compiler }}
-        dune-cache: true
-        allow-prerelease-opam: true
+        submodules: 'recursive'
     - run: opam pin -n .
-    - run: opam depext -yt linol linol-lwt linol-eio
     - run: opam install -t . --deps-only
     - run: opam exec -- dune build
     - run: opam exec -- dune runtest
-      if: ${{ matrix.os == 'ubuntu-latest'  }}

CHANGES.md

@@ -3,6 +3,9 @@
 
 - breaking: the Eio library now needs the output channel to be paired with
     an `Eio.Mutex.t` to prevent race conditions (#58)
+- Allow request handlers to return Response.Errors
+- bring back `Linol_eio.spawn` for logging uncaught exceptions
+- Make template-eio handle requests concurrently
 
 # 0.10
 

Makefile

@@ -13,9 +13,12 @@ clean:
 doc:
 	@dune build @doc
 
-fmt:
+format:
 	@dune build @fmt --auto-promote
 
+format-check:
+	@dune build $(DUNE_OPTS) @fmt --display=quiet
+
 update-submodules:
 	@git submodule update --init
 

dune-project

@@ -8,7 +8,7 @@
 
 (name linol)
 
-(version 0.10)
+(version 0.11)
 
 (license MIT)
 

example/template-eio/main.ml

@@ -37,7 +37,7 @@ let diagnostics (_state : state_after_processing) : Lsp.Types.Diagnostic.t list
    so that users only need to override methods that they want the server to
    actually meaningfully interpret and respond to.
 *)
-class lsp_server ~(sw: Eio.Switch.t) =
+class lsp_server ~(sw : Eio.Switch.t) =
   object (self)
     inherit Linol_eio.Jsonrpc2.server
 

linol-eio.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.10"
+version: "0.11"
 synopsis: "LSP server library (with Eio for concurrency)"
 maintainer: ["Simon Cruanes"]
 authors: ["Nick Hu"]

linol-lwt.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.10"
+version: "0.11"
 synopsis: "LSP server library (with Lwt for concurrency)"
 maintainer: ["Simon Cruanes"]
 authors: ["Simon Cruanes"]

linol.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.10"
+version: "0.11"
 synopsis: "LSP server library"
 maintainer: ["Simon Cruanes"]
 authors: ["Simon Cruanes"]

src/eio/linol_eio.ml

@@ -54,12 +54,11 @@ end
 (** Spawn function. *)
 let spawn ~sw f =
   Eio.Fiber.fork ~sw (fun () ->
-   try
-     f ()
-   with exn ->
-     Printf.eprintf "uncaught exception in `spawn`:\n%s\n%!"
-       (Printexc.to_string exn);
-     raise exn)
+      try f ()
+      with exn ->
+        Printf.eprintf "uncaught exception in `spawn`:\n%s\n%!"
+          (Printexc.to_string exn);
+        raise exn)
 
 include Lsp.Types
 include IO_eio

src/jsonrpc2.ml

@@ -228,10 +228,7 @@ module Make (IO : IO) : S with module IO = IO = struct
             | Ok reply ->
               let reply_json = Lsp.Client_request.yojson_of_result r reply in
               Jsonrpc.Response.ok id reply_json
-            | Error message ->
-              Jsonrpc.Response.error id
-                (Jsonrpc.Response.Error.make
-                   ~code:Jsonrpc.Response.Error.Code.InternalError ~message ())
+            | Error err -> Jsonrpc.Response.error id err
           in
 
           send_response self response

src/server.ml

@@ -61,7 +61,7 @@ module Make (IO : IO) = struct
             server_request:send_request ->
             id:Req_id.t ->
             'a Lsp.Client_request.t ->
-            ('a, string) result IO.t
+            ('a, Jsonrpc.Response.Error.t) result IO.t
       (** Method called to handle client requests.
           @param notify_back
             an object used to reply to the client, send progress messages,
@@ -379,21 +379,31 @@ module Make (IO : IO) = struct
           server_request:_ ->
           id:Req_id.t ->
           r Lsp.Client_request.t ->
-          (r, string) result IO.t =
+          (r, Jsonrpc.Response.Error.t) result IO.t =
         fun ~notify_back ~server_request ~id (r : _ Lsp.Client_request.t) ->
           Trace.with_span ~__FILE__ ~__LINE__ "linol.on-request"
-          @@ fun _sp : (r, string) result IO.t ->
+          @@ fun _sp : (r, Jsonrpc.Response.Error.t) result IO.t ->
           (* handler to catch all errors *)
-          let try_catch : (unit -> (r, _) result IO.t) -> (r, _) result IO.t =
+          let try_catch :
+              (unit -> (r, Jsonrpc.Response.Error.t) result IO.t) ->
+              (r, Jsonrpc.Response.Error.t) result IO.t =
            fun f ->
-            IO.catch f (fun exn bt ->
-                let msg =
-                  spf "LSP request handler failed with %s\n%s"
-                    (Printexc.to_string exn)
-                    (Printexc.raw_backtrace_to_string bt)
-                in
-                Log.err (fun k -> k "%s" msg);
-                IO.return @@ Error msg)
+            IO.catch f (fun (exn : exn) bt ->
+                match exn with
+                | Linol_jsonrpc.Jsonrpc.Response.Error.E e ->
+                  IO.return @@ Error e
+                | _ ->
+                  let msg =
+                    spf "LSP request handler failed with %s\n%s"
+                      (Printexc.to_string exn)
+                      (Printexc.raw_backtrace_to_string bt)
+                  in
+                  Log.err (fun k -> k "%s" msg);
+                  IO.return
+                  @@ Error
+                       (Jsonrpc.Response.Error.make
+                          ~code:Jsonrpc.Response.Error.Code.InternalError
+                          ~message:msg ()))
           in
 
           try_catch @@ fun () ->
@@ -737,7 +747,8 @@ module Make (IO : IO) = struct
             in
 
             let new_doc : Lsp.Text_document.t =
-              Lsp.Text_document.apply_content_changes old_doc c
+              Lsp.Text_document.apply_content_changes ~version:doc.version
+                old_doc c
             in
 
             let new_st : doc_state =