Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix] [directory targets] Fix promotion of directory targets in some cases #10931

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[fix] [directory targets] Fix promotion of directory targets in some cases #10931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/changes/10931.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Fix promotion of directory targets when the promoted directory has
sub-directories with only other sub-directories inside; regression
in b1c339b / #9407 (@ejgallego, closes #10609)
4 changes: 1 addition & 3 deletions src/dune_targets/dune_targets.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,7 @@ module Produced = struct
acc_filenames, Path.Local.Map.union_exn acc_dirs dir
| _ -> Error (Unsupported_file (Path.Build.relative dir filename, kind)))
in
if not (Filename.Map.is_empty filenames)
then Path.Local.Map.add_exn dirs local filenames
else dirs
Path.Local.Map.add_exn dirs local filenames
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure for this fix, I think this code is fine. The issue is coming from somewhere else.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the help. My impression is that indeed it matters that we add the binding { dir -> [] } to the map, as even if the directory doesn't have files, it can have subdirs.

But I didn't track down exactly the part that makes the current code break.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So indeed you are correct that the crash happens at remove_state_files_and_subdirectories, but my impression is that we break the invariant about source representation that the above function requires.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get it, that's fair point.

The question I have now is, are we going to allow promoting empty directories ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the confusion is about what we call "empty directory", empty directories are OK not to promote in my view, however here the directories in question are not empty, they just have no files, however they do have other subdirectories, so definitively they need to be considered part of the sources.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested the fix, it is promoting even empty directories.
This is not fixing exactly the test-case, it's fixing it indirectly by allowing an empty directory.

Copy link
Collaborator Author

@ejgallego ejgallego Sep 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed after this, empty directories are promoted. I don't see why they shouldn't be promoted?

We could optimize this away, but I am not sure it is worth it, it would likely require more invasive changes. Note that in the PR that caused this regression, not promoting empty dirs was regarded as an optimization IIRC.

Note that the fix doesn't exactly allow "empty directories", it allows too, crutially, directories that have no files but are not empty, such as the test case.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking to this further. I agree with you, this where we need to fix the issue.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one of the solution moyodiallo@b00b92e.

The thing is adding all the parent directories of the collected files, it will ends up with no empty directory.

in
let directory root dirname =
let open Result.O in
Expand Down
24 changes: 24 additions & 0 deletions test/blackbox-tests/test-cases/directory-targets/github10609/run.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
We test that a directory target with only other subdirs can be
properly promoted.

$ cat > dune-project <<EOF
> (lang dune 3.16)
> (using directory-targets 0.1)
> EOF

$ cat > dune <<EOF
> (rule
> (targets (dir node_modules))
> (mode (promote (until-clean)))
> (action
> (progn
> (system "mkdir -p node_modules/node-cmake/")
> (system "touch node_modules/node-cmake/.jshintrc")
> (system "mkdir -p node_modules/node-cmake/node_modules/ansi-regex")
> (system "touch node_modules/node-cmake/node_modules/ansi-regex/index.js")
> )))
> EOF

$ dune build node_modules
$ ls node_modules
node-cmake
4 changes: 2 additions & 2 deletions test/blackbox-tests/test-cases/directory-targets/main.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Error message when the matching directory target is empty.
2 | (deps (sandbox always))
3 | (targets (dir output))
4 | (action (bash "mkdir output")))
Error: Rule produced directory "output" that contains no files nor non-empty
subdirectories
Error: This rule defines a directory target "output" that matches the
requested path "output/x" but the rule's action didn't produce it
[1]

Error message when the matching directory target doesn't contain a requested path.
Expand Down
Loading