michael-o commented on a change in pull request #158: URL: https://github.com/apache/maven-resolver/pull/158#discussion_r821418647
########## File path: maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipper.java ########## @@ -0,0 +1,260 @@ +package org.eclipse.aether.internal.impl.collect; + +/* + * 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. + */ + +import org.eclipse.aether.artifact.Artifact; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.util.artifact.ArtifactIdUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +final class DependencyResolveSkipper +{ + private static final Logger LOGGER = LoggerFactory.getLogger( DependencyResolveSkipper.class ); + + private Map<DependencyNode, DependencyResolveResult> resolveResults = new LinkedHashMap<>( 256 ); + private CacheManager cacheManager = new CacheManager(); + private CoordinateManager coordinateManager = new CoordinateManager(); + + DependencyResolveSkipper() + { + // enables default constructor + } + + Map<DependencyNode, DependencyResolveResult> report() + { + LOGGER.trace( "Skipped {} nodes as having deeper depth.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ).count() ); + LOGGER.trace( "Skipped {} nodes as having version conflict.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ).count() ); + LOGGER.trace( "Resolved {} nodes.", + resolveResults.entrySet().stream().filter( n -> n.getValue().resolve ).count() ); + LOGGER.trace( "Force resolved {} nodes for scope selection.", + resolveResults.entrySet().stream().filter( n -> n.getValue().forceResolve ).count() ); + + return resolveResults; + } Review comment: Should this rather be `getResults()`? ########## File path: maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DefaultDependencyCollector.java ########## @@ -277,6 +278,7 @@ public CollectResult collectDependencies( RepositorySystemSession session, Colle false ); } + args.skipper.report(); Review comment: Isn't it code smell? I mean you abuse this method to log, but never evaluate the output ########## File path: maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipper.java ########## @@ -0,0 +1,260 @@ +package org.eclipse.aether.internal.impl.collect; + +/* + * 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. + */ + +import org.eclipse.aether.artifact.Artifact; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.util.artifact.ArtifactIdUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +final class DependencyResolveSkipper +{ + private static final Logger LOGGER = LoggerFactory.getLogger( DependencyResolveSkipper.class ); + + private Map<DependencyNode, DependencyResolveResult> resolveResults = new LinkedHashMap<>( 256 ); + private CacheManager cacheManager = new CacheManager(); + private CoordinateManager coordinateManager = new CoordinateManager(); + + DependencyResolveSkipper() + { + // enables default constructor + } + + Map<DependencyNode, DependencyResolveResult> report() + { + LOGGER.trace( "Skipped {} nodes as having deeper depth.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ).count() ); + LOGGER.trace( "Skipped {} nodes as having version conflict.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ).count() ); + LOGGER.trace( "Resolved {} nodes.", + resolveResults.entrySet().stream().filter( n -> n.getValue().resolve ).count() ); + LOGGER.trace( "Force resolved {} nodes for scope selection.", + resolveResults.entrySet().stream().filter( n -> n.getValue().forceResolve ).count() ); + + return resolveResults; + } + + + boolean skipResolve( DependencyNode node, List<DependencyNode> parents ) + { + DependencyResolveResult resolveResult = new DependencyResolveResult( node ); + resolveResults.put( node, resolveResult ); + + int depth = parents.size() + 1; + coordinateManager.createCoordinate( node, depth ); + + if ( cacheManager.isVersionConflict( node ) ) + { + //skip resolving version conflict losers (omitted conflict) + resolveResult.skippedAsVersionConflict = true; + LOGGER.trace( "Skipped resolving node: {} as version conflict", + ArtifactIdUtils.toId( node.getArtifact() ) ); Review comment: I wonder how much overhead the `toId()` imposes. Would is make sense to wrap into `IsTraceEnabled()`? ########## File path: maven-resolver-impl/src/test/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipperTest.java ########## @@ -0,0 +1,252 @@ +package org.eclipse.aether.internal.impl.collect; +/* + * 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. + */ + +import org.eclipse.aether.DefaultRepositorySystemSession; +import org.eclipse.aether.RepositoryException; +import org.eclipse.aether.artifact.DefaultArtifact; +import org.eclipse.aether.collection.DependencyGraphTransformer; +import org.eclipse.aether.graph.DefaultDependencyNode; +import org.eclipse.aether.graph.Dependency; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.internal.impl.StubRemoteRepositoryManager; +import org.eclipse.aether.internal.impl.StubVersionRangeResolver; +import org.eclipse.aether.internal.test.util.TestUtils; +import org.eclipse.aether.internal.test.util.TestVersion; +import org.eclipse.aether.internal.test.util.TestVersionConstraint; +import org.eclipse.aether.util.graph.transformer.ConflictResolver; +import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver; +import org.eclipse.aether.util.graph.transformer.JavaScopeSelector; +import org.eclipse.aether.util.graph.transformer.NearestVersionSelector; +import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector; +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + + +public class DependencyResolveSkipperTest +{ + protected DefaultDependencyCollector collector; + + protected DefaultRepositorySystemSession session; + + protected DependencyGraphTransformer newTransformer() + { + return new ConflictResolver( new NearestVersionSelector(), new JavaScopeSelector(), + new SimpleOptionalitySelector(), new JavaScopeDeriver() ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version ) + { + return makeDependencyNode( groupId, artifactId, version, "compile" ); + } + + private static List<DependencyNode> mutableList( DependencyNode... nodes ) + { + return new ArrayList<>( Arrays.asList( nodes ) ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version, String scope ) + { + DefaultDependencyNode node = new DefaultDependencyNode( + new Dependency( new DefaultArtifact( groupId + ':' + artifactId + ':' + version ), scope ) + ); + node.setVersion( new TestVersion( version ) ); + node.setVersionConstraint( new TestVersionConstraint( node.getVersion() ) ); + return node; + } + + @Before + public void setup() + { + session = TestUtils.newSession(); + session.setDependencyGraphTransformer( newTransformer() ); + + collector = new DefaultDependencyCollector(); + collector.setVersionRangeResolver( new StubVersionRangeResolver() ); + collector.setRemoteRepositoryManager( new StubRemoteRepositoryManager() ); + } + + + @Test + public void testSkipVersionConflict() throws RepositoryException + { + // A -> B -> C 3.0 -> D => C3.0 SHOULD BE SKIPPED + // | -> E -> F -> G + // | -> C 2.0 -> H => C2.0 is the winner + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode c3Node = makeDependencyNode( "some-group", "C", "3.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode eNode = makeDependencyNode( "some-group", "E", "1.0" ); + DependencyNode fNode = makeDependencyNode( "some-group", "F", "1.0" ); + DependencyNode c2Node = makeDependencyNode( "some-group", "C", "2.0" ); + DependencyNode gNode = makeDependencyNode( "some-group", "G", "1.0" ); + DependencyNode hNode = makeDependencyNode( "some-group", "H", "1.0" ); + + aNode.setChildren( mutableList( bNode, eNode, c2Node ) ); + bNode.setChildren( mutableList( c3Node ) ); + c3Node.setChildren( mutableList( dNode ) ); + eNode.setChildren( mutableList( fNode ) ); + fNode.setChildren( mutableList( gNode ) ); + c2Node.setChildren( mutableList( hNode ) ); + + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( eNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( eNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( c2Node, mutableList( aNode ) ) ); + skipper.cacheWithDepth( c2Node, mutableList( aNode ) ); + assertTrue( skipper.skipResolve( c3Node, mutableList( aNode, bNode ) ) );//version conflict + assertFalse( skipper.skipResolve( fNode, mutableList( aNode, eNode ) ) ); + skipper.cacheWithDepth( fNode, mutableList( aNode, eNode ) ); + assertFalse( skipper.skipResolve( gNode, mutableList( aNode, eNode, fNode ) ) ); + skipper.cacheWithDepth( gNode, mutableList( aNode, eNode, fNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 7 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 1 ); + assertTrue( skipped.get( 0 ).current == c3Node ); + + } + + @Test + public void testSkipDeeperDuplicatedNode() throws RepositoryException + { + // A -> B + // |--> C -> B => B here will be skipped + // |--> D -> C => C here will be skipped + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode b1Node = new DefaultDependencyNode( bNode ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( new ArrayList<>( ) ); + cNode.setChildren( mutableList( b1Node ) ); + dNode.setChildren( mutableList( c1Node ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertTrue( skipper.skipResolve( b1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( b1Node, mutableList( aNode, cNode ) ); + + assertTrue( skipper.skipResolve( c1Node, mutableList( aNode, dNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, dNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 6 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 2 ); + assertTrue( skipped.get( 0 ).current == b1Node ); + assertTrue( skipped.get( 1 ).current == c1Node ); + } + + + @Test + public void testForceResolve() throws RepositoryException + { + + // A -> B -> C -> D => 3rd D here will be force resolved + // |--> C -> D => 2nd D will be force resolved + // |--> D => 1st D to resolve + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + DependencyNode d1Node = new DefaultDependencyNode( dNode ); + DependencyNode d2Node = new DefaultDependencyNode( dNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( mutableList( c1Node ) ); + c1Node.setChildren( mutableList( d2Node ) ); + cNode.setChildren( mutableList( d1Node ) ); + dNode.setChildren( new ArrayList<>( ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertFalse( skipper.skipResolve( c1Node, mutableList( aNode, bNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, bNode ) ); + + assertFalse( skipper.skipResolve( d1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( d1Node, mutableList( aNode, cNode ) ); + + assertFalse( skipper.skipResolve( d2Node, mutableList( aNode, bNode, c1Node ) ) ); + skipper.cacheWithDepth( d2Node, mutableList( aNode, bNode, c1Node ) ); + + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 7 ); + + List<DependencyResolveSkipper.DependencyResolveResult> forceResolved = + results.entrySet().stream().filter( n -> n.getValue().forceResolve ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( forceResolved.size(), 3 ); + assertTrue( forceResolved.get( 0 ).current == c1Node ); + assertTrue( forceResolved.get( 1 ).current == d1Node ); + assertTrue( forceResolved.get( 2 ).current == d2Node ); Review comment: Drop empty lines ########## File path: maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipper.java ########## @@ -0,0 +1,260 @@ +package org.eclipse.aether.internal.impl.collect; + +/* + * 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. + */ + +import org.eclipse.aether.artifact.Artifact; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.util.artifact.ArtifactIdUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +final class DependencyResolveSkipper +{ + private static final Logger LOGGER = LoggerFactory.getLogger( DependencyResolveSkipper.class ); + + private Map<DependencyNode, DependencyResolveResult> resolveResults = new LinkedHashMap<>( 256 ); + private CacheManager cacheManager = new CacheManager(); + private CoordinateManager coordinateManager = new CoordinateManager(); + + DependencyResolveSkipper() + { + // enables default constructor + } + + Map<DependencyNode, DependencyResolveResult> report() + { + LOGGER.trace( "Skipped {} nodes as having deeper depth.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ).count() ); + LOGGER.trace( "Skipped {} nodes as having version conflict.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ).count() ); + LOGGER.trace( "Resolved {} nodes.", + resolveResults.entrySet().stream().filter( n -> n.getValue().resolve ).count() ); + LOGGER.trace( "Force resolved {} nodes for scope selection.", + resolveResults.entrySet().stream().filter( n -> n.getValue().forceResolve ).count() ); + Review comment: Drop the period at the end of the statements, other don't contain periods too ########## File path: maven-resolver-impl/src/test/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipperTest.java ########## @@ -0,0 +1,252 @@ +package org.eclipse.aether.internal.impl.collect; +/* + * 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. + */ + +import org.eclipse.aether.DefaultRepositorySystemSession; +import org.eclipse.aether.RepositoryException; +import org.eclipse.aether.artifact.DefaultArtifact; +import org.eclipse.aether.collection.DependencyGraphTransformer; +import org.eclipse.aether.graph.DefaultDependencyNode; +import org.eclipse.aether.graph.Dependency; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.internal.impl.StubRemoteRepositoryManager; +import org.eclipse.aether.internal.impl.StubVersionRangeResolver; +import org.eclipse.aether.internal.test.util.TestUtils; +import org.eclipse.aether.internal.test.util.TestVersion; +import org.eclipse.aether.internal.test.util.TestVersionConstraint; +import org.eclipse.aether.util.graph.transformer.ConflictResolver; +import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver; +import org.eclipse.aether.util.graph.transformer.JavaScopeSelector; +import org.eclipse.aether.util.graph.transformer.NearestVersionSelector; +import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector; +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + + +public class DependencyResolveSkipperTest +{ + protected DefaultDependencyCollector collector; + + protected DefaultRepositorySystemSession session; + + protected DependencyGraphTransformer newTransformer() + { + return new ConflictResolver( new NearestVersionSelector(), new JavaScopeSelector(), + new SimpleOptionalitySelector(), new JavaScopeDeriver() ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version ) + { + return makeDependencyNode( groupId, artifactId, version, "compile" ); + } + + private static List<DependencyNode> mutableList( DependencyNode... nodes ) + { + return new ArrayList<>( Arrays.asList( nodes ) ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version, String scope ) + { + DefaultDependencyNode node = new DefaultDependencyNode( + new Dependency( new DefaultArtifact( groupId + ':' + artifactId + ':' + version ), scope ) + ); + node.setVersion( new TestVersion( version ) ); + node.setVersionConstraint( new TestVersionConstraint( node.getVersion() ) ); + return node; + } + + @Before + public void setup() + { + session = TestUtils.newSession(); + session.setDependencyGraphTransformer( newTransformer() ); + + collector = new DefaultDependencyCollector(); + collector.setVersionRangeResolver( new StubVersionRangeResolver() ); + collector.setRemoteRepositoryManager( new StubRemoteRepositoryManager() ); + } + + + @Test + public void testSkipVersionConflict() throws RepositoryException + { + // A -> B -> C 3.0 -> D => C3.0 SHOULD BE SKIPPED + // | -> E -> F -> G + // | -> C 2.0 -> H => C2.0 is the winner + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode c3Node = makeDependencyNode( "some-group", "C", "3.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode eNode = makeDependencyNode( "some-group", "E", "1.0" ); + DependencyNode fNode = makeDependencyNode( "some-group", "F", "1.0" ); + DependencyNode c2Node = makeDependencyNode( "some-group", "C", "2.0" ); + DependencyNode gNode = makeDependencyNode( "some-group", "G", "1.0" ); + DependencyNode hNode = makeDependencyNode( "some-group", "H", "1.0" ); + + aNode.setChildren( mutableList( bNode, eNode, c2Node ) ); + bNode.setChildren( mutableList( c3Node ) ); + c3Node.setChildren( mutableList( dNode ) ); + eNode.setChildren( mutableList( fNode ) ); + fNode.setChildren( mutableList( gNode ) ); + c2Node.setChildren( mutableList( hNode ) ); + + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( eNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( eNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( c2Node, mutableList( aNode ) ) ); + skipper.cacheWithDepth( c2Node, mutableList( aNode ) ); + assertTrue( skipper.skipResolve( c3Node, mutableList( aNode, bNode ) ) );//version conflict + assertFalse( skipper.skipResolve( fNode, mutableList( aNode, eNode ) ) ); + skipper.cacheWithDepth( fNode, mutableList( aNode, eNode ) ); + assertFalse( skipper.skipResolve( gNode, mutableList( aNode, eNode, fNode ) ) ); + skipper.cacheWithDepth( gNode, mutableList( aNode, eNode, fNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 7 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 1 ); + assertTrue( skipped.get( 0 ).current == c3Node ); + + } + + @Test + public void testSkipDeeperDuplicatedNode() throws RepositoryException + { + // A -> B + // |--> C -> B => B here will be skipped + // |--> D -> C => C here will be skipped + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode b1Node = new DefaultDependencyNode( bNode ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( new ArrayList<>( ) ); + cNode.setChildren( mutableList( b1Node ) ); + dNode.setChildren( mutableList( c1Node ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertTrue( skipper.skipResolve( b1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( b1Node, mutableList( aNode, cNode ) ); + + assertTrue( skipper.skipResolve( c1Node, mutableList( aNode, dNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, dNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 6 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 2 ); + assertTrue( skipped.get( 0 ).current == b1Node ); + assertTrue( skipped.get( 1 ).current == c1Node ); + } + + + @Test + public void testForceResolve() throws RepositoryException + { + + // A -> B -> C -> D => 3rd D here will be force resolved + // |--> C -> D => 2nd D will be force resolved + // |--> D => 1st D to resolve + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + DependencyNode d1Node = new DefaultDependencyNode( dNode ); + DependencyNode d2Node = new DefaultDependencyNode( dNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( mutableList( c1Node ) ); + c1Node.setChildren( mutableList( d2Node ) ); + cNode.setChildren( mutableList( d1Node ) ); + dNode.setChildren( new ArrayList<>( ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertFalse( skipper.skipResolve( c1Node, mutableList( aNode, bNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, bNode ) ); + + assertFalse( skipper.skipResolve( d1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( d1Node, mutableList( aNode, cNode ) ); + + assertFalse( skipper.skipResolve( d2Node, mutableList( aNode, bNode, c1Node ) ) ); + skipper.cacheWithDepth( d2Node, mutableList( aNode, bNode, c1Node ) ); + + Review comment: Drop one empty line ########## File path: maven-resolver-impl/src/test/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipperTest.java ########## @@ -0,0 +1,252 @@ +package org.eclipse.aether.internal.impl.collect; +/* + * 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. + */ + +import org.eclipse.aether.DefaultRepositorySystemSession; +import org.eclipse.aether.RepositoryException; +import org.eclipse.aether.artifact.DefaultArtifact; +import org.eclipse.aether.collection.DependencyGraphTransformer; +import org.eclipse.aether.graph.DefaultDependencyNode; +import org.eclipse.aether.graph.Dependency; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.internal.impl.StubRemoteRepositoryManager; +import org.eclipse.aether.internal.impl.StubVersionRangeResolver; +import org.eclipse.aether.internal.test.util.TestUtils; +import org.eclipse.aether.internal.test.util.TestVersion; +import org.eclipse.aether.internal.test.util.TestVersionConstraint; +import org.eclipse.aether.util.graph.transformer.ConflictResolver; +import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver; +import org.eclipse.aether.util.graph.transformer.JavaScopeSelector; +import org.eclipse.aether.util.graph.transformer.NearestVersionSelector; +import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector; +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + + +public class DependencyResolveSkipperTest Review comment: Same here ########## File path: maven-resolver-impl/src/test/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipperTest.java ########## @@ -0,0 +1,252 @@ +package org.eclipse.aether.internal.impl.collect; +/* + * 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. + */ + +import org.eclipse.aether.DefaultRepositorySystemSession; +import org.eclipse.aether.RepositoryException; +import org.eclipse.aether.artifact.DefaultArtifact; +import org.eclipse.aether.collection.DependencyGraphTransformer; +import org.eclipse.aether.graph.DefaultDependencyNode; +import org.eclipse.aether.graph.Dependency; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.internal.impl.StubRemoteRepositoryManager; +import org.eclipse.aether.internal.impl.StubVersionRangeResolver; +import org.eclipse.aether.internal.test.util.TestUtils; +import org.eclipse.aether.internal.test.util.TestVersion; +import org.eclipse.aether.internal.test.util.TestVersionConstraint; +import org.eclipse.aether.util.graph.transformer.ConflictResolver; +import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver; +import org.eclipse.aether.util.graph.transformer.JavaScopeSelector; +import org.eclipse.aether.util.graph.transformer.NearestVersionSelector; +import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector; +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + + +public class DependencyResolveSkipperTest +{ + protected DefaultDependencyCollector collector; + + protected DefaultRepositorySystemSession session; + + protected DependencyGraphTransformer newTransformer() + { + return new ConflictResolver( new NearestVersionSelector(), new JavaScopeSelector(), + new SimpleOptionalitySelector(), new JavaScopeDeriver() ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version ) + { + return makeDependencyNode( groupId, artifactId, version, "compile" ); + } + + private static List<DependencyNode> mutableList( DependencyNode... nodes ) + { + return new ArrayList<>( Arrays.asList( nodes ) ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version, String scope ) + { + DefaultDependencyNode node = new DefaultDependencyNode( + new Dependency( new DefaultArtifact( groupId + ':' + artifactId + ':' + version ), scope ) + ); + node.setVersion( new TestVersion( version ) ); + node.setVersionConstraint( new TestVersionConstraint( node.getVersion() ) ); + return node; + } + + @Before + public void setup() + { + session = TestUtils.newSession(); + session.setDependencyGraphTransformer( newTransformer() ); + + collector = new DefaultDependencyCollector(); + collector.setVersionRangeResolver( new StubVersionRangeResolver() ); + collector.setRemoteRepositoryManager( new StubRemoteRepositoryManager() ); + } + + + @Test + public void testSkipVersionConflict() throws RepositoryException + { + // A -> B -> C 3.0 -> D => C3.0 SHOULD BE SKIPPED + // | -> E -> F -> G + // | -> C 2.0 -> H => C2.0 is the winner + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode c3Node = makeDependencyNode( "some-group", "C", "3.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode eNode = makeDependencyNode( "some-group", "E", "1.0" ); + DependencyNode fNode = makeDependencyNode( "some-group", "F", "1.0" ); + DependencyNode c2Node = makeDependencyNode( "some-group", "C", "2.0" ); + DependencyNode gNode = makeDependencyNode( "some-group", "G", "1.0" ); + DependencyNode hNode = makeDependencyNode( "some-group", "H", "1.0" ); + + aNode.setChildren( mutableList( bNode, eNode, c2Node ) ); + bNode.setChildren( mutableList( c3Node ) ); + c3Node.setChildren( mutableList( dNode ) ); + eNode.setChildren( mutableList( fNode ) ); + fNode.setChildren( mutableList( gNode ) ); + c2Node.setChildren( mutableList( hNode ) ); + + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( eNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( eNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( c2Node, mutableList( aNode ) ) ); + skipper.cacheWithDepth( c2Node, mutableList( aNode ) ); + assertTrue( skipper.skipResolve( c3Node, mutableList( aNode, bNode ) ) );//version conflict + assertFalse( skipper.skipResolve( fNode, mutableList( aNode, eNode ) ) ); + skipper.cacheWithDepth( fNode, mutableList( aNode, eNode ) ); + assertFalse( skipper.skipResolve( gNode, mutableList( aNode, eNode, fNode ) ) ); + skipper.cacheWithDepth( gNode, mutableList( aNode, eNode, fNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 7 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 1 ); + assertTrue( skipped.get( 0 ).current == c3Node ); + + } + + @Test + public void testSkipDeeperDuplicatedNode() throws RepositoryException + { + // A -> B + // |--> C -> B => B here will be skipped + // |--> D -> C => C here will be skipped + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode b1Node = new DefaultDependencyNode( bNode ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( new ArrayList<>( ) ); + cNode.setChildren( mutableList( b1Node ) ); + dNode.setChildren( mutableList( c1Node ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertTrue( skipper.skipResolve( b1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( b1Node, mutableList( aNode, cNode ) ); + + assertTrue( skipper.skipResolve( c1Node, mutableList( aNode, dNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, dNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 6 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 2 ); + assertTrue( skipped.get( 0 ).current == b1Node ); + assertTrue( skipped.get( 1 ).current == c1Node ); + } + + + @Test + public void testForceResolve() throws RepositoryException + { + Review comment: Drop empty line ########## File path: maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipper.java ########## @@ -0,0 +1,260 @@ +package org.eclipse.aether.internal.impl.collect; + +/* + * 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. + */ + +import org.eclipse.aether.artifact.Artifact; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.util.artifact.ArtifactIdUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +final class DependencyResolveSkipper +{ + private static final Logger LOGGER = LoggerFactory.getLogger( DependencyResolveSkipper.class ); + + private Map<DependencyNode, DependencyResolveResult> resolveResults = new LinkedHashMap<>( 256 ); + private CacheManager cacheManager = new CacheManager(); + private CoordinateManager coordinateManager = new CoordinateManager(); + + DependencyResolveSkipper() + { + // enables default constructor + } + + Map<DependencyNode, DependencyResolveResult> report() + { + LOGGER.trace( "Skipped {} nodes as having deeper depth.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ).count() ); + LOGGER.trace( "Skipped {} nodes as having version conflict.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ).count() ); + LOGGER.trace( "Resolved {} nodes.", + resolveResults.entrySet().stream().filter( n -> n.getValue().resolve ).count() ); + LOGGER.trace( "Force resolved {} nodes for scope selection.", + resolveResults.entrySet().stream().filter( n -> n.getValue().forceResolve ).count() ); + + return resolveResults; + } + + + boolean skipResolve( DependencyNode node, List<DependencyNode> parents ) + { + DependencyResolveResult resolveResult = new DependencyResolveResult( node ); + resolveResults.put( node, resolveResult ); + + int depth = parents.size() + 1; + coordinateManager.createCoordinate( node, depth ); + + if ( cacheManager.isVersionConflict( node ) ) + { + //skip resolving version conflict losers (omitted conflict) + resolveResult.skippedAsVersionConflict = true; + LOGGER.trace( "Skipped resolving node: {} as version conflict", + ArtifactIdUtils.toId( node.getArtifact() ) ); + } + else if ( coordinateManager.isLeftmost( node, parents ) ) + { + /* + * Force resolving the node to retain conflict paths when its coordinate is more left than last resolved. + * This is because maven picks the widest scope present among conflicting dependencies. Review comment: Maven ########## File path: maven-resolver-impl/src/test/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipperTest.java ########## @@ -0,0 +1,252 @@ +package org.eclipse.aether.internal.impl.collect; +/* + * 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. + */ + +import org.eclipse.aether.DefaultRepositorySystemSession; +import org.eclipse.aether.RepositoryException; +import org.eclipse.aether.artifact.DefaultArtifact; +import org.eclipse.aether.collection.DependencyGraphTransformer; +import org.eclipse.aether.graph.DefaultDependencyNode; +import org.eclipse.aether.graph.Dependency; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.internal.impl.StubRemoteRepositoryManager; +import org.eclipse.aether.internal.impl.StubVersionRangeResolver; +import org.eclipse.aether.internal.test.util.TestUtils; +import org.eclipse.aether.internal.test.util.TestVersion; +import org.eclipse.aether.internal.test.util.TestVersionConstraint; +import org.eclipse.aether.util.graph.transformer.ConflictResolver; +import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver; +import org.eclipse.aether.util.graph.transformer.JavaScopeSelector; +import org.eclipse.aether.util.graph.transformer.NearestVersionSelector; +import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector; +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + + +public class DependencyResolveSkipperTest +{ + protected DefaultDependencyCollector collector; + + protected DefaultRepositorySystemSession session; + + protected DependencyGraphTransformer newTransformer() + { + return new ConflictResolver( new NearestVersionSelector(), new JavaScopeSelector(), + new SimpleOptionalitySelector(), new JavaScopeDeriver() ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version ) + { + return makeDependencyNode( groupId, artifactId, version, "compile" ); + } + + private static List<DependencyNode> mutableList( DependencyNode... nodes ) + { + return new ArrayList<>( Arrays.asList( nodes ) ); + } + + private static DependencyNode makeDependencyNode( String groupId, String artifactId, String version, String scope ) + { + DefaultDependencyNode node = new DefaultDependencyNode( + new Dependency( new DefaultArtifact( groupId + ':' + artifactId + ':' + version ), scope ) + ); + node.setVersion( new TestVersion( version ) ); + node.setVersionConstraint( new TestVersionConstraint( node.getVersion() ) ); + return node; + } + + @Before + public void setup() + { + session = TestUtils.newSession(); + session.setDependencyGraphTransformer( newTransformer() ); + + collector = new DefaultDependencyCollector(); + collector.setVersionRangeResolver( new StubVersionRangeResolver() ); + collector.setRemoteRepositoryManager( new StubRemoteRepositoryManager() ); + } + + + @Test + public void testSkipVersionConflict() throws RepositoryException + { + // A -> B -> C 3.0 -> D => C3.0 SHOULD BE SKIPPED + // | -> E -> F -> G + // | -> C 2.0 -> H => C2.0 is the winner + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode c3Node = makeDependencyNode( "some-group", "C", "3.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode eNode = makeDependencyNode( "some-group", "E", "1.0" ); + DependencyNode fNode = makeDependencyNode( "some-group", "F", "1.0" ); + DependencyNode c2Node = makeDependencyNode( "some-group", "C", "2.0" ); + DependencyNode gNode = makeDependencyNode( "some-group", "G", "1.0" ); + DependencyNode hNode = makeDependencyNode( "some-group", "H", "1.0" ); + + aNode.setChildren( mutableList( bNode, eNode, c2Node ) ); + bNode.setChildren( mutableList( c3Node ) ); + c3Node.setChildren( mutableList( dNode ) ); + eNode.setChildren( mutableList( fNode ) ); + fNode.setChildren( mutableList( gNode ) ); + c2Node.setChildren( mutableList( hNode ) ); + + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( eNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( eNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( c2Node, mutableList( aNode ) ) ); + skipper.cacheWithDepth( c2Node, mutableList( aNode ) ); + assertTrue( skipper.skipResolve( c3Node, mutableList( aNode, bNode ) ) );//version conflict + assertFalse( skipper.skipResolve( fNode, mutableList( aNode, eNode ) ) ); + skipper.cacheWithDepth( fNode, mutableList( aNode, eNode ) ); + assertFalse( skipper.skipResolve( gNode, mutableList( aNode, eNode, fNode ) ) ); + skipper.cacheWithDepth( gNode, mutableList( aNode, eNode, fNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 7 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 1 ); + assertTrue( skipped.get( 0 ).current == c3Node ); + + } + + @Test + public void testSkipDeeperDuplicatedNode() throws RepositoryException + { + // A -> B + // |--> C -> B => B here will be skipped + // |--> D -> C => C here will be skipped + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode b1Node = new DefaultDependencyNode( bNode ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( new ArrayList<>( ) ); + cNode.setChildren( mutableList( b1Node ) ); + dNode.setChildren( mutableList( c1Node ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertTrue( skipper.skipResolve( b1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( b1Node, mutableList( aNode, cNode ) ); + + assertTrue( skipper.skipResolve( c1Node, mutableList( aNode, dNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, dNode ) ); + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 6 ); + + List<DependencyResolveSkipper.DependencyResolveResult> skipped = + results.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( skipped.size(), 2 ); + assertTrue( skipped.get( 0 ).current == b1Node ); + assertTrue( skipped.get( 1 ).current == c1Node ); + } + + + @Test + public void testForceResolve() throws RepositoryException + { + + // A -> B -> C -> D => 3rd D here will be force resolved + // |--> C -> D => 2nd D will be force resolved + // |--> D => 1st D to resolve + DependencyNode aNode = makeDependencyNode( "some-group", "A", "1.0" ); + DependencyNode bNode = makeDependencyNode( "some-group", "B", "1.0" ); + DependencyNode cNode = makeDependencyNode( "some-group", "C", "1.0" ); + DependencyNode dNode = makeDependencyNode( "some-group", "D", "1.0" ); + DependencyNode c1Node = new DefaultDependencyNode( cNode ); + DependencyNode d1Node = new DefaultDependencyNode( dNode ); + DependencyNode d2Node = new DefaultDependencyNode( dNode ); + + aNode.setChildren( mutableList( bNode, cNode, dNode ) ); + bNode.setChildren( mutableList( c1Node ) ); + c1Node.setChildren( mutableList( d2Node ) ); + cNode.setChildren( mutableList( d1Node ) ); + dNode.setChildren( new ArrayList<>( ) ); + + //follow the BFS resolve sequence + DependencyResolveSkipper skipper = new DependencyResolveSkipper(); + assertFalse( skipper.skipResolve( aNode, new ArrayList<>() ) ); + skipper.cacheWithDepth( aNode, new ArrayList<>() ); + assertFalse( skipper.skipResolve( bNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( bNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( cNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( cNode, mutableList( aNode ) ); + assertFalse( skipper.skipResolve( dNode, mutableList( aNode ) ) ); + skipper.cacheWithDepth( dNode, mutableList( aNode ) ); + + assertFalse( skipper.skipResolve( c1Node, mutableList( aNode, bNode ) ) ); + skipper.cacheWithDepth( c1Node, mutableList( aNode, bNode ) ); + + assertFalse( skipper.skipResolve( d1Node, mutableList( aNode, cNode ) ) ); + skipper.cacheWithDepth( d1Node, mutableList( aNode, cNode ) ); + + assertFalse( skipper.skipResolve( d2Node, mutableList( aNode, bNode, c1Node ) ) ); + skipper.cacheWithDepth( d2Node, mutableList( aNode, bNode, c1Node ) ); + + + Map<DependencyNode, DependencyResolveSkipper.DependencyResolveResult> results = skipper.report(); + assertEquals( results.size(), 7 ); + + List<DependencyResolveSkipper.DependencyResolveResult> forceResolved = + results.entrySet().stream().filter( n -> n.getValue().forceResolve ) + .map( s -> s.getValue() ).collect( + Collectors.toList() ); + assertEquals( forceResolved.size(), 3 ); + assertTrue( forceResolved.get( 0 ).current == c1Node ); + assertTrue( forceResolved.get( 1 ).current == d1Node ); + assertTrue( forceResolved.get( 2 ).current == d2Node ); + + + } +} Review comment: Add empty line ########## File path: maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyResolveSkipper.java ########## @@ -0,0 +1,260 @@ +package org.eclipse.aether.internal.impl.collect; + +/* + * 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. + */ + +import org.eclipse.aether.artifact.Artifact; +import org.eclipse.aether.graph.DependencyNode; +import org.eclipse.aether.util.artifact.ArtifactIdUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +final class DependencyResolveSkipper +{ + private static final Logger LOGGER = LoggerFactory.getLogger( DependencyResolveSkipper.class ); + + private Map<DependencyNode, DependencyResolveResult> resolveResults = new LinkedHashMap<>( 256 ); + private CacheManager cacheManager = new CacheManager(); + private CoordinateManager coordinateManager = new CoordinateManager(); + + DependencyResolveSkipper() + { + // enables default constructor + } + + Map<DependencyNode, DependencyResolveResult> report() + { + LOGGER.trace( "Skipped {} nodes as having deeper depth.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsDeeper ).count() ); + LOGGER.trace( "Skipped {} nodes as having version conflict.", + resolveResults.entrySet().stream().filter( n -> n.getValue().skippedAsVersionConflict ).count() ); + LOGGER.trace( "Resolved {} nodes.", + resolveResults.entrySet().stream().filter( n -> n.getValue().resolve ).count() ); + LOGGER.trace( "Force resolved {} nodes for scope selection.", + resolveResults.entrySet().stream().filter( n -> n.getValue().forceResolve ).count() ); + + return resolveResults; + } + + + boolean skipResolve( DependencyNode node, List<DependencyNode> parents ) + { + DependencyResolveResult resolveResult = new DependencyResolveResult( node ); + resolveResults.put( node, resolveResult ); + + int depth = parents.size() + 1; + coordinateManager.createCoordinate( node, depth ); + + if ( cacheManager.isVersionConflict( node ) ) + { + //skip resolving version conflict losers (omitted conflict) + resolveResult.skippedAsVersionConflict = true; + LOGGER.trace( "Skipped resolving node: {} as version conflict", + ArtifactIdUtils.toId( node.getArtifact() ) ); + } + else if ( coordinateManager.isLeftmost( node, parents ) ) + { + /* + * Force resolving the node to retain conflict paths when its coordinate is more left than last resolved. + * This is because maven picks the widest scope present among conflicting dependencies. + */ + resolveResult.forceResolve = true; + LOGGER.trace( "Force resolving node: {} for scope selection", + ArtifactIdUtils.toId( node.getArtifact() ) ); + } + else if ( cacheManager.getWinnerDepth( node ) <= depth ) + { + //skip resolve if depth deeper (omitted duplicate) + resolveResult.skippedAsDeeper = true; + LOGGER.trace( "Skipped resolving node: {} as the node's depth is deeper than winner", + ArtifactIdUtils.toId( node.getArtifact() ) ); + } + else + { + resolveResult.resolve = true; + LOGGER.trace( "Resolving node: {}", + ArtifactIdUtils.toId( node.getArtifact() ) ); + } + + if ( resolveResult.toResolve() ) + { + coordinateManager.updateLeftmost( node ); + return false; + } + + return true; + } + + void cacheWithDepth( DependencyNode node, List<DependencyNode> parents ) + { + boolean parentForceResolve = parents.stream() + .anyMatch( n -> resolveResults.containsKey( n ) && resolveResults.get( n ).forceResolve ); + if ( parentForceResolve ) + { + LOGGER.trace( + "Won't cache as current node: {} inherits from a force-resolved node and will be omitted duplicate", + ArtifactIdUtils.toId( node.getArtifact() ) ); + } + else + { + cacheManager.cacheWinnerDepth( node, parents.size() + 1 ); + } + } + + + static final class DependencyResolveResult Review comment: I think this should rather be `DependencyResolutionResult` and many others, e.g., `parentForceResolution` -- 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: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
