[ECO-5118] Added tests for occupancy, presence and typing

Sources/AblyChat/Dependencies.swift

@@ -25,6 +25,8 @@ public protocol RealtimeChannelsProtocol: ARTRealtimeChannelsProtocol, Sendable
 /// Expresses the requirements of the object returned by ``RealtimeChannelsProtocol/get(_:options:)``.
 public protocol RealtimeChannelProtocol: ARTRealtimeChannelProtocol, Sendable {}
 
+public protocol RealtimePresenceProtocol: ARTRealtimePresenceProtocol, Sendable {}
+
 public protocol ConnectionProtocol: ARTConnectionProtocol, Sendable {}
 
 /// Like (a subset of) `ARTRealtimeChannelOptions` but with value semantics. (It’s unfortunate that `ARTRealtimeChannelOptions` doesn’t have a `-copy` method.)

Tests/AblyChatTests/DefaultRoomOccupancyTests.swift

@@ -0,0 +1,101 @@
+import Ably
+@testable import AblyChat
+import Testing
+
+struct DefaultRoomOccupancyTests {
+    // @spec CHA-O1
+    @Test
+    func channelNameIsSetAsChatMessagesChannelName() async throws {
+        // Given
+        let realtime = MockRealtime.create()
+        let chatAPI = ChatAPI(realtime: realtime)
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$chatMessages")
+        let featureChannel = MockFeatureChannel(channel: channel)
+
+        // When
+        let defaultOccupancy = DefaultOccupancy(featureChannel: featureChannel, chatAPI: chatAPI, roomID: "basketball", logger: TestLogger())
+
+        // Then
+        #expect(defaultOccupancy.channel.name == "basketball::$chat::$chatMessages")
+    }
+
+    // @spec CHA-O2
+    // @spec CHA-O3
+    @Test
+    func requestOccupancyCheck() async throws {
+        // Given
+        let realtime = MockRealtime.create {
+            (MockHTTPPaginatedResponse(
+                items: [
+                    [
+                        "connections": 5,
+                        "presenceMembers": 2,
+                    ],
+                ]
+            ), nil)
+        }
+        let chatAPI = ChatAPI(realtime: realtime)
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$chatMessages")
+        let featureChannel = MockFeatureChannel(channel: channel)
+        let defaultOccupancy = DefaultOccupancy(featureChannel: featureChannel, chatAPI: chatAPI, roomID: "basketball", logger: TestLogger())
+
+        // When
+        let occupancyInfo = try await defaultOccupancy.get()
+
+        // Then
+        #expect(occupancyInfo.connections == 5)
+        #expect(occupancyInfo.presenceMembers == 2)
+    }
+
+    // @spec CHA-O4
+    @Test
+    func usersCanSubscribeToRealtimeOccupancyUpdates() async throws {
+        // Given
+        let realtime = MockRealtime.create()
+        let chatAPI = ChatAPI(realtime: realtime)
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$chatMessages")
+        let featureChannel = MockFeatureChannel(channel: channel)
+        let defaultOccupancy = DefaultOccupancy(featureChannel: featureChannel, chatAPI: chatAPI, roomID: "basketball", logger: TestLogger())
+
+        // CHA-O4a, CHA-O4c
+
+        // When
+        let subscription = await defaultOccupancy.subscribe()
+        subscription.emit(OccupancyEvent(connections: 5, presenceMembers: 2))
+
+        // Then
+        let occupancyInfo = try #require(await subscription.first { _ in true })
+        #expect(occupancyInfo.connections == 5)
+        #expect(occupancyInfo.presenceMembers == 2)
+
+        // CHA-O4b
+
+        // When
+        subscription.unsubscribe()
+        subscription.emit(OccupancyEvent(connections: 5, presenceMembers: 2))
+
+        // Then
+        let nilOccupancyInfo = await subscription.first { _ in true }
+        #expect(nilOccupancyInfo == nil)
+    }
+
+    // @spec CHA-O5
+    @Test
+    func onDiscontinuity() async throws {
+        // Given
+        let realtime = MockRealtime.create()
+        let chatAPI = ChatAPI(realtime: realtime)
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$chatMessages")
+        let featureChannel = MockFeatureChannel(channel: channel)
+        let defaultOccupancy = DefaultOccupancy(featureChannel: featureChannel, chatAPI: chatAPI, roomID: "basketball", logger: TestLogger())
+
+        // When: The feature channel emits a discontinuity through `onDiscontinuity`
+        let featureChannelDiscontinuity = DiscontinuityEvent(error: ARTErrorInfo.createUnknownError()) // arbitrary error
+        let discontinuitySubscription = await defaultOccupancy.onDiscontinuity()
+        await featureChannel.emitDiscontinuity(featureChannelDiscontinuity)
+
+        // Then: The DefaultOccupancy instance emits this discontinuity through `onDiscontinuity`
+        let discontinuity = try #require(await discontinuitySubscription.first { _ in true })
+        #expect(discontinuity == featureChannelDiscontinuity)
+    }
+}

