[MNG-7619] Reverse Dependency Tree #900

cstamas · 2022-12-03T21:05:52Z

Adds Maven feature that is able to explain why an artifact is present in local repository.

Usable for diagnosing resolution issues.

In local repository, for each artifact it records .tracking folder, containing farthest artifact that got to this artifact, and the list of graph nodes that lead to it.

Note: this is based on by @grgrzybek proposal and reuses some code he provided. See apache/maven-resolver#182

https://issues.apache.org/jira/browse/MNG-7619

Adds Maven feature that is able to explain why an artifact is present in local repository. Usable for diagnosing resolution issues. --- https://issues.apache.org/jira/browse/MNG-7619

cstamas · 2022-12-03T21:12:20Z

Excercise: build this PR (will produce Maven 3.9.0-SNAPSHOT distro), then use same distro to build itself (or just maven.3.9.x, does not matter) using these:

mvn clean install -Dmaven.repo.local=local -Dmaven.repo.local.recordReverseTree -Drat.skip

(rat is dumb to inspect "local" where local repository is and fail, so we skip it).

Q1: why is maven-core 2.2.1 in local repo?

[cstamas@infinity maven (maven-3.9.x  %)]$ tree -L 1 local/org/apache/maven/maven-core/2.2.1/.tracking/
local/org/apache/maven/maven-core/2.2.1/.tracking/
├── org.apache.maven.plugins_maven-remote-resources-plugin_jar_1.7.0
├── org.codehaus.mojo_build-helper-maven-plugin_jar_1.12
└── org.codehaus.mojo_buildnumber-maven-plugin_jar_1.4

0 directories, 3 files
[cstamas@infinity maven (maven-3.9.x  %)]$ cat local/org/apache/maven/maven-core/2.2.1/.tracking/org.codehaus.mojo_build-helper-maven-plugin_jar_1.12 
org.apache.maven:maven-core:jar:2.2.1 (compile) (plugin)
  org.codehaus.mojo:build-helper-maven-plugin:jar:1.12 () (plugin)
[cstamas@infinity maven (maven-3.9.x  %)]$

Q2: how many commons-codec we used and why?

[cstamas@infinity maven (maven-3.9.x %)]$ tree -L 1 local/commons-codec/commons-codec/
local/commons-codec/commons-codec/
├── 1.11
└── 1.15

2 directories, 0 files
[cstamas@infinity maven (maven-3.9.x %)]$ tree -L 1 local/commons-codec/commons-codec/1.15/.tracking/
local/commons-codec/commons-codec/1.15/.tracking/
└── org.apache.maven.plugins_maven-enforcer-plugin_jar_3.1.0

0 directories, 1 file
[cstamas@infinity maven (maven-3.9.x %)]$ tree -L 1 local/commons-codec/commons-codec/1.11/.tracking/
local/commons-codec/commons-codec/1.11/.tracking/
├── org.apache.maven_apache-maven_pom_3.9.0-SNAPSHOT
├── org.apache.maven_maven-resolver-provider_jar_3.9.0-SNAPSHOT
├── org.apache.maven.plugins_maven-checkstyle-plugin_jar_3.2.0
├── org.apache.maven.plugins_maven-dependency-plugin_jar_3.3.0
├── org.apache.maven.plugins_maven-site-plugin_jar_3.12.1
└── org.apache.rat_apache-rat-plugin_jar_0.15

0 directories, 6 files
[cstamas@infinity maven (maven-3.9.x %)]$ cat local/commons-codec/commons-codec/1.11/.tracking/org.apache.maven.plugins_maven-dependency-plugin_jar_3.3.0 
commons-codec:commons-codec:jar:1.11 (compile) (plugin)
  org.apache.httpcomponents:httpclient:jar:4.5.13 (compile) (plugin)
    org.apache.maven.doxia:doxia-core:jar:1.11.1 (compile) (plugin)
      org.apache.maven.reporting:maven-reporting-impl:jar:3.1.0 (compile) (plugin)
        org.apache.maven.plugins:maven-dependency-plugin:jar:3.3.0 () (plugin)
[cstamas@infinity maven (maven-3.9.x %)]$

maven-core/src/main/java/org/apache/maven/internal/aether/ReverseTreeRepositoryListener.java

cstamas · 2022-12-03T21:42:46Z

Note: this is based on by @grgrzybek proposal and reuses some code he provided. See apache/maven-resolver#182

michael-o · 2022-12-03T21:55:36Z

Can we leave out these empty parens: org.apache.maven.plugins:maven-dependency-plugin:jar:3.3.0 () (plugin)? From a user PoV it looks like a bug.

cstamas · 2022-12-03T22:01:18Z

Thats org.eclipse.aether.graph.Dependency#toString, we could fix it, but given this is "advanced" feature, I don't think is something would block this?

michael-o · 2022-12-03T22:04:09Z

Thats org.eclipse.aether.graph.Dependency#toString, we could fix it, but given this is "advanced" feature, I don't think is something would block this?

Agree, we need to spin off the issue there. Here, no change is required.

laeubi · 2022-12-04T05:50:05Z

Not sure if this was already mentioned, but instead of "bake this in" would it not be better to have a way for (core-)plugins to hook in a RepositoryListener or even on the project level as we already to for AbstractMavenLifeCycleListeners / WorkspaceReaders? The this can become part of m-dependency-p for example.

I also wonder if it is even required to record the data at all, should it not be sufficient to first load the pom(s), then generate a list of used plugins and then resolve their dependencies and then do something similar to dependency:tree (maybe plugin-dependency-tree)? To make it more convenient then one might pass a -DdependencyReverse=<GAV> to have a reverse output rooted at the given GAV when build finished.

