-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Structured BuilderProblem pipeline for DiagnosticCollector #12702
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
Open
gnodet
wants to merge
1
commit into
feature/mvnlog
Choose a base branch
from
feature/12643-structured-problems
base: feature/mvnlog
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,6 +43,7 @@ | |
| import org.apache.maven.api.model.Model; | ||
| import org.apache.maven.api.model.Prerequisites; | ||
| import org.apache.maven.api.model.Profile; | ||
| import org.apache.maven.api.services.BuilderProblem; | ||
| import org.apache.maven.api.services.Lookup; | ||
| import org.apache.maven.api.services.LookupException; | ||
| import org.apache.maven.artifact.ArtifactUtils; | ||
|
|
@@ -59,6 +60,7 @@ | |
| import org.apache.maven.execution.ProjectDependencyGraph; | ||
| import org.apache.maven.graph.GraphBuilder; | ||
| import org.apache.maven.graph.ProjectSelector; | ||
| import org.apache.maven.internal.build.DefaultDiagnosticCollector; | ||
| import org.apache.maven.internal.impl.DefaultSessionFactory; | ||
| import org.apache.maven.internal.impl.InternalMavenSession; | ||
| import org.apache.maven.lifecycle.LifecycleExecutionException; | ||
|
|
@@ -113,6 +115,8 @@ public class DefaultMaven implements Maven { | |
|
|
||
| private final ProjectSelector projectSelector; | ||
|
|
||
| private final DefaultDiagnosticCollector diagnosticCollector; | ||
|
|
||
| @Inject | ||
| @SuppressWarnings("checkstyle:ParameterNumber") | ||
| public DefaultMaven( | ||
|
|
@@ -126,7 +130,8 @@ public DefaultMaven( | |
| BuildResumptionDataRepository buildResumptionDataRepository, | ||
| SuperPomProvider superPomProvider, | ||
| DefaultSessionFactory defaultSessionFactory, | ||
| @Nullable @Named("ide") WorkspaceReader ideWorkspaceReader) { | ||
| @Nullable @Named("ide") WorkspaceReader ideWorkspaceReader, | ||
| DefaultDiagnosticCollector diagnosticCollector) { | ||
| this.lookup = lookup; | ||
| this.eventCatapult = eventCatapult; | ||
| this.legacySupport = legacySupport; | ||
|
|
@@ -138,6 +143,7 @@ public DefaultMaven( | |
| this.superPomProvider = superPomProvider; | ||
| this.ideWorkspaceReader = ideWorkspaceReader; | ||
| this.defaultSessionFactory = defaultSessionFactory; | ||
| this.diagnosticCollector = diagnosticCollector; | ||
| this.projectSelector = new ProjectSelector(); // if necessary switch to DI | ||
| } | ||
|
|
||
|
|
@@ -650,6 +656,10 @@ private Result<? extends ProjectDependencyGraph> buildGraph(MavenSession session | |
| } else { | ||
| logger.error(problem.getMessage()); | ||
| } | ||
| // Pipe structured problem directly to DiagnosticCollector so that | ||
| // source location and severity are preserved in the build report. | ||
| // The SLF4J hook excludes this logger to avoid double-counting. | ||
| diagnosticCollector.report(toBuilderProblem(problem)); | ||
| } | ||
|
|
||
| if (!graphResult.hasErrors()) { | ||
|
|
@@ -662,6 +672,28 @@ private Result<? extends ProjectDependencyGraph> buildGraph(MavenSession session | |
| return graphResult; | ||
| } | ||
|
|
||
| /** | ||
| * Converts a compat {@link ModelProblem} to the Maven 4 {@link BuilderProblem} API, | ||
| * preserving source, line, column, severity, and message. | ||
| */ | ||
| private static BuilderProblem toBuilderProblem(ModelProblem problem) { | ||
| BuilderProblem.Severity severity = | ||
| switch (problem.getSeverity()) { | ||
| case FATAL -> BuilderProblem.Severity.FATAL; | ||
| case ERROR -> BuilderProblem.Severity.ERROR; | ||
| default -> BuilderProblem.Severity.WARNING; | ||
| }; | ||
| return BuilderProblem.builder() | ||
| .source(problem.getSource()) | ||
| .lineNumber(problem.getLineNumber()) | ||
| .columnNumber(problem.getColumnNumber()) | ||
| .exception(problem.getException()) | ||
| .message(problem.getMessage()) | ||
| .severity(severity) | ||
| .key("model:" + problem.getMessage().hashCode()) | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [Low — Fragile dedup key] |
||
| .build(); | ||
| } | ||
|
|
||
| @Deprecated | ||
| // 5 January 2014 | ||
| protected Logger getLogger() { | ||
|
|
||
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The diagnostic key is generated as
"model:" + problem.getMessage().hashCode(). UsingString.hashCode()for deduplication keys is fragile — hash collisions would cause unrelated problems to be silently deduplicated. The same pattern appears inDefaultProjectsSelectorand the deprecated adapters inPluginValidationManager.Elsewhere in this PR, human-readable keys are used (e.g.
"plugin-validation:contextualizable","plugin-validation:maven2-plugin"). Consider using a more collision-resistant approach here too — e.g., incorporating the problem source and a truncated/normalized message.