Implement package registry resolution in Workspace

Author: mattt

Sources/Workspace/Workspace.swift

@@ -15,6 +15,7 @@ import Foundation
 import PackageLoading
 import PackageModel
 import PackageGraph
+import PackageRegistry
 import SourceControl
 
 /// Enumeration of the different reasons for which the resolver needs to be run.
@@ -194,9 +195,6 @@ public class Workspace {
     // var for backwards compatibility with deprecated initializers, remove with them
     fileprivate var identityResolver: IdentityResolver
 
-    /// The package container provider.
-    fileprivate let containerProvider: RepositoryPackageContainerProvider
-
     /// The http client used for downloading binary artifacts.
     fileprivate let httpClient: HTTPClient
 
@@ -226,6 +224,8 @@ public class Workspace {
 
     fileprivate var resolvedFileWatcher: ResolvedFileWatcher?
 
+    fileprivate var registryManager: RegistryManager?
+
     /// Create a new package workspace.
     ///
     /// This initializer is designed for use cases when the workspace needs to be highly customized such as testing.
@@ -306,7 +306,6 @@ public class Workspace {
         let resolverPrefetchingEnabled = resolverPrefetchingEnabled ?? false
         let resolverTracingEnabled = resolverTracingEnabled ?? false
 
-
         // initialize
         self.fileSystem = fileSystem
         self.location = location
@@ -322,15 +321,6 @@ public class Workspace {
         self.identityResolver = identityResolver
         self.checksumAlgorithm = checksumAlgorithm
 
-        self.containerProvider = RepositoryPackageContainerProvider(
-            fileSystem: fileSystem,
-            repositoryManager: repositoryManager,
-            identityResolver: self.identityResolver,
-            manifestLoader: manifestLoader,
-            currentToolsVersion: currentToolsVersion,
-            toolsVersionLoader: toolsVersionLoader
-        )
-
         self.pinsStore = LoadableResult {
             try PinsStore(
                 pinsFile: location.resolvedVersionsFile,
@@ -1218,6 +1208,70 @@ fileprivate extension PinsStore {
     }
 }
 
+// MARK: - PackageContainerProvider
+
+extension Workspace: PackageContainerProvider {
+    public func getContainer(
+            for package: PackageReference,
+            skipUpdate: Bool,
+            on queue: DispatchQueue,
+            completion: @escaping (Result<PackageContainer, Swift.Error>) -> Void
+    ) {
+        // If the container is local, just create and return a local package container.
+        if package.kind != .remote {
+            return queue.async {
+                let container = LocalPackageContainer(
+                    package: package,
+                    identityResolver: self.identityResolver,
+                    manifestLoader: self.manifestLoader,
+                    toolsVersionLoader: self.toolsVersionLoader,
+                    currentToolsVersion: self.currentToolsVersion,
+                    fileSystem: self.fileSystem)
+                completion(.success(container))
+            }
+        }
+
+        // If it's a dependency from a package registry
+        if let registryManager = registryManager,
+           let _ = package.identity.scopeAndName
+        {
+            let container = RegistryPackageContainer(
+                package: package,
+                identityResolver: identityResolver,
+                manager: registryManager,
+                manifestLoader: manifestLoader,
+                toolsVersionLoader: toolsVersionLoader,
+                currentToolsVersion: currentToolsVersion
+            )
+            queue.async {
+                completion(.success(container))
+            }
+        } else {
+            // Resolve the container using the repository manager.
+            repositoryManager.lookup(repository: package.repository, skipUpdate: skipUpdate, on: queue) { result in
+                queue.async {
+                    // Create the container wrapper.
+                    let result = result.tryMap { handle -> PackageContainer in
+                        // Open the repository.
+                        //
+                        // FIXME: Do we care about holding this open for the lifetime of the container.
+                        let repository = try handle.open()
+                        return RepositoryPackageContainer(
+                            package: package,
+                            identityResolver: self.identityResolver,
+                            repository: repository,
+                            manifestLoader: self.manifestLoader,
+                            toolsVersionLoader: self.toolsVersionLoader,
+                            currentToolsVersion: self.currentToolsVersion
+                        )
+                    }
+                    completion(result)
+                }
+            }
+        }
+    }
+}
+
 // MARK: - TSCUtility Functions
 
 extension Workspace {
@@ -2004,7 +2058,7 @@ extension Workspace {
         // We just request the packages here, repository manager will
         // automatically manage the parallelism.
         for pin in pinsStore.pins {
-            containerProvider.getContainer(for: pin.packageRef, skipUpdate: true, on: .sharedConcurrent, completion: { _ in })
+            getContainer(for: pin.packageRef, skipUpdate: true, on: .sharedConcurrent, completion: { _ in })
         }
 
         // Compute the pins that we need to actually clone.
@@ -2431,7 +2485,7 @@ extension Workspace {
                 // Get the latest revision from the container.
                 // TODO: replace with async/await when available
                 guard let container = (try temp_await {
-                    containerProvider.getContainer(for: packageRef, skipUpdate: true, on: .sharedConcurrent, completion: $0)
+                    getContainer(for: packageRef, skipUpdate: true, on: .sharedConcurrent, completion: $0)
                 }) as? RepositoryPackageContainer else {
                     throw InternalError("invalid container for \(packageRef) expected a RepositoryPackageContainer")
                 }
@@ -2502,7 +2556,7 @@ extension Workspace {
         let delegate = !delegates.isEmpty ? MultiplexResolverDelegate(delegates) : nil
 
         return PubgrubDependencyResolver(
-            provider: containerProvider,
+            provider: self,
             pinsMap: pinsMap,
             updateEnabled: self.resolverUpdateEnabled,
             prefetchingEnabled: self.resolverPrefetchingEnabled,
@@ -2744,7 +2798,7 @@ extension Workspace {
             // this?
             // FIXME: this should not block
             guard let container = (try temp_await {
-                containerProvider.getContainer(for: package, skipUpdate: true, on: .sharedConcurrent, completion: $0)
+                getContainer(for: package, skipUpdate: true, on: .sharedConcurrent, completion: $0)
             }) as? RepositoryPackageContainer else {
                 throw InternalError("invalid container for \(package) expected a RepositoryPackageContainer")
             }