Add the ability to specify GC options via client options

We'll use this when porting the garbage collection JS integration tests.

Author: lawrence-forooghian

Sources/AblyLiveObjects/Internal/ARTClientOptions+Objects.swift

@@ -0,0 +1,45 @@
+internal import AblyPlugin
+
+internal extension ARTClientOptions {
+    private class Box<T> {
+        internal let boxed: T
+
+        internal init(boxed: T) {
+            self.boxed = boxed
+        }
+    }
+
+    private static let garbageCollectionOptionsKey = "Objects.garbageCollectionOptions"
+
+    /// Can be overriden for testing purposes.
+    var garbageCollectionOptions: InternalDefaultRealtimeObjects.GarbageCollectionOptions? {
+        get {
+            let optionsValue = PluginAPI.sharedInstance().pluginOptionsValue(
+                forKey: Self.garbageCollectionOptionsKey,
+                clientOptions: self,
+            )
+
+            guard let optionsValue else {
+                return nil
+            }
+
+            guard let box = optionsValue as? Box<InternalDefaultRealtimeObjects.GarbageCollectionOptions> else {
+                preconditionFailure("Expected GarbageCollectionOptionsBox, got \(optionsValue)")
+            }
+
+            return box.boxed
+        }
+
+        set {
+            guard let newValue else {
+                preconditionFailure("Not implemented the ability to un-set GC options")
+            }
+
+            PluginAPI.sharedInstance().setPluginOptionsValue(
+                Box<InternalDefaultRealtimeObjects.GarbageCollectionOptions>(boxed: newValue),
+                forKey: Self.garbageCollectionOptionsKey,
+                clientOptions: self,
+            )
+        }
+    }
+}

Sources/AblyLiveObjects/Internal/DefaultInternalPlugin.swift

@@ -36,9 +36,15 @@ internal final class DefaultInternalPlugin: NSObject, AblyPlugin.LiveObjectsInte
     internal func prepare(_ channel: AblyPlugin.RealtimeChannel, client: AblyPlugin.RealtimeClient) {
         let logger = pluginAPI.logger(for: channel)
         let callbackQueue = pluginAPI.callbackQueue(for: client)
+        let options = pluginAPI.options(for: client)
 
         logger.log("LiveObjects.DefaultInternalPlugin received prepare(_:)", level: .debug)
-        let liveObjects = InternalDefaultRealtimeObjects(logger: logger, userCallbackQueue: callbackQueue, clock: DefaultSimpleClock())
+        let liveObjects = InternalDefaultRealtimeObjects(
+            logger: logger,
+            userCallbackQueue: callbackQueue,
+            clock: DefaultSimpleClock(),
+            garbageCollectionOptions: options.garbageCollectionOptions ?? .init(),
+        )
         pluginAPI.setPluginDataValue(liveObjects, forKey: Self.pluginDataKey, channel: channel)
     }
 

Sources/AblyLiveObjects/Internal/InternalDefaultRealtimeObjects.swift

@@ -26,7 +26,7 @@ internal final class InternalDefaultRealtimeObjects: Sendable, LiveMapObjectPool
     private nonisolated(unsafe) var garbageCollectionTask: Task<Void, Never>!
 
     /// Parameters used to control the garbage collection of tombstoned objects and map entries, as described in RTO10.
-    internal struct GarbageCollectionOptions {
+    internal struct GarbageCollectionOptions: Encodable, Hashable {
         /// The RTO10a interval at which we will perform garbage collection.
         ///
         /// The default value comes from the suggestion in RTO10a.

Tests/AblyLiveObjectsTests/Helpers/ClientHelper.swift

@@ -1,5 +1,5 @@
 import Ably
-import AblyLiveObjects
+@testable import AblyLiveObjects
 
 /// Helper for creating ably-cocoa objects, for use in integration tests.
 enum ClientHelper {
@@ -26,6 +26,9 @@ enum ClientHelper {
             let logger = PrefixedLogger(prefix: "(\(logIdentifier)) ")
             clientOptions.logHandler = logger
         }
+        if let garbageCollectionOptions = options.garbageCollectionOptions {
+            clientOptions.garbageCollectionOptions = garbageCollectionOptions
+        }
 
         return ARTRealtime(options: clientOptions)
     }
@@ -69,6 +72,7 @@ enum ClientHelper {
     struct PartialClientOptions: Encodable, Hashable {
         var useBinaryProtocol: Bool?
         var autoConnect: Bool?
+        var garbageCollectionOptions: InternalDefaultRealtimeObjects.GarbageCollectionOptions?
 
         /// A prefix for all log messages emitted by the client. Allows clients to be distinguished in log messages for tests which use multiple clients.
         var logIdentifier: String?