-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
DependencyGraphBuilder.java
651 lines (597 loc) · 33.9 KB
/
DependencyGraphBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
/*
* Copyright 2017 the original author or authors.
*
* Licensed 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.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.builder;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.ModuleVersionIdentifier;
import org.gradle.api.artifacts.component.ComponentIdentifier;
import org.gradle.api.artifacts.component.ComponentSelector;
import org.gradle.api.artifacts.component.ModuleComponentSelector;
import org.gradle.api.attributes.Attribute;
import org.gradle.api.capabilities.Capability;
import org.gradle.api.internal.artifacts.ComponentSelectorConverter;
import org.gradle.api.internal.artifacts.ResolveContext;
import org.gradle.api.internal.artifacts.ResolvedVersionConstraint;
import org.gradle.api.internal.artifacts.configurations.ResolutionStrategyInternal;
import org.gradle.api.internal.artifacts.ivyservice.dependencysubstitution.DependencySubstitutionApplicator;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.Version;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParser;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.excludes.ModuleExclusions;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.DependencyGraphSelector;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.DependencyGraphVisitor;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.conflicts.CapabilitiesConflictHandler;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.conflicts.DefaultCapabilitiesConflictHandler;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.conflicts.ModuleConflictHandler;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.conflicts.PotentialConflict;
import org.gradle.api.internal.attributes.AttributesSchemaInternal;
import org.gradle.api.internal.attributes.CompatibilityRule;
import org.gradle.api.internal.attributes.ImmutableAttributes;
import org.gradle.api.internal.attributes.ImmutableAttributesFactory;
import org.gradle.api.specs.Spec;
import org.gradle.internal.component.IncompatibleVariantsSelectionException;
import org.gradle.internal.component.external.model.DefaultModuleComponentIdentifier;
import org.gradle.internal.component.model.ComponentResolveMetadata;
import org.gradle.internal.component.model.DefaultCompatibilityCheckResult;
import org.gradle.internal.component.model.DependencyMetadata;
import org.gradle.internal.id.IdGenerator;
import org.gradle.internal.id.LongIdGenerator;
import org.gradle.internal.operations.BuildOperationExecutor;
import org.gradle.internal.resolve.ModuleVersionResolveException;
import org.gradle.internal.resolve.resolver.ComponentMetaDataResolver;
import org.gradle.internal.resolve.resolver.DependencyToComponentIdResolver;
import org.gradle.internal.resolve.resolver.ResolveContextToComponentResolver;
import org.gradle.internal.resolve.result.DefaultBuildableComponentResolveResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nullable;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
public class DependencyGraphBuilder {
private static final Logger LOGGER = LoggerFactory.getLogger(DependencyGraphBuilder.class);
private final ModuleConflictHandler moduleConflictHandler;
private final Spec<? super DependencyMetadata> edgeFilter;
private final ResolveContextToComponentResolver moduleResolver;
private final DependencyToComponentIdResolver idResolver;
private final ComponentMetaDataResolver metaDataResolver;
private final AttributesSchemaInternal attributesSchema;
private final ModuleExclusions moduleExclusions;
private final BuildOperationExecutor buildOperationExecutor;
private final ComponentSelectorConverter componentSelectorConverter;
private final DependencySubstitutionApplicator dependencySubstitutionApplicator;
private final ImmutableAttributesFactory attributesFactory;
private final CapabilitiesConflictHandler capabilitiesConflictHandler;
private final VersionSelectorScheme versionSelectorScheme;
private final Comparator<Version> versionComparator;
private final VersionParser versionParser;
final static Spec<EdgeState> ENDORSE_STRICT_VERSIONS_DEPENDENCY_SPEC = dependencyState -> dependencyState.getDependencyState().getDependency().isEndorsingStrictVersions();
final static Spec<EdgeState> NOT_ENDORSE_STRICT_VERSIONS_DEPENDENCY_SPEC = dependencyState -> !dependencyState.getDependencyState().getDependency().isEndorsingStrictVersions();
public DependencyGraphBuilder(DependencyToComponentIdResolver componentIdResolver,
ComponentMetaDataResolver componentMetaDataResolver,
ResolveContextToComponentResolver resolveContextToComponentResolver,
ModuleConflictHandler moduleConflictHandler,
CapabilitiesConflictHandler capabilitiesConflictHandler,
Spec<? super DependencyMetadata> edgeFilter,
AttributesSchemaInternal attributesSchema,
ModuleExclusions moduleExclusions,
BuildOperationExecutor buildOperationExecutor,
DependencySubstitutionApplicator dependencySubstitutionApplicator,
ComponentSelectorConverter componentSelectorConverter,
ImmutableAttributesFactory attributesFactory,
VersionSelectorScheme versionSelectorScheme,
Comparator<Version> versionComparator,
VersionParser versionParser) {
this.idResolver = componentIdResolver;
this.metaDataResolver = componentMetaDataResolver;
this.moduleResolver = resolveContextToComponentResolver;
this.moduleConflictHandler = moduleConflictHandler;
this.edgeFilter = edgeFilter;
this.attributesSchema = attributesSchema;
this.moduleExclusions = moduleExclusions;
this.buildOperationExecutor = buildOperationExecutor;
this.dependencySubstitutionApplicator = dependencySubstitutionApplicator;
this.componentSelectorConverter = componentSelectorConverter;
this.attributesFactory = attributesFactory;
this.capabilitiesConflictHandler = capabilitiesConflictHandler;
this.versionSelectorScheme = versionSelectorScheme;
this.versionComparator = versionComparator;
this.versionParser = versionParser;
}
public void resolve(final ResolveContext resolveContext, final DependencyGraphVisitor modelVisitor) {
IdGenerator<Long> idGenerator = new LongIdGenerator();
DefaultBuildableComponentResolveResult rootModule = new DefaultBuildableComponentResolveResult();
moduleResolver.resolve(resolveContext, rootModule);
int graphSize = estimateSize(resolveContext);
ResolutionStrategyInternal resolutionStrategy = resolveContext.getResolutionStrategy();
final ResolveState resolveState = new ResolveState(idGenerator, rootModule, resolveContext.getName(), idResolver, metaDataResolver, edgeFilter, attributesSchema, moduleExclusions, componentSelectorConverter, attributesFactory, dependencySubstitutionApplicator, versionSelectorScheme, versionComparator, versionParser, moduleConflictHandler.getResolver(), graphSize, resolveContext.getResolutionStrategy().getConflictResolution());
Map<ModuleVersionIdentifier, ComponentIdentifier> componentIdentifierCache = Maps.newHashMapWithExpectedSize(graphSize / 2);
traverseGraph(resolveState, componentIdentifierCache);
validateGraph(resolveState, resolutionStrategy.isFailingOnDynamicVersions(), resolutionStrategy.isFailingOnChangingVersions());
assembleResult(resolveState, modelVisitor);
}
/**
* This method is a heuristic that gives an idea of the "size" of the graph. The larger
* the graph is, the higher the risk of internal resizes exists, so we try to estimate
* the size of the graph to avoid maps resizing.
*/
private static int estimateSize(ResolveContext resolveContext) {
int estimate = 0;
if (resolveContext instanceof Configuration) {
estimate = (int) (512 * Math.log(((Configuration) resolveContext).getAllDependencies().size()));
}
return Math.max(10, estimate);
}
/**
* Traverses the dependency graph, resolving conflicts and building the paths from the root configuration.
*/
private void traverseGraph(final ResolveState resolveState, final Map<ModuleVersionIdentifier, ComponentIdentifier> componentIdentifierCache) {
resolveState.onMoreSelected(resolveState.getRoot());
final List<EdgeState> dependencies = Lists.newArrayList();
while (resolveState.peek() != null || moduleConflictHandler.hasConflicts() || capabilitiesConflictHandler.hasConflicts()) {
if (resolveState.peek() != null) {
final NodeState node = resolveState.pop();
LOGGER.debug("Visiting configuration {}.", node);
// Register capabilities for this node
registerCapabilities(resolveState, node);
// Initialize and collect any new outgoing edges of this node
dependencies.clear();
node.visitOutgoingDependencies(dependencies);
boolean edgeWasProcessed = resolveEdges(node, dependencies, ENDORSE_STRICT_VERSIONS_DEPENDENCY_SPEC, false, resolveState, componentIdentifierCache);
node.collectEndorsedStrictVersions(dependencies);
resolveEdges(node, dependencies, NOT_ENDORSE_STRICT_VERSIONS_DEPENDENCY_SPEC, edgeWasProcessed, resolveState, componentIdentifierCache);
} else {
// We have some batched up conflicts. Resolve the first, and continue traversing the graph
if (moduleConflictHandler.hasConflicts()) {
moduleConflictHandler.resolveNextConflict(resolveState.getReplaceSelectionWithConflictResultAction());
} else {
capabilitiesConflictHandler.resolveNextConflict(resolveState.getReplaceSelectionWithConflictResultAction());
}
}
}
}
private void registerCapabilities(final ResolveState resolveState, final NodeState node) {
node.forEachCapability(capabilitiesConflictHandler, new Action<Capability>() {
@Override
public void execute(Capability capability) {
// This is a performance optimization. Most modules do not declare capabilities. So, instead of systematically registering
// an implicit capability for each module that we see, we only consider modules which _declare_ capabilities. If they do,
// then we try to find a module which provides the same capability. It that module has been found, then we register it.
// Otherwise, we have nothing to do. This avoids most of registrations.
Collection<NodeState> implicitProvidersForCapability = Collections.emptyList();
for (ModuleResolveState state : resolveState.getModules()) {
if (state.getId().getGroup().equals(capability.getGroup()) && state.getId().getName().equals(capability.getName())) {
Collection<ComponentState> versions = state.getVersions();
implicitProvidersForCapability = Lists.newArrayListWithExpectedSize(versions.size());
for (ComponentState version : versions) {
List<NodeState> nodes = version.getNodes();
for (NodeState nodeState : nodes) {
// Collect nodes as implicit capability providers if different than current node, selected and not having explicit capabilities
if (node != nodeState && nodeState.isSelected() && doesNotDeclareExplicitCapability(nodeState)) {
implicitProvidersForCapability.add(nodeState);
}
}
}
break;
}
}
PotentialConflict c = capabilitiesConflictHandler.registerCandidate(
DefaultCapabilitiesConflictHandler.candidate(node, capability, implicitProvidersForCapability)
);
if (c.conflictExists()) {
c.withParticipatingModules(resolveState.getDeselectVersionAction());
}
}
private boolean doesNotDeclareExplicitCapability(NodeState nodeState) {
return nodeState.getMetadata().getCapabilities().getCapabilities().isEmpty();
}
});
}
private boolean resolveEdges(final NodeState node,
final List<EdgeState> dependencies,
final Spec<EdgeState> dependencyFilter,
final boolean recomputeSelectors,
final ResolveState resolveState,
final Map<ModuleVersionIdentifier, ComponentIdentifier> componentIdentifierCache) {
if (dependencies.isEmpty()) {
return false;
}
if (performSelectionSerially(dependencies, dependencyFilter, resolveState, recomputeSelectors)) {
maybeDownloadMetadataInParallel(node, componentIdentifierCache, dependencies, dependencyFilter);
attachToTargetRevisionsSerially(dependencies, dependencyFilter);
return true;
} else {
return false;
}
}
private boolean performSelectionSerially(List<EdgeState> dependencies, Spec<EdgeState> dependencyFilter, ResolveState resolveState, boolean recomputeSelectors) {
boolean processed = false;
for (EdgeState dependency : dependencies) {
if (!dependencyFilter.isSatisfiedBy(dependency)) {
continue;
}
if (recomputeSelectors) {
dependency.computeSelector();
}
SelectorState selector = dependency.getSelector();
ModuleResolveState module = selector.getTargetModule();
if (selector.canResolve() && module.getSelectors().size() > 0) {
// Have an unprocessed/new selector for this module. Need to re-select the target version (if there are any selectors that can be used).
performSelection(resolveState, module);
}
module.addUnattachedDependency(dependency);
processed = true;
}
return processed;
}
/**
* Attempts to resolve a target `ComponentState` for the given dependency.
* On successful resolve, a `ComponentState` is constructed for the identifier, recorded as {@link ModuleResolveState#getSelected()},
* and added to the graph.
* On resolve failure, the failure is recorded and no `ComponentState` is selected.
*/
private void performSelection(ResolveState resolveState, ModuleResolveState module) {
ComponentState currentSelection = module.getSelected();
try {
module.maybeUpdateSelection();
} catch (ModuleVersionResolveException e) {
// Ignore: All selectors failed, and will have failures recorded
return;
}
// If no current selection for module, just use the candidate.
if (currentSelection == null) {
// This is the first time we've seen the module, so register with conflict resolver.
checkForModuleConflicts(resolveState, module);
}
}
private void checkForModuleConflicts(ResolveState resolveState, ModuleResolveState module) {
// A new module. Check for conflict with capabilities and module replacements.
PotentialConflict c = moduleConflictHandler.registerCandidate(module);
if (c.conflictExists()) {
// We have a conflict
LOGGER.debug("Found new conflicting module {}", module);
// For each module participating in the conflict, deselect the currently selection, and remove all outgoing edges from the version.
// This will propagate through the graph and prune configurations that are no longer required.
c.withParticipatingModules(resolveState.getDeselectVersionAction());
}
}
/**
* Prepares the resolution of edges, either serially or concurrently.
* It uses a simple heuristic to determine if we should perform concurrent resolution, based on the the number of edges, and whether they have unresolved metadata.
*/
private void maybeDownloadMetadataInParallel(NodeState node, Map<ModuleVersionIdentifier, ComponentIdentifier> componentIdentifierCache, List<EdgeState> dependencies, Spec<EdgeState> dependencyFilter) {
List<ComponentState> requiringDownload = null;
for (EdgeState dependency : dependencies) {
if (!dependencyFilter.isSatisfiedBy(dependency)) {
continue;
}
ComponentState targetComponent = dependency.getTargetComponent();
if (targetComponent != null && targetComponent.isSelected() && !targetComponent.alreadyResolved()) {
if (!metaDataResolver.isFetchingMetadataCheap(toComponentId(targetComponent.getId(), componentIdentifierCache))) {
// Avoid initializing the list if there are no components requiring download (a common case)
if (requiringDownload == null) {
requiringDownload = Lists.newArrayList();
}
requiringDownload.add(targetComponent);
}
}
}
// Only download in parallel if there is more than 1 component to download
if (requiringDownload != null && requiringDownload.size() > 1) {
final ImmutableList<ComponentState> toDownloadInParallel = ImmutableList.copyOf(requiringDownload);
LOGGER.debug("Submitting {} metadata files to resolve in parallel for {}", toDownloadInParallel.size(), node);
buildOperationExecutor.runAll(buildOperationQueue -> {
for (final ComponentState componentState : toDownloadInParallel) {
buildOperationQueue.add(new DownloadMetadataOperation(componentState));
}
});
}
}
private ComponentIdentifier toComponentId(ModuleVersionIdentifier id, Map<ModuleVersionIdentifier, ComponentIdentifier> componentIdentifierCache) {
ComponentIdentifier identifier = componentIdentifierCache.get(id);
if (identifier == null) {
identifier = DefaultModuleComponentIdentifier.newId(id);
componentIdentifierCache.put(id, identifier);
}
return identifier;
}
private void attachToTargetRevisionsSerially(List<EdgeState> dependencies, Spec<EdgeState> dependencyFilter) {
// the following only needs to be done serially to preserve ordering of dependencies in the graph: we have visited the edges
// but we still didn't add the result to the queue. Doing it from resolve threads would result in non-reproducible graphs, where
// edges could be added in different order. To avoid this, the addition of new edges is done serially.
for (EdgeState dependency : dependencies) {
if (dependencyFilter.isSatisfiedBy(dependency)) {
dependency.attachToTargetConfigurations();
}
}
}
private void validateGraph(ResolveState resolveState, boolean denyDynamicSelectors, boolean denyChangingModules) {
for (ModuleResolveState module : resolveState.getModules()) {
ComponentState selected = module.getSelected();
if (selected != null) {
if (selected.isRejected()) {
GradleException error = new GradleException(selected.getRejectedErrorMessage());
attachFailureToEdges(error, module.getIncomingEdges());
// We need to attach failures on unattached dependencies too, in case a node wasn't selected
// at all, but we still want to see an error message for it.
attachFailureToEdges(error, module.getUnattachedDependencies());
} else {
if (module.isVirtualPlatform()) {
attachMultipleForceOnPlatformFailureToEdges(module);
} else if (selected.hasMoreThanOneSelectedNodeUsingVariantAwareResolution()) {
validateMultipleNodeSelection(module, selected);
}
if (denyDynamicSelectors) {
validateDynamicSelectors(selected);
}
if (denyChangingModules) {
validateChangingVersions(selected);
}
}
} else if (module.isVirtualPlatform()) {
attachMultipleForceOnPlatformFailureToEdges(module);
}
}
}
private static boolean isDynamic(SelectorState selector) {
ResolvedVersionConstraint versionConstraint = selector.getVersionConstraint();
if (versionConstraint != null) {
return versionConstraint.isDynamic();
}
return false;
}
private void validateDynamicSelectors(ComponentState selected) {
List<SelectorState> selectors = ImmutableList.copyOf(selected.getModule().getSelectors());
if (!selectors.isEmpty()) {
if (selectors.stream().allMatch(DependencyGraphBuilder::isDynamic)) {
// when all selectors are dynamic, result is undoubtedly unstable
markDeniedDynamicVersions(selected);
} else if (selectors.stream().anyMatch(DependencyGraphBuilder::isDynamic)) {
checkIfDynamicVersionAllowed(selected, selectors);
}
}
}
private void checkIfDynamicVersionAllowed(ComponentState selected, List<SelectorState> selectors) {
String version = selected.getId().getVersion();
// There must be at least one non dynamic selector agreeing with the selection
// for the resolution result to be stable
// and for dynamic selectors, only the "stable" ones work, which is currently
// only ranges because those are the only ones which accept a selection without
// upgrading
boolean accept = false;
for (SelectorState selector : selectors) {
ResolvedVersionConstraint versionConstraint = selector.getVersionConstraint();
if (!versionConstraint.isDynamic()) {
// this selector is not dynamic, let's see if it agrees with the selection
if (versionConstraint.accepts(version)) {
accept = true;
}
} else if (!versionConstraint.canBeStable()) {
accept = false;
break;
}
}
if (!accept) {
markDeniedDynamicVersions(selected);
}
}
private void markDeniedDynamicVersions(ComponentState cs) {
for (NodeState node : cs.getNodes()) {
List<EdgeState> incomingEdges = node.getIncomingEdges();
for (EdgeState incomingEdge : incomingEdges) {
ComponentSelector selector = incomingEdge.getSelector().getSelector();
incomingEdge.failWith(new ModuleVersionResolveException(selector, () ->
String.format("Could not resolve %s: Resolution strategy disallows usage of dynamic versions", selector)));
}
}
}
private void validateChangingVersions(ComponentState selected) {
ComponentResolveMetadata metadata = selected.getMetadata();
boolean moduleIsChanging = metadata != null && metadata.isChanging();
for (NodeState node : selected.getNodes()) {
List<EdgeState> incomingEdges = node.getIncomingEdges();
for (EdgeState incomingEdge : incomingEdges) {
if (moduleIsChanging || incomingEdge.getDependencyMetadata().isChanging()) {
ComponentSelector selector = incomingEdge.getSelector().getSelector();
incomingEdge.failWith(new ModuleVersionResolveException(selector, () ->
String.format("Could not resolve %s: Resolution strategy disallows usage of changing versions", selector)));
}
}
}
}
/**
* Validates that all selected nodes of a single component have compatible attributes,
* when using variant aware resolution.
*/
private void validateMultipleNodeSelection(ModuleResolveState module, ComponentState selected) {
Set<NodeState> selectedNodes = selected.getNodes().stream()
.filter(n -> n.isSelected() && !n.isAttachedToVirtualPlatform() && !n.hasShadowedCapability())
.collect(Collectors.toSet());
if (selectedNodes.size() < 2) {
return;
}
Set<Set<NodeState>> combinations = Sets.combinations(selectedNodes, 2);
Set<NodeState> incompatibleNodes = Sets.newHashSet();
for (Set<NodeState> combination : combinations) {
Iterator<NodeState> it = combination.iterator();
NodeState first = it.next();
NodeState second = it.next();
assertCompatibleAttributes(first, second, incompatibleNodes);
}
if (!incompatibleNodes.isEmpty()) {
IncompatibleVariantsSelectionException variantsSelectionException = new IncompatibleVariantsSelectionException(
IncompatibleVariantsSelectionMessageBuilder.buildMessage(selected, incompatibleNodes)
);
for (EdgeState edge : module.getIncomingEdges()) {
edge.failWith(variantsSelectionException);
}
}
}
private void assertCompatibleAttributes(NodeState first, NodeState second, Set<NodeState> incompatibleNodes) {
ImmutableAttributes firstAttributes = first.getMetadata().getAttributes();
ImmutableAttributes secondAttributes = second.getMetadata().getAttributes();
ImmutableSet<Attribute<?>> firstKeys = firstAttributes.keySet();
ImmutableSet<Attribute<?>> secondKeys = secondAttributes.keySet();
for (Attribute<?> attribute : Sets.intersection(firstKeys, secondKeys)) {
CompatibilityRule<Object> rule = attributesSchema.compatibilityRules(attribute);
Object v1 = firstAttributes.getAttribute(attribute);
Object v2 = secondAttributes.getAttribute(attribute);
// for all commons attributes, make sure they are compatible with each other
if (!compatible(rule, v1, v2) && !compatible(rule, v2, v1)) {
incompatibleNodes.add(first);
incompatibleNodes.add(second);
}
}
}
private static boolean compatible(CompatibilityRule<Object> rule, @Nullable Object v1, @Nullable Object v2) {
if (Objects.equals(v1, v2)) {
// Equal values are compatible
return true;
}
DefaultCompatibilityCheckResult<Object> result = new DefaultCompatibilityCheckResult<>(v1, v2);
rule.execute(result);
return result.hasResult() && result.isCompatible();
}
private void attachMultipleForceOnPlatformFailureToEdges(ModuleResolveState module) {
List<EdgeState> forcedEdges = null;
boolean hasMultipleVersions = false;
String currentVersion = module.maybeFindForcedPlatformVersion();
Set<ModuleResolveState> participatingModules = module.getPlatformState().getParticipatingModules();
for (ModuleResolveState participatingModule : participatingModules) {
for (EdgeState incomingEdge : participatingModule.getIncomingEdges()) {
SelectorState selector = incomingEdge.getSelector();
if (isPlatformForcedEdge(selector)) {
ComponentSelector componentSelector = selector.getSelector();
if (componentSelector instanceof ModuleComponentSelector) {
ModuleComponentSelector mcs = (ModuleComponentSelector) componentSelector;
if (!incomingEdge.getFrom().getComponent().getModule().equals(module)) {
if (forcedEdges == null) {
forcedEdges = Lists.newArrayList();
}
forcedEdges.add(incomingEdge);
if (currentVersion == null) {
currentVersion = mcs.getVersion();
} else {
if (!currentVersion.equals(mcs.getVersion())) {
hasMultipleVersions = true;
}
}
}
}
}
}
}
if (hasMultipleVersions) {
attachFailureToEdges(new GradleException("Multiple forces on different versions for virtual platform " + module.getId()), forcedEdges);
}
}
private static boolean isPlatformForcedEdge(SelectorState selector) {
return selector.isForce() && !selector.isSoftForce();
}
/**
* Attaches errors late in the process. This is useful whenever we have built a graph, and that
* validation is going to cause a failure (the error is not in the graph itself, but in the way
* we handle it: do we use failOnVersionConflict?). This method therefore needs to be called
* before the graph is handed over, so that we can properly fail resolution.
*/
private void attachFailureToEdges(GradleException error, Collection<EdgeState> incomingEdges) {
for (EdgeState edge : incomingEdges) {
edge.failWith(error);
}
}
/**
* Populates the result from the graph traversal state.
*/
private void assembleResult(ResolveState resolveState, DependencyGraphVisitor visitor) {
visitor.start(resolveState.getRoot());
// Visit the selectors
for (DependencyGraphSelector selector : resolveState.getSelectors()) {
visitor.visitSelector(selector);
}
// Visit the nodes prior to visiting the edges
for (NodeState nodeState : resolveState.getNodes()) {
if (nodeState.shouldIncludedInGraphResult()) {
visitor.visitNode(nodeState);
}
}
// Collect the components to sort in consumer-first order
LinkedList<ComponentState> queue = Lists.newLinkedList();
for (ModuleResolveState module : resolveState.getModules()) {
if (module.getSelected() != null && !module.isVirtualPlatform()) {
queue.add(module.getSelected());
}
}
// Visit the edges after sorting the components in consumer-first order
while (!queue.isEmpty()) {
ComponentState component = queue.peekFirst();
if (component.getVisitState() == VisitState.NotSeen) {
component.setVisitState(VisitState.Visiting);
int pos = 0;
for (NodeState node : component.getNodes()) {
if (!node.isSelected()) {
continue;
}
for (EdgeState edge : node.getIncomingEdges()) {
ComponentState owner = edge.getFrom().getOwner();
if (owner.getVisitState() == VisitState.NotSeen && !owner.getModule().isVirtualPlatform()) {
queue.add(pos, owner);
pos++;
} // else, already visited or currently visiting (which means a cycle), skip
}
}
if (pos == 0) {
// have visited all consumers, so visit this node
component.setVisitState(VisitState.Visited);
queue.removeFirst();
for (NodeState node : component.getNodes()) {
if (node.isSelected()) {
visitor.visitEdges(node);
}
}
}
} else if (component.getVisitState() == VisitState.Visiting) {
// have visited all consumers, so visit this node
component.setVisitState(VisitState.Visited);
queue.removeFirst();
for (NodeState node : component.getNodes()) {
if (node.isSelected()) {
visitor.visitEdges(node);
}
}
} else {
// else, already visited previously, skip
queue.removeFirst();
}
}
visitor.finish(resolveState.getRoot());
}
enum VisitState {
NotSeen, Visiting, Visited
}
}