This is an automated email from the ASF dual-hosted git repository.
cstamas pushed a commit to branch maven-3.9.x
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/maven-3.9.x by this push:
new ecd577b363 [MNG-8177] Add contextual info for model warnings (#1633)
ecd577b363 is described below
commit ecd577b363e0b7dd45cd7ab05f1c46f61c6a8bf8
Author: Tamas Cservenak <[email protected]>
AuthorDate: Mon Aug 12 13:51:26 2024 +0200
[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
---
.../internal/DefaultArtifactDescriptorReader.java | 31 ++++++---
.../repository/internal/RequestTraceHelper.java | 77 ++++++++++++++++++++++
2 files changed, 100 insertions(+), 8 deletions(-)
diff --git
a/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/DefaultArtifactDescriptorReader.java
b/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/DefaultArtifactDescriptorReader.java
index 9054f89afd..bfea91cb6c 100644
---
a/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/DefaultArtifactDescriptorReader.java
+++
b/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/DefaultArtifactDescriptorReader.java
@@ -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();
- logger.warn(
- "{} {} encountered while building the effective
model for {}",
- 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));
+ 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 {} during {} (use -X to see details)",
+ problems.size(),
+ (problems.size() == 1) ? "problem was" :
"problems were",
+ request.getArtifact(),
+ RequestTraceHelper.interpretTrace(false,
request.getTrace()));
}
}
model = modelResult.getEffectiveModel();
diff --git
a/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/RequestTraceHelper.java
b/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/RequestTraceHelper.java
new file mode 100644
index 0000000000..cc704cd0dc
--- /dev/null
+++
b/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/RequestTraceHelper.java
@@ -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";
+ }
+}
