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

[MBUILDCACHE-106] Missing compile source roots matching 'generated-sources' and 'generated-test-sources' when compiler is skipped #178

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

[MBUILDCACHE-106] Missing compile source roots matching 'generated-sources' and 'generated-test-sources' when compiler is skipped #178

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
12 changes: 12 additions & 0 deletions src/main/java/org/apache/maven/buildcache/CacheControllerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,18 @@ private void restoreGeneratedSources(Artifact artifact, Path artifactFilePath, M
Files.createDirectories(outputDir);
}
CacheUtils.unzip(artifactFilePath, outputDir);
OutputType outputType = OutputType.fromClassifier(artifact.getClassifier());
if (outputType != OutputType.GENERATED_SOURCE) {
return;
}
Path targetDir = Paths.get(project.getBuild().getDirectory());
if (outputDir.equals(targetDir.resolve("generated-sources"))
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please explain why we need to attach the sources to the project? The cache should not affect the build; it should only restore dependencies. If the build doesn't require these source roots, it doesn't seem correct to attach them.

Copy link
Member Author

@reda-alaoui reda-alaoui Aug 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The bug fixed by this PR can emerge with #177 merged.
If reconciliation is done like proposed in #177, we can have the following situation.

A project uses an annotation processor to generate some java files. A cached entry exists and comes from a verify -DskipTests. The new build verify reuses this entry by skipping all plugin executions preceding maven-surefire-plugin. Among the skipped executions is compiler:compile. After the tests comes maven-javadoc-plugin. When maven-javadoc-plugin runs, the build fails because maven-javadoc-plugin is unable to find the source files of the compiled generated-sources.
This is because maven-javadoc-plugin expects maven-compiler-plugin to have enriched the maven context with the additional source roots. But since this later was skipped by the cache, additional source roots are missing.

Copy link
Contributor

@AlexanderAshitkin AlexanderAshitkin Aug 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

It's possible that there are multiple generated source roots attached at different levels. The best solution would be to add extra metadata to accurately track and restore all the source roots. Alternatively, it's possible to implement a convention-based restoration by matching the logic in CacheControllerImpl#attachGeneratedSources to restore all the sources associated with a GENERATED_SOURCE cache entry. Check this part too:

        for (String sourceRoot : sourceRoots) {
            final Path sourceRootPath = Paths.get(sourceRoot);
            if (Files.isDirectory(sourceRootPath)
                    && sourceRootPath.startsWith(targetDir)
                    && !(sourceRootPath.startsWith(generatedSourcesDir)
                            || sourceRootPath.startsWith(generatedTestSourcesDir))) { // dir within target
                attachDirIfNotEmpty(sourceRootPath, targetDir, project);
            }
        }

&& !project.getCompileSourceRoots().contains(outputDir.toString())) {
project.addCompileSourceRoot(outputDir.toString());
} else if (outputDir.equals(targetDir.resolve("generated-test-sources"))
&& !project.getTestCompileSourceRoots().contains(outputDir.toString())) {
project.addTestCompileSourceRoot(outputDir.toString());
}
}

// TODO: move to config
Expand Down