WIP Move AblyPlugin to an external repository

TODO explain motivation

Author: lawrence-forooghian

AblyLiveObjects.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -21,6 +21,11 @@ let package = Package(
         .package(
             path: "ably-cocoa",
         ),
+        .package(
+            // TODO: Unpin this before release
+            url: "https://github.com/ably/ably-cocoa-plugin-support",
+            revision: "97c3d52a",
+        ),
         .package(
             url: "https://github.com/apple/swift-argument-parser",
             from: "1.5.0",
@@ -48,7 +53,7 @@ let package = Package(
                 ),
                 .product(
                     name: "AblyPlugin",
-                    package: "ably-cocoa",
+                    package: "ably-cocoa-plugin-support",
                 ),
             ],
         ),
@@ -62,7 +67,7 @@ let package = Package(
                 ),
                 .product(
                     name: "AblyPlugin",
-                    package: "ably-cocoa",
+                    package: "ably-cocoa-plugin-support",
                 ),
             ],
             resources: [

Package.resolved

@@ -1,4 +1,5 @@
 internal import AblyPlugin
+import Ably
 
 internal extension ARTClientOptions {
     private class Box<T> {

Package.swift

@@ -14,7 +14,7 @@ internal protocol CoreSDK: AnyObject, Sendable {
     func testsOnly_overridePublish(with newImplementation: @escaping ([OutboundObjectMessage]) async throws(InternalError) -> Void)
 
     /// Returns the current state of the Realtime channel that this wraps.
-    var channelState: ARTRealtimeChannelState { get }
+    var channelState: AblyPlugin.RealtimeChannelState { get }
 }
 
 internal final class DefaultCoreSDK: CoreSDK {
@@ -24,7 +24,7 @@ internal final class DefaultCoreSDK: CoreSDK {
     private let channel: AblyPlugin.RealtimeChannel
     private let client: AblyPlugin.RealtimeClient
     private let pluginAPI: PluginAPIProtocol
-    private let logger: AblyPlugin.Logger
+    private let logger: Logger
 
     /// If set to true, ``publish(objectMessages:)`` will behave like a no-op.
     ///
@@ -37,7 +37,7 @@ internal final class DefaultCoreSDK: CoreSDK {
         channel: AblyPlugin.RealtimeChannel,
         client: AblyPlugin.RealtimeClient,
         pluginAPI: PluginAPIProtocol,
-        logger: AblyPlugin.Logger
+        logger: Logger
     ) {
         self.channel = channel
         self.client = client
@@ -81,8 +81,8 @@ internal final class DefaultCoreSDK: CoreSDK {
         }
     }
 
-    internal var channelState: ARTRealtimeChannelState {
-        channel.state
+    internal var channelState: AblyPlugin.RealtimeChannelState {
+        pluginAPI.state(for: channel)
     }
 }
 
@@ -97,7 +97,7 @@ internal extension CoreSDK {
     ///   - operationDescription: A description of the operation being performed, used in error messages
     /// - Throws: `ARTErrorInfo` with code 90001 and statusCode 400 if the channel is in any of the invalid states
     func validateChannelState(
-        notIn invalidStates: [ARTRealtimeChannelState],
+        notIn invalidStates: [AblyPlugin.RealtimeChannelState],
         operationDescription: String,
     ) throws(ARTErrorInfo) {
         let currentChannelState = channelState

Sources/AblyLiveObjects/Internal/ARTClientOptions+Objects.swift

@@ -1,4 +1,5 @@
 internal import AblyPlugin
+import Ably
 
 // We explicitly import the NSObject class, else it seems to get transitively imported from  `internal import AblyPlugin`, leading to the error "Class cannot be declared public because its superclass is internal".
 import ObjectiveC.NSObject
@@ -34,10 +35,11 @@ internal final class DefaultInternalPlugin: NSObject, AblyPlugin.LiveObjectsInte
 
     // Populates the channel's `objects` property.
     internal func prepare(_ channel: AblyPlugin.RealtimeChannel, client: AblyPlugin.RealtimeClient) {
-        let logger = pluginAPI.logger(for: channel)
+        let pluginLogger = pluginAPI.logger(for: channel)
         let callbackQueue = pluginAPI.callbackQueue(for: client)
-        let options = pluginAPI.options(for: client)
+        let options = pluginAPI.options(for: client) as! ARTClientOptions
 
+        let logger = DefaultLogger(pluginLogger: pluginLogger, pluginAPI: pluginAPI)
         logger.log("LiveObjects.DefaultInternalPlugin received prepare(_:)", level: .debug)
         let liveObjects = InternalDefaultRealtimeObjects(
             logger: logger,
@@ -68,8 +70,7 @@ internal final class DefaultInternalPlugin: NSObject, AblyPlugin.LiveObjectsInte
         _ serialized: [String: Any],
         context: DecodingContextProtocol,
         format: EncodingFormat,
-        error errorPtr: AutoreleasingUnsafeMutablePointer<ARTErrorInfo?>?,
-    ) -> (any ObjectMessageProtocol)? {
+    ) throws -> any ObjectMessageProtocol {
         let wireObject = WireValue.objectFromAblyPluginData(serialized)
 
         do {
@@ -83,8 +84,8 @@ internal final class DefaultInternalPlugin: NSObject, AblyPlugin.LiveObjectsInte
             )
             return ObjectMessageBox(objectMessage: objectMessage)
         } catch {
-            errorPtr?.pointee = error.toARTErrorInfo()
-            return nil
+            // Note that although not enforced by the type system, we must throw ARTErrorInfo
+            throw error.toARTErrorInfo()
         }
     }
 

Sources/AblyLiveObjects/Internal/CoreSDK.swift

@@ -21,7 +21,7 @@ internal final class InternalDefaultLiveCounter: Sendable {
         }
     }
 
-    private let logger: AblyPlugin.Logger
+    private let logger: Logger
     private let userCallbackQueue: DispatchQueue
     private let clock: SimpleClock
 
@@ -30,7 +30,7 @@ internal final class InternalDefaultLiveCounter: Sendable {
     internal convenience init(
         testsOnly_data data: Double,
         objectID: String,
-        logger: AblyPlugin.Logger,
+        logger: Logger,
         userCallbackQueue: DispatchQueue,
         clock: SimpleClock
     ) {
@@ -40,7 +40,7 @@ internal final class InternalDefaultLiveCounter: Sendable {
     private init(
         data: Double,
         objectID: String,
-        logger: AblyPlugin.Logger,
+        logger: Logger,
         userCallbackQueue: DispatchQueue,
         clock: SimpleClock
     ) {
@@ -56,7 +56,7 @@ internal final class InternalDefaultLiveCounter: Sendable {
     ///   - objectID: The value for the "private objectId field" of RTO5c1b1a.
     internal static func createZeroValued(
         objectID: String,
-        logger: AblyPlugin.Logger,
+        logger: Logger,
         userCallbackQueue: DispatchQueue,
         clock: SimpleClock,
     ) -> Self {

Sources/AblyLiveObjects/Internal/DefaultInternalPlugin.swift

@@ -38,7 +38,7 @@ internal final class InternalDefaultLiveMap: Sendable {
         }
     }
 
-    private let logger: AblyPlugin.Logger
+    private let logger: Logger
     private let userCallbackQueue: DispatchQueue
     private let clock: SimpleClock
 
@@ -48,7 +48,7 @@ internal final class InternalDefaultLiveMap: Sendable {
         testsOnly_data data: [String: InternalObjectsMapEntry],
         objectID: String,
         testsOnly_semantics semantics: WireEnum<ObjectsMapSemantics>? = nil,
-        logger: AblyPlugin.Logger,
+        logger: Logger,
         userCallbackQueue: DispatchQueue,
         clock: SimpleClock,
     ) {
@@ -66,7 +66,7 @@ internal final class InternalDefaultLiveMap: Sendable {
         data: [String: InternalObjectsMapEntry],
         objectID: String,
         semantics: WireEnum<ObjectsMapSemantics>?,
-        logger: AblyPlugin.Logger,
+        logger: Logger,
         userCallbackQueue: DispatchQueue,
         clock: SimpleClock,
     ) {
@@ -84,7 +84,7 @@ internal final class InternalDefaultLiveMap: Sendable {
     internal static func createZeroValued(
         objectID: String,
         semantics: WireEnum<ObjectsMapSemantics>? = nil,
-        logger: AblyPlugin.Logger,
+        logger: Logger,
         userCallbackQueue: DispatchQueue,
         clock: SimpleClock,
     ) -> Self {
@@ -398,7 +398,7 @@ internal final class InternalDefaultLiveMap: Sendable {
             using state: ObjectState,
             objectMessageSerialTimestamp: Date?,
             objectsPool: inout ObjectsPool,
-            logger: AblyPlugin.Logger,
+            logger: Logger,
             clock: SimpleClock,
             userCallbackQueue: DispatchQueue,
         ) -> LiveObjectUpdate<DefaultLiveMapUpdate> {
@@ -467,7 +467,7 @@ internal final class InternalDefaultLiveMap: Sendable {
         internal mutating func mergeInitialValue(
             from operation: ObjectOperation,
             objectsPool: inout ObjectsPool,
-            logger: AblyPlugin.Logger,
+            logger: Logger,
             userCallbackQueue: DispatchQueue,
             clock: SimpleClock,
         ) -> LiveObjectUpdate<DefaultLiveMapUpdate> {
@@ -621,7 +621,7 @@ internal final class InternalDefaultLiveMap: Sendable {
             operationTimeserial: String?,
             operationData: ObjectData?,
             objectsPool: inout ObjectsPool,
-            logger: AblyPlugin.Logger,
+            logger: Logger,
             userCallbackQueue: DispatchQueue,
             clock: SimpleClock,
         ) -> LiveObjectUpdate<DefaultLiveMapUpdate> {
@@ -744,7 +744,7 @@ internal final class InternalDefaultLiveMap: Sendable {
         internal mutating func applyMapCreateOperation(
             _ operation: ObjectOperation,
             objectsPool: inout ObjectsPool,
-            logger: AblyPlugin.Logger,
+            logger: Logger,
             userCallbackQueue: DispatchQueue,
             clock: SimpleClock,
         ) -> LiveObjectUpdate<DefaultLiveMapUpdate> {

Sources/AblyLiveObjects/Internal/InternalDefaultLiveCounter.swift

@@ -8,7 +8,7 @@ internal final class InternalDefaultRealtimeObjects: Sendable, LiveMapObjectPool
 
     private nonisolated(unsafe) var mutableState: MutableState!
 
-    private let logger: AblyPlugin.Logger
+    private let logger: Logger
     private let userCallbackQueue: DispatchQueue
     private let clock: SimpleClock
 
@@ -91,7 +91,7 @@ internal final class InternalDefaultRealtimeObjects: Sendable, LiveMapObjectPool
         }
     }
 
-    internal init(logger: AblyPlugin.Logger, userCallbackQueue: DispatchQueue, clock: SimpleClock, garbageCollectionOptions: GarbageCollectionOptions = .init()) {
+    internal init(logger: Logger, userCallbackQueue: DispatchQueue, clock: SimpleClock, garbageCollectionOptions: GarbageCollectionOptions = .init()) {
         self.logger = logger
         self.userCallbackQueue = userCallbackQueue
         self.clock = clock

Sources/AblyLiveObjects/Internal/InternalDefaultLiveMap.swift

@@ -1,4 +1,5 @@
 internal import AblyPlugin
+import Ably
 
 /// This is the equivalent of the `LiveObject` abstract class described in RTLO.
 ///