[Package{Model, Graph}] Make it possible to mark modules as implicit

xedin · xedin · commit 7750aa961efb · 2025-06-12T08:35:30.000-07:00
It's currently impossible to distringuish between modules that
are created from the declarations in a manifest and the ones
synthesized as part of module graph building and/or build plan
creation. This was only a problem for `SystemLibraryModule` before,
but with the introduction of `swift package migrate` command the
situation changed because the command can only operate on modules
that appear in the manifest file because it won't be possible to
update code or settings of the synthesized modules.
diff --git a/Sources/Build/BuildPlan/BuildPlan+Test.swift b/Sources/Build/BuildPlan/BuildPlan+Test.swift
@@ -102,7 +102,8 @@ extension BuildPlan {
                     dependencies: testProduct.underlying.modules.map { .module($0, conditions: []) },
                     packageAccess: true, // test target is allowed access to package decls by default
                     testDiscoverySrc: Sources(paths: discoveryPaths, root: discoveryDerivedDir),
-                    buildSettings: discoveryBuildSettings
+                    buildSettings: discoveryBuildSettings,
+                    implicit: true
                 )
                 let discoveryResolvedModule = ResolvedModule(
                     packageIdentity: testProduct.packageIdentity,
@@ -287,7 +288,8 @@ private extension PackageModel.SwiftModule {
             dependencies: dependencies,
             packageAccess: packageAccess,
             buildSettings: buildSettings,
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: true
         )
     }
 }
diff --git a/Sources/PackageGraph/ModulesGraph+Loading.swift b/Sources/PackageGraph/ModulesGraph+Loading.swift
@@ -680,12 +680,7 @@ private func createResolvedPackages(
         // 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
-            }
+            .filter(\.module.implicit)
 
         let packageDoesNotSupportProductAliases = packageBuilder.package.doesNotSupportProductAliases
         let lookupByProductIDs = !packageDoesNotSupportProductAliases &&
diff --git a/Sources/PackageGraph/Resolution/ResolvedModule.swift b/Sources/PackageGraph/Resolution/ResolvedModule.swift
@@ -180,6 +180,12 @@ public struct ResolvedModule {
         })
     }
 
+    /// Whether this module comes from a declaration in the manifest file
+    /// or was synthesized (i.e. some test modules are synthesized).
+    public var implicit: Bool {
+        self.underlying.implicit
+    }
+
     /// Create a resolved module instance.
     public init(
         packageIdentity: PackageIdentity,
diff --git a/Sources/PackageLoading/PackageBuilder.swift b/Sources/PackageLoading/PackageBuilder.swift
@@ -1079,7 +1079,8 @@ public final class PackageBuilder {
                 declaredSwiftVersions: self.declaredSwiftVersions(),
                 buildSettings: buildSettings,
                 buildSettingsDescription: manifestTarget.settings,
-                usesUnsafeFlags: manifestTarget.usesUnsafeFlags
+                usesUnsafeFlags: manifestTarget.usesUnsafeFlags,
+                implicit: false
             )
         } else {
             // It's not a Swift target, so it's a Clang target (those are the only two types of source target currently
@@ -1124,7 +1125,8 @@ public final class PackageBuilder {
                 dependencies: dependencies,
                 buildSettings: buildSettings,
                 buildSettingsDescription: manifestTarget.settings,
-                usesUnsafeFlags: manifestTarget.usesUnsafeFlags
+                usesUnsafeFlags: manifestTarget.usesUnsafeFlags,
+                implicit: false
             )
         }
     }
@@ -1903,7 +1905,8 @@ extension PackageBuilder {
                     packageAccess: false,
                     buildSettings: buildSettings,
                     buildSettingsDescription: targetDescription.settings,
-                    usesUnsafeFlags: false
+                    usesUnsafeFlags: false,
+                    implicit: true
                 )
             }
     }
diff --git a/Sources/PackageModel/Module/BinaryModule.swift b/Sources/PackageModel/Module/BinaryModule.swift
@@ -49,7 +49,8 @@ public final class BinaryModule: Module {
             buildSettings: .init(),
             buildSettingsDescription: [],
             pluginUsages: [],
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: false
         )
     }
 
diff --git a/Sources/PackageModel/Module/ClangModule.swift b/Sources/PackageModel/Module/ClangModule.swift
@@ -61,7 +61,8 @@ public final class ClangModule: Module {
         dependencies: [Module.Dependency] = [],
         buildSettings: BuildSettings.AssignmentTable = .init(),
         buildSettingsDescription: [TargetBuildSettingDescription.Setting] = [],
-        usesUnsafeFlags: Bool
+        usesUnsafeFlags: Bool,
+        implicit: Bool
     ) throws {
         guard includeDir.isDescendantOfOrEqual(to: sources.root) else {
             throw StringError("\(includeDir) should be contained in the source root \(sources.root)")
@@ -86,7 +87,8 @@ public final class ClangModule: Module {
             buildSettings: buildSettings,
             buildSettingsDescription: buildSettingsDescription,
             pluginUsages: [],
-            usesUnsafeFlags: usesUnsafeFlags
+            usesUnsafeFlags: usesUnsafeFlags,
+            implicit: implicit
         )
     }
 }
