Merge pull request ejgallego#547 from ejgallego/fix_parsing_of_waitin…

…g_requests

[lsp] Fix bug when retrieving URIs from document params

CHANGES.md

@@ -7,6 +7,9 @@
    Saavedra (@Nfsaavedra, #536)
  - Properly concatenate warnings from _CoqProject (@ejgallego,
    reported by @mituharu, #541, fixes #540)
+ - Fix broken `coq/saveVo` and `coq/getDocument` requests due to a
+   parsing problem with extra fields in their requests (@ejgallego,
+   #549, reported by @Zimmi48)
 
 # coq-lsp 0.1.7: Just-in-time
 -----------------------------

controller/lsp_core.ml

@@ -35,11 +35,21 @@ module LIO = Lsp.Io
 module LSP = Lsp.Base
 
 module Helpers = struct
-  (* helpers; fix to have better errors on wrong protocol code *)
+  (* XXX helpers; fix to have better errors on wrong protocol code *)
+  (* Also note that rely sometimes on "subtyping" of fields, that's something to
+     think about better and fix, see #547 *)
   let get_uri params =
     let document =
-      field "textDocument" params
-      |> Lsp.Doc.TextDocumentIdentifier.of_yojson |> Result.get_ok
+      match
+        field "textDocument" params |> Lsp.Doc.TextDocumentIdentifier.of_yojson
+      with
+      | Ok uri -> uri
+      | Error err ->
+        (* ppx_deriving_yojson error messages leave a lot to be desired *)
+        let message = Format.asprintf "json parsing failed: %s" err in
+        LIO.logMessage ~lvl:1 ~message;
+        (* XXX Fixme *)
+        CErrors.user_err (Pp.str "failed to parse uri")
     in
     let Lsp.Doc.TextDocumentIdentifier.{ uri } = document in
     uri

lsp/doc.ml

@@ -17,8 +17,10 @@ module TextDocumentItem = struct
   [@@deriving yojson]
 end
 
+(* Sometimes we use this to parse VersionedTextDocumentIdentifier, we use {
+   strict = false } as a quick fix *)
 module TextDocumentIdentifier = struct
-  type t = { uri : Lang.LUri.File.t } [@@deriving yojson]
+  type t = { uri : Lang.LUri.File.t } [@@deriving yojson { strict = false }]
 end
 
 module OVersionedTextDocumentIdentifier = struct