Do not validate unused SCM dependencies

Examples/package-info/Sources/package-info/example.swift

@@ -22,9 +22,9 @@ struct Example {
 
         let workspace = try Workspace(forRootPackage: packagePath)
 
-        let manifest = try await workspace.loadRootManifest(at: packagePath, observabilityScope: observability.topScope)
+        let manifest = try await workspace.loadRootManifest(at: packagePath, rootPackageIdentities: [], observabilityScope: observability.topScope)
 
-        let package = try await workspace.loadRootPackage(at: packagePath, observabilityScope: observability.topScope)
+        let package = try await workspace.loadRootPackage(at: packagePath, rootPackageIdentities: [], observabilityScope: observability.topScope)
 
         let graph = try workspace.loadPackageGraph(rootPath: packagePath, observabilityScope: observability.topScope)
 

Sources/Commands/PackageTools/Describe.swift

@@ -39,6 +39,7 @@ extension SwiftPackageTool {
             let package = try temp_await {
                 workspace.loadRootPackage(
                     at: packagePath,
+                    rootPackageIdentities: [PackageIdentity(path: packagePath)],
                     observabilityScope: swiftTool.observabilityScope,
                     completion: $0
                 )

Sources/Commands/PackageTools/DumpCommands.swift

@@ -100,6 +100,7 @@ struct DumpPackage: SwiftCommand {
         let rootManifests = try temp_await {
             workspace.loadRootManifests(
                 packages: root.packages,
+                rootPackageIdentities: root.packages.map { PackageIdentity(path: $0) },
                 observabilityScope: swiftTool.observabilityScope,
                 completion: $0
             )

Sources/Commands/PackageTools/EditCommands.swift

@@ -45,6 +45,7 @@ extension SwiftPackageTool {
                 path: path,
                 revision: revision,
                 checkoutBranch: checkoutBranch,
+                rootPackageIdentities: [],
                 observabilityScope: swiftTool.observabilityScope
             )
         }

Sources/Commands/PackageTools/Format.swift

@@ -51,6 +51,7 @@ extension SwiftPackageTool {
             let package = try temp_await {
                 workspace.loadRootPackage(
                     at: packagePath,
+                    rootPackageIdentities: [PackageIdentity(path: packagePath)],
                     observabilityScope: swiftTool.observabilityScope,
                     completion: $0
                 )

Sources/Commands/SwiftTestTool.swift

@@ -402,6 +402,7 @@ public struct SwiftTestTool: SwiftCommand {
         let rootManifests = try temp_await {
             workspace.loadRootManifests(
                 packages: root.packages,
+                rootPackageIdentities: root.packages.map { PackageIdentity(path: $0) },
                 observabilityScope: swiftTool.observabilityScope,
                 completion: $0
             )
@@ -517,6 +518,7 @@ extension SwiftTestTool {
              let rootManifests = try temp_await {
                  workspace.loadRootManifests(
                      packages: root.packages,
+                     rootPackageIdentities: root.packages.map { PackageIdentity(path: $0) },
                      observabilityScope: swiftTool.observabilityScope,
                      completion: $0
                  )

Sources/PackageLoading/ManifestLoader+Validation.swift

@@ -25,10 +25,14 @@ public struct ManifestValidator {
     private let manifest: Manifest
     private let sourceControlValidator: ManifestSourceControlValidator
     private let fileSystem: FileSystem
+    private let dependencyMapper: DependencyMapper
+    private let rootPackageIdentities: [PackageIdentity]
 
-    public init(manifest: Manifest, sourceControlValidator: ManifestSourceControlValidator, fileSystem: FileSystem) {
+    public init(manifest: Manifest, sourceControlValidator: ManifestSourceControlValidator, dependencyMapper: DependencyMapper, rootPackageIdentities: [PackageIdentity], fileSystem: FileSystem) {
         self.manifest = manifest
         self.sourceControlValidator = sourceControlValidator
+        self.dependencyMapper = dependencyMapper
+        self.rootPackageIdentities = rootPackageIdentities
         self.fileSystem = fileSystem
     }
 
@@ -96,7 +100,12 @@ public struct ManifestValidator {
 
         // validate dependency requirements
         for dependency in self.manifest.dependencies {
-            switch dependency {
+            guard !rootPackageIdentities.contains(dependency.identity) else {
+                // avoid validating dependencies which are overidden by a root
+                continue
+            }
+            let mappedDependency = try? dependencyMapper.mappedDependency(for: dependency, fileSystem: self.fileSystem)
+            switch mappedDependency {
             case .sourceControl(let sourceControl):
                 diagnostics += validateSourceControlDependency(sourceControl)
             default:

Sources/SPMTestSupport/MockWorkspace.swift

@@ -348,6 +348,7 @@ public final class MockWorkspace {
                 path: path,
                 revision: revision,
                 checkoutBranch: checkoutBranch,
+                rootPackageIdentities: [],
                 observabilityScope: observability.topScope
             )
         }
@@ -516,7 +517,7 @@ public final class MockWorkspace {
         let pinsStore = try workspace.pinsStore.load()
 
         let rootInput = PackageGraphRootInput(packages: try rootPaths(for: roots.map { $0.name }), dependencies: [])
-        let rootManifests = try temp_await { workspace.loadRootManifests(packages: rootInput.packages, observabilityScope: observability.topScope, completion: $0) }
+        let rootManifests = try temp_await { workspace.loadRootManifests(packages: rootInput.packages, rootPackageIdentities: [], observabilityScope: observability.topScope, completion: $0) }
         let root = PackageGraphRoot(input: rootInput, manifests: rootManifests, observabilityScope: observability.topScope)
 
         let dependencyManifests = try workspace.loadDependencyManifests(root: root, observabilityScope: observability.topScope)
@@ -732,7 +733,7 @@ public final class MockWorkspace {
         let rootInput = PackageGraphRootInput(
             packages: try rootPaths(for: roots), dependencies: dependencies
         )
-        let rootManifests = try temp_await { workspace.loadRootManifests(packages: rootInput.packages, observabilityScope: observability.topScope, completion: $0) }
+        let rootManifests = try temp_await { workspace.loadRootManifests(packages: rootInput.packages, rootPackageIdentities: [], observabilityScope: observability.topScope, completion: $0) }
         let graphRoot = PackageGraphRoot(input: rootInput, manifests: rootManifests, observabilityScope: observability.topScope)
         let manifests = try workspace.loadDependencyManifests(root: graphRoot, observabilityScope: observability.topScope)
         result(manifests, observability.diagnostics)

Sources/Workspace/Workspace+Dependencies.swift

@@ -70,6 +70,7 @@ extension Workspace {
         // Load the root manifests and currently checked out manifests.
         let rootManifests = try temp_await { self.loadRootManifests(
             packages: root.packages,
+            rootPackageIdentities: root.packages.map { PackageIdentity(path: $0) },
             observabilityScope: observabilityScope,
             completion: $0
         ) }
@@ -333,6 +334,7 @@ extension Workspace {
         // FIXME: this should not block
         let rootManifests = try temp_await { self.loadRootManifests(
             packages: root.packages,
+            rootPackageIdentities: root.packages.map { PackageIdentity(path: $0) },
             observabilityScope: observabilityScope,
             completion: $0
         ) }
@@ -481,6 +483,7 @@ extension Workspace {
         // Load the root manifests and currently checked out manifests.
         let rootManifests = try temp_await { self.loadRootManifests(
             packages: root.packages,
+            rootPackageIdentities: root.packages.map { PackageIdentity(path: $0) },
             observabilityScope: observabilityScope,
             completion: $0
         ) }

Sources/Workspace/Workspace+Editing.swift

@@ -18,13 +18,16 @@ import struct PackageGraph.PackageGraphRootInput
 import struct SourceControl.Revision
 import class TSCBasic.InMemoryFileSystem
 
+import PackageModel
+
 extension Workspace {
     /// Edit implementation.
     func _edit(
         packageName: String,
         path: AbsolutePath? = nil,
         revision: Revision? = nil,
         checkoutBranch: String? = nil,
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope
     ) throws {
         // Look up the dependency and check if we can edit it.
@@ -70,6 +73,7 @@ extension Workspace {
                     packageKind: .fileSystem(destination),
                     packagePath: destination,
                     packageLocation: dependency.packageRef.locationString,
+                    rootPackageIdentities: rootPackageIdentities,
                     observabilityScope: observabilityScope,
                     completion: $0
                 )

Sources/Workspace/Workspace+Manifests.swift

@@ -444,8 +444,10 @@ extension Workspace {
 
         // Load root dependencies manifests (in parallel)
         let rootDependencies = root.dependencies.map(\.packageRef)
+        let rootPackageIdentities = Array(root.packages.keys)
         let rootDependenciesManifests = try temp_await { self.loadManagedManifests(
             for: rootDependencies,
+            rootPackageIdentities: rootPackageIdentities,
             observabilityScope: observabilityScope,
             completion: $0
         ) }
@@ -458,6 +460,7 @@ extension Workspace {
         let firstLevelDependencies = topLevelManifests.values.map { $0.dependencies.map(\.packageRef) }.flatMap { $0 }
         let firstLevelManifests = try temp_await { self.loadManagedManifests(
             for: firstLevelDependencies,
+            rootPackageIdentities: rootPackageIdentities,
             observabilityScope: observabilityScope,
             completion: $0
         ) } // FIXME: this should not block
@@ -492,6 +495,7 @@ extension Workspace {
             }
             let dependenciesManifests = try temp_await { self.loadManagedManifests(
                 for: dependenciesToLoad,
+                rootPackageIdentities: rootPackageIdentities,
                 observabilityScope: observabilityScope,
                 completion: $0
             ) }
@@ -591,14 +595,15 @@ extension Workspace {
     /// Loads the given manifests, if it is present in the managed dependencies.
     private func loadManagedManifests(
         for packages: [PackageReference],
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope,
         completion: @escaping (Result<[PackageIdentity: Manifest], Error>) -> Void
     ) {
         let sync = DispatchGroup()
         let manifests = ThreadSafeKeyValueStore<PackageIdentity, Manifest>()
         Set(packages).forEach { package in
             sync.enter()
-            self.loadManagedManifest(for: package, observabilityScope: observabilityScope) { manifest in
+            self.loadManagedManifest(for: package, rootPackageIdentities: rootPackageIdentities, observabilityScope: observabilityScope) { manifest in
                 defer { sync.leave() }
                 if let manifest {
                     manifests[package.identity] = manifest
@@ -614,6 +619,7 @@ extension Workspace {
     /// Loads the given manifest, if it is present in the managed dependencies.
     private func loadManagedManifest(
         for package: PackageReference,
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope,
         completion: @escaping (Manifest?) -> Void
     ) {
@@ -675,6 +681,7 @@ extension Workspace {
             packagePath: packagePath,
             packageLocation: managedDependency.packageRef.locationString,
             packageVersion: packageVersion,
+            rootPackageIdentities: rootPackageIdentities,
             fileSystem: fileSystem,
             observabilityScope: observabilityScope
         ) { result in
@@ -692,6 +699,7 @@ extension Workspace {
         packagePath: AbsolutePath,
         packageLocation: String,
         packageVersion: Version? = nil,
+        rootPackageIdentities: [PackageIdentity],
         fileSystem: FileSystem? = nil,
         observabilityScope: ObservabilityScope,
         completion: @escaping (Result<Manifest, Error>) -> Void
@@ -747,6 +755,8 @@ extension Workspace {
                 let validator = ManifestValidator(
                     manifest: manifest,
                     sourceControlValidator: self.repositoryManager,
+                    dependencyMapper: self.dependencyMapper,
+                    rootPackageIdentities: rootPackageIdentities,
                     fileSystem: self.fileSystem
                 )
                 let validationIssues = validator.validate()

Sources/Workspace/Workspace.swift

@@ -585,12 +585,15 @@ extension Workspace {
     ///       should be checked out to otherwise current revision.
     ///     - checkoutBranch: If provided, a new branch with this name will be
     ///       created from the revision provided.
+    ///     - rootPackageIdentities: Identities of any root packages being used
+    ///       in the given package graph.
     ///     - observabilityScope: The observability scope that reports errors, warnings, etc
     public func edit(
         packageName: String,
         path: AbsolutePath? = nil,
         revision: Revision? = nil,
         checkoutBranch: String? = nil,
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope
     ) {
         do {
@@ -599,6 +602,7 @@ extension Workspace {
                 path: path,
                 revision: revision,
                 checkoutBranch: checkoutBranch,
+                rootPackageIdentities: rootPackageIdentities,
                 observabilityScope: observabilityScope
             )
         } catch {
@@ -939,10 +943,11 @@ extension Workspace {
     /// Loads and returns manifests at the given paths.
     public func loadRootManifests(
         packages: [AbsolutePath],
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope
     ) async throws -> [AbsolutePath: Manifest] {
         try await withCheckedThrowingContinuation { continuation in
-            self.loadRootManifests(packages: packages, observabilityScope: observabilityScope) { result in
+            self.loadRootManifests(packages: packages, rootPackageIdentities: rootPackageIdentities, observabilityScope: observabilityScope) { result in
                 continuation.resume(with: result)
             }
         }
@@ -951,6 +956,7 @@ extension Workspace {
     /// Loads and returns manifests at the given paths.
     public func loadRootManifests(
         packages: [AbsolutePath],
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope,
         completion: @escaping (Result<[AbsolutePath: Manifest], Error>) -> Void
     ) {
@@ -965,6 +971,7 @@ extension Workspace {
                 packageKind: .root(package),
                 packagePath: package,
                 packageLocation: package.pathString,
+                rootPackageIdentities: rootPackageIdentities,
                 observabilityScope: observabilityScope
             ) { result in
                 defer { sync.leave() }
@@ -992,10 +999,11 @@ extension Workspace {
     /// Loads and returns manifest at the given path.
     public func loadRootManifest(
         at path: AbsolutePath,
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope
     ) async throws -> Manifest {
         try await withCheckedThrowingContinuation { continuation in
-            self.loadRootManifest(at: path, observabilityScope: observabilityScope) { result in
+            self.loadRootManifest(at: path, rootPackageIdentities: rootPackageIdentities, observabilityScope: observabilityScope) { result in
                 continuation.resume(with: result)
             }
         }
@@ -1004,10 +1012,11 @@ extension Workspace {
     /// Loads and returns manifest at the given path.
     public func loadRootManifest(
         at path: AbsolutePath,
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope,
         completion: @escaping (Result<Manifest, Error>) -> Void
     ) {
-        self.loadRootManifests(packages: [path], observabilityScope: observabilityScope) { result in
+        self.loadRootManifests(packages: [path], rootPackageIdentities: rootPackageIdentities, observabilityScope: observabilityScope) { result in
             completion(result.tryMap {
                 // normally, we call loadRootManifests which attempts to load any manifest it can and report errors via
                 // diagnostics
@@ -1025,9 +1034,9 @@ extension Workspace {
     }
 
     /// Loads root package
-    public func loadRootPackage(at path: AbsolutePath, observabilityScope: ObservabilityScope) async throws -> Package {
+    public func loadRootPackage(at path: AbsolutePath, rootPackageIdentities: [PackageIdentity], observabilityScope: ObservabilityScope) async throws -> Package {
         try await withCheckedThrowingContinuation { continuation in
-            self.loadRootPackage(at: path, observabilityScope: observabilityScope) { result in
+            self.loadRootPackage(at: path, rootPackageIdentities: rootPackageIdentities, observabilityScope: observabilityScope) { result in
                 continuation.resume(with: result)
             }
         }
@@ -1036,10 +1045,11 @@ extension Workspace {
     /// Loads root package
     public func loadRootPackage(
         at path: AbsolutePath,
+        rootPackageIdentities: [PackageIdentity],
         observabilityScope: ObservabilityScope,
         completion: @escaping (Result<Package, Error>) -> Void
     ) {
-        self.loadRootManifest(at: path, observabilityScope: observabilityScope) { result in
+        self.loadRootManifest(at: path, rootPackageIdentities: rootPackageIdentities, observabilityScope: observabilityScope) { result in
             let result = result.tryMap { manifest -> Package in
                 let identity = try self.identityResolver.resolveIdentity(for: manifest.packageKind)
 
@@ -1140,6 +1150,7 @@ extension Workspace {
             packageKind: previousPackage.underlyingPackage.manifest.packageKind,
             packagePath: previousPackage.path,
             packageLocation: previousPackage.underlyingPackage.manifest.packageLocation,
+            rootPackageIdentities: packageGraph.rootPackages.map { $0.identity },
             observabilityScope: observabilityScope
         ) { result in
             let result = result.tryMap { manifest -> Package in

Tests/CommandsTests/PackageToolTests.swift

@@ -2956,6 +2956,7 @@ final class PackageToolTests: CommandsTestCase {
             let rootManifests = try temp_await {
                 workspace.loadRootManifests(
                     packages: rootInput.packages,
+                    rootPackageIdentities: rootInput.packages.map { PackageIdentity(path: $0) },
                     observabilityScope: observability.topScope,
                     completion: $0
                 )