Use (format-dune-file) instead of dune format-dune-file

[nojb]

Hello,

You are currently calling dune format-dune-file from one of your tests. This command does not honour the Dune lang version used in the project which means that your test will break whenever we change the formatting style in Dune.

In Dune 3.18 we introduced a built-in action (format-dune-file <src> <dst>) precisely for this purpose. This action honours the current Dune lang version and does not require shelling out to an external process.

Note that dune format-dune-file may evolve in ways that may not be backwards compatible in the near future (as the CLI interface does not have any backwards compatibility or versioning guarantees), so we are encouraging users of this command to switch to the action instead.

See ocaml/dune#10892 (comment) for some of the context.

[maiste]

Thanks @nojb!
I was about to do it today but you were clearly faster 😄

One question I have regarding this: shouldn't it add a dependency on dune >= 3.18 to make sure it supports the functionality?

[nojb]

Thanks @nojb! I was about to do it today but you were clearly faster 😄

One question I have regarding this: shouldn't it add a dependency on dune >= 3.18 to make sure it supports the functionality?

Yes, indeed. I pushed a fix (I think ; I am not very familiar with OPAM).

[panglesd]

Thanks @nojb! That looks good.

The benchmark CI failure seems to be related to ocaml/dune#11045.
It does not happen on ocaml-ci, which install deps and then call dune. On the contrary, the benchmark ci seems to pin everything and install them with opam, which calls dune subst and that is what is breaking.

Maybe that would be better to wait for the ocaml/dune#11045 fix to be released before raising dune lang if that is what triggers the bug?

[maiste]

The new fix was merged. It should be available in 3.20.

[panglesd]

With the newly released dune, the benchmark CI still fails :(

#10 217.7 #=== ERROR while compiling odoc-parser.dev ====================================#
#10 217.7 # context              2.1.6 | linux/x86_64 | ocaml-base-compiler.5.0.0 | pinned(file:///home/opam/bench-dir)
#10 217.7 # path                 ~/.opam/5.0/.opam-switch/build/odoc-parser.dev
#10 217.7 # command              ~/.opam/5.0/bin/dune subst
#10 217.7 # exit-code            1
#10 217.7 # env-file             ~/.opam/log/odoc-parser-63-674de6.env
#10 217.7 # output-file          ~/.opam/log/odoc-parser-63-674de6.out
#10 217.7 ### output ###
#10 217.7 # File "odoc-bench.opam", line 1, characters 0-0:
#10 217.7 # Error: repository does not contain any version information

[maiste]

I'm not sure it contains the patch from: ocaml/dune@ad06a13.

[panglesd]

I think it does include it. The old error message was:

File "odoc-bench.opam", line 1, characters 10-25:
1 | # This file is generated by dune, edit dune-project instead
              ^^^^^^^^^^^^^^^
Error: repository does not contain any version information

and it is now:

File "odoc-bench.opam", line 1, characters 0-0:
Error: repository does not contain any version information

I guess the error is either on the benchmark CI or on dune's side, so it would be a pity to block this PR on it. I don't know how much the benchmark CI is used, at least I struggle with its UI...

[shonfeder]

Hi, all 👋 !

I've just learned that we are blocking new release on dune until this can be resolved, and that some are waiting on fixes that are ready to be released there.

IIUC, from the issue here, the problem in the CI does not seem to be fixable from this PR. So could we please move forward with merging this fix, and create a followup issue wherever needed to fix the benchmarking issue?

[jonludlam]

OK, we'll assume a fix is on its way and merge this anyway.

[shonfeder]

Thanks very much!