Prepare for connection tests.

Author: maratal

Sources/AblyChat/ChatClient.swift

@@ -74,7 +74,7 @@ public actor DefaultChatClient: ChatClient {
         self.init(realtime: suppliedRealtime, clientOptions: clientOptions, internalRealtimeClientFactory: DefaultInternalRealtimeClientFactory())
     }
 
-    internal init(realtime suppliedRealtime: any SuppliedRealtimeClientProtocol, clientOptions: ChatClientOptions?, internalRealtimeClientFactory: any InternalRealtimeClientFactory) {
+    internal init(realtime suppliedRealtime: any SuppliedRealtimeClientProtocol, clientOptions: ChatClientOptions?, internalRealtimeClientFactory: any InternalRealtimeClientFactory, timerManager: TimerManagerProtocol = TimerManager()) {
         self.realtime = suppliedRealtime
         self.clientOptions = clientOptions ?? .init()
 
@@ -84,7 +84,7 @@ public actor DefaultChatClient: ChatClient {
         logger = DefaultInternalLogger(logHandler: self.clientOptions.logHandler, logLevel: self.clientOptions.logLevel)
         let roomFactory = DefaultRoomFactory()
         rooms = DefaultRooms(realtime: internalRealtime, clientOptions: self.clientOptions, logger: logger, roomFactory: roomFactory)
-        connection = DefaultConnection(realtime: internalRealtime)
+        connection = DefaultConnection(realtime: internalRealtime, timerManager: timerManager)
     }
 
     public nonisolated var clientID: String {

Sources/AblyChat/DefaultConnection.swift

@@ -13,12 +13,13 @@ internal final class DefaultConnection: Connection {
     }
 
     private let realtime: any InternalRealtimeClientProtocol
-    private let timerManager = TimerManager()
+    private let timerManager: TimerManagerProtocol
     private let connectionStatusManager = ConnectionStatusManager()
 
-    internal init(realtime: any InternalRealtimeClientProtocol) {
+    internal init(realtime: any InternalRealtimeClientProtocol, timerManager: TimerManagerProtocol) {
         // (CHA-CS3) The initial status and error of the connection will be whatever status the realtime client returns whilst the connection status object is constructed.
         self.realtime = realtime
+        self.timerManager = timerManager
         Task {
             await connectionStatusManager.updateStatus(to: .init(from: realtime.connection.state))
             await connectionStatusManager.updateError(to: realtime.connection.errorReason)
@@ -87,7 +88,7 @@ internal final class DefaultConnection: Connection {
             }
 
             // (CHA-CS5b) Not withstanding CHA-CS5a. If a connection state event is observed from the underlying realtime library, the client must emit a status change event. The current status of that event shall reflect the status change in the underlying realtime library, along with the accompanying error.
-            subscription.emit(statusChange)
+//            subscription.emit(statusChange) // this call shouldn't be here - "Not withstanding CHA-CS5a" means just that I guess.
             Task {
                 // update local state and error
                 await connectionStatusManager.updateError(to: stateChange.reason)

Sources/AblyChat/TimerManager.swift

@@ -1,6 +1,12 @@
 import Foundation
 
-internal final actor TimerManager {
+internal protocol TimerManagerProtocol: Actor {
+    func setTimer(interval: TimeInterval, handler: @escaping @Sendable () -> Void)
+    func cancelTimer()
+    func hasRunningTask() -> Bool
+}
+
+internal final actor TimerManager: TimerManagerProtocol {
     private var currentTask: Task<Void, Never>?
 
     internal func setTimer(interval: TimeInterval, handler: @escaping @Sendable () -> Void) {

Tests/AblyChatTests/Helpers/Helpers.swift

@@ -98,6 +98,8 @@ func compareAny(_ any1: Any?, with any2: Any?) -> Bool {
     }
     if let any1 = any1 as? Int, let any2 = any2 as? Int {
         return any1 == any2
+    } else if let any1 = any1 as? Double, let any2 = any2 as? Double {
+        return any1 == any2
     } else if let any1 = any1 as? Bool, let any2 = any2 as? Bool {
         return any1 == any2
     } else if let any1 = any1 as? String, let any2 = any2 as? String {
@@ -159,6 +161,16 @@ class MockMethodCallRecorder: @unchecked Sendable {
         mutex.unlock()
         return result
     }
+
+    func waitUntil(hasMatching signature: String, arguments: [String: Any], forMaxTimeout timeout: TimeInterval = 1.0) -> Bool {
+        let startedAt = Date()
+        while !hasRecord(matching: signature, arguments: arguments) {
+            if startedAt.distance(to: Date()) > timeout {
+                return false
+            }
+        }
+        return true
+    }
 }
 
 private extension [MockMethodCallRecorder.MethodArgument] {

Tests/AblyChatTests/Mocks/MockConnection.swift

@@ -1,21 +1,28 @@
 import Ably
 @testable import AblyChat
 
-final class MockConnection: NSObject, InternalConnectionProtocol {
+final class MockConnection: NSObject, InternalConnectionProtocol, @unchecked Sendable {
     let state: ARTRealtimeConnectionState
 
     let errorReason: ARTErrorInfo?
 
+    private var stateCallback: ((ARTConnectionStateChange) -> Void)?
+
     init(state: ARTRealtimeConnectionState = .initialized, errorReason: ARTErrorInfo? = nil) {
         self.state = state
         self.errorReason = errorReason
     }
 
-    func on(_: @escaping (ARTConnectionStateChange) -> Void) -> ARTEventListener {
-        fatalError("Not implemented")
+    func on(_ callback: @escaping (ARTConnectionStateChange) -> Void) -> ARTEventListener {
+        stateCallback = callback
+        return ARTEventListener()
     }
 
     func off(_: ARTEventListener) {
+        stateCallback = nil
+    }
+
+    func off() {
         fatalError("Not implemented")
     }
 }

Tests/AblyChatTests/Mocks/MockSuppliedRealtime.swift

@@ -4,7 +4,7 @@ import Foundation
 
 // This mock isn't used much in the tests, since inside the SDK we mainly use `InternalRealtimeClientProtocol` (whose mock is ``MockRealtime``).
 final class MockSuppliedRealtime: NSObject, SuppliedRealtimeClientProtocol, @unchecked Sendable {
-    let connection = Connection()
+    let connection: Connection
     let channels = Channels()
     let createWrapperSDKProxyReturnValue: MockSuppliedRealtime?
 
@@ -21,8 +21,10 @@ final class MockSuppliedRealtime: NSObject, SuppliedRealtimeClientProtocol, @unc
     }
 
     init(
+        connection: Connection = .init(),
         createWrapperSDKProxyReturnValue: MockSuppliedRealtime? = nil
     ) {
+        self.connection = connection
         self.createWrapperSDKProxyReturnValue = createWrapperSDKProxyReturnValue
     }
 
@@ -336,24 +338,28 @@ final class MockSuppliedRealtime: NSObject, SuppliedRealtimeClientProtocol, @unc
         }
     }
 
-    final class Connection: NSObject, ConnectionProtocol {
-        var id: String? {
-            fatalError("Not implemented")
-        }
+    final class Connection: NSObject, ConnectionProtocol, @unchecked Sendable {
+        let state: ARTRealtimeConnectionState
 
-        var key: String? {
-            fatalError("Not implemented")
+        let errorReason: ARTErrorInfo?
+
+        private let stateCallbackLock = NSLock()
+        private var stateCallback: ((ARTConnectionStateChange) -> Void)?
+
+        init(state: ARTRealtimeConnectionState = .initialized, errorReason: ARTErrorInfo? = nil) {
+            self.state = state
+            self.errorReason = errorReason
         }
 
-        var maxMessageSize: Int {
+        var id: String? {
             fatalError("Not implemented")
         }
 
-        var state: ARTRealtimeConnectionState {
+        var key: String? {
             fatalError("Not implemented")
         }
 
-        var errorReason: ARTErrorInfo? {
+        var maxMessageSize: Int {
             fatalError("Not implemented")
         }
 
@@ -381,8 +387,11 @@ final class MockSuppliedRealtime: NSObject, SuppliedRealtimeClientProtocol, @unc
             fatalError("Not implemented")
         }
 
-        func on(_: @escaping (ARTConnectionStateChange) -> Void) -> ARTEventListener {
-            fatalError("Not implemented")
+        func on(_ callback: @escaping (ARTConnectionStateChange) -> Void) -> ARTEventListener {
+            stateCallbackLock.withLock {
+                stateCallback = callback
+            }
+            return ARTEventListener()
         }
 
         func once(_: ARTRealtimeConnectionEvent, callback _: @escaping (ARTConnectionStateChange) -> Void) -> ARTEventListener {
@@ -404,5 +413,12 @@ final class MockSuppliedRealtime: NSObject, SuppliedRealtimeClientProtocol, @unc
         func off() {
             fatalError("Not implemented")
         }
+        
+        func transitionToState(_ state: ARTRealtimeConnectionState, event: ARTRealtimeConnectionEvent, error: ARTErrorInfo? = nil) {
+            let stateChange = ARTConnectionStateChange(current: state, previous: self.state, event: event, reason: error)
+            stateCallbackLock.withLock {
+                stateCallback?(stateChange)
+            }
+        }
     }
 }

Tests/AblyChatTests/Mocks/MockTimerManager.swift

@@ -0,0 +1,32 @@
+@testable import AblyChat
+import Foundation
+
+internal final actor MockTimerManager: TimerManagerProtocol {
+    let callRecorder = MockMethodCallRecorder()
+
+    private var handler: (@Sendable () -> Void)?
+
+    internal func setTimer(interval: TimeInterval, handler: @escaping @Sendable () -> Void) {
+        callRecorder.addRecord(
+            signature: "setTimer(interval:handler:)",
+            arguments: ["interval": interval]
+        )
+        self.handler = handler
+    }
+
+    internal func cancelTimer() {
+        handler = nil
+        callRecorder.addRecord(
+            signature: "cancelTimer",
+            arguments: [:]
+        )
+    }
+
+    internal func hasRunningTask() -> Bool {
+        handler != nil
+    }
+
+    internal func expireTimer() {
+        handler?()
+    }
+}