Add CycleAwareDependencyGraphDumper to visualize cycles (resolves #1561) #1758
+343
−0
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.
Following this checklist to help us incorporate your
contribution quickly and easily:
Summary
This PR adds
CycleAwareDependencyGraphDumper, a new dependency visitor that visualizes cycles in dependency graphs while preventing StackOverflow errors. This addresses issue #1561.What
Added
CycleAwareDependencyGraphDumperclass that wrapsDependencyGraphDumperand adds cycle detection capabilities- When a cycle is detected, it displays the cycle with^Nnotation where N is the index of the node in the path that it cycles back to- The visitor stops traversing children of cycle nodes to prevent infinite recursionWhy
Currently,
DependencyGraphDumperfails withStackOverflowErrorwhen visualizing dependency graphs in FULL verbosity mode that contain cycles. WhileTreeDependencyVisitorcan prevent the error, it doesn't visualize cycles. This new visitor provides both cycle visualization and StackOverflow prevention.How
The implementation uses a
Dequeto track the current path during traversal- Cycle detection is performed by comparing versionless artifact IDs usingArtifactIdUtils.equalsVersionlessId()- When a cycle is detected, custom indentation formatting is applied to match the tree structure- The visitor delegates toDependencyGraphDumperfor normal nodes and handles cycle nodes separatelyTesting
Added comprehensive unit tests in
CycleAwareDependencyGraphDumperTest- Tests verify: cycle detection, visualization format, StackOverflow prevention, and compatibility with non-cycle graphs- All tests pass successfullyRelated Issue
Resolves #1561
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
mvn -Prun-its verify).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.