ObservableWebSocketClientError -> CodableError

Author: backslash-f

Sources/ObservableWebSocketClient/Extensions/ObservableWebSocketClient+Codable.swift

@@ -6,6 +6,7 @@
 //
 
 import Foundation
+import Toolbox
 
 /// Required for encoding/decoding an observable object class. Refer to:
 /// https://www.hackingwithswift.com/books/ios-swiftui/encoding-an-observableobject-class
@@ -14,7 +15,7 @@ extension ObservableWebSocketClient {
         case id
         case websocketURL
         case message
-        case error
+        case codableError
     }
 
     // MARK: - Encode
@@ -24,7 +25,7 @@ extension ObservableWebSocketClient {
         try container.encode(id, forKey: .id)
         try container.encode(websocketURL, forKey: .websocketURL)
         try container.encodeIfPresent(codableMessage, forKey: .message)
-        try container.encodeIfPresent(error, forKey: .error)
+        try container.encodeIfPresent(codableError, forKey: .codableError)
     }
 
     // MARK: - Decode
@@ -34,7 +35,7 @@ extension ObservableWebSocketClient {
         let id = try container.decode(UUID.self, forKey: .id)
         let websocketURL = try container.decode(URL.self, forKey: .websocketURL)
         let message = try container.decodeIfPresent(CodableWebSocketMessage.self, forKey: .message)
-        let error = try container.decodeIfPresent(ObservableWebSocketClientError.self, forKey: .error)
-        self.init(id: id, websocketURL: websocketURL, message: message, error: error)
+        let codableError = try container.decodeIfPresent(CodableError.self, forKey: .codableError)
+        self.init(id: id, websocketURL: websocketURL, message: message, codableError: codableError)
     }
 }

Sources/ObservableWebSocketClient/Extensions/ObservableWebSocketClient+Equatable.swift

@@ -14,6 +14,6 @@ extension ObservableWebSocketClient {
         lhs.websocketURL == rhs.websocketURL &&
         lhs.isConnected == rhs.isConnected &&
         lhs.codableMessage == rhs.codableMessage &&
-        lhs.error == rhs.error
+        lhs.codableError == rhs.codableError
     }
 }

Sources/ObservableWebSocketClient/Extensions/ObservableWebSocketClient+Observation.swift

@@ -23,10 +23,11 @@ extension ObservableWebSocketClient {
 
         // MARK: Errors
 
-        service.$error.sink { [weak self] error in
-            if let error {
+        service.$codableError.sink { [weak self] codableError in
+            if let codableError {
+                self?.pingTimer?.invalidate()
                 self?.isConnected = false
-                self?.error = error
+                self?.codableError = codableError
             }
         }
         .store(in: &cancellables)

Sources/ObservableWebSocketClient/Interface/ObservableWebSocketClient.swift

@@ -7,6 +7,7 @@
 
 import Combine
 import Foundation
+import Toolbox
 
 /// Establishes a WebSocket connection using the given `websocketURL`.
 /// Publishes received messages and errors.
@@ -16,7 +17,7 @@ public final class ObservableWebSocketClient: Identifiable, Equatable, Codable,
     @Published public var codableMessage: CodableWebSocketMessage?
 
     /// Publishes any error that may occur.
-    @Published public var error: ObservableWebSocketClientError?
+    @Published public var codableError: CodableError?
 
     /// Publishes whether the WebSocket is still valid/alive.
     @Published public var isConnected: Bool = false
@@ -46,7 +47,7 @@ public final class ObservableWebSocketClient: Identifiable, Equatable, Codable,
     ///      wss://endpoint.com
     ///      ```
     ///   - message: Optional `CodableWebSocketMessage`. Useful for mocking the instance's state.
-    ///   - error: Optional `ObservableWebSocketClientError`. Useful for mocking the instance's state.
+    ///   - error: Optional `CodableError`. Useful for mocking the instance's state.
     ///   - pingTimerInterval: The value passed in (`TimeInterval`) will cause a timer to
     ///   continuously send ping-type messages to the WS server, keeping the connection alive.
     ///   - pingMessage: The ping-type `String` message.
@@ -74,14 +75,14 @@ public final class ObservableWebSocketClient: Identifiable, Equatable, Codable,
     public init(id: UUID = .init(),
                 websocketURL: URL,
                 message: CodableWebSocketMessage? = nil,
-                error: ObservableWebSocketClientError? = nil,
+                codableError: CodableError? = nil,
                 pingTimerInterval: TimeInterval? = nil,
                 pingMessage: String? = nil,
                 pingMessageWithGeneratedId: ((String) -> String)? = nil) {
         self.id = id
         self.websocketURL = websocketURL
         self.codableMessage = message
-        self.error = error
+        self.codableError = codableError
         self.pingTimerInterval = pingTimerInterval
         self.pingMessage = pingMessage
         self.pingMessageWithGeneratedId = pingMessageWithGeneratedId

Sources/ObservableWebSocketClient/Network/ObservableWebSocketService.swift

@@ -6,12 +6,13 @@
 //
 
 import Foundation
+import Toolbox
 
 public final class ObservableWebSocketService: ObservableObject {
 
     @Published public var message: URLSessionWebSocketTask.Message?
 
-    @Published public var error: ObservableWebSocketClientError?
+    @Published public var codableError: CodableError?
 
     public var session = URLSession(configuration: .default)
 
@@ -37,8 +38,7 @@ public extension ObservableWebSocketService {
         webSocketTask?.send(wsMessage) { error in
             if let error {
                 Task { @MainActor in
-                    let codableError = CodableError(error)
-                    self.error = .sendingMessage(codableError)
+                    self.codableError = .init(error)
                 }
             }
         }
@@ -68,8 +68,7 @@ private extension ObservableWebSocketService {
                 self.receiveMessage()
 
             case .failure(let error):
-                let codableError = CodableError(error)
-                self.error = .receivingMessage(codableError)
+                self.codableError = .init(error)
             }
         }
     }