Add progress reporter protocol (#394)

* Json Progress File

* Improve JSON progress file handling and error reporting

* Refactor progress file parsing and improve test validation

* Progress Reporter Protocol

Author: roulpriya

Sources/Swiftly/Install.swift

@@ -4,7 +4,6 @@ import Foundation
 import SwiftlyCore
 import SystemPackage
 @preconcurrency import TSCBasic
-import TSCUtility
 
 struct Install: SwiftlyCommand {
     public static let configuration = CommandConfiguration(
@@ -313,16 +312,16 @@ struct Install: SwiftlyCommand {
                 }
             }
 
-            let animation: ProgressAnimationProtocol =
+            let animation: ProgressReporterProtocol =
                 if let progressFile
             {
                 try JsonFileProgressReporter(ctx, filePath: progressFile)
             } else {
-                PercentProgressAnimation(stream: stdoutStream, header: "Downloading \(version)")
+                ConsoleProgressReporter(stream: stdoutStream, header: "Downloading \(version)")
             }
 
             defer {
-                try? (animation as? JsonFileProgressReporter)?.close()
+                try? animation.close()
             }
 
             var lastUpdate = Date()
@@ -351,22 +350,28 @@ struct Install: SwiftlyCommand {
 
                         lastUpdate = Date()
 
-                        animation.update(
-                            step: progress.receivedBytes,
-                            total: progress.totalBytes!,
-                            text:
-                            "Downloaded \(String(format: "%.1f", downloadedMiB)) MiB of \(String(format: "%.1f", totalMiB)) MiB"
-                        )
+                        do {
+                            try await animation.update(
+                                step: progress.receivedBytes,
+                                total: progress.totalBytes!,
+                                text:
+                                "Downloaded \(String(format: "%.1f", downloadedMiB)) MiB of \(String(format: "%.1f", totalMiB)) MiB"
+                            )
+                        } catch {
+                            await ctx.message(
+                                "Failed to update progress: \(error.localizedDescription)"
+                            )
+                        }
                     }
                 )
             } catch let notFound as DownloadNotFoundError {
                 throw SwiftlyError(
                     message: "\(version) does not exist at URL \(notFound.url), exiting")
             } catch {
-                animation.complete(success: false)
+                try? await animation.complete(success: false)
                 throw error
             }
-            animation.complete(success: true)
+            try await animation.complete(success: true)
 
             if verifySignature {
                 try await Swiftly.currentPlatform.verifyToolchainSignature(

Sources/Swiftly/JsonFileProgressReporter.swift

@@ -0,0 +1,86 @@
+import Foundation
+import SwiftlyCore
+import SystemPackage
+import TSCBasic
+import TSCUtility
+
+public protocol ProgressReporterProtocol {
+    /// Updates the progress animation with the current step, total steps, and an optional text message.
+    func update(step: Int, total: Int, text: String) async throws
+
+    /// Completes the progress animation, indicating success or failure.
+    func complete(success: Bool) async throws
+
+    /// Closes any resources used by the reporter, if applicable.
+    func close() throws
+}
+
+/// Progress reporter that delegates to a `PercentProgressAnimation` for console output.
+struct ConsoleProgressReporter: ProgressReporterProtocol {
+    private let reporter: PercentProgressAnimation
+
+    init(stream: WritableByteStream, header: String) {
+        self.reporter = PercentProgressAnimation(stream: stream, header: header)
+    }
+
+    func update(step: Int, total: Int, text: String) async throws {
+        self.reporter.update(step: step, total: total, text: text)
+    }
+
+    func complete(success: Bool) async throws {
+        self.reporter.complete(success: success)
+    }
+
+    func close() throws {
+        // No resources to close for console reporter
+    }
+}
+
+enum ProgressInfo: Codable {
+    case step(timestamp: Date, percent: Int, text: String)
+    case complete(success: Bool)
+}
+
+struct JsonFileProgressReporter: ProgressReporterProtocol {
+    let filePath: FilePath
+    private let encoder: JSONEncoder
+    private let ctx: SwiftlyCoreContext
+    private let fileHandle: FileHandle
+
+    init(_ ctx: SwiftlyCoreContext, filePath: FilePath, encoder: JSONEncoder = JSONEncoder()) throws
+    {
+        self.ctx = ctx
+        self.filePath = filePath
+        self.encoder = encoder
+        self.fileHandle = try FileHandle(forWritingTo: URL(fileURLWithPath: filePath.string))
+    }
+
+    private func writeProgress(_ progress: ProgressInfo) async throws {
+        let jsonData = try self.encoder.encode(progress)
+
+        self.fileHandle.write(jsonData)
+        self.fileHandle.write("\n".data(using: .utf8) ?? Data())
+        try self.fileHandle.synchronize()
+    }
+
+    func update(step: Int, total: Int, text: String) async throws {
+        guard total > 0 && step <= total else {
+            return
+        }
+        try await self.writeProgress(
+            ProgressInfo.step(
+                timestamp: Date(),
+                percent: Int(Double(step) / Double(total) * 100),
+                text: text
+            )
+        )
+    }
+
+    func complete(success: Bool) async throws {
+        try await self.writeProgress(ProgressInfo.complete(success: success))
+    }
+
+    func close() throws {
+        try self.fileHandle.close()
+    }
+}