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.

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

[MBUILDCACHE-105] Executing 'clean process-test-classes' then 'clean verify' leads to empty jars #176

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

reda-alaoui
Copy link
Member

This PR makes sure any cached build that doesn't involve phase package is considered as invalid.


Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a MBUILDCACHE JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MBUILDCACHE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MBUILDCACHE-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@reda-alaoui reda-alaoui changed the title [MBUILDCACHE-101] mvn test fails on missing classes after mvn compile leads to empty jars [MBUILDCACHE-105] Executing 'clean process-test-classes' then 'clean verify' leads to empty jars Aug 21, 2024
@@ -255,6 +255,11 @@ private CacheResult analyzeResult(CacheContext context, List<MojoExecution> mojo
build.getCacheImplementationVersion());
}

if (lifecyclePhasesHelper.isLaterPhaseThanBuild("package", build)) {
LOGGER.warn("Cached build doesn't include phase 'package', cannot restore");
Copy link
Contributor

@AlexanderAshitkin AlexanderAshitkin Aug 27, 2024

Choose a reason for hiding this comment

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

In the current implementation, the 'analyzeResult' returns partial success in lines 277-278 as expected.

More accurate implementation could support pre-compile phases - 'save' and restore generated sources and continue with compile. This will allow restoring missing sources from the cache and potentially saving time on the code generation. Could be handy in IDEs which could faster compile the project after a branch switch (if generated sources are restored).

The second concern is that we still process builds that will never be used in the 'save'. Save and restore should be consistent, and the situation when cached builds are not usable should also be considered for improvement.

Though overall, as a quick fix, this change seems legitimate, it feels like restoring generated sources and commencing with compilation would be more optimal.

Copy link
Member Author

Choose a reason for hiding this comment

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

@AlexanderAshitkin I agree with you.

At first I wanted to fix the extension to make it able to save cache state on phase < package. But there is this sentence in the documentation:

Once the extension is activated, the cache automatically kicks in on every package or higher phase.

I could not find the reason of this constraint, so I made sure this fix respects the latter. Also the fix should be quick to merge to prevent people from getting into trouble.

I also think this extension should not limit itself to phases >= package. We can still come back to that later.

@reda-alaoui
Copy link
Member Author

Can this be merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants