pkg: relock ocamlformat when version changes (#12605)

The .ocamlformat file can contain the version of ocamlformat which a
project uses for autoformatting. Previously this file was used to
determine which version of ocamlformat to install initially, but changes
to the version specified in .ocamlformat did not cause dune to relock
the tool with the new version, leading to a mismatch between the
specified and installed versions of ocamlformat within a project.

This change allows dune to detect when the specified and locked versions
of ocamlformat differ, and relocks (and re-installs) ocamlformat in this
case.

Signed-off-by: Stephen Sherratt <[email protected]>

Author: gridbugs

bin/lock_dev_tool.ml

@@ -185,34 +185,51 @@ let lockdir_status dev_tool =
     (match Lock_dir.read_disk dev_tool_lock_dir with
      | Error _ -> Memo.return `No_lockdir
      | Ok { packages; _ } ->
-       (match Dune_pkg.Dev_tool.needs_to_build_with_same_compiler_as_project dev_tool with
-        | false -> Memo.return `Lockdir_ok
-        | true ->
-          let* platform =
-            Pkg.Pkg_common.poll_solver_env_from_current_system ()
-            |> Memo.of_reproducible_fiber
-          in
-          let packages = Lock_dir.Packages.pkgs_on_platform_by_name packages ~platform in
-          (match Package_name.Map.find packages compiler_package_name with
-           | None -> Memo.return `No_compiler_lockfile_in_lockdir
-           | Some { info; _ } ->
-             let+ ocaml_compiler_version = locked_ocaml_compiler_version () in
-             (match Package_version.equal info.version ocaml_compiler_version with
-              | true -> `Lockdir_ok
-              | false ->
-                `Dev_tool_needs_to_be_relocked_because_project_compiler_version_changed
-                  (User_message.make
-                     [ Pp.textf
-                         "The version of the compiler package (%S) in this project's \
-                          lockdir has changed to %s (formerly the compiler version was \
-                          %s). The dev-tool %S will be re-locked and rebuilt with this \
-                          version of the compiler."
-                         (Package_name.to_string compiler_package_name)
-                         (Package_version.to_string ocaml_compiler_version)
-                         (Package_version.to_string info.version)
-                         (Dune_pkg.Dev_tool.package_name dev_tool
-                          |> Package_name.to_string)
-                     ])))))
+       let* platform =
+         Pkg.Pkg_common.poll_solver_env_from_current_system ()
+         |> Memo.of_reproducible_fiber
+       in
+       let packages = Lock_dir.Packages.pkgs_on_platform_by_name packages ~platform in
+       let package_name = Dune_pkg.Dev_tool.package_name dev_tool in
+       (match Package_name.Map.find packages package_name with
+        | None ->
+          Memo.return
+            (`Lockdir_missing_entry_for_tool
+                (User_message.make
+                   [ Pp.textf
+                       "The lock directory for the tool %S exists but does not contain a \
+                        lockfile for the package %S. This may indicate that the lock \
+                        directory has been tampered with. Please avoid making manual \
+                        changes to tool lock directories. The tool will now be relocked."
+                       (Dune_pkg.Dev_tool.exe_name dev_tool)
+                       (Package_name.to_string package_name)
+                   ]))
+        | Some pkg ->
+          (match
+             Dune_pkg.Dev_tool.needs_to_build_with_same_compiler_as_project dev_tool
+           with
+           | false -> Memo.return (`Lockdir_ok_with_tool_pkg pkg)
+           | true ->
+             (match Package_name.Map.find packages compiler_package_name with
+              | None -> Memo.return `No_compiler_lockfile_in_lockdir
+              | Some { info; _ } ->
+                let+ ocaml_compiler_version = locked_ocaml_compiler_version () in
+                (match Package_version.equal info.version ocaml_compiler_version with
+                 | true -> `Lockdir_ok_with_tool_pkg pkg
+                 | false ->
+                   `Dev_tool_needs_to_be_relocked_because_project_compiler_version_changed
+                     (User_message.make
+                        [ Pp.textf
+                            "The version of the compiler package (%S) in this project's \
+                             lockdir has changed to %s (formerly the compiler version \
+                             was %s). The dev-tool %S will be re-locked and rebuilt with \
+                             this version of the compiler."
+                            (Package_name.to_string compiler_package_name)
+                            (Package_version.to_string ocaml_compiler_version)
+                            (Package_version.to_string info.version)
+                            (Dune_pkg.Dev_tool.package_name dev_tool
+                             |> Package_name.to_string)
+                        ]))))))
 ;;
 
 (* [lock_dev_tool_at_version dev_tool version] generates the lockdir for the
@@ -224,7 +241,28 @@ let lock_dev_tool_at_version dev_tool version =
   let* need_to_solve =
     lockdir_status dev_tool
     >>| function
-    | `Lockdir_ok -> false
+    | `Lockdir_ok_with_tool_pkg (pkg : Dune_pkg.Lock_dir.Pkg.t) ->
+      (match version with
+       | None -> false
+       | Some version ->
+         (* If this function was passed a specific version, and the dev
+            tool's lockfile contains a different version from the specified
+            version, regenerate the lockdir. *)
+         let different_version_currently_locked =
+           not (Package_version.equal pkg.info.version version)
+         in
+         if different_version_currently_locked
+         then
+           Console.print
+             [ Pp.textf
+                 "The lock directory for the tool %S exists but contains a solution for \
+                  %s of the tool, whereas version %s now needs to be installed. The tool \
+                  will now be re-locked."
+                 (Dune_pkg.Dev_tool.exe_name dev_tool)
+                 (Package_version.to_string pkg.info.version)
+                 (Package_version.to_string version)
+             ];
+         different_version_currently_locked)
     | `No_lockdir -> true
     | `No_compiler_lockfile_in_lockdir ->
       Console.print
@@ -237,6 +275,9 @@ let lock_dev_tool_at_version dev_tool version =
     | `Dev_tool_needs_to_be_relocked_because_project_compiler_version_changed message ->
       Console.print_user_message message;
       true
+    | `Lockdir_missing_entry_for_tool message ->
+      User_warning.emit_message message;
+      true
   in
   if need_to_solve
   then

test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-relock-on-corrupt-lockdir.t

@@ -0,0 +1,28 @@
+When installing a dev tool which already has a lockdir, detect the case where
+the tool's lockfile is absent from the lockdir and relock.
+
+  $ . ./helpers.sh
+  $ mkrepo
+
+Make a fake ocamlformat package
+  $ make_fake_ocamlformat "0.26.0"
+  $ make_ocamlformat_opam_pkg "0.26.0"
+
+  $ make_project_with_dev_tool_lockdir
+
+Install ocamlformat once to generate the lockdir.
+  $ dune tools install ocamlformat
+  Solution for dev-tools.locks/ocamlformat:
+  - ocamlformat.0.26.0
+
+Delete ocamlformat's lockfile.
+  $ rm dev-tools.locks/ocamlformat/ocamlformat.pkg
+
+Reinstall ocamlformat.
+  $ dune tools install ocamlformat
+  Warning: The lock directory for the tool "ocamlformat" exists but does not
+  contain a lockfile for the package "ocamlformat". This may indicate that the
+  lock directory has been tampered with. Please avoid making manual changes to
+  tool lock directories. The tool will now be relocked.
+  Solution for dev-tools.locks/ocamlformat:
+  - ocamlformat.0.26.0

test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-version-change.t

@@ -0,0 +1,39 @@
+When the version in .ocamlformat changes, automatically relock ocamlformat with
+the new version.
+
+  $ . ./helpers.sh
+  $ mkrepo
+
+  $ make_fake_ocamlformat "0.26.0"
+  $ echo ocamlformat-0.26.0.tar > fake-curls
+  $ make_ocamlformat_opam_pkg "0.26.0" 1
+
+  $ make_fake_ocamlformat "0.27.0"
+  $ echo ocamlformat-0.27.0.tar >> fake-curls
+  $ make_ocamlformat_opam_pkg "0.27.0" 2
+
+Make dune-project that uses the mocked dev-tool opam-reposiotry.
+  $ make_project_with_dev_tool_lockdir
+
+Create .ocamlformat file
+  $ cat > .ocamlformat <<EOF
+  > version = 0.26.0
+  > EOF
+
+Install ocamlformat. 0.26.0 should be installed because that's the version in .ocamlformat.
+  $ dune tools install ocamlformat
+  Solution for dev-tools.locks/ocamlformat:
+  - ocamlformat.0.26.0
+
+Change the version in .ocamlformat.
+  $ cat > .ocamlformat <<EOF
+  > version = 0.27.0
+  > EOF
+
+Install ocamlformat again. Dune should detect that the version has changed and relock:
+  $ dune tools install ocamlformat
+  The lock directory for the tool "ocamlformat" exists but contains a solution
+  for 0.26.0 of the tool, whereas version 0.27.0 now needs to be installed. The
+  tool will now be re-locked.
+  Solution for dev-tools.locks/ocamlformat:
+  - ocamlformat.0.27.0