-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
Copy pathModulesGraph+Loading.swift
1413 lines (1272 loc) · 63.2 KB
/
ModulesGraph+Loading.swift
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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import OrderedCollections
import PackageLoading
import PackageModel
import func TSCBasic.bestMatch
import func TSCBasic.findCycle
import struct TSCBasic.KeyedPair
extension ModulesGraph {
/// Load the package graph for the given package path.
package static func load(
root: PackageGraphRoot,
identityResolver: IdentityResolver,
additionalFileRules: [FileRuleDescription] = [],
externalManifests: OrderedCollections.OrderedDictionary<PackageIdentity, (manifest: Manifest, fs: FileSystem)>,
requiredDependencies: [PackageReference] = [],
unsafeAllowedPackages: Set<PackageReference> = [],
binaryArtifacts: [PackageIdentity: [String: BinaryArtifact]],
prebuilts: [PackageIdentity: [String: PrebuiltLibrary]], // Product name to library mapping
shouldCreateMultipleTestProducts: Bool = false,
createREPLProduct: Bool = false,
customPlatformsRegistry: PlatformRegistry? = .none,
customXCTestMinimumDeploymentTargets: [PackageModel.Platform: PlatformVersion]? = .none,
testEntryPointPath: AbsolutePath? = nil,
fileSystem: FileSystem,
observabilityScope: ObservabilityScope,
productsFilter: ((Product) -> Bool)? = nil,
modulesFilter: ((Module) -> Bool)? = nil
) throws -> ModulesGraph {
let observabilityScope = observabilityScope.makeChildScope(description: "Loading Package Graph")
// Create a map of the manifests, keyed by their identity.
var manifestMap = externalManifests
// prefer roots
for manifest in root.manifests {
manifestMap[manifest.key] = (manifest.value, fileSystem)
}
// Construct the root root dependencies set.
let rootDependencies = Set(root.dependencies.compactMap {
manifestMap[$0.identity]?.manifest
})
let rootManifestNodes = try root.packages.map { identity, package in
// If we have enabled traits passed then we start with those. If there are no enabled
// traits passed then the default traits will be used.
let enabledTraits = root.enabledTraits[identity]
return try GraphLoadingNode(
identity: identity,
manifest: package.manifest,
productFilter: .everything,
enabledTraits: calculateEnabledTraits(
parentPackage: nil,
identity: identity,
manifest: package.manifest,
explictlyEnabledTraits: enabledTraits
)
)
}
let rootDependencyNodes = try root.dependencies.lazy.filter { requiredDependencies.contains($0.packageRef) }
.compactMap { dependency in
try manifestMap[dependency.identity].map {
try GraphLoadingNode(
identity: dependency.identity,
manifest: $0.manifest,
productFilter: dependency.productFilter,
enabledTraits: []
)
}
}
let inputManifests = (rootManifestNodes + rootDependencyNodes).map {
KeyedPair($0, key: $0.identity)
}
// Collect the manifests for which we are going to build packages.
var allNodes = OrderedDictionary<PackageIdentity, GraphLoadingNode>()
let nodeSuccessorProvider = { (node: KeyedPair<GraphLoadingNode, PackageIdentity>) in
try (node.item.requiredDependencies + node.item.traitGuardedDependencies)
.compactMap { dependency -> KeyedPair<
GraphLoadingNode,
PackageIdentity
>? in
return try manifestMap[dependency.identity].map { manifest, _ in
// We are going to check the conditionally enabled traits here and enable them if
// required. This checks the current node and then enables the conditional
// dependencies of the dependency node.
let explictlyEnabledTraits = dependency.traits?.filter {
guard let conditionTraits = $0.condition?.traits else {
return true
}
return !conditionTraits.intersection(node.item.enabledTraits).isEmpty
}.map(\.name)
let calculatedTraits = try calculateEnabledTraits(
parentPackage: node.item.identity,
identity: dependency.identity,
manifest: manifest,
explictlyEnabledTraits: explictlyEnabledTraits.flatMap { Set($0) }
)
return try KeyedPair(
GraphLoadingNode(
identity: dependency.identity,
manifest: manifest,
productFilter: dependency.productFilter,
enabledTraits: calculatedTraits
),
key: dependency.identity
)
}
}
}
// Package dependency cycles feature is gated on tools version 6.0.
if !root.manifests.allSatisfy({ $1.toolsVersion >= .v6_0 }) {
if let cycle = try findCycle(inputManifests, successors: nodeSuccessorProvider) {
let path = (cycle.path + cycle.cycle).map(\.item.manifest)
observabilityScope.emit(PackageGraphError.dependencyCycleDetected(
path: path, cycle: cycle.cycle[0].item.manifest
))
return try ModulesGraph(
rootPackages: [],
rootDependencies: [],
packages: IdentifiableSet(),
dependencies: requiredDependencies,
binaryArtifacts: binaryArtifacts
)
}
}
// Cycles in dependencies don't matter as long as there are no module cycles between packages.
try depthFirstSearch(
inputManifests,
successors: nodeSuccessorProvider
) {
allNodes[$0.key] = $0.item
} onDuplicate: { first, second in
// We are unifying the enabled traits on duplicate
allNodes[first.key]?.enabledTraits.formUnion(second.item.enabledTraits)
}
// Create the packages.
var manifestToPackage: [Manifest: Package] = [:]
for node in allNodes.values {
let nodeObservabilityScope = observabilityScope.makeChildScope(
description: "loading package \(node.identity)",
metadata: .packageMetadata(identity: node.identity, kind: node.manifest.packageKind)
)
let manifest = node.manifest
// Derive the path to the package.
//
// FIXME: Lift this out of the manifest.
let packagePath = manifest.path.parentDirectory
nodeObservabilityScope.trap {
// Create a package from the manifest and sources.
let builder = PackageBuilder(
identity: node.identity,
manifest: manifest,
productFilter: node.productFilter,
path: packagePath,
additionalFileRules: additionalFileRules,
binaryArtifacts: binaryArtifacts[node.identity] ?? [:],
prebuilts: prebuilts,
shouldCreateMultipleTestProducts: shouldCreateMultipleTestProducts,
testEntryPointPath: testEntryPointPath,
createREPLProduct: manifest.packageKind.isRoot ? createREPLProduct : false,
fileSystem: fileSystem,
observabilityScope: nodeObservabilityScope,
enabledTraits: node.enabledTraits
)
let package = try builder.construct()
manifestToPackage[manifest] = package
// Throw if any of the non-root package is empty.
if package.modules.isEmpty // System packages have modules in the package but not the manifest.
&& package.manifest.targets
.isEmpty // An unneeded dependency will not have loaded anything from the manifest.
&& !manifest.packageKind.isRoot
{
throw PackageGraphError.noModules(package)
}
}
}
let platformVersionProvider: PlatformVersionProvider = if let customXCTestMinimumDeploymentTargets {
.init(implementation: .customXCTestMinimumDeploymentTargets(customXCTestMinimumDeploymentTargets))
} else {
.init(implementation: .minimumDeploymentTargetDefault)
}
// Resolve dependencies and create resolved packages.
let resolvedPackages = try createResolvedPackages(
nodes: Array(allNodes.values),
identityResolver: identityResolver,
manifestToPackage: manifestToPackage,
rootManifests: root.manifests,
unsafeAllowedPackages: unsafeAllowedPackages,
prebuilts: prebuilts,
platformRegistry: customPlatformsRegistry ?? .default,
platformVersionProvider: platformVersionProvider,
fileSystem: fileSystem,
observabilityScope: observabilityScope,
productsFilter: productsFilter,
modulesFilter: modulesFilter
)
let rootPackages = resolvedPackages.filter { root.manifests.values.contains($0.manifest) }
checkAllDependenciesAreUsed(packages: resolvedPackages, rootPackages, observabilityScope: observabilityScope)
return try ModulesGraph(
rootPackages: rootPackages,
rootDependencies: resolvedPackages.filter { rootDependencies.contains($0.manifest) },
packages: resolvedPackages,
dependencies: requiredDependencies,
binaryArtifacts: binaryArtifacts
)
}
}
private func checkAllDependenciesAreUsed(
packages: IdentifiableSet<ResolvedPackage>,
_ rootPackages: [ResolvedPackage],
observabilityScope: ObservabilityScope
) {
for package in rootPackages {
// List all dependency products dependent on by the package modules.
let productDependencies = IdentifiableSet(package.modules.flatMap { module in
module.dependencies.compactMap { moduleDependency in
switch moduleDependency {
case .product(let product, _):
product
case .module:
nil
}
}
})
// List all dependencies of modules that are guarded by a trait.
let traitGuardedProductDependencies = Set(package.underlying.modules.flatMap { module in
module.dependencies.compactMap { moduleDependency in
switch moduleDependency {
case .product(let product, let conditions):
if conditions.contains(where: { $0.traitCondition != nil }) {
// This is a product dependency that was enabled by a trait
return product.name
}
return nil
case .module:
return nil
}
}
})
for dependencyId in package.dependencies {
guard let dependency = packages[dependencyId] else {
observabilityScope.emit(.error("Unknown package: \(dependencyId)"))
return
}
// We continue if the dependency contains executable products to make sure we don't
// warn on a valid use-case for a lone dependency: swift run dependency executables.
guard !dependency.products.contains(where: { $0.type == .executable }) else {
continue
}
// Skip this check if this dependency is a system module because system module packages
// have no products.
//
// FIXME: Do/should we print a warning if a dependency has no products?
if dependency.products.isEmpty && dependency.modules.filter({ $0.type == .systemModule }).count == 1 {
continue
}
// Skip this check if this dependency contains a command plugin product.
if dependency.products.contains(where: \.isCommandPlugin) {
continue
}
// Skip this check if traits are enabled since it is valid to add a dependency just
// to enable traits on it. This is useful if there is a transitive dependency in the graph
// that can be configured by enabling traits e.g. the depdency has a trait for its logging
// behaviour. This allows the root package to configure traits of transitive dependencies
// without emitting an unused dependency warning.
if !dependency.enabledTraits.isEmpty {
continue
}
// Make sure that any diagnostics we emit below are associated with the package.
let packageDiagnosticsScope = observabilityScope.makeChildScope(
description: "Package Dependency Validation",
metadata: package.underlying.diagnosticsMetadata
)
// Otherwise emit a warning if none of the dependency package's products are used.
let dependencyIsUsed = dependency.products.contains { product in
// Don't compare by product ID, but by product name to make sure both build triples as properties of
// `ResolvedProduct.ID` are allowed.
let usedByPackage = productDependencies.contains { $0.name == product.name }
// We check if any of the products of this dependency is guarded by a trait.
let traitGuarded = traitGuardedProductDependencies.contains(product.name)
// If the product is either used directly or guarded by a trait we consider it as used
return usedByPackage || traitGuarded
}
if !dependencyIsUsed && !observabilityScope.errorsReportedInAnyScope {
packageDiagnosticsScope.emit(.unusedDependency(dependency.identity.description))
}
}
}
}
fileprivate extension ResolvedProduct {
/// Returns true if and only if the product represents a command plugin module.
var isCommandPlugin: Bool {
guard type == .plugin else { return false }
guard let module = underlying.modules.compactMap({ $0 as? PluginModule }).first else { return false }
guard case .command = module.capability else { return false }
return true
}
}
/// Create resolved packages from the loaded packages.
private func createResolvedPackages(
nodes: [GraphLoadingNode],
identityResolver: IdentityResolver,
manifestToPackage: [Manifest: Package],
// FIXME: This shouldn't be needed once <rdar://problem/33693433> is fixed.
rootManifests: [PackageIdentity: Manifest],
unsafeAllowedPackages: Set<PackageReference>,
prebuilts: [PackageIdentity: [String: PrebuiltLibrary]],
platformRegistry: PlatformRegistry,
platformVersionProvider: PlatformVersionProvider,
fileSystem: FileSystem,
observabilityScope: ObservabilityScope,
productsFilter: ((Product) -> Bool)?,
modulesFilter: ((Module) -> Bool)?
) throws -> IdentifiableSet<ResolvedPackage> {
// Create package builder objects from the input manifests.
let packageBuilders: [ResolvedPackageBuilder] = nodes.compactMap { node in
guard let package = manifestToPackage[node.manifest] else {
return nil
}
let isAllowedToVendUnsafeProducts = unsafeAllowedPackages.contains { $0.identity == package.identity }
let allowedToOverride = rootManifests.values.contains(node.manifest)
return ResolvedPackageBuilder(
package,
productFilter: node.productFilter,
enabledTraits: node.enabledTraits,
isAllowedToVendUnsafeProducts: isAllowedToVendUnsafeProducts,
allowedToOverride: allowedToOverride,
platformVersionProvider: platformVersionProvider
)
}
// Create a map of package builders keyed by the package identity.
// This is guaranteed to be unique so we can use spm_createDictionary
let packagesByIdentity: [PackageIdentity: ResolvedPackageBuilder] = packageBuilders.spm_createDictionary {
($0.package.identity, $0)
}
// Resolve module aliases, if specified, for modules and their dependencies
// across packages. Aliasing will result in module renaming.
let moduleAliasingUsed = try resolveModuleAliases(
packageBuilders: packageBuilders,
observabilityScope: observabilityScope
)
// Scan and validate the dependencies
for packageBuilder in packageBuilders {
let package = packageBuilder.package
let packageObservabilityScope = observabilityScope.makeChildScope(
description: "Validating package dependencies",
metadata: package.diagnosticsMetadata
)
var dependencies = OrderedCollections.OrderedDictionary<PackageIdentity, ResolvedPackageBuilder>()
var dependenciesByNameForModuleDependencyResolution = [String: ResolvedPackageBuilder]()
var dependencyNamesForModuleDependencyResolutionOnly = [PackageIdentity: String]()
try package.manifest.dependenciesRequired(
for: packageBuilder.productFilter,
packageBuilder.enabledTraits
).forEach { dependency in
let dependencyPackageRef = dependency.packageRef
// Otherwise, look it up by its identity.
if let resolvedPackage = packagesByIdentity[dependency.identity] {
// check if this resolved package already listed in the dependencies
// this means that the dependencies share the same identity
// FIXME: this works but the way we find out about this is based on a side effect, need to improve it
guard dependencies[resolvedPackage.package.identity] == nil else {
let error = PackageGraphError.dependencyAlreadySatisfiedByIdentifier(
package: package.identity.description,
dependencyLocation: dependencyPackageRef.locationString,
otherDependencyURL: resolvedPackage.package.manifest.packageLocation,
identity: dependency.identity
)
return packageObservabilityScope.emit(error)
}
// check if the resolved package location is the same as the dependency one
// if not, this means that the dependencies share the same identity
// which only allowed when overriding
if resolvedPackage.package.manifest.canonicalPackageLocation != dependencyPackageRef
.canonicalLocation && !resolvedPackage.allowedToOverride
{
let error = PackageGraphError.dependencyAlreadySatisfiedByIdentifier(
package: package.identity.description,
dependencyLocation: dependencyPackageRef.locationString,
otherDependencyURL: resolvedPackage.package.manifest.packageLocation,
identity: dependency.identity
)
// 9/2021 this is currently emitting a warning only to support
// backwards compatibility with older versions of SwiftPM that had too weak of a validation
// we will upgrade this to an error in a few versions to tighten up the validation
if dependency.explicitNameForModuleDependencyResolutionOnly == .none ||
resolvedPackage.package.manifest.displayName == dependency
.explicitNameForModuleDependencyResolutionOnly
{
packageObservabilityScope
.emit(
warning: error
.description + ". this will be escalated to an error in future versions of SwiftPM."
)
} else {
return packageObservabilityScope.emit(error)
}
} else if resolvedPackage.package.manifest.canonicalPackageLocation == dependencyPackageRef
.canonicalLocation &&
resolvedPackage.package.manifest.packageLocation != dependencyPackageRef.locationString &&
!resolvedPackage.allowedToOverride
{
packageObservabilityScope
.emit(
info: "dependency on '\(resolvedPackage.package.identity)' is represented by similar locations ('\(resolvedPackage.package.manifest.packageLocation)' and '\(dependencyPackageRef.locationString)') which are treated as the same canonical location '\(dependencyPackageRef.canonicalLocation)'."
)
}
// checks if two dependencies have the same explicit name which can cause module based dependency
// package lookup issue
if let explicitDependencyName = dependency.explicitNameForModuleDependencyResolutionOnly {
if let previouslyResolvedPackage =
dependenciesByNameForModuleDependencyResolution[explicitDependencyName]
{
let error = PackageGraphError.dependencyAlreadySatisfiedByName(
package: package.identity.description,
dependencyLocation: dependencyPackageRef.locationString,
otherDependencyURL: previouslyResolvedPackage.package.manifest.packageLocation,
name: explicitDependencyName
)
return packageObservabilityScope.emit(error)
}
}
// checks if two dependencies have the same implicit (identity based) name which can cause module based
// dependency package lookup issue
if let previouslyResolvedPackage =
dependenciesByNameForModuleDependencyResolution[dependency.identity.description]
{
let error = PackageGraphError.dependencyAlreadySatisfiedByName(
package: package.identity.description,
dependencyLocation: dependencyPackageRef.locationString,
otherDependencyURL: previouslyResolvedPackage.package.manifest.packageLocation,
name: dependency.identity.description
)
return packageObservabilityScope.emit(error)
}
let nameForModuleDependencyResolution = dependency
.explicitNameForModuleDependencyResolutionOnly ?? dependency.identity.description
dependenciesByNameForModuleDependencyResolution[nameForModuleDependencyResolution] = resolvedPackage
dependencyNamesForModuleDependencyResolutionOnly[resolvedPackage.package.identity] =
nameForModuleDependencyResolution
dependencies[resolvedPackage.package.identity] = resolvedPackage
}
}
packageBuilder.dependencies = Array(dependencies.values)
packageBuilder
.dependencyNamesForModuleDependencyResolutionOnly = dependencyNamesForModuleDependencyResolutionOnly
packageBuilder.defaultLocalization = package.manifest.defaultLocalization
packageBuilder.supportedPlatforms = computePlatforms(
package: package,
platformRegistry: platformRegistry
)
// Create module builders for each module in the package.
let modules: [Module] = if let modulesFilter {
package.modules.filter(modulesFilter)
} else {
package.modules
}
let moduleBuilders = modules.map {
ResolvedModuleBuilder(
packageIdentity: package.identity,
module: $0,
observabilityScope: packageObservabilityScope,
platformVersionProvider: platformVersionProvider
)
}
packageBuilder.modules = moduleBuilders
// Establish dependencies between the modules. A module can only depend on another module present in the same
// package.
let modulesMap = moduleBuilders.spm_createDictionary { ($0.module, $0) }
for moduleBuilder in moduleBuilders {
moduleBuilder.dependencies += try moduleBuilder.module.dependencies.compactMap { dependency in
switch dependency {
case .module(let moduleDependency, let conditions):
try moduleBuilder.module.validateDependency(module: moduleDependency)
guard let moduleBuilder = modulesMap[moduleDependency] else {
throw InternalError("unknown target \(moduleDependency.name)")
}
return .module(moduleBuilder, conditions: conditions)
case .product:
return nil
}
}
moduleBuilder.defaultLocalization = packageBuilder.defaultLocalization
moduleBuilder.supportedPlatforms = packageBuilder.supportedPlatforms
}
// Create product builders for each product in the package. A product can only contain a module present in the
// same package.
let products: [Product] = if let productsFilter {
package.products.filter(productsFilter)
} else {
package.products
}
packageBuilder.products = try products.map { product in
try ResolvedProductBuilder(
product: product,
packageBuilder: packageBuilder,
moduleBuilders: product.modules.map {
guard let module = modulesMap[$0] else {
throw InternalError("unknown target \($0)")
}
return module
}
)
}
// add registry metadata if available
if fileSystem.exists(package.path.appending(component: RegistryReleaseMetadataStorage.fileName)) {
packageBuilder.registryMetadata = try RegistryReleaseMetadataStorage.load(
from: package.path.appending(component: RegistryReleaseMetadataStorage.fileName),
fileSystem: fileSystem
)
}
}
let dupProductsChecker = DuplicateProductsChecker(
packageBuilders: packageBuilders,
moduleAliasingUsed: moduleAliasingUsed,
observabilityScope: observabilityScope
)
try dupProductsChecker.run(lookupByProductIDs: moduleAliasingUsed, observabilityScope: observabilityScope)
// The set of all module names.
var allModuleNames = Set<String>()
// Track if multiple modules are found with the same name.
var foundDuplicateModule = false
for packageBuilder in packageBuilders {
for moduleBuilder in packageBuilder.modules {
// Record if we see a duplicate module.
foundDuplicateModule = foundDuplicateModule || !allModuleNames.insert(moduleBuilder.module.name).inserted
}
}
// Do another pass and establish product dependencies of each module.
for packageBuilder in packageBuilders {
let package = packageBuilder.package
let packageObservabilityScope = observabilityScope.makeChildScope(
description: "Validating package targets",
metadata: package.diagnosticsMetadata
)
// Get all implicit system library dependencies in this package.
let implicitSystemLibraryDeps = packageBuilder.dependencies
.flatMap(\.modules)
.filter {
if case let systemLibrary as SystemLibraryModule = $0.module {
return systemLibrary.isImplicit
}
return false
}
let packageDoesNotSupportProductAliases = packageBuilder.package.doesNotSupportProductAliases
let lookupByProductIDs = !packageDoesNotSupportProductAliases &&
(packageBuilder.package.manifest.disambiguateByProductIDs || moduleAliasingUsed)
// Get all the products from dependencies of this package.
let productDependencies = packageBuilder.dependencies
.flatMap { (dependency: ResolvedPackageBuilder) -> [ResolvedProductBuilder] in
// Filter out synthesized products such as tests and implicit executables.
// Check if a dependency product is explicitly declared as a product in its package manifest
let manifestProducts = dependency.package.manifest.products.lazy.map(\.name)
let explicitProducts = dependency.package.products.filter { manifestProducts.contains($0.name) }
let explicitIdsOrNames = Set(explicitProducts.lazy.map { lookupByProductIDs ? $0.identity : $0.name })
return dependency.products
.filter {
lookupByProductIDs ? explicitIdsOrNames.contains($0.product.identity) : explicitIdsOrNames
.contains($0.product.name)
}
}
let productDependencyMap: [String: ResolvedProductBuilder] = if lookupByProductIDs {
try Dictionary(uniqueKeysWithValues: productDependencies.map {
guard let packageName = packageBuilder
.dependencyNamesForModuleDependencyResolutionOnly[$0.packageBuilder.package.identity]
else {
throw InternalError(
"could not determine name for dependency on package '\($0.packageBuilder.package.identity)' from package '\(packageBuilder.package.identity)'"
)
}
let key = "\(packageName.lowercased())_\($0.product.name)"
return (key, $0)
})
} else {
try Dictionary(
productDependencies.map { ($0.product.name, $0) },
uniquingKeysWith: { lhs, _ in
let duplicates = productDependencies.filter { $0.product.name == lhs.product.name }
throw emitDuplicateProductDiagnostic(
productName: lhs.product.name,
packages: duplicates.map(\.packageBuilder.package),
moduleAliasingUsed: moduleAliasingUsed,
observabilityScope: observabilityScope
)
}
)
}
// Establish dependencies in each module.
for moduleBuilder in packageBuilder.modules {
// Directly add all the system module dependencies.
moduleBuilder.dependencies += implicitSystemLibraryDeps.map { .module($0, conditions: []) }
// Establish product dependencies.
for case .product(let productRef, let conditions) in moduleBuilder.module.dependencies {
// Find the product in this package's dependency products.
// Look it up by ID if module aliasing is used, otherwise by name.
let product = lookupByProductIDs ? productDependencyMap[productRef.identity] :
productDependencyMap[productRef.name]
guard let product else {
// Only emit a diagnostic if there are no other diagnostics.
// This avoids flooding the diagnostics with product not
// found errors when there are more important errors to
// resolve (like authentication issues).
if !observabilityScope.errorsReportedInAnyScope {
let error = prepareProductDependencyNotFoundError(
packageBuilder: packageBuilder,
moduleBuilder: moduleBuilder,
dependency: productRef,
lookupByProductIDs: lookupByProductIDs
)
packageObservabilityScope.emit(error)
}
continue
}
// Starting in 5.2, and module-based dependency, we require module product dependencies to
// explicitly reference the package containing the product, or for the product, package and
// dependency to share the same name. We don't check this in manifest loading for root-packages so
// we can provide a more detailed diagnostic here.
if packageBuilder.package.manifest.toolsVersion >= .v5_2 && productRef.package == nil {
let referencedPackageIdentity = product.packageBuilder.package.identity
guard let referencedPackageDependency = (
packageBuilder.package.manifest.dependencies
.first { package in
package.identity == referencedPackageIdentity
}
) else {
throw InternalError(
"dependency reference for \(product.packageBuilder.package.manifest.packageLocation) not found"
)
}
let referencedPackageName = referencedPackageDependency.nameForModuleDependencyResolutionOnly
if productRef.name != referencedPackageName {
let error = PackageGraphError.productDependencyMissingPackage(
productName: productRef.name,
moduleName: moduleBuilder.module.name,
packageIdentifier: referencedPackageName
)
packageObservabilityScope.emit(error)
}
}
moduleBuilder.dependencies.append(.product(product, conditions: conditions))
}
}
}
// If a module with similar name was encountered before, we emit a diagnostic.
if foundDuplicateModule {
var duplicateModules = [String: [Package]]()
for moduleName in Set(allModuleNames).sorted() {
let packages = packageBuilders
.filter { $0.modules.contains(where: { $0.module.name == moduleName }) }
.map(\.package)
if packages.count > 1 {
duplicateModules[moduleName, default: []].append(contentsOf: packages)
}
}
var potentiallyDuplicatePackages = [Pair: [String]]()
for entry in duplicateModules {
// the duplicate is across exactly two packages
if entry.value.count == 2 {
potentiallyDuplicatePackages[Pair(package1: entry.value[0], package2: entry.value[1]), default: []]
.append(entry.key)
}
}
var duplicateModulesAddressed = [String]()
for potentiallyDuplicatePackage in potentiallyDuplicatePackages {
// more than three module matches, or all modules in the package match
if potentiallyDuplicatePackage.value.count > 3 ||
(
potentiallyDuplicatePackage.value.sorted() == potentiallyDuplicatePackage.key.package1.modules
.map(\.name).sorted()
&&
potentiallyDuplicatePackage.value.sorted() == potentiallyDuplicatePackage.key.package2.modules
.map(\.name).sorted()
)
{
switch (
potentiallyDuplicatePackage.key.package1.identity.registry,
potentiallyDuplicatePackage.key.package2.identity.registry
) {
case (.some(let registryIdentity), .none):
observabilityScope.emit(
ModuleError.duplicateModulesScmAndRegistry(
registryPackage: registryIdentity,
scmPackage: potentiallyDuplicatePackage.key.package2.identity,
modules: potentiallyDuplicatePackage.value
)
)
case (.none, .some(let registryIdentity)):
observabilityScope.emit(
ModuleError.duplicateModulesScmAndRegistry(
registryPackage: registryIdentity,
scmPackage: potentiallyDuplicatePackage.key.package1.identity,
modules: potentiallyDuplicatePackage.value
)
)
default:
observabilityScope.emit(
ModuleError.duplicateModules(
package: potentiallyDuplicatePackage.key.package1.identity,
otherPackage: potentiallyDuplicatePackage.key.package2.identity,
modules: potentiallyDuplicatePackage.value
)
)
}
duplicateModulesAddressed += potentiallyDuplicatePackage.value
}
}
for entry in duplicateModules.filter({ !duplicateModulesAddressed.contains($0.key) }) {
observabilityScope.emit(
ModuleError.duplicateModule(
moduleName: entry.key,
packages: entry.value.map(\.identity)
)
)
}
}
do {
let moduleBuilders = packageBuilders.flatMap {
$0.modules.map {
KeyedPair($0, key: $0.module)
}
}
if let cycle = findCycle(moduleBuilders, successors: {
$0.item.dependencies.flatMap {
switch $0 {
case .product(let productBuilder, conditions: _):
return productBuilder.moduleBuilders.map { KeyedPair($0, key: $0.module) }
case .module:
return [] // local modules were checked by PackageBuilder.
}
}
}) {
observabilityScope.emit(
ModuleError.cycleDetected(
(cycle.path.map(\.key.name), cycle.cycle.map(\.key.name))
)
)
return IdentifiableSet()
}
}
return try IdentifiableSet(packageBuilders.map { try $0.construct() })
}
private func prepareProductDependencyNotFoundError(
packageBuilder: ResolvedPackageBuilder,
moduleBuilder: ResolvedModuleBuilder,
dependency: Module.ProductReference,
lookupByProductIDs: Bool
) -> PackageGraphError {
let packageName = packageBuilder.package.identity.description
// Module's dependency is either a local module or a product from another package.
// If dependency is a product from the current package, that's an incorrect
// declaration of the dependency and we should show relevant error. Let's see
// if indeed the dependency matches any of the products.
let declProductsAsDependency = packageBuilder.package.products.filter { product in
lookupByProductIDs ? product.identity == dependency.identity : product.name == dependency.name
}.flatMap(\.modules).filter { t in
t.name != dependency.name
}
if !declProductsAsDependency.isEmpty {
return PackageGraphError.productDependencyNotFound(
package: packageName,
moduleName: moduleBuilder.module.name,
dependencyProductName: dependency.name,
dependencyPackageName: dependency.package,
dependencyProductInDecl: true,
similarProductName: nil,
packageContainingSimilarProduct: nil
)
}
// If dependency name is a typo, find best possible match from the available destinations.
// Depending on how the dependency is declared, "available destinations" might be:
// - modules within the current package
// - products across all packages in the graph
// - products from a specific package
var packageContainingBestMatchedProduct: String?
var bestMatchedProductName: String?
if dependency.package == nil {
// First assume it's a dependency on modules within the same package.
let localModules = Array(packageBuilder.modules.map(\.module.name).filter { $0 != moduleBuilder.module.name })
bestMatchedProductName = bestMatch(for: dependency.name, from: localModules)
if bestMatchedProductName != nil {
return PackageGraphError.productDependencyNotFound(
package: packageName,
moduleName: moduleBuilder.module.name,
dependencyProductName: dependency.name,
dependencyPackageName: nil,
dependencyProductInDecl: false,
similarProductName: bestMatchedProductName,
packageContainingSimilarProduct: nil
)
}
// Since there's no package name in the dependency declaration, and no match across
// the local modules, we assume the user actually meant to use product dependency,
// but didn't specify package to use the product from. Since products are globally
// unique, we should be able to find a good match across the graph, if the package
// is already a part of the dependency tree.
let availableProducts = Dictionary(
uniqueKeysWithValues: packageBuilder.dependencies
.flatMap { (packageDep: ResolvedPackageBuilder) -> [(
String,
String
)] in
let manifestProducts = packageDep.package.manifest.products.map(\.name)
let explicitProducts = packageDep.package.products.filter { manifestProducts.contains($0.name) }
let explicitIdsOrNames = Set(explicitProducts.map { lookupByProductIDs ? $0.identity : $0.name })
return explicitIdsOrNames.map { ($0, packageDep.package.identity.description) }
}
)
bestMatchedProductName = bestMatch(for: dependency.name, from: Array(availableProducts.keys))
if bestMatchedProductName != nil {
packageContainingBestMatchedProduct = availableProducts[bestMatchedProductName!]
}
return PackageGraphError.productDependencyNotFound(
package: packageName,
moduleName: moduleBuilder.module.name,
dependencyProductName: dependency.name,
dependencyPackageName: nil,
dependencyProductInDecl: false,
similarProductName: bestMatchedProductName,
packageContainingSimilarProduct: packageContainingBestMatchedProduct
)
} else {
// Package is explicitly listed in the product dependency, we shall search
// within the products from that package.
let availableProducts = packageBuilder.dependencies
.filter { $0.package.identity.description == dependency.package }
.flatMap { (packageDep: ResolvedPackageBuilder) -> [String] in
let manifestProducts = packageDep.package.manifest.products.map(\.name)
let explicitProducts = packageDep.package.products.filter { manifestProducts.contains($0.name) }
let explicitIdsOrNames = Set(explicitProducts.map { lookupByProductIDs ? $0.identity : $0.name })
return Array(explicitIdsOrNames)
}
bestMatchedProductName = bestMatch(for: dependency.name, from: availableProducts)
return PackageGraphError.productDependencyNotFound(
package: packageName,
moduleName: moduleBuilder.module.name,
dependencyProductName: dependency.name,
dependencyPackageName: dependency.package,
dependencyProductInDecl: false,
similarProductName: bestMatchedProductName,
packageContainingSimilarProduct: dependency.package
)
}
}
private func emitDuplicateProductDiagnostic(
productName: String,
packages: [Package],
moduleAliasingUsed: Bool,
observabilityScope: ObservabilityScope
) -> PackageGraphError {
if moduleAliasingUsed {
for package in packages.filter(\.doesNotSupportProductAliases) {
// Emit an additional warning about product aliasing in case of older tools-versions.
observabilityScope
.emit(
warning: "product aliasing requires tools-version 5.2 or later, so it is not supported by '\(package.identity.description)'"
)
}
}
return PackageGraphError.duplicateProduct(
product: productName,
packages: packages
)
}
private func calculateEnabledTraits(
parentPackage: PackageIdentity?,
identity: PackageIdentity,
manifest: Manifest,
explictlyEnabledTraits: Set<String>?
) throws -> Set<String> {
// This the point where we flatten the enabled traits and resolve the recursive traits
var recursiveEnabledTraits = explictlyEnabledTraits ?? []
let areDefaultsEnabled = recursiveEnabledTraits.remove("default") != nil
// We are going to calculate which traits are actually enabled for a node here. To do this
// we have to check if default traits should be used and then flatten all the enabled traits.
for trait in recursiveEnabledTraits {
// Check if the enabled trait is a valid trait
if manifest.traits.first(where: { $0.name == trait }) == nil {
// The enabled trait is invalid
throw ModuleError.invalidTrait(package: identity, trait: trait)
}
}
// explicitlyEnabledTraits != nil && !areDefaultsEnabled
if let parentPackage, !(explictlyEnabledTraits == nil || areDefaultsEnabled) && !manifest.supportsTraits {
// We throw an error when default traits are disabled for a package without any traits
// This allows packages to initially move new API behind traits once.
throw ModuleError.disablingDefaultTraitsOnEmptyTraits(
parentPackage: parentPackage,
packageName: manifest.displayName
)
}
// We have to enable all default traits if no traits are enabled or the defaults are explicitly enabled
if explictlyEnabledTraits == nil || areDefaultsEnabled {
recursiveEnabledTraits.formUnion(manifest.traits.first { $0.name == "default" }?.enabledTraits ?? [])
}
while true {
let flattendEnabledTraits = Set(
manifest.traits
.lazy
.filter { recursiveEnabledTraits.contains($0.name) }
.map(\.enabledTraits)
.joined()
)
let newRecursiveEnabledTraits = recursiveEnabledTraits.union(flattendEnabledTraits)
if newRecursiveEnabledTraits.count == recursiveEnabledTraits.count {
break
} else {
recursiveEnabledTraits = newRecursiveEnabledTraits
}
}
return recursiveEnabledTraits