refactoring-function-to-throw

Author: roulpriya

Sources/Swiftly/Install.swift

@@ -350,22 +350,28 @@ struct Install: SwiftlyCommand {
 
                         lastUpdate = Date()
 
-                        await 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 {
+                            throw SwiftlyError(
+                                message: "Failed to report progress: \(error.localizedDescription)"
+                            )
+                        }
                     }
                 )
             } catch let notFound as DownloadNotFoundError {
                 throw SwiftlyError(
                     message: "\(version) does not exist at URL \(notFound.url), exiting")
             } catch {
-                await animation.complete(success: false)
+                try? await animation.complete(success: false)
                 throw error
             }
-            await animation.complete(success: true)
+            try await animation.complete(success: true)
 
             if verifySignature {
                 try await Swiftly.currentPlatform.verifyToolchainSignature(

Sources/Swiftly/ProgressReporter.swift

@@ -6,10 +6,10 @@ 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
+    func update(step: Int, total: Int, text: String) async throws
 
     /// Completes the progress animation, indicating success or failure.
-    func complete(success: Bool) async
+    func complete(success: Bool) async throws
 
     /// Closes any resources used by the reporter, if applicable.
     func close() throws
@@ -23,15 +23,15 @@ struct ConsoleProgressReporter: ProgressReporterProtocol {
         self.reporter = PercentProgressAnimation(stream: stream, header: header)
     }
 
-    func update(step: Int, total: Int, text: String) async {
+    func update(step: Int, total: Int, text: String) async throws {
         self.reporter.update(step: step, total: total, text: text)
     }
 
-    func complete(success: Bool) async {
+    func complete(success: Bool) async throws {
         self.reporter.complete(success: success)
     }
 
-    func close() {
+    func close() throws {
         // No resources to close for console reporter
     }
 }
@@ -55,23 +55,19 @@ struct JsonFileProgressReporter: ProgressReporterProtocol {
         self.fileHandle = try FileHandle(forWritingTo: URL(fileURLWithPath: filePath.string))
     }
 
-    private func writeProgress(_ progress: ProgressInfo) async {
-        let jsonData = try? self.encoder.encode(progress)
-        guard let jsonData = jsonData else {
-            await self.ctx.message("Failed to encode progress entry to JSON")
-            return
-        }
+    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()
+        try self.fileHandle.synchronize()
     }
 
-    func update(step: Int, total: Int, text: String) async {
+    func update(step: Int, total: Int, text: String) async throws {
         guard total > 0 && step <= total else {
             return
         }
-        await self.writeProgress(
+        try await self.writeProgress(
             ProgressInfo.step(
                 timestamp: Date(),
                 percent: Int(Double(step) / Double(total) * 100),
@@ -80,8 +76,8 @@ struct JsonFileProgressReporter: ProgressReporterProtocol {
         )
     }
 
-    func complete(success: Bool) async {
-        await self.writeProgress(ProgressInfo.complete(success: success))
+    func complete(success: Bool) async throws {
+        try await self.writeProgress(ProgressInfo.complete(success: success))
     }
 
     func close() throws {

Tests/SwiftlyTests/JsonFileProgressReporterTests.swift

@@ -13,7 +13,7 @@ import Testing
         defer { try? FileManager.default.removeItem(atPath: tempFile.string) }
         let reporter = try JsonFileProgressReporter(SwiftlyTests.ctx, filePath: tempFile)
 
-        await reporter.update(step: 1, total: 10, text: "Processing item 1")
+        try await reporter.update(step: 1, total: 10, text: "Processing item 1")
         try reporter.close()
 
         let decoder = JSONDecoder()
@@ -49,7 +49,7 @@ import Testing
         let reporter = try JsonFileProgressReporter(SwiftlyTests.ctx, filePath: tempFile)
 
         let status = Bool.random()
-        await reporter.complete(success: status)
+        try await reporter.complete(success: status)
         try reporter.close()
 
         let decoder = JSONDecoder()
@@ -78,7 +78,7 @@ import Testing
         defer { try? FileManager.default.removeItem(atPath: tempFile.string) }
         let reporter = try JsonFileProgressReporter(SwiftlyTests.ctx, filePath: tempFile)
 
-        await reporter.update(step: 25, total: 100, text: "Quarter way")
+        try await reporter.update(step: 25, total: 100, text: "Quarter way")
         try reporter.close()
 
         let decoder = JSONDecoder()
@@ -108,12 +108,12 @@ import Testing
 
         let reporter = try JsonFileProgressReporter(SwiftlyTests.ctx, filePath: tempFile)
 
-        await reporter.update(step: 5, total: 100, text: "Processing item 5")
-        await reporter.update(step: 10, total: 100, text: "Processing item 10")
-        await reporter.update(step: 50, total: 100, text: "Processing item 50")
-        await reporter.update(step: 100, total: 100, text: "Processing item 100")
+        try await reporter.update(step: 5, total: 100, text: "Processing item 5")
+        try await reporter.update(step: 10, total: 100, text: "Processing item 10")
+        try await reporter.update(step: 50, total: 100, text: "Processing item 50")
+        try await reporter.update(step: 100, total: 100, text: "Processing item 100")
 
-        await reporter.complete(success: true)
+        try await reporter.complete(success: true)
         try? reporter.close()
 
         let decoder = JSONDecoder()