Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[MNG-8177] Add contextual info for model warnings (#1633) 

As they really can come from anywhere. In case of this issue even from some eliminated POM that was read while collecting dirty tree, and was later eliminated. So confusing for users.

---

https://issues.apache.org/jira/browse/MNG-8177
This commit is contained in:
Tamas Cservenak 2024-08-12 13:51:26 +02:00 committed by GitHub
parent 42fc90e018
commit ecd577b363
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 100 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/DefaultArtifactDescriptorReader.java
View File

@ -42,6 +42,7 @@ import org.apache.maven.model.building.ModelBuildingResult;
import org.apache.maven.model.building.ModelProblem;
import org.apache.maven.model.building.ModelProblemUtils;
import org.apache.maven.model.resolution.UnresolvableModelException;
import org.codehaus.plexus.util.StringUtils;
import org.eclipse.aether.RepositoryEvent;
import org.eclipse.aether.RepositoryEvent.EventType;
import org.eclipse.aether.RepositoryException;
@ -195,6 +196,7 @@ public class DefaultArtifactDescriptorReader implements ArtifactDescriptorReader
return result;
}
@SuppressWarnings("MethodLength")
private Model loadPom(
RepositorySystemSession session, ArtifactDescriptorRequest request, ArtifactDescriptorResult result)
throws ArtifactDescriptorException {
@ -293,16 +295,29 @@ public class DefaultArtifactDescriptorReader implements ArtifactDescriptorReader
// that may lead to unexpected build failure, log them
if (!modelResult.getProblems().isEmpty()) {
List<ModelProblem> problems = modelResult.getProblems();
if (logger.isDebugEnabled()) {
String problem = (problems.size() == 1) ? "problem" : "problems";
String problemPredicate = problem + ((problems.size() == 1) ? " was" : " were");
String message = String.format(
"%s %s encountered while building the effective model for %s during %s\n",
problems.size(),
problemPredicate,
request.getArtifact(),
RequestTraceHelper.interpretTrace(true, request.getTrace()));
message += StringUtils.capitalizeFirstLetter(problem);
for (ModelProblem modelProblem : problems) {
message += String.format(
"\n* %s @ %s",
modelProblem.getMessage(), ModelProblemUtils.formatLocation(modelProblem, null));
}
logger.warn(message);
} else {
logger.warn(
"{} {} encountered while building the effective model for {}",
"{} {} encountered while building the effective model for {} during {} (use -X to see details)",
problems.size(),
(problems.size() == 1) ? "problem was" : "problems were",
request.getArtifact());
if (logger.isDebugEnabled()) {
for (ModelProblem problem : problems) {
logger.warn(
"{} @ {}", problem.getMessage(), ModelProblemUtils.formatLocation(problem, null));
}
request.getArtifact(),
RequestTraceHelper.interpretTrace(false, request.getTrace()));
}
}
model = modelResult.getEffectiveModel();

77
maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/RequestTraceHelper.java Normal file
View File

@ -0,0 +1,77 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.repository.internal;
import java.util.stream.Collectors;
import org.apache.maven.model.Plugin;
import org.eclipse.aether.RequestTrace;
import org.eclipse.aether.collection.CollectRequest;
import org.eclipse.aether.collection.CollectStepData;
import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
import org.eclipse.aether.resolution.ArtifactRequest;
import org.eclipse.aether.resolution.DependencyRequest;
/**
* Helper class to manage {@link RequestTrace} for better error logging.
*
* @since 3.9.9
*/
public final class RequestTraceHelper {
/**
* Method that creates some informational string based on passed in {@link RequestTrace}. The contents of request
* trace can literally be anything, but this class tries to cover "most common" cases that are happening in Maven.
*/
public static String interpretTrace(boolean detailed, RequestTrace requestTrace) {
while (requestTrace != null) {
Object data = requestTrace.getData();
if (data instanceof DependencyRequest) {
DependencyRequest request = (DependencyRequest) data;
return "dependency resolution for " + request;
} else if (data instanceof CollectRequest) {
CollectRequest request = (CollectRequest) data;
return "dependency collection for " + request;
} else if (data instanceof CollectStepData) {
CollectStepData stepData = (CollectStepData) data;
String msg = "dependency collection step for " + stepData.getContext();
if (detailed) {
msg += ". Path to offending node from root:\n";
msg += stepData.getPath().stream()
.map(n -> " -> " + n.toString())
.collect(Collectors.joining("\n"));
msg += "\n => " + stepData.getNode();
}
return msg;
} else if (data instanceof ArtifactDescriptorRequest) {
ArtifactDescriptorRequest request = (ArtifactDescriptorRequest) data;
return "artifact descriptor request for " + request.getArtifact();
} else if (data instanceof ArtifactRequest) {
ArtifactRequest request = (ArtifactRequest) data;
return "artifact request for " + request.getArtifact();
} else if (data instanceof Plugin) {
Plugin plugin = (Plugin) data;
return "plugin request " + plugin.getId();
}
requestTrace = requestTrace.getParent();
}
return "n/a";
}
}