Check if ocamllsp is present the dune way (#1907)

* check if ocamllsp is present the dune way

* add changelog

* Update src/dune.ml

Co-authored-by: Sonja Heinze <[email protected]>

* Update src/dune.ml

Co-authored-by: Sonja Heinze <[email protected]>

* Update src/sandbox.ml

Co-authored-by: Sonja Heinze <[email protected]>

* Update src/dune.mli

Co-authored-by: Sonja Heinze <[email protected]>

* minor bug fix

* install ocamllsp for dune

* remove changelog

* Update src/dune.mli

Signed-off-by: Sora Morimoto <[email protected]>

---------

Signed-off-by: Sora Morimoto <[email protected]>
Co-authored-by: Sonja Heinze <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>

Author: 3 people

src/dune.ml

@@ -70,16 +70,6 @@ let is_project_locked t =
   Fs.exists (Path.to_string dune_lock_path)
 ;;
 
-let is_ocamllsp_present t =
-  (* Path to the ocaml-lsp-server.pkg file *)
-  let ocamllsp =
-    Path.join
-      t.root
-      (Path.join (Path.of_string "dev-tools.locks") (Path.of_string "ocaml-lsp-server"))
-  in
-  Fs.exists (Path.to_string ocamllsp)
-;;
-
 let command t ~args = Cmd.Spawn (Cmd.append t.bin args)
 
 let exec ~target ?(args = []) t =
@@ -88,8 +78,21 @@ let exec ~target ?(args = []) t =
 
 let exec_pkg ~cmd ?(args = []) t = Cmd.Spawn (Cmd.append t.bin ([ "pkg"; cmd ] @ args))
 
-let exec_tool ~tool ?(args = []) t =
-  Cmd.Spawn (Cmd.append t.bin ([ "tools"; "exec"; tool; "--" ] @ args))
+let tools ~tool ?(args = []) t cmd =
+  match cmd with
+  | `Exec_ -> Cmd.Spawn (Cmd.append t.bin ([ "tools"; "exec"; tool; "--" ] @ args))
+  | `Which -> Cmd.Spawn (Cmd.append t.bin ([ "tools"; "which"; tool ] @ args))
+  | `Install -> Cmd.Spawn (Cmd.append t.bin ([ "tools"; "install"; tool ] @ args))
+;;
+
+let is_ocamllsp_present t =
+  let open Promise.Syntax in
+  let+ ocamllsp_path = tools ~tool:"ocamllsp" t `Which |> Cmd.output ~cwd:t.root in
+  match ocamllsp_path with
+  | Ok _path -> true
+  | Error err ->
+    log_chan `Info ~section:"dune" "Ocamllsp not found with error %s" err;
+    false
 ;;
 
 let equal d1 d2 = Path.equal d1.root d2.root

src/dune.mli

@@ -10,9 +10,6 @@ type t =
     If not, user should be advised to run `dune pkg lock` *)
 val is_project_locked : t -> bool Promise.t
 
-(** Check if the dune project has ocamllsp server as a dev-tool. *)
-val is_ocamllsp_present : t -> bool Promise.t
-
 (** Generic function to execute dune commands *)
 val command : t -> args:string list -> Cmd.t
 
@@ -22,8 +19,16 @@ val exec : target:string -> ?args:string list -> t -> Cmd.t
 (** Run specific `dune pkg <foo> commands*)
 val exec_pkg : cmd:string -> ?args:string list -> t -> Cmd.t
 
-(** Execute any `dune tools exec` command*)
-val exec_tool : tool:string -> ?args:string list -> t -> Cmd.t
+(** Run `dune tools <exec/which>` *)
+val tools
+  :  tool:string
+  -> ?args:string list
+  -> t
+  -> [< `Exec_ | `Which | `Install ]
+  -> Cmd.t
+
+(** Check if the dune project has ocamllsp server as a dev-tool. *)
+val is_ocamllsp_present : t -> bool Promise.t
 
 (** Check if amy two instances of dune pkg management projects are equal *)
 val equal : t -> t -> bool

src/extension_commands.ml

@@ -114,14 +114,14 @@ let _install_dune_lsp_server =
             let options =
               ProgressOptions.create
                 ~location:(`ProgressLocation Notification)
-                ~title:"Installing ocaml-lsp server using `dune tools exec ocamllsp`"
+                ~title:"Installing ocaml-lsp server using `dune tools install ocamllsp`"
                 ~cancellable:false
                 ()
             in
             let task ~progress:_ ~token:_ =
               let+ result =
                 (* We first check the version so that the process can exit, otherwise the progress indicator runs forever.*)
-                Sandbox.get_command sandbox "ocamllsp" [ "--version" ] `Tool
+                Sandbox.get_command sandbox "ocamllsp" [] `Install
                 |> Cmd.output ~cwd:(Dune.root dune)
               in
               match result with

src/sandbox.ml

@@ -545,13 +545,20 @@ let select_sandbox_and_save t =
   Some sandbox
 ;;
 
-let get_command sandbox bin args (dune_cmd_type : [> `Tool | `Command | `Exec ]) : Cmd.t =
+let get_command
+      sandbox
+      bin
+      args
+      (dune_cmd_type : [> `Tool | `Command | `Exec | `Install ])
+  : Cmd.t
+  =
   match sandbox with
   | Opam (opam, switch) -> Opam.exec opam switch ~args:(bin :: args)
   | Esy (esy, manifest) -> Esy.exec esy manifest ~args:(bin :: args)
   | Dune dune ->
     (match dune_cmd_type with
-     | `Tool -> Dune.exec_tool ~tool:bin ~args dune
+     | `Install -> Dune.tools ~tool:bin ~args dune `Install
+     | `Tool -> Dune.tools ~tool:bin ~args dune `Exec_
      | `Command -> Dune.command dune ~args
      | `Exec -> Dune.exec ~target:bin ~args dune)
   | Global -> Spawn { bin = Path.of_string bin; args }

src/sandbox.mli

@@ -54,7 +54,12 @@ val select_sandbox : t -> t option Promise.t
 (* Helper utils *)
 
 (** Extract command to run with the sandbox *)
-val get_command : t -> string -> string list -> [ `Command | `Exec | `Tool ] -> Cmd.t
+val get_command
+  :  t
+  -> string
+  -> string list
+  -> [ `Command | `Exec | `Tool | `Install ]
+  -> Cmd.t
 
 (** Command to install dependencies in the sandbox *)
 val get_install_command : t -> string list -> Cmd.t option