Initial implementation of RegistryPackageContainer

Add PackageRegistry module target

Add PackageRegistryTests module target

Add --enable-package-registry command-line option

Author: mattt

Package.swift

@@ -43,6 +43,7 @@ let package = Package(
                 "PackageModel",
                 "PackageLoading",
                 "PackageGraph",
+                "PackageRegistry",
                 "Build",
                 "Xcodeproj",
                 "Workspace"
@@ -58,6 +59,7 @@ let package = Package(
                 "PackageModel",
                 "PackageLoading",
                 "PackageGraph",
+                "PackageRegistry",
                 "Build",
                 "Xcodeproj",
                 "Workspace"
@@ -111,10 +113,16 @@ let package = Package(
             name: "LLBuildManifest",
             dependencies: ["SwiftToolsSupport-auto", "Basics"]),
 
+        .target(
+            /** Package registry support */
+            name: "PackageRegistry",
+            dependencies: ["SwiftToolsSupport-auto", "Basics", "PackageLoading", "PackageModel"]),
+
         .target(
             /** Source control operations */
             name: "SourceControl",
             dependencies: ["SwiftToolsSupport-auto", "Basics"]),
+
         .target(
             /** Shim for llbuild library */
             name: "SPMLLBuild",
@@ -136,7 +144,7 @@ let package = Package(
         .target(
             /** Data structures and support for complete package graphs */
             name: "PackageGraph",
-            dependencies: ["SwiftToolsSupport-auto", "Basics", "PackageLoading", "PackageModel", "SourceControl"]),
+            dependencies: ["SwiftToolsSupport-auto", "Basics", "PackageLoading", "PackageModel", "PackageRegistry", "SourceControl"]),
 
         // MARK: Package Collections
 
@@ -248,6 +256,9 @@ let package = Package(
         .testTarget(
             name: "PackageCollectionsTests",
             dependencies: ["SPMTestSupport", "PackageCollections"]),
+        .testTarget(
+            name: "PackageRegistryTests",
+            dependencies: ["SPMTestSupport", "PackageRegistry"]),
         .testTarget(
             name: "SourceControlTests",
             dependencies: ["SourceControl", "SPMTestSupport"]),

Sources/CMakeLists.txt

@@ -15,6 +15,7 @@ add_subdirectory(PackageDescription)
 add_subdirectory(PackageGraph)
 add_subdirectory(PackageLoading)
 add_subdirectory(PackageModel)
+add_subdirectory(PackageRegistry)
 add_subdirectory(SPMBuildCore)
 add_subdirectory(SPMLLBuild)
 add_subdirectory(SourceControl)

Sources/Commands/Options.swift

@@ -238,6 +238,10 @@ public struct SwiftToolOptions: ParsableArguments {
     @Flag(name: .customLong("trace-resolver"))
     var enableResolverTrace: Bool = false
 
+    @Flag(name: .customLong("enable-package-registry"),
+          help: "Resolve dependencies using a package registry")
+    var enablePackageRegistry: Bool = false
+
     /// The number of jobs for llbuild to start (aka the number of schedulerLanes)
     @Option(name: .shortAndLong, help: "The number of jobs to spawn in parallel during the build process")
     var jobs: UInt32?

Sources/Commands/SwiftTool.swift

@@ -468,7 +468,8 @@ public class SwiftTool {
             netrcFilePath: try resolvedNetrcFilePath(),
             isResolverPrefetchingEnabled: options.shouldEnableResolverPrefetching,
             skipUpdate: options.skipDependencyUpdate,
-            enableResolverTrace: options.enableResolverTrace
+            enableResolverTrace: options.enableResolverTrace,
+            enablePackageRegistry: options.enablePackageRegistry
         )
         _workspace = workspace
         return workspace

Sources/PackageGraph/CMakeLists.txt

@@ -9,6 +9,7 @@
 add_library(PackageGraph
   BoundVersion.swift
   CheckoutState.swift
+  CompositePackageContainerProvider.swift
   DependencyMirrors.swift
   DependencyResolutionNode.swift
   DependencyResolver.swift
@@ -27,6 +28,7 @@ add_library(PackageGraph
   Pubgrub/PartialSolution.swift
   Pubgrub/PubgrubDependencyResolver.swift
   Pubgrub/Term.swift
+  RegistryPackageContainer.swift
   RepositoryPackageContainer.swift
   ResolvedPackage.swift
   ResolvedProduct.swift

Sources/PackageGraph/CompositePackageContainerProvider.swift

@@ -0,0 +1,95 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2014 - 2020 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 Swift project authors
+ */
+
+import Dispatch
+
+import PackageLoading
+import PackageModel
+import PackageRegistry
+import SourceControl
+
+import TSCBasic
+import TSCUtility
+
+public class CompositePackageContainerProvider: PackageContainerProvider {
+    let manifestLoader: ManifestLoaderProtocol
+    let repositoryManager: RepositoryManager
+    let mirrors: DependencyMirrors
+
+    /// The tools version currently in use. Only the container versions less than and equal to this will be provided by
+    /// the container.
+    let currentToolsVersion: ToolsVersion
+
+    /// The tools version loader.
+    let toolsVersionLoader: ToolsVersionLoaderProtocol
+
+    let fileSystem: FileSystem
+
+    /// Queue for callbacks.
+    private let callbacksQueue = DispatchQueue(label: "org.swift.swiftpm.container-provider")
+
+    /// Create a repository-based package provider.
+    ///
+    /// - Parameters:
+    ///   - repositoryManager: The repository manager responsible for providing repositories.
+    ///   - manifestLoader: The manifest loader instance.
+    ///   - currentToolsVersion: The current tools version in use.
+    ///   - toolsVersionLoader: The tools version loader.
+    public init(
+        repositoryManager: RepositoryManager,
+        mirrors: DependencyMirrors = DependencyMirrors(),
+        manifestLoader: ManifestLoaderProtocol,
+        currentToolsVersion: ToolsVersion = ToolsVersion.currentToolsVersion,
+        toolsVersionLoader: ToolsVersionLoaderProtocol = ToolsVersionLoader(),
+        fileSystem: FileSystem = localFileSystem
+    ) {
+        self.repositoryManager = repositoryManager
+        self.mirrors = mirrors
+        self.manifestLoader = manifestLoader
+        self.currentToolsVersion = currentToolsVersion
+        self.toolsVersionLoader = toolsVersionLoader
+        self.fileSystem = fileSystem
+    }
+
+    public func getContainer(
+        for reference: PackageReference,
+        skipUpdate: Bool,
+        completion: @escaping (Result<PackageContainer, Swift.Error>) -> Void
+    ) {
+        // For remote package references, attempt to load from registry before falling back to respository access.
+        if reference.kind == .remote {
+            RegistryManager.discover(for: reference) { result in
+                switch result {
+                case .success(let registryManager):
+                    let provider = RegistryPackageContainerProvider(registryManager: registryManager, mirrors: self.mirrors, manifestLoader: self.manifestLoader, currentToolsVersion: self.currentToolsVersion, toolsVersionLoader: self.toolsVersionLoader)
+                    provider.getContainer(for: reference, skipUpdate: skipUpdate) { result in
+                        self.callbacksQueue.async {
+                            completion(result)
+                        }
+                    }
+                default:
+                    let provider = RepositoryPackageContainerProvider(repositoryManager: self.repositoryManager, mirrors: self.mirrors, manifestLoader: self.manifestLoader, currentToolsVersion: self.currentToolsVersion, toolsVersionLoader: self.toolsVersionLoader)
+                    provider.getContainer(for: reference, skipUpdate: skipUpdate) { result in
+                        self.callbacksQueue.async {
+                            completion(result)
+                        }
+                    }
+                }
+            }
+        } else {
+            let provider = LocalPackageContainerProvider(mirrors: self.mirrors, manifestLoader: self.manifestLoader, currentToolsVersion: self.currentToolsVersion, toolsVersionLoader: self.toolsVersionLoader, fileSystem: self.fileSystem)
+            provider.getContainer(for: reference, skipUpdate: skipUpdate) { result in
+                self.callbacksQueue.async {
+                    completion(result)
+                }
+            }
+        }
+    }
+}

Sources/PackageGraph/LocalPackageContainer.swift

@@ -85,3 +85,54 @@ extension LocalPackageContainer: CustomStringConvertible  {
         return "LocalPackageContainer(\(identifier.path))"
     }
 }
+
+public class LocalPackageContainerProvider: PackageContainerProvider {
+    let manifestLoader: ManifestLoaderProtocol
+    let mirrors: DependencyMirrors
+
+    /// The tools version currently in use. Only the container versions less than and equal to this will be provided by
+    /// the container.
+    let currentToolsVersion: ToolsVersion
+
+    /// The tools version loader.
+    let toolsVersionLoader: ToolsVersionLoaderProtocol
+
+    let fileSystem: FileSystem
+
+    /// Queue for callbacks.
+    private let callbacksQueue = DispatchQueue(label: "org.swift.swiftpm.container-provider")
+
+    public init(
+        mirrors: DependencyMirrors = DependencyMirrors(),
+        manifestLoader: ManifestLoaderProtocol,
+        currentToolsVersion: ToolsVersion = ToolsVersion.currentToolsVersion,
+        toolsVersionLoader: ToolsVersionLoaderProtocol = ToolsVersionLoader(),
+        fileSystem: FileSystem = localFileSystem
+    ) {
+        self.mirrors = mirrors
+        self.manifestLoader = manifestLoader
+        self.currentToolsVersion = currentToolsVersion
+        self.toolsVersionLoader = toolsVersionLoader
+        self.fileSystem = fileSystem
+    }
+
+    public func getContainer(
+        for identifier: PackageReference,
+        skipUpdate: Bool,
+        completion: @escaping (Result<PackageContainer, Swift.Error>) -> Void
+    ) {
+        assert(identifier.kind == .local)
+        callbacksQueue.async {
+            let container = LocalPackageContainer(
+                identifier,
+                mirrors: self.mirrors,
+                manifestLoader: self.manifestLoader,
+                toolsVersionLoader: self.toolsVersionLoader,
+                currentToolsVersion: self.currentToolsVersion,
+                fs: self.fileSystem
+            )
+            
+            completion(.success(container))
+        }
+    }
+}