fix(pkg): dune fmt missing extra files from the locks.

bin/build_cmd.ml

@@ -82,12 +82,11 @@ let run_build_system ~common ~request =
       Fiber.return ())
 ;;
 
-let run_build_command_poll_eager ~(common : Common.t) ~config ~request : unit =
-  Scheduler.go_with_rpc_server_and_console_status_reporting ~common ~config (fun () ->
-    Scheduler.Run.poll (run_build_system ~common ~request))
+let run_build_command_poll_eager ~(common : Common.t) ~request =
+  Scheduler.Run.poll (run_build_system ~common ~request)
 ;;
 
-let run_build_command_poll_passive ~(common : Common.t) ~config ~request:_ : unit =
+let run_build_command_poll_passive ~(common : Common.t) ~config ~request:_ =
   (* CR-someday aalekseyev: It would've been better to complain if [request] is
      non-empty, but we can't check that here because [request] is a function.*)
   let open Fiber.O in
@@ -96,35 +95,67 @@ let run_build_command_poll_passive ~(common : Common.t) ~config ~request:_ : uni
     | `Allow server -> server
     | `Forbid_builds -> Code_error.raise "rpc server must be allowed in passive mode" []
   in
-  Scheduler.go_with_rpc_server_and_console_status_reporting ~common ~config (fun () ->
-    Scheduler.Run.poll_passive
-      ~get_build_request:
-        (let+ (Build (targets, ivar)) = Dune_rpc_impl.Server.pending_build_action rpc in
-         let request setup =
-           Target.interpret_targets (Common.root common) config setup targets
-         in
-         run_build_system ~common ~request, ivar))
+  Scheduler.Run.poll_passive
+    ~get_build_request:
+      (let+ (Build (targets, ivar)) = Dune_rpc_impl.Server.pending_build_action rpc in
+       let request setup =
+         Target.interpret_targets (Common.root common) config setup targets
+       in
+       run_build_system ~common ~request, ivar)
 ;;
 
-let run_build_command_once ~(common : Common.t) ~config ~request =
+let run_build_command_once ~(common : Common.t) ~request =
   let open Fiber.O in
-  let once () =
-    let+ res = run_build_system ~common ~request in
-    match res with
-    | Error `Already_reported -> raise Dune_util.Report_error.Already_reported
-    | Ok () -> ()
-  in
-  Scheduler.go ~common ~config once
+  let+ res = run_build_system ~common ~request in
+  match res with
+  | Error `Already_reported -> raise Dune_util.Report_error.Already_reported
+  | Ok () -> ()
 ;;
 
 let run_build_command ~(common : Common.t) ~config ~request =
-  (match Common.watch common with
-   | Yes Eager -> run_build_command_poll_eager
-   | Yes Passive -> run_build_command_poll_passive
-   | No -> run_build_command_once)
-    ~common
-    ~config
-    ~request
+  match Common.watch common with
+  | Yes Eager ->
+    (fun () -> run_build_command_poll_eager ~common ~request)
+    |> Scheduler.go_with_rpc_server_and_console_status_reporting ~common ~config
+  | Yes Passive ->
+    (fun () -> run_build_command_poll_passive ~common ~config ~request)
+    |> Scheduler.go_with_rpc_server_and_console_status_reporting ~common ~config
+  | No ->
+    (fun () -> run_build_command_once ~common ~request) |> Scheduler.go ~common ~config
+;;
+
+let run_build_command_fmt ~(common : Common.t) ~config ~request =
+  let lock_ocamlformat () =
+    if Lazy.force Lock_dev_tool.is_enabled
+    then
+      (* Note that generating the ocamlformat lockdir here means
+         that it will be created when a user runs `dune fmt` but not
+         when a user runs `dune build @fmt`. It's important that
+         this logic remain outside of `dune build`, as `dune
+         build` is intended to only build targets, and generating
+         a lockdir is not building a target. *)
+      Lock_dev_tool.lock_ocamlformat () |> Memo.run
+    else Fiber.return ()
+  in
+  match Common.watch common with
+  | Yes Eager ->
+    (fun () ->
+      let open Fiber.O in
+      let* () = lock_ocamlformat () in
+      run_build_command_poll_eager ~common ~request)
+    |> Scheduler.go_with_rpc_server_and_console_status_reporting ~common ~config
+  | Yes Passive ->
+    (fun () ->
+      let open Fiber.O in
+      let* () = lock_ocamlformat () in
+      run_build_command_poll_passive ~common ~config ~request)
+    |> Scheduler.go_with_rpc_server_and_console_status_reporting ~common ~config
+  | No ->
+    (fun () ->
+      let open Fiber.O in
+      let* () = lock_ocamlformat () in
+      run_build_command_once ~common ~request)
+    |> Scheduler.go ~common ~config
 ;;
 
 let runtest_info =
@@ -231,24 +262,11 @@ let fmt =
     in
     let common, config = Common.init builder in
     let request (setup : Import.Main.build_system) =
-      let open Action_builder.O in
-      let* () =
-        if Lazy.force Lock_dev_tool.is_enabled
-        then
-          (* Note that generating the ocamlformat lockdir here means
-             that it will be created when a user runs `dune fmt` but not
-             when a user runs `dune build @fmt`. It's important that
-             this logic remain outside of `dune build`, as `dune
-             build` is intended to only build targets, and generating
-             a lockdir is not building a target. *)
-          Action_builder.of_memo (Lock_dev_tool.lock_ocamlformat ())
-        else Action_builder.return ()
-      in
       let dir = Path.(relative root) (Common.prefix_target common ".") in
       Alias.in_dir ~name:Dune_rules.Alias.fmt ~recursive:true ~contexts:setup.contexts dir
       |> Alias.request
     in
-    run_build_command ~common ~config ~request
+    run_build_command_fmt ~common ~config ~request
   in
   Cmd.v (Cmd.info "fmt" ~doc ~man ~envs:Common.envs) term
 ;;

test/blackbox-tests/test-cases/pkg/ocamlformat/dune

@@ -5,3 +5,7 @@
 (cram
  (deps %{bin:curl})
  (applies_to ocamlformat-e2e))
+
+(cram
+ (deps %{bin:md5sum})
+ (applies_to ocamlformat-patch-extra-files))

test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-patch-extra-files.t

@@ -0,0 +1,61 @@
+'dune fmt' could miss the extra-files from "dev-tools.locks" directory for the first run, if the
+auto-locking comes before the setup of the dune project meaning the loading of dune source tree.
+
+  $ . ./helpers.sh
+  $ mkrepo
+
+Make a fake ocamlformat:
+  $ make_fake_ocamlformat "0.1"
+
+A patch that changes the version from "0.1" to "0.26.2":
+  $ cat > patch-for-ocamlformat.patch <<EOF
+  > diff a/ocamlformat.ml b/ocamlformat.ml
+  > --- a/ocamlformat.ml
+  > +++ b/ocamlformat.ml
+  > @@ -1,6 +1,6 @@
+  > -let version = "0.1"
+  > +let version = "0.26.2"
+  >  let () =
+  >    if Sys.file_exists ".ocamlformat-ignore" then
+  >    print_endline "ignoring some files"
+  >  ;;
+  >  let () = print_endline ("formatted with version "^version)
+  > EOF
+
+Make the ocamlformat opam package which uses a patch:
+  $ mkpkg ocamlformat "0.26.2"  <<EOF
+  > build: [
+  >   [
+  >     "dune"
+  >     "build"
+  >     "-p"
+  >     name
+  >     "-j"
+  >     jobs
+  >   ]
+  > ]
+  > extra-files: ["patch-for-ocamlformat.patch" "md5=$(md5sum patch-for-ocamlformat.patch | cut -f1 -d' ')"]
+  > patches: ["patch-for-ocamlformat.patch"]
+  > url {
+  >  src:"file://$PWD/ocamlformat-0.1.tar"
+  >  checksum: [
+  >   "md5=$(md5sum ocamlformat-0.1.tar | cut -f1 -d' ')"
+  >  ]
+  > }
+  > EOF
+  $ mkdir -p mock-opam-repository/packages/ocamlformat/ocamlformat.0.26.2/files/
+  $ cp patch-for-ocamlformat.patch mock-opam-repository/packages/ocamlformat/ocamlformat.0.26.2/files/
+
+Make a project that uses the fake ocamlformat:
+  $ make_project_with_dev_tool_lockdir
+
+First time run
+  $ DUNE_CONFIG__LOCK_DEV_TOOL=enabled dune fmt 2>&1 | sed -E 's#.*.sandbox/[^/]+#.sandbox/$SANDBOX#g'
+  Solution for dev-tools.locks/ocamlformat:
+  - ocamlformat.0.26.2
+  File "foo.ml", line 1, characters 0-0:
+  Error: Files _build/default/foo.ml and _build/default/.formatted/foo.ml
+  differ.
+  Promoting _build/default/.formatted/foo.ml to foo.ml.
+  $ cat foo.ml
+  formatted with version 0.26.2