diff --git a/Sources/PackageModel/Module/Module.swift b/Sources/PackageModel/Module/Module.swift
@@ -242,6 +242,10 @@ public class Module {
     /// Whether or not this target uses any custom unsafe flags.
     public let usesUnsafeFlags: Bool
 
+    /// Whether this module comes from a declaration in the manifest file
+    /// or was synthesized (i.e. some test modules are synthesized).
+    public let implicit: Bool
+
     init(
         name: String,
         potentialBundleName: String? = nil,
@@ -256,7 +260,8 @@ public class Module {
         buildSettings: BuildSettings.AssignmentTable,
         buildSettingsDescription: [TargetBuildSettingDescription.Setting],
         pluginUsages: [PluginUsage],
-        usesUnsafeFlags: Bool
+        usesUnsafeFlags: Bool,
+        implicit: Bool
     ) {
         self.name = name
         self.potentialBundleName = potentialBundleName
@@ -273,6 +278,7 @@ public class Module {
         self.buildSettingsDescription = buildSettingsDescription
         self.pluginUsages = pluginUsages
         self.usesUnsafeFlags = usesUnsafeFlags
+        self.implicit = implicit
     }
 }
 
diff --git a/Sources/PackageModel/Module/PluginModule.swift b/Sources/PackageModel/Module/PluginModule.swift
@@ -45,7 +45,8 @@ public final class PluginModule: Module {
             buildSettings: .init(),
             buildSettingsDescription: [],
             pluginUsages: [],
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: false
         )
     }
 }
