refactor error handling

Author: swiftuiux

Sources/openai-async-image-swiftui/enum/AsyncImageErrors.swift

@@ -1,26 +1,21 @@
 //
 //  AsyncImageErrors.swift
-//  
+//
 //
 //  Created by Igor on 18.02.2023.
 //
 
 import Foundation
+import async_http_client
 
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-enum AsyncImageErrors: Error, Equatable {
-    
-    /// Error indicating that an image could not be created from a `uiImage`
-    case imageInit
-    
-    /// Error indicating that the client was not found, likely due to an invalid URL
-    case clientIsNotDefined
-    
-    /// Error indicating that the response returned no images
-    case returnedNoImages
-    
-    /// Status is not valid
-    case httpStatus(String)
+/// Enum representing different errors that can occur when loading images asynchronously
+enum AsyncImageErrors: Error {
+    case imageInit               // Error initializing an image from data
+    case clientIsNotDefined      // HTTP client is not defined
+    case returnedNoImages        // No images were returned in the response
+    case httpStatus(String)      // HTTP status error with a message
+    case responseError(Error)    // Generic response error
 }
 
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
@@ -33,8 +28,50 @@ extension AsyncImageErrors: LocalizedError {
             return NSLocalizedString("Client not found. The URL might be invalid.", comment: "")
         case .returnedNoImages:
             return NSLocalizedString("The response did not contain any images.", comment: "")
-        case .httpStatus(let data):
-            return NSLocalizedString("HTTP status error: \(data).", comment: "")
+        case .httpStatus(let status):
+            return NSLocalizedString("HTTP status error: \(status).", comment: "")
+        case .responseError(let error):
+            return error.localizedDescription
+        }
+    }
+}
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
+extension AsyncImageErrors {
+    /// Handles errors that occur during the request
+    /// - Parameter error: The error that occurred
+    /// - Returns: An instance of `AsyncImageErrors`
+    static func handleRequest(_ error: Error) -> AsyncImageErrors {
+        if let httpError = error as? Http.Errors,
+           case let .status(_, _, data) = httpError,
+           let responseData = data {
+            return decodeErrorResponse(from: responseData)
         }
+        return .responseError(error)
     }
 }
+
+/// Decodes the error response data
+/// - Parameter responseData: The response data to decode
+/// - Returns: An instance of `AsyncImageErrors` with a decoded message
+fileprivate func decodeErrorResponse(from responseData: Data) -> AsyncImageErrors {
+    if let apiResponse = try? JSONDecoder().decode(ErrorResponseWrapper.self, from: responseData) {
+        return .httpStatus(apiResponse.error.message)
+    }
+    
+    let dataString = String(data: responseData, encoding: .utf8) ?? "Unable to decode data"
+    return .httpStatus(dataString)
+}
+
+/// Defines the structure for the inner "error" object in the API response
+fileprivate struct ErrorResponse: Decodable {
+    let code: String?
+    let message: String
+    let param: String?
+    let type: String
+}
+
+/// Defines the structure for the overall response wrapper containing the error object
+fileprivate struct ErrorResponseWrapper: Decodable {
+    let error: ErrorResponse
+}

Sources/openai-async-image-swiftui/viewModel/OpenAIDefaultLoader.swift

@@ -58,7 +58,7 @@ public final class OpenAIDefaultLoader: IOpenAILoader {
             return try imageBase64(from: result.value)
 
         } catch {
-           try handleRequestError(error)
+            throw AsyncImageErrors.handleRequest(error)
         }
     }
 
@@ -74,16 +74,6 @@ public final class OpenAIDefaultLoader: IOpenAILoader {
         return (path, body, headers)
     }
 
-    /// Handles errors that occur during the request
-    /// - Parameter error: The error that occurred
-    private func handleRequestError(_ error: Error) throws -> Never {
-        if case let Http.Errors.status(_, _, data) = error, let responseData = data {
-            let data = String(data: responseData, encoding: .utf8) ?? "Unable to decode data"
-            throw AsyncImageErrors.httpStatus(data)
-        }
-        
-        throw error
-    }
 
     /// Decodes base64 encoded string to Data
     /// - Parameter output: The output received from the endpoint