Yojson 3 compat (#1534)

* Update Yojson constraint

* Make jsonrpc compatible with both Yojson 2 and 3. This patch has a drawback: now jsonrpc also depends on yojson.


---------

Co-authored-by: Ulysse Gérard <[email protected]>

Author: Leonidas-from-XIV

.github/workflows/build-and-test.yml

@@ -49,7 +49,7 @@ jobs:
 
       # Remove this pin once a compatible version of Merlin has been released
       - name: Pin dev Merlin
-        run: opam --cli=2.1 pin --with-version=5.4-503 https://github.com/ocaml/merlin.git#main
+        run: opam --cli=2.1 pin --with-version=5.5-503 https://github.com/ocaml/merlin.git#main
 
       - name: Build and install dependencies
         run: opam install .
@@ -90,7 +90,7 @@ jobs:
 
       # Remove this pin once a compatible version of Merlin has been released
       - name: Pin dev Merlin
-        run: opam --cli=2.1 pin --with-version=5.4-503 https://github.com/ocaml/merlin.git#main
+        run: opam --cli=2.1 pin --with-version=5.5-503 https://github.com/ocaml/merlin.git#main
 
       - name: Install dependencies
         run: |

CHANGES.md

@@ -14,6 +14,7 @@
 - Fix `inlay-hint` for function parameters (#1515)
 - More precise diagnostics in the event of a failed identifier search (`Definition_query`) (#1518)
 - Remove `ocamlformat` application after `destruct` (that remove some useful parenthesis) (#1519)
+- Make compatible with Yojson 3.x by removing `Tuple` and `Variant` (#1534)
 
 # 1.22.0
 

dune-project

@@ -31,7 +31,7 @@ possible and does not make any assumptions about IO.
 ")
  (depends
   (jsonrpc (= :version))
-  (yojson (< 3.0.0))
+  yojson
   (ppx_yojson_conv_lib (>= "v0.14"))
   (cinaps :with-test)
   (ppx_expect (and (>= v0.17.0) :with-test))
@@ -45,7 +45,7 @@ possible and does not make any assumptions about IO.
  (synopsis "LSP Server for OCaml")
  (description "An LSP server for OCaml.")
  (depends
-  (yojson (< 3.0.0))
+  yojson
   (base (>= v0.16.0))
   (lsp (= :version))
   (jsonrpc (= :version))
@@ -75,8 +75,9 @@ possible and does not make any assumptions about IO.
 
 (package
  (name jsonrpc)
- (synopsis "Jsonrpc protocol implemenation")
+ (synopsis "Jsonrpc protocol implementation")
  (description "See https://www.jsonrpc.org/specification")
  (depends
+  yojson
   (ocaml (>= 4.08))
   (odoc :with-doc)))

jsonrpc.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-synopsis: "Jsonrpc protocol implemenation"
+synopsis: "Jsonrpc protocol implementation"
 description: "See https://www.jsonrpc.org/specification"
 maintainer: ["Rudi Grinberg <[email protected]>"]
 authors: [
@@ -20,6 +20,7 @@ homepage: "https://github.com/ocaml/ocaml-lsp"
 bug-reports: "https://github.com/ocaml/ocaml-lsp/issues"
 depends: [
   "dune" {>= "3.0"}
+  "yojson"
   "ocaml" {>= "4.08"}
   "odoc" {with-doc}
 ]

jsonrpc/src/dune

@@ -1,4 +1,5 @@
 (library
  (public_name jsonrpc)
+ (libraries yojson)
  (instrumentation
   (backend bisect_ppx)))

jsonrpc/src/import.ml

@@ -9,18 +9,7 @@ module Option = struct
 end
 
 module Json = struct
-  type t =
-    [ `Assoc of (string * t) list
-    | `Bool of bool
-    | `Float of float
-    | `Int of int
-    | `Intlit of string
-    | `List of t list
-    | `Null
-    | `String of string
-    | `Tuple of t list
-    | `Variant of string * t option
-    ]
+  type t = Yojson.Safe.t
 
   exception Of_json of (string * t)
 

jsonrpc/src/jsonrpc.mli

@@ -1,18 +1,7 @@
 (** Jsonrpc implementation *)
 
 module Json : sig
-  type t =
-    [ `Assoc of (string * t) list
-    | `Bool of bool
-    | `Float of float
-    | `Int of int
-    | `Intlit of string
-    | `List of t list
-    | `Null
-    | `String of string
-    | `Tuple of t list
-    | `Variant of string * t option
-    ]
+  type t = Yojson.Safe.t
 
   (** Raised when conversions from json fail *)
   exception Of_json of (string * t)

lsp-fiber/src/import.ml

@@ -64,11 +64,11 @@ module Json = struct
     | `Bool f -> Bool f
     | `Assoc o -> Record (List.map o ~f:(fun (k, v) -> k, to_dyn v))
     | `List l -> List (List.map l ~f:to_dyn)
-    | `Tuple args -> Tuple (List.map args ~f:to_dyn)
     | `Null -> Dyn.Variant ("Null", [])
-    | `Variant (name, Some arg) -> Variant (name, [ to_dyn arg ])
-    | `Variant (name, None) -> Variant (name, [])
     | `Intlit s -> String s
+    | _ -> Dyn.Variant ("Unsupported", [])
+    (* This last case is unused with Yojson >= 3 *)
+  [@@warning "-11"]
   ;;
 end
 

lsp.opam

@@ -25,7 +25,7 @@ bug-reports: "https://github.com/ocaml/ocaml-lsp/issues"
 depends: [
   "dune" {>= "3.0"}
   "jsonrpc" {= version}
-  "yojson" {< "3.0.0"}
+  "yojson"
   "ppx_yojson_conv_lib" {>= "v0.14"}
   "cinaps" {with-test}
   "ppx_expect" {>= "v0.17.0" & with-test}

ocaml-lsp-server.opam

@@ -20,7 +20,7 @@ homepage: "https://github.com/ocaml/ocaml-lsp"
 bug-reports: "https://github.com/ocaml/ocaml-lsp/issues"
 depends: [
   "dune" {>= "3.0"}
-  "yojson" {< "3.0.0"}
+  "yojson"
   "base" {>= "v0.16.0"}
   "lsp" {= version}
   "jsonrpc" {= version}