Add PackageIdentity to Workspace prebuilt delegate methods (#8740)

In order to associate what prebuilt artifact goes with what package, add
the `PackageIdentity` as a parameter to the delegate methods for
prebuilts on `WorkspaceDelegate`.

Author: plemarquand

Sources/Commands/CommandWorkspaceDelegate.swift

@@ -183,7 +183,7 @@ final class CommandWorkspaceDelegate: WorkspaceDelegate {
     }
 
     /// The workspace has started downloading a binary artifact.
-    func willDownloadPrebuilt(from url: String, fromCache: Bool) {
+    func willDownloadPrebuilt(package: PackageIdentity, from url: String, fromCache: Bool) {
         if fromCache {
             self.outputHandler("Fetching package prebuilt \(url) from cache", false)
         } else {
@@ -193,6 +193,7 @@ final class CommandWorkspaceDelegate: WorkspaceDelegate {
 
     /// The workspace has finished downloading a binary artifact.
     func didDownloadPrebuilt(
+        package: PackageIdentity,
         from url: String,
         result: Result<(path: AbsolutePath, fromCache: Bool), Error>,
         duration: DispatchTimeInterval
@@ -209,7 +210,7 @@ final class CommandWorkspaceDelegate: WorkspaceDelegate {
     }
 
     /// The workspace is downloading a binary artifact.
-    func downloadingPrebuilt(from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?) {
+    func downloadingPrebuilt(package: PackageIdentity, from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?) {
 
     }
 

Sources/Workspace/Workspace+Delegation.swift

@@ -139,15 +139,25 @@ public protocol WorkspaceDelegate: AnyObject {
     func didDownloadAllBinaryArtifacts()
 
     /// The workspace has started downloading a binary artifact.
-    func willDownloadPrebuilt(from url: String, fromCache: Bool)
+    func willDownloadPrebuilt(
+        package: PackageIdentity,
+        from url: String,
+        fromCache: Bool
+    )
     /// The workspace has finished downloading a binary artifact.
     func didDownloadPrebuilt(
+        package: PackageIdentity,
         from url: String,
         result: Result<(path: AbsolutePath, fromCache: Bool), Error>,
         duration: DispatchTimeInterval
     )
     /// The workspace is downloading a binary artifact.
-    func downloadingPrebuilt(from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?)
+    func downloadingPrebuilt(
+        package: PackageIdentity,
+        from url: String,
+        bytesDownloaded: Int64,
+        totalBytesToDownload: Int64?
+    )
     /// The workspace finished downloading all binary artifacts.
     func didDownloadAllPrebuilts()
 
@@ -444,20 +454,40 @@ struct WorkspacePrebuiltsManagerDelegate: Workspace.PrebuiltsManager.Delegate {
         self.workspaceDelegate = workspaceDelegate
     }
 
-    func willDownloadPrebuilt(from url: String, fromCache: Bool) {
-        self.workspaceDelegate?.willDownloadPrebuilt(from: url, fromCache: fromCache)
+    func willDownloadPrebuilt(
+        for package: PackageIdentity,
+        from url: String,
+        fromCache: Bool
+    ) {
+        self.workspaceDelegate?.willDownloadPrebuilt(
+            package: package,
+            from: url,
+            fromCache: fromCache
+        )
     }
 
     func didDownloadPrebuilt(
+        for package: PackageIdentity,
         from url: String,
         result: Result<(path: AbsolutePath, fromCache: Bool), Error>,
         duration: DispatchTimeInterval
     ) {
-        self.workspaceDelegate?.didDownloadPrebuilt(from: url, result: result, duration: duration)
+        self.workspaceDelegate?.didDownloadPrebuilt(
+            package: package,
+            from: url,
+            result: result,
+            duration: duration
+        )
     }
 
-    func downloadingPrebuilt(from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?) {
+    func downloadingPrebuilt(
+        for package: PackageIdentity,
+        from url: String,
+        bytesDownloaded: Int64,
+        totalBytesToDownload: Int64?
+    ) {
         self.workspaceDelegate?.downloadingPrebuilt(
+            package: package,
             from: url,
             bytesDownloaded: bytesDownloaded,
             totalBytesToDownload: totalBytesToDownload

Sources/Workspace/Workspace+Prebuilts.swift

@@ -22,15 +22,21 @@ import struct TSCUtility.Version
 /// Delegate to notify clients about actions being performed by BinaryArtifactsDownloadsManage.
 public protocol PrebuiltsManagerDelegate {
     /// The workspace has started downloading a binary artifact.
-    func willDownloadPrebuilt(from url: String, fromCache: Bool)
+    func willDownloadPrebuilt(
+        for package: PackageIdentity,
+        from url: String,
+        fromCache: Bool
+    )
     /// The workspace has finished downloading a binary artifact.
     func didDownloadPrebuilt(
+        for package: PackageIdentity,
         from url: String,
         result: Result<(path: AbsolutePath, fromCache: Bool), Error>,
         duration: DispatchTimeInterval
     )
     /// The workspace is downloading a binary artifact.
     func downloadingPrebuilt(
+        for package: PackageIdentity,
         from url: String,
         bytesDownloaded: Int64,
         totalBytesToDownload: Int64?
@@ -446,8 +452,14 @@ extension Workspace {
                     if artifactURL.scheme == "file" {
                         let artifactPath = try AbsolutePath(validating: artifactURL.path)
                         if fileSystem.exists(artifactPath) {
+                            self.delegate?.willDownloadPrebuilt(
+                                for: package.identity,
+                                from: artifactURL.absoluteString,
+                                fromCache: true
+                            )
                             try fileSystem.copy(from: artifactPath, to: destination)
                             self.delegate?.didDownloadPrebuilt(
+                                for: package.identity,
                                 from: artifactURL.absoluteString,
                                 result: .success((destination, false)),
                                 duration: fetchStart.distance(to: .now())
@@ -473,6 +485,7 @@ extension Workspace {
                         request.options.validResponseCodes = [200]
 
                         self.delegate?.willDownloadPrebuilt(
+                            for: package.identity,
                             from: artifactURL.absoluteString,
                             fromCache: false
                         )
@@ -481,6 +494,7 @@ extension Workspace {
                                 bytesDownloaded,
                                 totalBytesToDownload in
                                 self.delegate?.downloadingPrebuilt(
+                                    for: package.identity,
                                     from: artifactURL.absoluteString,
                                     bytesDownloaded: bytesDownloaded,
                                     totalBytesToDownload: totalBytesToDownload
@@ -492,6 +506,7 @@ extension Workspace {
                                 underlyingError: error
                             )
                             self.delegate?.didDownloadPrebuilt(
+                                for: package.identity,
                                 from: artifactURL.absoluteString,
                                 result: .failure(error),
                                 duration: fetchStart.distance(to: .now())
@@ -505,6 +520,7 @@ extension Workspace {
                                 "Prebuilt artifact \(artifactFile) checksum mismatch"
                             observabilityScope.emit(info: errorString)
                             self.delegate?.didDownloadPrebuilt(
+                                for: package.identity,
                                 from: artifactURL.absoluteString,
                                 result: .failure(StringError(errorString)),
                                 duration: fetchStart.distance(to: .now())
@@ -513,6 +529,7 @@ extension Workspace {
                         }
 
                         self.delegate?.didDownloadPrebuilt(
+                            for: package.identity,
                             from: artifactURL.absoluteString,
                             result: .success((destination, false)),
                             duration: fetchStart.distance(to: .now())
@@ -592,7 +609,7 @@ extension Workspace {
                             artifact: artifact,
                             observabilityScope: observabilityScope
                         )
-                    {   
+                    {
                         // Add to workspace state
                         let managedPrebuilt = ManagedPrebuilt(
                             identity: prebuilt.identity,

Sources/_InternalTestSupport/MockWorkspace.swift

@@ -1206,19 +1206,20 @@ public final class MockWorkspaceDelegate: WorkspaceDelegate {
         // noop
     }
 
-    public func willDownloadPrebuilt(from url: String, fromCache: Bool) {
+    public func willDownloadPrebuilt(package: PackageIdentity, from url: String, fromCache: Bool) {
         self.append("downloading package prebuilt: \(url)")
     }
 
     public func didDownloadPrebuilt(
+        package: PackageIdentity,
         from url: String,
         result: Result<(path: AbsolutePath, fromCache: Bool), Error>,
         duration: DispatchTimeInterval
     ) {
         self.append("finished downloading package prebuilt: \(url)")
     }
 
-    public func downloadingPrebuilt(from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?) {
+    public func downloadingPrebuilt(package: PackageIdentity, from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?) {
         // noop
     }