ably · lawrence-forooghian · Jan 16, 2025 · coderabbitai · Jan 16, 2025 · coderabbitai
diff --git a/Example/AblyChatExample/Mocks/MockClients.swift b/Example/AblyChatExample/Mocks/MockClients.swift
@@ -88,7 +88,7 @@ actor MockRoom: Room {
 actor MockMessages: Messages {
     let clientID: String
     let roomID: String
-    let channel: RealtimeChannelProtocol
+    let channel: any RealtimeChannelProtocol
 
     private let mockSubscriptions = MockSubscriptionStorage<Message>()
 
@@ -146,7 +146,7 @@ actor MockMessages: Messages {
 actor MockRoomReactions: RoomReactions {
     let clientID: String
     let roomID: String
-    let channel: RealtimeChannelProtocol
+    let channel: any RealtimeChannelProtocol
 
     private let mockSubscriptions = MockSubscriptionStorage<Reaction>()
 
@@ -193,7 +193,7 @@ actor MockRoomReactions: RoomReactions {
 actor MockTyping: Typing {
     let clientID: String
     let roomID: String
-    let channel: RealtimeChannelProtocol
+    let channel: any RealtimeChannelProtocol
 
     private let mockSubscriptions = MockSubscriptionStorage<TypingEvent>()
 
@@ -356,7 +356,7 @@ actor MockPresence: Presence {
 actor MockOccupancy: Occupancy {
     let clientID: String
     let roomID: String
-    let channel: RealtimeChannelProtocol
+    let channel: any RealtimeChannelProtocol
 
     private let mockSubscriptions = MockSubscriptionStorage<OccupancyEvent>()
 

diff --git a/Example/AblyChatExample/Mocks/MockRealtime.swift b/Example/AblyChatExample/Mocks/MockRealtime.swift
@@ -105,9 +105,7 @@ final class MockRealtime: NSObject, RealtimeClientProtocol, Sendable {
             fatalError("Not implemented")
         }
 
-        var presence: ARTRealtimePresenceProtocol {
-            fatalError("Not implemented")
-        }
+        let presence = RealtimePresence()
 
         var errorReason: ARTErrorInfo? {
             fatalError("Not implemented")
@@ -250,6 +248,102 @@ final class MockRealtime: NSObject, RealtimeClientProtocol, Sendable {
         }
     }
 
+    final class RealtimePresence: RealtimePresenceProtocol {
+        var syncComplete: Bool {
+            fatalError("Not implemented")
+        }
+
+        func get(_: @escaping ARTPresenceMessagesCallback) {
+            fatalError("Not implemented")
+        }
+
+        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(_: String, data _: Any?) {
+            fatalError("Not implemented")
+        }
+
+        func enterClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func updateClient(_: String, data _: Any?) {
+            fatalError("Not implemented")
+        }
+
+        func updateClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func leaveClient(_: String, data _: Any?) {
+            fatalError("Not implemented")
+        }
+
+        func leaveClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func subscribe(_: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+            fatalError("Not implemented")
+        }
+
+        func subscribe(attachCallback _: ARTCallback?, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+            fatalError("Not implemented")
+        }
+
+        func subscribe(_: ARTPresenceAction, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+            fatalError("Not implemented")
+        }
+
+        func subscribe(_: ARTPresenceAction, onAttach _: ARTCallback?, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+            fatalError("Not implemented")
+        }
+
+        func unsubscribe() {
+            fatalError("Not implemented")
+        }
+
+        func unsubscribe(_: ARTEventListener) {
+            fatalError("Not implemented")
+        }
+
+        func unsubscribe(_: ARTPresenceAction, listener _: ARTEventListener) {
+            fatalError("Not implemented")
+        }
+
+        func history(_: @escaping ARTPaginatedPresenceCallback) {}
+
+        func history(_: ARTRealtimeHistoryQuery?, callback _: @escaping ARTPaginatedPresenceCallback) throws {
+            fatalError("Not implemented")
+        }
+    }
+
     required init(options _: ARTClientOptions) {}
 
     required init(key _: String) {}

diff --git a/Sources/AblyChat/AblyCocoaExtensions/Ably+Dependencies.swift b/Sources/AblyChat/AblyCocoaExtensions/Ably+Dependencies.swift
@@ -6,4 +6,6 @@ extension ARTRealtimeChannels: RealtimeChannelsProtocol {}
 
 extension ARTRealtimeChannel: RealtimeChannelProtocol {}
 
+extension ARTRealtimePresence: RealtimePresenceProtocol {}
+
 extension ARTConnection: ConnectionProtocol {}
diff --git a/Sources/AblyChat/Dependencies.swift b/Sources/AblyChat/Dependencies.swift
@@ -23,7 +23,14 @@ public protocol RealtimeChannelsProtocol: ARTRealtimeChannelsProtocol, Sendable
 }
 
 /// Expresses the requirements of the object returned by ``RealtimeChannelsProtocol/get(_:options:)``.
-public protocol RealtimeChannelProtocol: ARTRealtimeChannelProtocol, Sendable {}
+public protocol RealtimeChannelProtocol: ARTRealtimeChannelProtocol, Sendable {
+    associatedtype Presence: RealtimePresenceProtocol
+
+    var presence: Presence { get }
+}
+
+/// Expresses the requirements of the object returned by ``RealtimeChannelProtocol/presence``.
+public protocol RealtimePresenceProtocol: ARTRealtimePresenceProtocol, Sendable {}
 
 public protocol ConnectionProtocol: ARTConnectionProtocol, Sendable {}
 

diff --git a/Sources/AblyChat/Messages.swift b/Sources/AblyChat/Messages.swift
@@ -51,7 +51,7 @@ public protocol Messages: AnyObject, Sendable, EmitsDiscontinuities {
      *
      * - Returns: The realtime channel.
      */
-    var channel: RealtimeChannelProtocol { get }
+    var channel: any RealtimeChannelProtocol { get }
 }
 
 public extension Messages {

diff --git a/Sources/AblyChat/Occupancy.swift b/Sources/AblyChat/Occupancy.swift
@@ -34,7 +34,7 @@ public protocol Occupancy: AnyObject, Sendable, EmitsDiscontinuities {
      *
      * - Returns: The underlying Ably channel for occupancy events.
      */
-    var channel: RealtimeChannelProtocol { get }
+    var channel: any RealtimeChannelProtocol { get }
 }
 
 public extension Occupancy {

diff --git a/Sources/AblyChat/Room.swift b/Sources/AblyChat/Room.swift
@@ -300,7 +300,7 @@ internal actor DefaultRoom<LifecycleManagerFactory: RoomLifecycleManagerFactory>
     }
 
     private struct FeatureChannelPartialDependencies {
-        internal var channel: RealtimeChannelProtocol
+        internal var channel: any RealtimeChannelProtocol
         internal var contributor: DefaultRoomLifecycleContributor
     }
 

diff --git a/Sources/AblyChat/RoomFeature.swift b/Sources/AblyChat/RoomFeature.swift
@@ -46,7 +46,7 @@ internal enum RoomFeature: CaseIterable {
 /// - the discontinuities emitted by the room lifecycle
 /// - the presence-readiness wait mechanism supplied by the room lifecycle
 internal protocol FeatureChannel: Sendable, EmitsDiscontinuities {
-    var channel: RealtimeChannelProtocol { get }
+    var channel: any RealtimeChannelProtocol { get }
 
     /// Waits until we can perform presence operations on the contributors of this room without triggering an implicit attach.
     ///
@@ -62,7 +62,7 @@ internal protocol FeatureChannel: Sendable, EmitsDiscontinuities {
 }
 
 internal struct DefaultFeatureChannel: FeatureChannel {
-    internal var channel: RealtimeChannelProtocol
+    internal var channel: any RealtimeChannelProtocol
     internal var contributor: DefaultRoomLifecycleContributor
     internal var roomLifecycleManager: RoomLifecycleManager
 

diff --git a/Sources/AblyChat/RoomReactions.swift b/Sources/AblyChat/RoomReactions.swift
@@ -22,7 +22,7 @@ public protocol RoomReactions: AnyObject, Sendable, EmitsDiscontinuities {
      *
      * - Returns: The realtime channel.
      */
-    var channel: RealtimeChannelProtocol { get }
+    var channel: any RealtimeChannelProtocol { get }
 
     /**
      * Subscribes a given listener to receive room-level reactions.

diff --git a/Sources/AblyChat/Typing.swift b/Sources/AblyChat/Typing.swift
@@ -54,7 +54,7 @@ public protocol Typing: AnyObject, Sendable, EmitsDiscontinuities {
      *
      * - Returns: The Ably realtime channel.
      */
-    var channel: RealtimeChannelProtocol { get }
+    var channel: any RealtimeChannelProtocol { get }
 }
 
 public extension Typing {

diff --git a/Tests/AblyChatTests/Mocks/MockFeatureChannel.swift b/Tests/AblyChatTests/Mocks/MockFeatureChannel.swift
@@ -2,12 +2,12 @@ import Ably
 @testable import AblyChat
 
 final actor MockFeatureChannel: FeatureChannel {
-    let channel: RealtimeChannelProtocol
+    let channel: any RealtimeChannelProtocol
     private var discontinuitySubscriptions = SubscriptionStorage<DiscontinuityEvent>()
     private let resultOfWaitToBeAbleToPerformPresenceOperations: Result<Void, ARTErrorInfo>?
 
     init(
-        channel: RealtimeChannelProtocol,
+        channel: any RealtimeChannelProtocol,
         resultOfWaitToBeAblePerformPresenceOperations: Result<Void, ARTErrorInfo>? = nil
     ) {
         self.channel = channel

diff --git a/Tests/AblyChatTests/Mocks/MockRealtimeChannel.swift b/Tests/AblyChatTests/Mocks/MockRealtimeChannel.swift
@@ -2,9 +2,7 @@ import Ably
 import AblyChat
 
 final class MockRealtimeChannel: NSObject, RealtimeChannelProtocol {
-    var presence: ARTRealtimePresenceProtocol {
-        fatalError("Not implemented")
-    }
+    let presence = MockRealtimePresence()
 
     private let attachSerial: String?
     private let channelSerial: String?

diff --git a/Tests/AblyChatTests/Mocks/MockRealtimePresence.swift b/Tests/AblyChatTests/Mocks/MockRealtimePresence.swift
@@ -0,0 +1,98 @@
+import Ably
+import AblyChat
+
+final class MockRealtimePresence: RealtimePresenceProtocol {
+    var syncComplete: Bool {
+        fatalError("Not implemented")
+    }
+
+    func get(_: @escaping ARTPresenceMessagesCallback) {
+        fatalError("Not implemented")
+    }
+
+    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(_: String, data _: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func enterClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func updateClient(_: String, data _: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func updateClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func leaveClient(_: String, data _: Any?) {
+        fatalError("Not implemented")
+    }
+
+    func leaveClient(_: String, data _: Any?, callback _: ARTCallback? = nil) {
+        fatalError("Not implemented")
+    }
+
+    func subscribe(_: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        fatalError("Not implemented")
+    }
+
+    func subscribe(attachCallback _: ARTCallback?, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        fatalError("Not implemented")
+    }
+
+    func subscribe(_: ARTPresenceAction, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        fatalError("Not implemented")
+    }
+
+    func subscribe(_: ARTPresenceAction, onAttach _: ARTCallback?, callback _: @escaping ARTPresenceMessageCallback) -> ARTEventListener? {
+        fatalError("Not implemented")
+    }
+
+    func unsubscribe() {
+        fatalError("Not implemented")
+    }
+
+    func unsubscribe(_: ARTEventListener) {
+        fatalError("Not implemented")
+    }
+
+    func unsubscribe(_: ARTPresenceAction, listener _: ARTEventListener) {
+        fatalError("Not implemented")
+    }
+
+    func history(_: @escaping ARTPaginatedPresenceCallback) {}
+
+    func history(_: ARTRealtimeHistoryQuery?, callback _: @escaping ARTPaginatedPresenceCallback) throws {
+        fatalError("Not implemented")
+    }
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,6 @@ extension ARTRealtimeChannels: RealtimeChannelsProtocol {}

		extension ARTRealtimeChannel: RealtimeChannelProtocol {}
Copy link coderabbitai bot Jan 16, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. ⚠️ Potential issue Fix protocol conformance for `ARTRealtimeChannel`. The pipeline is failing with the error: "`type 'ARTRealtimeChannel' does not conform to protocol 'RealtimeChannelProtocol'`". This is likely because `ARTRealtimeChannel` is missing required members of `RealtimeChannelProtocol`, specifically the `presence` property of type `any RealtimePresenceProtocol`. To resolve this, you need to ensure that `ARTRealtimeChannel` provides an implementation for the `presence` property that conforms to `RealtimePresenceProtocol`. Apply this diff to fix the issue: extension ARTRealtimeChannel: RealtimeChannelProtocol { + public var presence: any RealtimePresenceProtocol { + return self.presence as any RealtimePresenceProtocol + } } Ensure that `self.presence` correctly returns an instance conforming to `RealtimePresenceProtocol`. This should satisfy the protocol requirements and fix the pipeline failure. Committable suggestion skipped: line range outside the PR's diff. 🧰 Tools 🪛 GitHub Actions: Check [error] 7-7: type 'ARTRealtimeChannel' does not conform to protocol 'RealtimeChannelProtocol'

		extension ARTRealtimePresence: RealtimePresenceProtocol {}

		extension ARTConnection: ConnectionProtocol {}