cstamas · 2022-12-04T10:07:45Z

@laeubi while I agree with ideas you wrote, I am still for this PR to go in, here is why:
This PR is (nearly) trivial, but gives you powerful tool (for investigation, answering several questions), is registered early (earliest possible), and does not prevent anything of those you wrote (a plugin). Moreover, by being earliest present, and present during whole session of a real build, it covers everything (even extensions in bootstrap, and even some plugin that may dynamically resolve). Not easily done with something like build extension or even plugin (they are all too late to cover everything).

Also, none of these prevents anything of those things you wrote, this is totally orthogonal. I personally see this like -X for resolver, a handy switch seldom used by users, but when one needs it, is very very handy.

pzygielo · 2022-12-04T10:35:57Z

maven-core/src/main/java/org/apache/maven/internal/aether/ReverseTreeRepositoryListener.java

+                .getFile()
+                .getPath()
+                .startsWith(event.getSession().getLocalRepository().getBasedir().getPath())) {
+            return; // reactor artifact


Could this condition be extracted to method IDK, isReactorArtifact(event)?
The comment then removed?
The method tested?

pzygielo · 2022-12-04T10:39:35Z

maven-core/src/main/java/org/apache/maven/internal/aether/ReverseTreeRepositoryListener.java

+            return; // reactor artifact
+        }
+        RequestTrace trace = event.getTrace();
+        CollectStepData collectStepTrace = null;


Could this variable be moved one line up, and the loop then extracted to (tested) class method?

Class method (static) would need no instance for test. Like it doesn't to do its job.

cstamas · 2022-12-04T12:43:07Z

Um, unsure why GH says "removed request" from @pzygielo , I actually asked both @michael-o and @pzygielo for repeated review...

@grgrzybek

Adds Maven feature that is able to explain why an artifact is present in local repository. Usable for diagnosing resolution issues. In local repository, for each artifact it records `.tracking` folder, containing farthest artifact that got to this artifact, and the list of graph nodes that lead to it. Note: this is based on by @grgrzybek proposal and reuses some code he provided. See apache/maven-resolver#182 Forward-port of: apache#900 --- https://issues.apache.org/jira/browse/MNG-7619

[MNG-7619] Reverse Dependency Tree

6231067

Adds Maven feature that is able to explain why an artifact is present in local repository. Usable for diagnosing resolution issues. --- https://issues.apache.org/jira/browse/MNG-7619

cstamas self-assigned this Dec 3, 2022

cstamas marked this pull request as ready for review December 3, 2022 21:19

cstamas added this to the 3.9.0 milestone Dec 3, 2022

michael-o requested changes Dec 3, 2022

View reviewed changes

maven-core/src/main/java/org/apache/maven/internal/aether/ReverseTreeRepositoryListener.java Outdated Show resolved Hide resolved

maven-core/src/main/java/org/apache/maven/internal/aether/ReverseTreeRepositoryListener.java Show resolved Hide resolved

Rework

a869104

pzygielo reviewed Dec 4, 2022

View reviewed changes

PR comments.

115f485

cstamas requested review from pzygielo and michael-o and removed request for pzygielo December 4, 2022 12:32

Make all helper methods static

d973e5f

cstamas mentioned this pull request Dec 4, 2022

[MNG-7619] Reverse Dependency Tree #902

Merged

michael-o approved these changes Dec 5, 2022

View reviewed changes

cstamas merged commit 69c5a5d into apache:maven-3.9.x Dec 5, 2022

cstamas deleted the maven-3.9.x-MNG-7619-reverse-dep-tree branch December 5, 2022 15:19

gnodet mentioned this pull request May 16, 2023

[MNG-7785] Clean usage of SessionData #1111

Merged

gnodet mentioned this pull request May 24, 2023

MNG 7587 3.9.x #1120

Closed

gnodet mentioned this pull request May 29, 2024

Maven 3.9.x should use Maven 3.1 validation in strict mode #1541

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MNG-7619] Reverse Dependency Tree #900

[MNG-7619] Reverse Dependency Tree #900

cstamas commented Dec 3, 2022 •

edited

Loading

cstamas commented Dec 3, 2022 •

edited

Loading

cstamas commented Dec 3, 2022

michael-o commented Dec 3, 2022

cstamas commented Dec 3, 2022

michael-o commented Dec 3, 2022

laeubi commented Dec 4, 2022

cstamas commented Dec 4, 2022 •

edited

Loading

pzygielo Dec 4, 2022

pzygielo Dec 4, 2022

pzygielo Dec 4, 2022

cstamas commented Dec 4, 2022

[MNG-7619] Reverse Dependency Tree #900

[MNG-7619] Reverse Dependency Tree #900

Conversation

cstamas commented Dec 3, 2022 • edited Loading

cstamas commented Dec 3, 2022 • edited Loading

cstamas commented Dec 3, 2022

michael-o commented Dec 3, 2022

cstamas commented Dec 3, 2022

michael-o commented Dec 3, 2022

laeubi commented Dec 4, 2022

cstamas commented Dec 4, 2022 • edited Loading

pzygielo Dec 4, 2022

Choose a reason for hiding this comment

pzygielo Dec 4, 2022

Choose a reason for hiding this comment

pzygielo Dec 4, 2022

Choose a reason for hiding this comment

cstamas commented Dec 4, 2022

cstamas commented Dec 3, 2022 •

edited

Loading

cstamas commented Dec 3, 2022 •

edited

Loading

cstamas commented Dec 4, 2022 •

edited

Loading