Compatibility changes for StreamChat migration

Sources/StreamAttachments/HTTP/RequestDecoder.swift

@@ -111,13 +111,6 @@ extension ClientError {
     }
 }
 
-extension ErrorPayload {
-    /// Returns `true` if the code determines that the token is expired.
-    var isExpiredTokenError: Bool {
-        code == StreamErrorCode.expiredToken
-    }
-}
-
 /// https://getstream.io/chat/docs/ios-swift/api_errors_response/
 enum StreamErrorCode {
     /// Usually returned when trying to perform an API call without a token.

Sources/StreamCore/Concurrency/Atomic.swift

@@ -57,6 +57,14 @@ public final class Atomic<T>: @unchecked Sendable {
         queue.sync { _value = changes(_value) }
     }
 
+    public func mutate(_ changes: (_ value: inout T) -> Void) {
+        mutate { value in
+            var updated = value
+            changes(&updated)
+            return updated
+        }
+    }
+
     /// Update the value safely.
     /// - Parameter changes: a block with changes. It should return a new value.
     public func callAsFunction(_ changes: (_ value: T) -> T) { mutate(changes) }

Sources/StreamCore/Errors/ErrorPayload.swift

@@ -29,13 +29,18 @@ public struct ErrorPayload: LocalizedError, Codable, CustomDebugStringConvertibl
 }
 
 extension ErrorPayload {
+    /// Returns `true` if the code determines that the token is expired.
+    public var isExpiredTokenError: Bool {
+        code == StreamErrorCode.expiredToken
+    }
+
     /// Returns `true` if code is withing invalid token codes range.
-    var isInvalidTokenError: Bool {
-        ClosedRange.tokenInvalidErrorCodes ~= code
+    public var isInvalidTokenError: Bool {
+        ClosedRange.tokenInvalidErrorCodes ~= code || code == StreamErrorCode.accessKeyInvalid
     }
 
     /// Returns `true` if status code is withing client error codes range.
-    var isClientError: Bool {
+    public var isClientError: Bool {
         ClosedRange.clientErrorCodes ~= statusCode
     }
 }

Sources/StreamCore/Errors/Errors.swift

@@ -21,7 +21,7 @@ open class ClientError: Error, ReflectiveStringConvertible, @unchecked Sendable
 
     public let apiError: APIError?
 
-    var errorDescription: String? {
+    public var errorDescription: String? {
         if let apiError {
             apiError.message
         } else {
@@ -138,3 +138,13 @@ struct APIErrorContainer: Codable {
 }
 
 extension APIError: Error {}
+
+/// https://getstream.io/chat/docs/ios-swift/api_errors_response/
+enum StreamErrorCode {
+    /// Usually returned when trying to perform an API call without a token.
+    static let accessKeyInvalid = 2
+    static let expiredToken = 40
+    static let notYetValidToken = 41
+    static let invalidTokenDate = 42
+    static let invalidTokenSignature = 43
+}

Sources/StreamCore/Utils/Data+Gzip.swift

@@ -35,7 +35,7 @@ extension Data {
     ///
     /// - Returns: Gzip-compressed `Data` instance.
     /// - Throws: `GzipError`
-    public func gzipped() throws -> Data {
+    func gzipped() throws -> Data {
         guard !isEmpty else {
             return Data()
         }

Sources/StreamCore/Utils/InternetConnection.swift

@@ -26,7 +26,7 @@ extension Notification {
 ///
 /// Basically, it's a wrapper over legacy monitor based on `Reachability` (iOS 11 only)
 /// and default monitor based on `Network`.`NWPathMonitor` (iOS 12+).
-public final class InternetConnection: @unchecked Sendable {
+open class InternetConnection: @unchecked Sendable {
     /// The current Internet connection status.
     @Published private(set) var status: InternetConnectionStatus {
         didSet {

Sources/StreamCore/Utils/Timers.swift

@@ -5,7 +5,7 @@
 import Combine
 import Foundation
 
-public protocol StreamTimer {
+public protocol TimerScheduling {
     /// Schedules a new timer.
     ///
     /// - Parameters:
@@ -33,7 +33,7 @@ public protocol StreamTimer {
     static func currentTime() -> Date
 }
 
-extension StreamTimer {
+extension TimerScheduling {
     public static func currentTime() -> Date {
         Date()
     }
@@ -58,7 +58,7 @@ extension DispatchWorkItem: TimerControl {}
 extension DispatchWorkItem: @retroactive @unchecked Sendable {}
 
 /// Default real-world implementations of timers.
-public struct DefaultTimer: StreamTimer {
+public struct DefaultTimer: TimerScheduling {
     @discardableResult
     public static func schedule(
         timeInterval: TimeInterval,

Sources/StreamCore/WebSocket/Client/BackgroundTaskScheduler.swift

@@ -43,6 +43,7 @@ public class IOSBackgroundTaskScheduler: BackgroundTaskScheduler, @unchecked Sen
 
     @MainActor
     public func beginTask(expirationHandler: (@Sendable () -> Void)?) -> Bool {
+        endTask()
         activeBackgroundTask = app?.beginBackgroundTask { [weak self] in
             self?._endTask()
             expirationHandler?()

Sources/StreamCore/WebSocket/Client/ConnectionRecoveryHandler.swift

@@ -6,7 +6,10 @@ import CoreData
 import Foundation
 
 /// The type that keeps track of active chat components and asks them to reconnect when it's needed
-public protocol ConnectionRecoveryHandler: ConnectionStateDelegate, Sendable {}
+public protocol ConnectionRecoveryHandler: ConnectionStateDelegate, Sendable {
+    func start()
+    func stop()
+}
 
 /// The type is designed to obtain missing events that happened in watched channels while user
 /// was not connected to the web-socket.
@@ -24,7 +27,7 @@ public final class DefaultConnectionRecoveryHandler: ConnectionRecoveryHandler,
     private let eventNotificationCenter: EventNotificationCenter
     private let backgroundTaskScheduler: BackgroundTaskScheduler?
     private let internetConnection: InternetConnection
-    private let reconnectionTimerType: StreamTimer.Type
+    private let reconnectionTimerType: TimerScheduling.Type
     private let keepConnectionAliveInBackground: Bool
     private nonisolated(unsafe) var reconnectionStrategy: RetryStrategy
     private nonisolated(unsafe) var reconnectionTimer: TimerControl?
@@ -38,7 +41,7 @@ public final class DefaultConnectionRecoveryHandler: ConnectionRecoveryHandler,
         backgroundTaskScheduler: BackgroundTaskScheduler?,
         internetConnection: InternetConnection,
         reconnectionStrategy: RetryStrategy,
-        reconnectionTimerType: StreamTimer.Type,
+        reconnectionTimerType: TimerScheduling.Type,
         keepConnectionAliveInBackground: Bool
     ) {
         self.init(
@@ -51,7 +54,6 @@ public final class DefaultConnectionRecoveryHandler: ConnectionRecoveryHandler,
             keepConnectionAliveInBackground: keepConnectionAliveInBackground,
             reconnectionPolicies: [
                 WebSocketAutomaticReconnectionPolicy(webSocketClient),
-                InternetAvailabilityReconnectionPolicy(internetConnection),
                 BackgroundStateReconnectionPolicy(backgroundTaskScheduler)
             ]
         )
@@ -63,7 +65,7 @@ public final class DefaultConnectionRecoveryHandler: ConnectionRecoveryHandler,
         backgroundTaskScheduler: BackgroundTaskScheduler?,
         internetConnection: InternetConnection,
         reconnectionStrategy: RetryStrategy,
-        reconnectionTimerType: StreamTimer.Type,
+        reconnectionTimerType: TimerScheduling.Type,
         keepConnectionAliveInBackground: Bool,
         reconnectionPolicies: [AutomaticReconnectionPolicy]
     ) {
@@ -75,14 +77,22 @@ public final class DefaultConnectionRecoveryHandler: ConnectionRecoveryHandler,
         self.reconnectionTimerType = reconnectionTimerType
         self.keepConnectionAliveInBackground = keepConnectionAliveInBackground
         self.reconnectionPolicies = reconnectionPolicies
-
-        subscribeOnNotifications()
+        
+        start()
     }
 
-    deinit {
+    public func start() {
+        subscribeOnNotifications()
+    }
+
+    public func stop() {
         unsubscribeFromNotifications()
         cancelReconnectionTimer()
     }
+
+    deinit {
+        stop()
+    }
 }
 
 // MARK: - Subscriptions
@@ -94,21 +104,19 @@ private extension DefaultConnectionRecoveryHandler {
                 onEnteringBackground: { [weak self] in self?.appDidEnterBackground() },
                 onEnteringForeground: { [weak self] in self?.appDidBecomeActive() }
             )
-
-            internetConnection.notificationCenter.addObserver(
-                self,
-                selector: #selector(internetConnectionAvailabilityDidChange(_:)),
-                name: .internetConnectionAvailabilityDidChange,
-                object: nil
-            )
         }
+        internetConnection.notificationCenter.addObserver(
+            self,
+            selector: #selector(internetConnectionAvailabilityDidChange(_:)),
+            name: .internetConnectionAvailabilityDidChange,
+            object: nil
+        )
     }
 
     func unsubscribeFromNotifications() {
         Task { @MainActor [backgroundTaskScheduler] in
             backgroundTaskScheduler?.stopListeningForAppStateUpdates()
         }
-
         internetConnection.notificationCenter.removeObserver(
             self,
             name: .internetConnectionStatusDidChange,

Sources/StreamCore/WebSocket/Client/ConnectionStatus.swift

@@ -42,23 +42,24 @@ public extension ConnectionStatus {
             self = .disconnecting
 
         case let .disconnected(source):
-            let isWaitingForReconnect = webSocketConnectionState.isAutomaticReconnectionEnabled || source.serverError?
-                .isInvalidTokenError == true
-
+            let isWaitingForReconnect = webSocketConnectionState.isAutomaticReconnectionEnabled
             self = isWaitingForReconnect ? .connecting : .disconnected(error: source.serverError)
         }
     }
 }
 
-typealias ConnectionId = String
+public typealias ConnectionId = String
 
 /// A web socket connection state.
-public enum WebSocketConnectionState: Equatable {
+public enum WebSocketConnectionState: Equatable, Sendable {
     /// Provides additional information about the source of disconnecting.
-    public enum DisconnectionSource: Equatable {
+    public indirect enum DisconnectionSource: Equatable, Sendable {
         /// A user initiated web socket disconnecting.
         case userInitiated
 
+        /// The connection timed out while trying to connect.
+        case timeout(from: WebSocketConnectionState)
+
         /// A server initiated web socket disconnecting, an optional error object is provided.
         case serverInitiated(error: ClientError? = nil)
 
@@ -95,7 +96,7 @@ public enum WebSocketConnectionState: Equatable {
     case disconnecting(source: DisconnectionSource)
 
     /// Checks if the connection state is connected.
-    var isConnected: Bool {
+    public var isConnected: Bool {
         if case .connected = self {
             return true
         }
@@ -141,6 +142,8 @@ public enum WebSocketConnectionState: Equatable {
             return true
         case .userInitiated:
             return false
+        case .timeout:
+            return false
         }
     }
 }