refactor workspace repository handling (#3766)

motivation: make supporting registry depedencies easier

changes:
* rename LocalPackageContainer to FileSystemPackageContainer and move it to workspace module as internal struct
* rename RepositoryPackageContainer to SourceControlPackageContainer and move it to the workspace module as internal class
* remove RepositoryPackageContainerProvider and move its logic to workspace itself, including the logic to switch over dependecy type (local/remote) and providing the correct container type
* conform workspace to PackageContainerProvider and change getContiner call-sites to use it
* reorgnize repository related methods in a consistent manner so its easier to read the code that deals with repositories
* adjust call sites and tests

rdar://81621441

Author: tomerd

Package.swift

@@ -161,6 +161,7 @@ let package = Package(
             /** Primitive Package model objects */
             name: "PackageModel",
             dependencies: ["SwiftToolsSupport-auto", "Basics"]),
+
         .target(
             /** Package model conventions and loading support */
             name: "PackageLoading",

Sources/PackageGraph/CMakeLists.txt

@@ -14,7 +14,6 @@ add_library(PackageGraph
   DependencyResolver.swift
   Diagnostics.swift
   GraphLoadingNode.swift
-  LocalPackageContainer.swift
   PackageContainer.swift
   PackageGraph.swift
   PackageGraph+Loading.swift
@@ -27,7 +26,6 @@ add_library(PackageGraph
   Pubgrub/PartialSolution.swift
   Pubgrub/PubgrubDependencyResolver.swift
   Pubgrub/Term.swift
-  RepositoryPackageContainer.swift
   ResolvedPackage.swift
   ResolvedProduct.swift
   ResolvedTarget.swift

Sources/PackageGraph/CheckoutState.swift

@@ -8,9 +8,8 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
  */
 
-import TSCBasic
-import SourceControl
-import TSCUtility
+import struct SourceControl.Revision // FIXME: remove this dependency
+import struct TSCUtility.Version
 
 /// A checkout state represents the current state of a repository.
 ///

Sources/PackageGraph/DependencyMirrors.swift

@@ -9,9 +9,7 @@
 */
 
 import Foundation
-
 import TSCBasic
-import TSCUtility
 
 /// A collection of dependency mirrors.
 public final class DependencyMirrors: Equatable {

Sources/PackageGraph/GraphLoadingNode.swift

@@ -8,10 +8,9 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
  */
 
-import TSCBasic
 import PackageLoading
 import PackageModel
-import TSCUtility
+import TSCBasic
 
 /// A node used while loading the packages in a resolved graph.
 ///

Sources/PackageGraph/PackageContainer.swift

@@ -9,9 +9,7 @@
  */
 
 import Dispatch
-import PackageLoading
 import PackageModel
-import SourceControl
 import struct TSCUtility.Version
 
 /// A container of packages.
@@ -104,7 +102,7 @@ extension PackageContainer {
     }
 }
 
-// MARK: -
+// MARK: - PackageContainerConstraint
 
 /// An individual constraint onto a container.
 public struct PackageContainerConstraint: Equatable, Hashable {
@@ -139,7 +137,7 @@ extension PackageContainerConstraint: CustomStringConvertible {
     }
 }
 
-// MARK: -
+// MARK: - PackageContainerProvider
 
 /// An interface for resolving package containers.
 public protocol PackageContainerProvider {

Sources/PackageGraph/PackageGraph+Loading.swift

@@ -11,9 +11,7 @@
 import Basics
 import PackageLoading
 import PackageModel
-import SourceControl
 import TSCBasic
-import TSCUtility
 
 extension PackageGraph {
 

Sources/PackageGraph/PackageGraph.swift

@@ -8,8 +8,8 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
  */
 
-import TSCBasic
 import PackageModel
+import TSCBasic
 
 enum PackageGraphError: Swift.Error {
     /// Indicates a non-root package with no targets.

Sources/PackageGraph/PackageGraphRoot.swift

@@ -10,9 +10,8 @@
 
 import Basics
 import PackageModel
-import SourceControl
 import TSCBasic
-import TSCUtility
+import enum TSCUtility.Git
 
 /// Represents the input to the package graph root.
 public struct PackageGraphRootInput {

Sources/PackageGraph/PackageModel+Extensions.swift

@@ -9,7 +9,6 @@
 */
 
 import PackageModel
-import SourceControl
 
 extension PackageDependency {
     /// Create the package reference object for the dependency.

Sources/PackageGraph/PinsStore.swift

@@ -11,7 +11,7 @@
 import Basics
 import Foundation
 import PackageModel
-import SourceControl
+import struct SourceControl.Revision // FIXME: remove this dependency
 import TSCBasic
 
 public final class PinsStore {

Sources/PackageGraph/Version+Extensions.swift

@@ -8,7 +8,7 @@ See http://swift.org/LICENSE.txt for license information
 See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-import TSCUtility
+import struct TSCUtility.Version
 
 extension Version {
     func nextPatch() -> Version {

Sources/PackageGraph/VersionSetSpecifier.swift

@@ -8,7 +8,7 @@ See http://swift.org/LICENSE.txt for license information
 See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-import TSCUtility
+import struct TSCUtility.Version
 
 /// An abstract definition for a set of versions.
 public enum VersionSetSpecifier: Hashable {

Sources/PackageLoading/Diagnostics.swift

@@ -11,7 +11,6 @@
 import Basics
 import PackageModel
 import TSCBasic
-import TSCUtility
 
 extension Basics.Diagnostic {
     static func targetHasNoSources(targetPath: String, target: String) -> Self {

Sources/PackageLoading/IdentityResolver.swift

@@ -47,6 +47,8 @@ public struct DefaultIdentityResolver: IdentityResolver {
             return try self.resolveIdentity(for: path)
         case .remoteSourceControl(let url):
             return try self.resolveIdentity(for: url)
+        case .registry(let identity):
+            return identity
         }
     }
 

Sources/PackageLoading/ManifestJSONParser.swift

@@ -11,7 +11,7 @@
 import Basics
 import Foundation
 import PackageModel
-import SourceControl
+import SourceControl // FIXME: remove this dependency
 import TSCBasic
 import TSCUtility
 
@@ -233,6 +233,9 @@ enum ManifestJSONParser {
         case .remoteSourceControl:
             // nothing to fix
             return dependencyLocation
+        case .registry:
+            // nothing to fix
+            return dependencyLocation
         }
 
         if dependencyLocation.hasPrefix("~/") {

Sources/PackageLoading/ManifestLoader.swift

@@ -9,11 +9,12 @@
 */
 
 import Basics
-import TSCBasic
-import PackageModel
-import TSCUtility
 import Foundation
-public typealias FileSystem = TSCBasic.FileSystem
+import PackageModel
+import TSCBasic
+import struct TSCUtility.Triple
+import enum TSCUtility.Diagnostics
+import var TSCUtility.verbosity
 
 public enum ManifestParseError: Swift.Error, Equatable {
     /// The manifest contains invalid format.

Sources/PackageLoading/PackageBuilder.swift

@@ -12,7 +12,6 @@ import Basics
 import Dispatch
 import PackageModel
 import TSCBasic
-import TSCUtility
 
 /// An error in the structure or layout of a package.
 public enum ModuleError: Swift.Error {

Sources/PackageLoading/Target+PkgConfig.swift

@@ -9,8 +9,8 @@
 */
 
 import Basics
-import TSCBasic
 import PackageModel
+import TSCBasic
 import TSCUtility
 
 /// Wrapper struct containing result of a pkgConfig query.

Sources/PackageLoading/TargetSourcesBuilder.swift

@@ -12,7 +12,6 @@ import Basics
 import Foundation
 import PackageModel
 import TSCBasic
-import TSCUtility
 
 /// A utility to compute the source/resource files of a target.
 public struct TargetSourcesBuilder {

Sources/PackageLoading/ToolsVersionLoader.swift

@@ -12,7 +12,6 @@ import Basics
 import Foundation
 import PackageModel
 import TSCBasic
-import TSCUtility
 
 /// Protocol for the manifest loader interface.
 public protocol ToolsVersionLoaderProtocol {

Sources/PackageModel/PackageReference.swift

@@ -6,7 +6,7 @@
 
  See http://swift.org/LICENSE.txt for license information
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
-*/
+ */
 
 import Basics
 import Foundation
@@ -16,7 +16,7 @@ import TSCUtility
 /// A package reference.
 ///
 /// This represents a reference to a package containing its identity and location.
-public struct PackageReference: Encodable {
+public struct PackageReference {
     /// The kind of package reference.
     public enum Kind: Equatable {
         /// A root package.
@@ -31,6 +31,9 @@ public struct PackageReference: Encodable {
         /// A remote source package.
         case remoteSourceControl(Foundation.URL)
 
+        /// A package from  a registry.
+        case registry(PackageIdentity)
+
         // FIXME: we should not need this
         //@available(*, deprecated)
         public var locationString: String {
@@ -43,6 +46,9 @@ public struct PackageReference: Encodable {
                 return path.pathString
             case .remoteSourceControl(let url):
                 return url.absoluteString
+            case .registry(let identity):
+                // FIXME: this is a placeholder
+                return identity.description
             }
         }
 
@@ -75,7 +81,7 @@ public struct PackageReference: Encodable {
     /// The kind of package: root, local, or remote.
     public let kind: Kind
 
-    /// Create a package reference given its identity and repository.
+    /// Create a package reference given its identity and kind.
     public init(identity: PackageIdentity, kind: Kind, name: String? = nil) {
         self.identity = identity
         self.kind = kind
@@ -88,6 +94,9 @@ public struct PackageReference: Encodable {
             self.name = name ?? LegacyPackageIdentity.computeDefaultName(fromPath: path)
         case .remoteSourceControl(let url):
             self.name = name ?? LegacyPackageIdentity.computeDefaultName(fromURL: url)
+        case .registry(let identity):
+            // FIXME: this is a placeholder
+            self.name = name ?? identity.description
         }
     }
 
@@ -104,14 +113,17 @@ public struct PackageReference: Encodable {
         PackageReference(identity: identity, kind: .fileSystem(path))
     }
 
-
     public static func localSourceControl(identity: PackageIdentity, path: AbsolutePath) -> PackageReference {
         PackageReference(identity: identity, kind: .localSourceControl(path))
     }
 
     public static func remoteSourceControl(identity: PackageIdentity, url: Foundation.URL) -> PackageReference {
         PackageReference(identity: identity, kind: .remoteSourceControl(url))
     }
+
+    public static func registry(identity: PackageIdentity) -> PackageReference {
+        PackageReference(identity: identity, kind: .registry(identity))
+    }
 }
 
 extension PackageReference: Equatable {
@@ -136,7 +148,7 @@ extension PackageReference: CustomStringConvertible {
 
 extension PackageReference.Kind: Encodable {
     private enum CodingKeys: String, CodingKey {
-        case root, fileSystem, localSourceControl, remoteSourceControl
+        case root, fileSystem, localSourceControl, remoteSourceControl, registry
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -154,6 +166,9 @@ extension PackageReference.Kind: Encodable {
         case .remoteSourceControl(let url):
             var unkeyedContainer = container.nestedUnkeyedContainer(forKey: .remoteSourceControl)
             try unkeyedContainer.encode(url)
+        case .registry:
+            var unkeyedContainer = container.nestedUnkeyedContainer(forKey: .registry)
+            try unkeyedContainer.encode(self.isRoot)
         }
     }
 }

Sources/SPMTestSupport/MockManifestLoader.swift

@@ -8,15 +8,14 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-import func XCTest.XCTFail
-import Dispatch
-
 import Basics
-import TSCBasic
+import Dispatch
 import PackageModel
 import PackageLoading
 import PackageGraph
+import TSCBasic
 import TSCUtility
+import func XCTest.XCTFail
 
 public enum MockManifestLoaderError: Swift.Error {
     case unknownRequest(String)
@@ -82,7 +81,7 @@ extension ManifestLoader {
         packageKind: PackageModel.PackageReference.Kind,
         toolsVersion: PackageModel.ToolsVersion,
         identityResolver: IdentityResolver = DefaultIdentityResolver(),
-        fileSystem: PackageLoading.FileSystem,
+        fileSystem: TSCBasic.FileSystem,
         diagnostics: TSCBasic.DiagnosticsEngine? = nil
     ) throws -> Manifest{
         let packageIdentity: PackageIdentity
@@ -100,6 +99,10 @@ extension ManifestLoader {
         case .remoteSourceControl(let url):
             packageIdentity = try identityResolver.resolveIdentity(for: url)
             packageLocation = url.absoluteString
+        case .registry(let identity):
+            packageIdentity = identity
+            // FIXME: placeholder
+            packageLocation = identity.description
         }
         return try tsc_await {
             self.load(at: path,

Sources/SPMTestSupport/MockWorkspace.swift

@@ -777,6 +777,8 @@ extension PackageReference.Kind {
             return "localSourceControl"
         case .remoteSourceControl:
             return "remoteSourceControl"
+        case .registry:
+            return "registry"
         }
     }
 }

Sources/Workspace/CMakeLists.txt

@@ -10,11 +10,13 @@ add_library(Workspace
   DefaultPluginScriptRunner.swift
   Destination.swift
   Diagnostics.swift
+  FileSystemPackageContainer.swift
   InitPackage.swift
   ManagedArtifact.swift
   ManagedDependency.swift
   ResolvedFileWatcher.swift
   ResolverPrecomputationProvider.swift
+  SourceControlPackageContainer.swift
   ToolsVersionSpecificationRewriter.swift
   UserToolchain.swift
   Workspace.swift