Merge pull request #264 from ably/post-MainActor-fixes

A few fixes post-`@MainActor`

Author: lawrence-forooghian

Sources/AblyChat/AblyCocoaExtensions/InternalAblyCocoaTypes.swift

@@ -7,7 +7,6 @@ import Ably
 /// - `async` methods instead of callbacks
 /// - typed throws
 /// - `JSONValue` instead of `Any`
-/// - `Sendable` types where helpful
 /// - `AsyncSequence` where helpful
 ///
 /// Note that the API of this protocol is not currently consistent; for example there are some places in the codebase where we subscribe to Realtime channel state using callbacks, and other places where we subscribe using `AsyncSequence`. We should aim to make this consistent; see https://github.com/ably/ably-chat-swift/issues/245.
@@ -236,10 +235,6 @@ internal final class InternalRealtimeClientAdapter: InternalRealtimeClientProtoc
             underlying.unsubscribe(listener)
         }
 
-        internal func publish(_ name: String?, data: JSONValue?, extras: [String: JSONValue]?) {
-            underlying.publish(name, data: data?.toAblyCocoaData, extras: extras?.toARTJsonCompatible)
-        }
-
         internal func subscribe(_ name: String, callback: @escaping @MainActor (ARTMessage) -> Void) -> ARTEventListener? {
             underlying.subscribe(name, callback: callback)
         }
@@ -403,7 +398,7 @@ internal final class InternalRealtimeClientAdapter: InternalRealtimeClientProtoc
     }
 }
 
-/// A `Sendable` version of `ARTPresenceMessage`. Only contains the properties that the Chat SDK is currently using; add as needed.
+/// A version of `ARTPresenceMessage` that uses strongly-typed `data` and `extras` properties. Only contains the properties that the Chat SDK is currently using; add as needed.
 internal struct PresenceMessage {
     internal var clientId: String?
     internal var timestamp: Date?

Tests/AblyChatTests/DefaultMessagesTests.swift

@@ -91,19 +91,22 @@ struct DefaultMessagesTests {
                 channelSerial: "001"
             ),
             initialState: .attached,
-            messageToEmitOnSubscribe: .init(
-                action: .create, // arbitrary
-                serial: "", // arbitrary
-                clientID: "", // arbitrary
-                data: [
+            messageToEmitOnSubscribe: {
+                let message = ARTMessage()
+                message.action = .create // arbitrary
+                message.serial = "" // arbitrary
+                message.clientId = "" // arbitrary
+                message.data = [
                     "text": "", // arbitrary
-                ],
-                extras: [
+                ]
+                message.extras = [
                     "headers": ["numberKey": 10, "stringKey": "hello"],
-                ],
-                operation: nil,
-                version: ""
-            )
+                ] as ARTJsonCompatible
+                message.operation = nil
+                message.version = ""
+
+                return message
+            }()
         )
         let featureChannel = MockFeatureChannel(channel: channel)
         let defaultMessages = DefaultMessages(featureChannel: featureChannel, chatAPI: chatAPI, roomID: "basketball", clientID: "clientId", logger: TestLogger())
@@ -128,18 +131,21 @@ struct DefaultMessagesTests {
                 channelSerial: "001"
             ),
             initialState: .attached,
-            messageToEmitOnSubscribe: .init(
-                action: .create, // arbitrary
-                serial: "", // arbitrary
-                clientID: "", // arbitrary
-                data: [
+            messageToEmitOnSubscribe: {
+                let message = ARTMessage()
+                message.action = .create // arbitrary
+                message.serial = "" // arbitrary
+                message.clientId = "" // arbitrary
+                message.data = [
                     "text": "", // arbitrary
                     "metadata": ["numberKey": 10, "stringKey": "hello"],
-                ],
-                extras: [:],
-                operation: nil,
-                version: ""
-            )
+                ]
+                message.extras = [:] as ARTJsonCompatible
+                message.operation = nil
+                message.version = ""
+
+                return message
+            }()
         )
         let featureChannel = MockFeatureChannel(channel: channel)
         let defaultMessages = DefaultMessages(featureChannel: featureChannel, chatAPI: chatAPI, roomID: "basketball", clientID: "clientId", logger: TestLogger())

Tests/AblyChatTests/Mocks/MockRealtimeChannel.swift

@@ -17,25 +17,14 @@ final class MockRealtimeChannel: InternalRealtimeChannelProtocol {
     var lastMessagePublishedData: JSONValue?
     var lastMessagePublishedExtras: [String: JSONValue]?
 
-    // TODO: If we tighten up the types we then we should be able to get rid of the `@unchecked Sendable` here, but I’m in a rush. Revisit in https://github.com/ably/ably-chat-swift/issues/195
-    struct MessageToEmit: @unchecked Sendable {
-        var action: ARTMessageAction
-        var serial: String
-        var clientID: String
-        var data: Any
-        var extras: NSDictionary
-        var operation: ARTMessageOperation?
-        var version: String
-    }
-
     init(
         name: String? = nil,
         properties: ARTChannelProperties = .init(),
         initialState: ARTRealtimeChannelState? = nil,
         initialErrorReason: ARTErrorInfo? = nil,
         attachBehavior: AttachOrDetachBehavior? = nil,
         detachBehavior: AttachOrDetachBehavior? = nil,
-        messageToEmitOnSubscribe: MessageToEmit? = nil,
+        messageToEmitOnSubscribe: ARTMessage? = nil,
         subscribeToStateBehavior: SubscribeToStateBehavior? = nil
     ) {
         _name = name
@@ -137,18 +126,11 @@ final class MockRealtimeChannel: InternalRealtimeChannelProtocol {
         try result.get()
     }
 
-    let messageToEmitOnSubscribe: MessageToEmit?
+    let messageToEmitOnSubscribe: ARTMessage?
 
     func subscribe(_: String, callback: @escaping @MainActor (ARTMessage) -> Void) -> ARTEventListener? {
         if let messageToEmitOnSubscribe {
-            let message = ARTMessage(name: nil, data: messageToEmitOnSubscribe.data)
-            message.action = messageToEmitOnSubscribe.action
-            message.serial = messageToEmitOnSubscribe.serial
-            message.clientId = messageToEmitOnSubscribe.clientID
-            message.extras = messageToEmitOnSubscribe.extras
-            message.operation = messageToEmitOnSubscribe.operation
-            message.version = messageToEmitOnSubscribe.version
-            callback(message)
+            callback(messageToEmitOnSubscribe)
         }
         return ARTEventListener()
     }