diff --git a/Sources/PackageModel/Module/SwiftModule.swift b/Sources/PackageModel/Module/SwiftModule.swift
@@ -33,7 +33,8 @@ public final class SwiftModule: Module {
         dependencies: [Module.Dependency],
         packageAccess: Bool,
         testDiscoverySrc: Sources,
-        buildSettings: BuildSettings.AssignmentTable = .init()) {
+        buildSettings: BuildSettings.AssignmentTable = .init(),
+        implicit: Bool) {
         self.declaredSwiftVersions = []
 
         super.init(
@@ -46,7 +47,8 @@ public final class SwiftModule: Module {
             buildSettings: buildSettings,
             buildSettingsDescription: [],
             pluginUsages: [],
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: implicit
         )
     }
 
@@ -68,7 +70,8 @@ public final class SwiftModule: Module {
         buildSettings: BuildSettings.AssignmentTable = .init(),
         buildSettingsDescription: [TargetBuildSettingDescription.Setting] = [],
         pluginUsages: [PluginUsage] = [],
-        usesUnsafeFlags: Bool
+        usesUnsafeFlags: Bool,
+        implicit: Bool
     ) {
         self.declaredSwiftVersions = declaredSwiftVersions
         super.init(
@@ -85,7 +88,8 @@ public final class SwiftModule: Module {
             buildSettings: buildSettings,
             buildSettingsDescription: buildSettingsDescription,
             pluginUsages: pluginUsages,
-            usesUnsafeFlags: usesUnsafeFlags
+            usesUnsafeFlags: usesUnsafeFlags,
+            implicit: implicit
         )
     }
 
@@ -133,7 +137,8 @@ public final class SwiftModule: Module {
             buildSettings: buildSettings,
             buildSettingsDescription: [],
             pluginUsages: [],
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: true
         )
     }
 
diff --git a/Sources/PackageModel/Module/SystemLibraryModule.swift b/Sources/PackageModel/Module/SystemLibraryModule.swift
@@ -25,9 +25,6 @@ public final class SystemLibraryModule: Module {
     /// List of system package providers, if any.
     public let providers: [SystemPackageProviderDescription]?
 
-    /// True if this system library should become implicit dependency of its dependent packages.
-    public let isImplicit: Bool
-
     public init(
         name: String,
         path: AbsolutePath,
@@ -38,7 +35,6 @@ public final class SystemLibraryModule: Module {
         let sources = Sources(paths: [], root: path)
         self.pkgConfig = pkgConfig
         self.providers = providers
-        self.isImplicit = isImplicit
         super.init(
             name: name,
             type: .systemModule,
@@ -49,7 +45,8 @@ public final class SystemLibraryModule: Module {
             buildSettings: .init(),
             buildSettingsDescription: [],
             pluginUsages: [],
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: isImplicit
         )
     }
 }
diff --git a/Sources/_InternalTestSupport/ResolvedModule+Mock.swift b/Sources/_InternalTestSupport/ResolvedModule+Mock.swift
@@ -29,7 +29,8 @@ extension ResolvedModule {
                 sources: Sources(paths: [], root: "/"),
                 dependencies: [],
                 packageAccess: false,
-                usesUnsafeFlags: false
+                usesUnsafeFlags: false,
+                implicit: true
             ),
             dependencies: deps.map { .module($0, conditions: conditions) },
             defaultLocalization: nil,
diff --git a/Tests/BuildTests/BuildPlanTests.swift b/Tests/BuildTests/BuildPlanTests.swift
@@ -7348,6 +7348,94 @@ class BuildPlanTestCase: BuildSystemProviderTestCase {
             }
         }
     }
+
+    func testImplicitModules() async throws {
+        let fileSystem = InMemoryFileSystem(
+            emptyFiles:
+            "/A/Sources/ATarget/foo.swift",
+            "/A/Sources/AMacro/macro.swift",
+            "/A/Sources/AExecutable/main.swift",
+            "/A/Sources/ASystemLib/module.modulemap",
+            "/A/Plugins/APlugin/main.swift",
+            "/A/Tests/ATargetTests/foo.swift"
+        )
+
+        let observability = ObservabilitySystem.makeForTesting()
+        let graph = try loadModulesGraph(
+            fileSystem: fileSystem,
+            manifests: [
+                Manifest.createRootManifest(
+                    displayName: "A",
+                    path: "/A",
+                    dependencies: [
+                    ],
+                    targets: [
+                        TargetDescription(name: "ATarget"),
+                        TargetDescription(
+                            name: "AMacro",
+                            dependencies: [],
+                            type: .`macro`
+                        ),
+                        TargetDescription(
+                            name: "AExecutable",
+                            dependencies: ["ATarget"],
+                            type: .executable
+                        ),
+                        TargetDescription(
+                            name: "APlugin",
+                            type: .plugin,
+                            pluginCapability: .buildTool
+                        ),
+                        TargetDescription(
+                            name: "ASystemLib",
+                            type: .system
+                        ),
+                        TargetDescription(
+                            name: "ATargetTests",
+                            dependencies: ["ATarget"],
+                            type: .test
+                        ),
+                    ]
+                ),
+            ],
+            observabilityScope: observability.topScope
+        )
+        XCTAssertNoDiagnostics(observability.diagnostics)
+
+        let result = try await BuildPlanResult(plan: mockBuildPlan(
+            graph: graph,
+            fileSystem: fileSystem,
+            observabilityScope: observability.topScope
+        ))
+
+        struct ExpectedTarget: Hashable, Equatable {
+            let name: String
+            let implicit: Bool
+        }
+
+        var expectedTargets: Set<ExpectedTarget> = [
+            .init(name: "ATarget", implicit: false),
+            .init(name: "AMacro", implicit: false),
+            .init(name: "AExecutable", implicit: false),
+            .init(name: "ATargetTests", implicit: false),
+            .init(name: "APackageTests", implicit: true),
+        ]
+        #if !os(macOS)
+        expectedTargets.insert(.init(name: "APackageDiscoveredTests", implicit: true))
+        #endif
+        XCTAssertEqual(
+            Set(result.targetMap.map { ExpectedTarget(name: $0.module.name, implicit: $0.module.implicit) }),
+            expectedTargets
+        )
+        XCTAssertEqual(
+            result.plan.graph.module(for: "APlugin")?.implicit,
+            false
+        )
+        XCTAssertEqual(
+            result.plan.graph.module(for: "ASystemLib")?.implicit,
+            false
+        )
+    }
 }
 
 class BuildPlanNativeTests: BuildPlanTestCase {
diff --git a/Tests/BuildTests/ClangTargetBuildDescriptionTests.swift b/Tests/BuildTests/ClangTargetBuildDescriptionTests.swift
@@ -61,7 +61,8 @@ final class ClangTargetBuildDescriptionTests: XCTestCase {
             type: .library,
             path: .root,
             sources: .init(paths: [.root.appending(component: "foo.c")], root: .root),
-            usesUnsafeFlags: false
+            usesUnsafeFlags: false,
+            implicit: true
         )
     }
 

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,8 @@ extension BuildPlan {`
`102`	`102`	`dependencies: testProduct.underlying.modules.map { .module($0, conditions: []) },`
`103`	`103`	`packageAccess: true, // test target is allowed access to package decls by default`
`104`	`104`	`testDiscoverySrc: Sources(paths: discoveryPaths, root: discoveryDerivedDir),`
`105`		`- buildSettings: discoveryBuildSettings`
	`105`	`+ buildSettings: discoveryBuildSettings,`
	`106`	`+ implicit: true`
`106`	`107`	`)`
`107`	`108`	`let discoveryResolvedModule = ResolvedModule(`
`108`	`109`	`packageIdentity: testProduct.packageIdentity,`
`@@ -287,7 +288,8 @@ private extension PackageModel.SwiftModule {`
`287`	`288`	`dependencies: dependencies,`
`288`	`289`	`packageAccess: packageAccess,`
`289`	`290`	`buildSettings: buildSettings,`
`290`		`- usesUnsafeFlags: false`
	`291`	`+ usesUnsafeFlags: false,`
	`292`	`+ implicit: true`
`291`	`293`	`)`
`292`	`294`	`}`
`293`	`295`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1079,7 +1079,8 @@ public final class PackageBuilder {`
`1079`	`1079`	`declaredSwiftVersions: self.declaredSwiftVersions(),`
`1080`	`1080`	`buildSettings: buildSettings,`
`1081`	`1081`	`buildSettingsDescription: manifestTarget.settings,`
`1082`		`- usesUnsafeFlags: manifestTarget.usesUnsafeFlags`
	`1082`	`+ usesUnsafeFlags: manifestTarget.usesUnsafeFlags,`
	`1083`	`+ implicit: false`
`1083`	`1084`	`)`
`1084`	`1085`	`} else {`
`1085`	`1086`	`// It's not a Swift target, so it's a Clang target (those are the only two types of source target currently`
`@@ -1124,7 +1125,8 @@ public final class PackageBuilder {`
`1124`	`1125`	`dependencies: dependencies,`
`1125`	`1126`	`buildSettings: buildSettings,`
`1126`	`1127`	`buildSettingsDescription: manifestTarget.settings,`
`1127`		`- usesUnsafeFlags: manifestTarget.usesUnsafeFlags`
	`1128`	`+ usesUnsafeFlags: manifestTarget.usesUnsafeFlags,`
	`1129`	`+ implicit: false`
`1128`	`1130`	`)`
`1129`	`1131`	`}`
`1130`	`1132`	`}`
`@@ -1903,7 +1905,8 @@ extension PackageBuilder {`
`1903`	`1905`	`packageAccess: false,`
`1904`	`1906`	`buildSettings: buildSettings,`
`1905`	`1907`	`buildSettingsDescription: targetDescription.settings,`
`1906`		`- usesUnsafeFlags: false`
	`1908`	`+ usesUnsafeFlags: false,`
	`1909`	`+ implicit: true`
`1907`	`1910`	`)`
`1908`	`1911`	`}`
`1909`	`1912`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,8 @@ public final class BinaryModule: Module {`
`49`	`49`	`buildSettings: .init(),`
`50`	`50`	`buildSettingsDescription: [],`
`51`	`51`	`pluginUsages: [],`
`52`		`- usesUnsafeFlags: false`
	`52`	`+ usesUnsafeFlags: false,`
	`53`	`+ implicit: false`
`53`	`54`	`)`
`54`	`55`	`}`
`55`	`56`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,8 @@ public final class ClangModule: Module {`
`61`	`61`	`dependencies: [Module.Dependency] = [],`
`62`	`62`	`buildSettings: BuildSettings.AssignmentTable = .init(),`
`63`	`63`	`buildSettingsDescription: [TargetBuildSettingDescription.Setting] = [],`
`64`		`- usesUnsafeFlags: Bool`
	`64`	`+ usesUnsafeFlags: Bool,`
	`65`	`+ implicit: Bool`
`65`	`66`	`) throws {`
`66`	`67`	`guard includeDir.isDescendantOfOrEqual(to: sources.root) else {`
`67`	`68`	`throw StringError("\(includeDir) should be contained in the source root \(sources.root)")`
`@@ -86,7 +87,8 @@ public final class ClangModule: Module {`
`86`	`87`	`buildSettings: buildSettings,`
`87`	`88`	`buildSettingsDescription: buildSettingsDescription,`
`88`	`89`	`pluginUsages: [],`
`89`		`- usesUnsafeFlags: usesUnsafeFlags`
	`90`	`+ usesUnsafeFlags: usesUnsafeFlags,`
	`91`	`+ implicit: implicit`
`90`	`92`	`)`
`91`	`93`	`}`
`92`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,8 @@ public final class PluginModule: Module {`
`45`	`45`	`buildSettings: .init(),`
`46`	`46`	`buildSettingsDescription: [],`
`47`	`47`	`pluginUsages: [],`
`48`		`- usesUnsafeFlags: false`
	`48`	`+ usesUnsafeFlags: false,`
	`49`	`+ implicit: false`
`49`	`50`	`)`
`50`	`51`	`}`
`51`	`52`	`}`