Tests/AblyChatTests/DefaultRoomTypingTests.swift

@@ -0,0 +1,101 @@
+import Ably
+@testable import AblyChat
+import Testing
+
+struct DefaultRoomTypingTests {
+    // @spec CHA-T1
+    @Test
+    func channelNameIsSetAsTypingIndicatorsChannelName() async throws {
+        // Given
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$typingIndicators")
+        let featureChannel = MockFeatureChannel(channel: channel)
+
+        // When
+        let defaultTyping = DefaultTyping(featureChannel: featureChannel, roomID: "basketball", clientID: "mockClientId", logger: TestLogger(), timeout: 5)
+
+        // Then
+        #expect(defaultTyping.channel.name == "basketball::$chat::$typingIndicators")
+    }
+
+    // @spec CHA-T2
+    @Test
+    func retrieveCurrentlyTypingClientIDs() async throws {
+        // Given
+        let typingPresence = MockRealtimePresence(["client1", "client2"].map { .init(clientId: $0) })
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$typingIndicators", mockPresence: typingPresence)
+        let featureChannel = MockFeatureChannel(channel: channel, resultOfWaitToBeAblePerformPresenceOperations: .success(()))
+        let defaultTyping = DefaultTyping(featureChannel: featureChannel, roomID: "basketball", clientID: "mockClientId", logger: TestLogger(), timeout: 5)
+
+        // When
+        let typingInfo = try await defaultTyping.get()
+
+        // Then
+        #expect(typingInfo.sorted() == ["client1", "client2"])
+    }
+
+    // @spec CHA-T4
+    // @spec CHA-T5
+    @Test
+    func usersMayIndicateThatTheyHaveStartedOrStoppedTyping() async throws {
+        // Given
+        let typingPresence = MockRealtimePresence([])
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$typingIndicators", mockPresence: typingPresence)
+        let featureChannel = MockFeatureChannel(channel: channel, resultOfWaitToBeAblePerformPresenceOperations: .success(()))
+        let defaultTyping = DefaultTyping(featureChannel: featureChannel, roomID: "basketball", clientID: "client1", logger: TestLogger(), timeout: 5)
+
+        // CHA-T4
+
+        // When
+        try await defaultTyping.start()
+
+        // Then
+        var typingInfo = try await defaultTyping.get()
+        #expect(typingInfo == ["client1"])
+
+        // CHA-T5
+
+        // When
+        try await defaultTyping.stop()
+
+        // Then
+        typingInfo = try await defaultTyping.get()
+        #expect(typingInfo.isEmpty)
+    }
+
+    // @spec CHA-T6
+    @Test
+    func usersMaySubscribeToTypingEvents() async throws {
+        // Given
+        let typingPresence = MockRealtimePresence([])
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$typingIndicators", mockPresence: typingPresence)
+        let featureChannel = MockFeatureChannel(channel: channel, resultOfWaitToBeAblePerformPresenceOperations: .success(()))
+        let defaultTyping = DefaultTyping(featureChannel: featureChannel, roomID: "basketball", clientID: "client1", logger: TestLogger(), timeout: 5)
+
+        // When
+        let subscription = await defaultTyping.subscribe()
+        subscription.emit(TypingEvent(currentlyTyping: ["client1"]))
+
+        // Then
+        let typingEvent = try #require(await subscription.first { _ in true })
+        #expect(typingEvent.currentlyTyping == ["client1"])
+    }
+
+    // @spec CHA-T7
+    @Test
+    func onDiscontinuity() async throws {
+        // Given
+        let typingPresence = MockRealtimePresence([])
+        let channel = MockRealtimeChannel(name: "basketball::$chat::$typingIndicators", mockPresence: typingPresence)
+        let featureChannel = MockFeatureChannel(channel: channel, resultOfWaitToBeAblePerformPresenceOperations: .success(()))
+        let defaultTyping = DefaultTyping(featureChannel: featureChannel, roomID: "basketball", clientID: "client1", logger: TestLogger(), timeout: 5)
+
+        // When: The feature channel emits a discontinuity through `onDiscontinuity`
+        let featureChannelDiscontinuity = DiscontinuityEvent(error: ARTErrorInfo.createUnknownError()) // arbitrary error
+        let discontinuitySubscription = await defaultTyping.onDiscontinuity()
+        await featureChannel.emitDiscontinuity(featureChannelDiscontinuity)
+
+        // Then: The DefaultOccupancy instance emits this discontinuity through `onDiscontinuity`
+        let discontinuity = try #require(await discontinuitySubscription.first { _ in true })
+        #expect(discontinuity == featureChannelDiscontinuity)
+    }
+}

