Fix "clean" hooks in non-umbrella apps and when override are presents #2863
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This patch currently breaks profile application with |
ferd
force-pushed
the
fix-clean-hooks
branch
from
f06e116
to
2a7801b
Compare
|
huh, I think this fixed the application of single app hooks by properly assigning them in the top-level app in a non-umbrella project. See how the multi app filehas a single @tsloughter I think this is fixing things properly and we'll need to update the shelltests to accomodate this. |
ferd
added a commit
to tsloughter/rebar3_tests
that referenced
this pull request
Feb 20, 2024
As mentioned in erlang/rebar3#2863, fixing the `clean` hooks appears to have fixed their count by properly assigning them in the top-level app in a non-umbrella project. See how [the multi app file](https:/tsloughter/rebar3_tests/blob/cba67afa851747bcdb5294c9d88c697f0d814b3c/multi_app_hooks/multi_app_hooks.test#L5) has a single `CLEAN!` hook but [the single app one had two for clean](https:/tsloughter/rebar3_tests/blob/cba67afa851747bcdb5294c9d88c697f0d814b3c/single_app_hooks/single_app_hooks.test#L5-L6) while [having a single one for compile](https:/tsloughter/rebar3_tests/blob/cba67afa851747bcdb5294c9d88c697f0d814b3c/single_app_hooks/single_app_hooks.test#L14). This is because the discovery step we weren't doing right before the PR meant that the hook was assigned both to the project and the individual app. By fixing the detection and overrides, the hook is properly assigned to the app in a single-app project, and to the project root when in an umbrella. This PR prepares tests to pass once the rebar3 one is merged.
|
Related PR: tsloughter/rebar3_tests#20 |
ferd
changed the title
The issue appears to be that because the 'clean' operation might be run while dependencies have not yet been compiled, we applied a partial app detection mechanism with `rebar_app_disover:find_apps(..., ..., all, ...)`, which worked to parse "invalid" (unbuilt) apps, but also did not apply overrides. Instead, we trust the `install_deps` provider dependency by reusing the apps as they were fully parsed _if_ they were valid, and falling back to the `rebar_app_discover:find_apps/4` call only to cover the unreadable ones. This, it turns out, has the side effect of properly applying hooks when apps are fully parsed, and fixes erlang#2862 Note that we can only clean paths safely if the discovery steps for the apps is done with the right profile and options, which may also impact configurations and hooks. So rather than duplicating that, we invoke the 'as' provider. This also opens the door on choosing a different provider (such as 'app_discover' only) down the road if the -a option isn't given.
ferd
force-pushed
the
fix-clean-hooks
branch
from
2a7801b
to
c4dce2d
Compare
The selection is a bit coarse right now (it's possible a specific app is not a dep but a top-level app), but we regardless keep basic cleaning as a simple discovery step to avoid installing deps there.
ferd
added a commit
to tsloughter/rebar3_tests
that referenced
this pull request
Feb 21, 2024
erlang/rebar3#2863 makes it so we stop scanning dependencies when cleaning only top-level apps.
|
tsloughter/rebar3_tests#21 is needed for this to pass. |
tsloughter
approved these changes
Feb 21, 2024
|
tsloughter/rebar3_tests#22 again :( |
cannadayr
added a commit
to cannadayr/BeamQN
that referenced
this pull request
May 18, 2024
Expand documentation with risks and status. Include a local rebar3 build to include erlang/rebar3#2863. Extend commands to use path environment variable to prevent erlang/otp header mismatch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The issue appears to be that because the 'clean' operation might be run while dependencies have not yet been compiled, we applied a partial app detection mechanism with
rebar_app_disover:find_apps(..., ..., all, ...), which worked to parse "invalid" (unbuilt) apps, but also did not apply overrides.Instead, we trust the
install_depsprovider dependency by reusing the apps as they were fully parsed if they were valid, and falling back to therebar_app_discover:find_apps/4call only to cover the unreadable ones.This, it turns out, has the side effect of properly applying hooks when apps are fully parsed, and fixes #2862
In turn, this change let me fix things up such that we no longer call
install_depswhen just callingrebar3 clean-- we still need to call it when doing a broader clean (--appsor--all) but not when just calling it with no arguments.