Jimin15 opened a new pull request, #1758:
URL: https://github.com/apache/maven-resolver/pull/1758
Following this checklist to help us incorporate your
contribution quickly and easily:
- [x] Your pull request should address just one issue, without pulling in
other changes.
- [x] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
## SummaryThis PR adds `CycleAwareDependencyGraphDumper`, a new dependency
visitor that visualizes cycles in dependency graphs while preventing
StackOverflow errors. This addresses issue #1561.
## What
Added `CycleAwareDependencyGraphDumper` class that wraps
`DependencyGraphDumper` and adds cycle detection capabilities- When a cycle is
detected, it displays the cycle with `^N` notation 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 recursion
## Why
Currently, `DependencyGraphDumper` fails with `StackOverflowError` when
visualizing dependency graphs in FULL verbosity mode that contain cycles. While
`TreeDependencyVisitor` can prevent the error, it doesn't visualize cycles.
This new visitor provides both cycle visualization and StackOverflow prevention.
## How
The implementation uses a `Deque` to track the current path during
traversal- Cycle detection is performed by comparing versionless artifact IDs
using `ArtifactIdUtils.equalsVersionlessId()`- When a cycle is detected, custom
indentation formatting is applied to match the tree structure- The visitor
delegates to `DependencyGraphDumper` for normal nodes and handles cycle nodes
separately
## Testing
Added comprehensive unit tests in `CycleAwareDependencyGraphDumperTest`-
Tests verify: cycle detection, visualization format, StackOverflow prevention,
and compatibility with non-cycle graphs- All tests pass successfully
## Related Issue
Resolves #1561
- [x] Each commit in the pull request should have a meaningful subject line
and body.
Note that commits might be squashed by a maintainer on merge.
- [x] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
- [x] Run `mvn verify` to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.
- [x] You have run the integration tests successfully (`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](https://www.apache.org/licenses/icla.pdf) 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](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [x] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
