refactor binary depedencies handling outside workspace class (#4197)

motivation: code handling binary dependencies has become complex and large, factor it out to its own class

changes:
* factor out the code that deals with downloading and extracting binary dependencies out of Workspace and into a dedicated struct
* adjust workspace initializers to allow customizing the BinaryArtifactsManager instead of the HTTPClient and Archiver that are in service of handling binary dependencies (used for testing only)
* adjjust call sites and test

Author: tomerd

Sources/Commands/SwiftPackageTool.swift

@@ -860,8 +860,16 @@ extension SwiftPackageTool {
         var path: AbsolutePath
 
         func run(_ swiftTool: SwiftTool) throws {
-            let workspace = try swiftTool.getActiveWorkspace()
-            let checksum = try workspace.checksum(forBinaryArtifactAt: path)
+            let binaryArtifactsManager = try Workspace.BinaryArtifactsManager(
+                fileSystem: swiftTool.fileSystem,
+                authorizationProvider: swiftTool.getAuthorizationProvider(),
+                hostToolchain: swiftTool.getHostToolchain(),
+                checksumAlgorithm: SHA256(),
+                customHTTPClient: .none,
+                customArchiver: .none,
+                delegate: .none
+            )
+            let checksum = try binaryArtifactsManager.checksum(forBinaryArtifactAt: path)
             print(checksum)
         }
     }

Sources/PackageLoading/ManifestLoader.swift

@@ -78,7 +78,7 @@ public protocol ManifestLoaderProtocol {
 }
 
 public extension ManifestLoaderProtocol {
-    var supportedArchiveExtensions: [String] { ["zip"] }
+    static var supportedArchiveExtensions: [String] { ["zip"] }
 }
 
 public protocol ManifestLoaderDelegate {
@@ -437,7 +437,7 @@ public final class ManifestLoader: ManifestLoaderProtocol {
                     continue
                 }
 
-                let validExtensions = self.supportedArchiveExtensions + BinaryTarget.Kind.allCases.filter{ $0 != .unknown }.map { $0.fileExtension }
+                let validExtensions = Self.supportedArchiveExtensions + BinaryTarget.Kind.allCases.filter{ $0 != .unknown }.map { $0.fileExtension }
                 guard let fileExtension = relativePath.extension, validExtensions.contains(fileExtension) else {
                     observabilityScope.emit(.unsupportedBinaryLocationExtension(
                         targetName: target.name,
@@ -470,10 +470,10 @@ public final class ManifestLoader: ManifestLoaderProtocol {
                     continue
                 }
 
-                guard self.supportedArchiveExtensions.contains(url.pathExtension) else {
+                guard Self.supportedArchiveExtensions.contains(url.pathExtension) else {
                     observabilityScope.emit(.unsupportedBinaryLocationExtension(
                         targetName: target.name,
-                        validExtensions: self.supportedArchiveExtensions
+                        validExtensions: Self.supportedArchiveExtensions
                     ))
                     continue
                 }

Sources/SPMTestSupport/MockWorkspace.swift

@@ -28,10 +28,9 @@ public final class MockWorkspace {
     let toolsVersion: ToolsVersion
     let fingerprints: MockPackageFingerprintStorage
     let mirrors: DependencyMirrors
-    public var  httpClient: HTTPClient
     public var registryClient: RegistryClient
     let registry: MockRegistry
-    public var archiver: MockArchiver
+    let customBinaryArtifactsManager: Workspace.CustomBinaryArtifactsManager
     public var checksumAlgorithm: MockHashAlgorithm
     public private(set) var manifestLoader: MockManifestLoader
     public let repositoryProvider: InMemoryGitRepositoryProvider
@@ -49,9 +48,8 @@ public final class MockWorkspace {
         toolsVersion: ToolsVersion = ToolsVersion.currentToolsVersion,
         fingerprints customFingerprints: MockPackageFingerprintStorage? = .none,
         mirrors customMirrors: DependencyMirrors? = nil,
-        httpClient customHttpClient: HTTPClient? = .none,
         registryClient customRegistryClient: RegistryClient? = .none,
-        binaryArchiver customBinaryArchiver: MockArchiver? = .none,
+        binaryArtifactsManager customBinaryArtifactsManager: Workspace.CustomBinaryArtifactsManager? = .none,
         checksumAlgorithm customChecksumAlgorithm: MockHashAlgorithm? = .none,
         customPackageContainerProvider: MockPackageContainerProvider? = .none,
         skipDependenciesUpdates: Bool = false,
@@ -66,8 +64,8 @@ public final class MockWorkspace {
         self.identityResolver = DefaultIdentityResolver(locationMapper: self.mirrors.effectiveURL(for:))
         self.manifestLoader = MockManifestLoader(manifests: [:])
         self.customPackageContainerProvider = customPackageContainerProvider
-        self.checksumAlgorithm = customChecksumAlgorithm ?? MockHashAlgorithm()
         self.repositoryProvider = InMemoryGitRepositoryProvider()
+        self.checksumAlgorithm = customChecksumAlgorithm ?? MockHashAlgorithm()
         self.registry = MockRegistry(
             filesystem: self.fileSystem,
             identityResolver: self.identityResolver,
@@ -78,8 +76,10 @@ public final class MockWorkspace {
         self.toolsVersion = toolsVersion
         self.skipDependenciesUpdates = skipDependenciesUpdates
         self.sourceControlToRegistryDependencyTransformation = sourceControlToRegistryDependencyTransformation
-        self.httpClient = customHttpClient ?? HTTPClient.mock(fileSystem: fileSystem)
-        self.archiver = customBinaryArchiver ?? MockArchiver()
+        self.customBinaryArtifactsManager = customBinaryArtifactsManager ?? .init(
+            httpClient: HTTPClient.mock(fileSystem: fileSystem),
+            archiver: MockArchiver()
+        )
         try self.create()
     }
 
@@ -268,9 +268,8 @@ public final class MockWorkspace {
             customPackageContainerProvider: self.customPackageContainerProvider,
             customRepositoryProvider: self.repositoryProvider,
             customRegistryClient: self.registryClient,
+            customBinaryArtifactsManager: self.customBinaryArtifactsManager,
             customIdentityResolver: self.identityResolver,
-            customHTTPClient: self.httpClient,
-            customArchiver: self.archiver,
             customChecksumAlgorithm: self.checksumAlgorithm,
             delegate: self.delegate
         )

Sources/Workspace/CMakeLists.txt

@@ -22,8 +22,9 @@ add_library(Workspace
   ToolsVersionSpecificationRewriter.swift
   UserToolchain.swift
   Workspace.swift
-  WorkspaceConfiguration.swift
-  WorkspaceState.swift
+  Workspace+BinaryArtifacts.swift
+  Workspace+Configuration.swift
+  Workspace+State.swift
   WindowsToolchainInfo.swift)
 target_link_libraries(Workspace PUBLIC
   TSCBasic