Rename PackageGraph type to ModulesGraph (#7363)

We have to operate on two different graphs in the `PackageGraph` module:
1. A graph of packages in PubGrub package resolution code;
2. A graph of resolved products and modules that belong to those
products.

Currently the second graph is misleadingly called `PackageGraph`,
although that name is much more suitable for the first graph. This
naming is confusing and unfortunate, and can be especially misleading
for first-time contributors. We should better document the SwiftPM
resolution and build pipeline in the future, but cleaning up naming is
the first step.

I'm keeping old names as deprecated overloads or typealiases to make
migration easier for SwiftPM clients. This renaming has no impact on any
public stable modules like `PackageDescription`.

In the short term we should also split the `PackageGraph` module into
`PubGrub` and `ModulesGraph` modules, but for now I'm renaming a single
type to keep the PR manageable.

Author: MaxDesiatov

Sources/Build/BuildDescription/ClangTargetBuildDescription.swift

@@ -13,7 +13,7 @@
 import Basics
 import PackageLoading
 import PackageModel
-import struct PackageGraph.PackageGraph
+import struct PackageGraph.ModulesGraph
 import struct PackageGraph.ResolvedTarget
 import struct SPMBuildCore.BuildParameters
 import struct SPMBuildCore.BuildToolPluginInvocationResult
@@ -134,7 +134,7 @@ public final class ClangTargetBuildDescription {
         if toolsVersion >= .v5_9 {
             self.buildToolPluginInvocationResults = buildToolPluginInvocationResults
 
-            (self.pluginDerivedSources, self.pluginDerivedResources) = PackageGraph.computePluginGeneratedFiles(
+            (self.pluginDerivedSources, self.pluginDerivedResources) = ModulesGraph.computePluginGeneratedFiles(
                 target: target,
                 toolsVersion: toolsVersion,
                 additionalFileRules: additionalFileRules,

Sources/Build/BuildDescription/SwiftTargetBuildDescription.swift

@@ -287,7 +287,7 @@ public final class SwiftTargetBuildDescription {
         self.fileSystem = fileSystem
         self.observabilityScope = observabilityScope
 
-        (self.pluginDerivedSources, self.pluginDerivedResources) = PackageGraph.computePluginGeneratedFiles(
+        (self.pluginDerivedSources, self.pluginDerivedResources) = ModulesGraph.computePluginGeneratedFiles(
             target: target,
             toolsVersion: toolsVersion,
             additionalFileRules: additionalFileRules,

Sources/Build/BuildOperation.swift

@@ -47,7 +47,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
     let toolsBuildParameters: BuildParameters
 
     /// The closure for loading the package graph.
-    let packageGraphLoader: () throws -> PackageGraph
+    let packageGraphLoader: () throws -> ModulesGraph
 
     /// the plugin configuration for build plugins
     let pluginConfiguration: PluginConfiguration?
@@ -78,7 +78,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
     private let buildDescription = ThreadSafeBox<BuildDescription>()
 
     /// The loaded package graph.
-    private let packageGraph = ThreadSafeBox<PackageGraph>()
+    private let packageGraph = ThreadSafeBox<ModulesGraph>()
 
     /// The output stream for the build delegate.
     private let outputStream: OutputByteStream
@@ -112,7 +112,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         productsBuildParameters: BuildParameters,
         toolsBuildParameters: BuildParameters,
         cacheBuildManifest: Bool,
-        packageGraphLoader: @escaping () throws -> PackageGraph,
+        packageGraphLoader: @escaping () throws -> ModulesGraph,
         pluginConfiguration: PluginConfiguration? = .none,
         additionalFileRules: [FileRuleDescription],
         pkgConfigDirectories: [AbsolutePath],
@@ -145,7 +145,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         self.observabilityScope = observabilityScope.makeChildScope(description: "Build Operation")
     }
 
-    public func getPackageGraph() throws -> PackageGraph {
+    public func getPackageGraph() throws -> ModulesGraph {
         try self.packageGraph.memoize {
             try self.packageGraphLoader()
         }
@@ -877,7 +877,7 @@ extension BuildDescription {
 }
 
 extension BuildSubset {
-    func recursiveDependencies(for graph: PackageGraph, observabilityScope: ObservabilityScope) throws -> [ResolvedTarget]? {
+    func recursiveDependencies(for graph: ModulesGraph, observabilityScope: ObservabilityScope) throws -> [ResolvedTarget]? {
         switch self {
         case .allIncludingTests:
             return Array(graph.reachableTargets)
@@ -899,7 +899,7 @@ extension BuildSubset {
     }
 
     /// Returns the name of the llbuild target that corresponds to the build subset.
-    func llbuildTargetName(for graph: PackageGraph, config: String, observabilityScope: ObservabilityScope)
+    func llbuildTargetName(for graph: ModulesGraph, config: String, observabilityScope: ObservabilityScope)
         -> String?
     {
         switch self {

Sources/Build/BuildPlan/BuildPlan+Test.swift

@@ -15,7 +15,7 @@ import struct Basics.InternalError
 import struct Basics.AbsolutePath
 import struct LLBuildManifest.TestDiscoveryTool
 import struct LLBuildManifest.TestEntryPointTool
-import struct PackageGraph.PackageGraph
+import struct PackageGraph.ModulesGraph
 import struct PackageGraph.ResolvedProduct
 import struct PackageGraph.ResolvedTarget
 import struct PackageModel.Sources
@@ -27,7 +27,7 @@ import protocol TSCBasic.FileSystem
 extension BuildPlan {
     static func makeDerivedTestTargets(
         _ buildParameters: BuildParameters,
-        _ graph: PackageGraph,
+        _ graph: ModulesGraph,
         _ disableSandbox: Bool,
         _ fileSystem: FileSystem,
         _ observabilityScope: ObservabilityScope

Sources/Build/BuildPlan/BuildPlan.swift

@@ -196,7 +196,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
     }
 
     /// The package graph.
-    public let graph: PackageGraph
+    public let graph: ModulesGraph
 
     /// The target build description map.
     public let targetMap: [ResolvedTarget.ID: TargetBuildDescription]
@@ -249,7 +249,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
     @available(*, deprecated, renamed: "init(productsBuildParameters:toolsBuildParameters:graph:)")
     public convenience init(
         buildParameters: BuildParameters,
-        graph: PackageGraph,
+        graph: ModulesGraph,
         additionalFileRules: [FileRuleDescription] = [],
         buildToolPluginInvocationResults: [ResolvedTarget.ID: [BuildToolPluginInvocationResult]] = [:],
         prebuildCommandResults: [ResolvedTarget.ID: [PrebuildCommandResult]] = [:],
@@ -272,7 +272,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
     public init(
         productsBuildParameters: BuildParameters,
         toolsBuildParameters: BuildParameters,
-        graph: PackageGraph,
+        graph: ModulesGraph,
         additionalFileRules: [FileRuleDescription] = [],
         buildToolPluginInvocationResults: [ResolvedTarget.ID: [BuildToolPluginInvocationResult]] = [:],
         prebuildCommandResults: [ResolvedTarget.ID: [PrebuildCommandResult]] = [:],

Sources/Commands/PackageTools/APIDiff.swift

@@ -160,7 +160,7 @@ struct APIDiff: SwiftCommand {
         }
     }
 
-    private func determineModulesToDiff(packageGraph: PackageGraph, observabilityScope: ObservabilityScope) throws -> Set<String> {
+    private func determineModulesToDiff(packageGraph: ModulesGraph, observabilityScope: ObservabilityScope) throws -> Set<String> {
         var modulesToDiff: Set<String> = []
         if products.isEmpty && targets.isEmpty {
             modulesToDiff.formUnion(packageGraph.apiDigesterModules)

Sources/Commands/PackageTools/PluginCommand.swift

@@ -211,7 +211,7 @@ struct PluginCommand: SwiftCommand {
     static func run(
         plugin: PluginTarget,
         package: ResolvedPackage,
-        packageGraph: PackageGraph,
+        packageGraph: ModulesGraph,
         options: PluginOptions,
         arguments: [String],
         swiftTool: SwiftTool
@@ -369,7 +369,7 @@ struct PluginCommand: SwiftCommand {
         // TODO: We should also emit a final line of output regarding the result.
     }
 
-    static func availableCommandPlugins(in graph: PackageGraph, limitedTo packageIdentity: String?) -> [PluginTarget] {
+    static func availableCommandPlugins(in graph: ModulesGraph, limitedTo packageIdentity: String?) -> [PluginTarget] {
         // All targets from plugin products of direct dependencies are "available".
         let directDependencyPackages = graph.rootPackages.flatMap { $0.dependencies }.filter { $0.matching(identity: packageIdentity) }
         let directDependencyPluginTargets = directDependencyPackages.flatMap { $0.products.filter { $0.type == .plugin } }.flatMap { $0.targets }
@@ -383,7 +383,7 @@ struct PluginCommand: SwiftCommand {
         }
     }
 
-    static func findPlugins(matching verb: String, in graph: PackageGraph, limitedTo packageIdentity: String?) -> [PluginTarget] {
+    static func findPlugins(matching verb: String, in graph: ModulesGraph, limitedTo packageIdentity: String?) -> [PluginTarget] {
         // Find and return the command plugins that match the command.
         Self.availableCommandPlugins(in: graph, limitedTo: packageIdentity).filter {
             // Filter out any non-command plugins and any whose verb is different.

Sources/Commands/SwiftRunTool.swift

@@ -216,7 +216,7 @@ public struct SwiftRunTool: SwiftCommand {
     }
 
     /// Returns the path to the correct executable based on options.
-    private func findProductName(in graph: PackageGraph) throws -> String {
+    private func findProductName(in graph: ModulesGraph) throws -> String {
         if let executable = options.executable {
             let executableExists = graph.allProducts.contains { ($0.type == .executable || $0.type == .snippet) && $0.name == executable }
             guard executableExists else {

Sources/Commands/Utilities/APIDigester.swift

@@ -310,7 +310,7 @@ extension BuildParameters {
     }
 }
 
-extension PackageGraph {
+extension ModulesGraph {
     /// The list of modules that should be used as an input to the API digester.
     var apiDigesterModules: [String] {
         self.rootPackages

Sources/CoreCommands/BuildSystemSupport.swift

@@ -18,7 +18,7 @@ import XCBuildSupport
 #endif
 
 import class Basics.ObservabilityScope
-import struct PackageGraph.PackageGraph
+import struct PackageGraph.ModulesGraph
 import struct PackageLoading.FileRuleDescription
 import protocol TSCBasic.OutputByteStream
 
@@ -30,7 +30,7 @@ private struct NativeBuildSystemFactory: BuildSystemFactory {
         cacheBuildManifest: Bool,
         productsBuildParameters: BuildParameters?,
         toolsBuildParameters: BuildParameters?,
-        packageGraphLoader: (() throws -> PackageGraph)?,
+        packageGraphLoader: (() throws -> ModulesGraph)?,
         outputStream: OutputByteStream?,
         logLevel: Diagnostic.Severity?,
         observabilityScope: ObservabilityScope?
@@ -72,7 +72,7 @@ private struct XcodeBuildSystemFactory: BuildSystemFactory {
         cacheBuildManifest: Bool,
         productsBuildParameters: BuildParameters?,
         toolsBuildParameters: BuildParameters?,
-        packageGraphLoader: (() throws -> PackageGraph)?,
+        packageGraphLoader: (() throws -> ModulesGraph)?,
         outputStream: OutputByteStream?,
         logLevel: Diagnostic.Severity?,
         observabilityScope: ObservabilityScope?