Tests/AblyChatTests/Helpers/Helpers.swift

@@ -21,3 +21,10 @@ func isChatError(_ maybeError: (any Error)?, withCodeAndStatusCode codeAndStatus
             return ablyError.message == message
         }()
 }
+
+extension ARTPresenceMessage {
+    convenience init(clientId: String) {
+        self.init()
+        self.clientId = clientId
+    }
+}

Tests/AblyChatTests/Mocks/MockRealtimeChannel.swift

@@ -2,16 +2,15 @@ import Ably
 import AblyChat
 
 final class MockRealtimeChannel: NSObject, RealtimeChannelProtocol {
-    var presence: ARTRealtimePresenceProtocol {
-        fatalError("Not implemented")
-    }
-
     private let attachSerial: String?
     private let channelSerial: String?
     private let _name: String?
+    private let mockPresence: MockRealtimePresence!
 
     var properties: ARTChannelProperties { .init(attachSerial: attachSerial, channelSerial: channelSerial) }
 
+    var presence: ARTRealtimePresenceProtocol { mockPresence }
+
     // I don't see why the nonisolated(unsafe) keyword would cause a problem when used for tests in this context.
     nonisolated(unsafe) var lastMessagePublishedName: String?
     nonisolated(unsafe) var lastMessagePublishedData: Any?
@@ -32,14 +31,16 @@ final class MockRealtimeChannel: NSObject, RealtimeChannelProtocol {
         state _: ARTRealtimeChannelState = .suspended,
         attachResult: AttachOrDetachResult? = nil,
         detachResult: AttachOrDetachResult? = nil,
-        messageToEmitOnSubscribe: MessageToEmit? = nil
+        messageToEmitOnSubscribe: MessageToEmit? = nil,
+        mockPresence: MockRealtimePresence! = nil
     ) {
         _name = name
         self.attachResult = attachResult
         self.detachResult = detachResult
         self.messageToEmitOnSubscribe = messageToEmitOnSubscribe
         attachSerial = properties.attachSerial
         channelSerial = properties.channelSerial
+        self.mockPresence = mockPresence
     }
 
     /// A threadsafe counter that starts at zero.

Tests/AblyChatTests/Mocks/MockRealtimePresence.swift

@@ -0,0 +1,105 @@
+import Ably
+import AblyChat
+
+final class MockRealtimePresence: NSObject, @unchecked Sendable, RealtimePresenceProtocol {
+    let syncComplete: Bool
+    private var members: [ARTPresenceMessage]
+
+    init(syncComplete: Bool = true, _ members: [ARTPresenceMessage]) {
+        self.syncComplete = syncComplete
+        self.members = members
+    }
+
+    func get(_ callback: @escaping ARTPresenceMessagesCallback) {
+        callback(members, nil)
+    }
+
+    func get(_: ARTRealtimePresenceQuery, callback _: @escaping ARTPresenceMessagesCallback) {
+        fatalError("Not implemented")
+    }
+
+    func enter(_: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func enter(_: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func update(_: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func update(_: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func leave(_: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func leave(_: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func enterClient(_ clientId: String, data _: Any?) {
+        members.append(ARTPresenceMessage(clientId: clientId))
+    }
+
+    func enterClient(_ clientId: String, data _: Any?, callback: ARTCallback? = nil) {
+        members.append(ARTPresenceMessage(clientId: clientId))
+        callback?(nil)
+    }
+
+    func updateClient(_: String, data _: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func updateClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func leaveClient(_ clientId: String, data _: Any?) {
+        members.removeAll { $0.clientId == clientId }
+    }
+
+    func leaveClient(_ clientId: String, data _: Any?, callback _: ARTCallback? = nil) {
+        members.removeAll { $0.clientId == clientId }
+    }
+
+    func subscribe(_: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        ARTEventListener()
+    }
+
+    func subscribe(attachCallback _: ARTCallback?, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        ARTEventListener()
+    }
+
+    func subscribe(_: ARTPresenceAction, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        ARTEventListener()
+    }
+
+    func subscribe(_: ARTPresenceAction, onAttach _: ARTCallback?, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        ARTEventListener()
+    }
+
+    func unsubscribe() {
+        fatalError("Not implemented")
+    }
+
+    func unsubscribe(_: ARTEventListener) {
+        fatalError("Not implemented")
+    }
+
+    func unsubscribe(_: ARTPresenceAction, listener _: ARTEventListener) {
+        fatalError("Not implemented")
+    }
+
+    func history(_: @escaping ARTPaginatedPresenceCallback) {
+        fatalError("Not implemented")
+    }
+
+    func history(_: ARTRealtimeHistoryQuery?, callback _: @escaping ARTPaginatedPresenceCallback) throws {
+        fatalError("Not implemented")
+    }
+}