Add logging to PublicObjectsStore

lawrence-forooghian · lawrence-forooghian · commit 76ca4982ae58 · 2025-07-31T15:15:24.000+01:00
I'm trying to debug an issue and this will be helpful. Code largely
generated by Cursor at my instruction.
diff --git a/Sources/AblyLiveObjects/Public/ARTRealtimeChannel+Objects.swift b/Sources/AblyLiveObjects/Public/ARTRealtimeChannel+Objects.swift
@@ -18,10 +18,13 @@ public extension ARTRealtimeChannel {
             pluginAPI: Plugin.defaultPluginAPI,
         )
 
+        let logger = pluginAPI.logger(for: underlyingObjects.channel)
+
         return PublicObjectsStore.shared.getOrCreateRealtimeObjects(
             proxying: internalObjects,
             creationArgs: .init(
                 coreSDK: coreSDK,
+                logger: logger,
             ),
         )
     }
diff --git a/Sources/AblyLiveObjects/Public/Public Proxy Objects/InternalLiveMapValue+ToPublic.swift b/Sources/AblyLiveObjects/Public/Public Proxy Objects/InternalLiveMapValue+ToPublic.swift
@@ -1,16 +1,19 @@
+internal import AblyPlugin
+
 internal extension InternalLiveMapValue {
     // MARK: - Mapping to public types
 
     struct PublicValueCreationArgs {
         internal var coreSDK: CoreSDK
         internal var mapDelegate: LiveMapObjectPoolDelegate
+        internal var logger: AblyPlugin.Logger
 
         internal var toCounterCreationArgs: PublicObjectsStore.CounterCreationArgs {
-            .init(coreSDK: coreSDK)
+            .init(coreSDK: coreSDK, logger: logger)
         }
 
         internal var toMapCreationArgs: PublicObjectsStore.MapCreationArgs {
-            .init(coreSDK: coreSDK, delegate: mapDelegate)
+            .init(coreSDK: coreSDK, delegate: mapDelegate, logger: logger)
         }
     }
 
diff --git a/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultLiveCounter.swift b/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultLiveCounter.swift
@@ -1,4 +1,5 @@
 import Ably
+internal import AblyPlugin
 
 /// Our default implementation of ``LiveCounter``.
 ///
@@ -9,10 +10,12 @@ internal final class PublicDefaultLiveCounter: LiveCounter {
     // MARK: - Dependencies that hold a strong reference to `proxied`
 
     private let coreSDK: CoreSDK
+    private let logger: AblyPlugin.Logger
 
-    internal init(proxied: InternalDefaultLiveCounter, coreSDK: CoreSDK) {
+    internal init(proxied: InternalDefaultLiveCounter, coreSDK: CoreSDK, logger: AblyPlugin.Logger) {
         self.proxied = proxied
         self.coreSDK = coreSDK
+        self.logger = logger
     }
 
     // MARK: - `LiveCounter` protocol
diff --git a/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultLiveMap.swift b/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultLiveMap.swift
@@ -1,4 +1,5 @@
 import Ably
+internal import AblyPlugin
 
 /// Our default implementation of ``LiveMap``.
 ///
@@ -10,11 +11,13 @@ internal final class PublicDefaultLiveMap: LiveMap {
 
     private let coreSDK: CoreSDK
     private let delegate: LiveMapObjectPoolDelegate
+    private let logger: AblyPlugin.Logger
 
-    internal init(proxied: InternalDefaultLiveMap, coreSDK: CoreSDK, delegate: LiveMapObjectPoolDelegate) {
+    internal init(proxied: InternalDefaultLiveMap, coreSDK: CoreSDK, delegate: LiveMapObjectPoolDelegate, logger: AblyPlugin.Logger) {
         self.proxied = proxied
         self.coreSDK = coreSDK
         self.delegate = delegate
+        self.logger = logger
     }
 
     // MARK: - `LiveMap` protocol
@@ -24,6 +27,7 @@ internal final class PublicDefaultLiveMap: LiveMap {
             creationArgs: .init(
                 coreSDK: coreSDK,
                 mapDelegate: delegate,
+                logger: logger,
             ),
         )
     }
@@ -43,6 +47,7 @@ internal final class PublicDefaultLiveMap: LiveMap {
                         creationArgs: .init(
                             coreSDK: coreSDK,
                             mapDelegate: delegate,
+                            logger: logger,
                         ),
                     )
                 )
@@ -63,6 +68,7 @@ internal final class PublicDefaultLiveMap: LiveMap {
                     creationArgs: .init(
                         coreSDK: coreSDK,
                         mapDelegate: delegate,
+                        logger: logger,
                     ),
                 )
             }
diff --git a/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultRealtimeObjects.swift b/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultRealtimeObjects.swift
@@ -1,4 +1,5 @@
 import Ably
+internal import AblyPlugin
 
 /// The class that provides the public API for interacting with LiveObjects, via the ``ARTRealtimeChannel/objects`` property.
 ///
@@ -12,10 +13,12 @@ internal final class PublicDefaultRealtimeObjects: RealtimeObjects {
     // MARK: - Dependencies that hold a strong reference to `proxied`
 
     private let coreSDK: CoreSDK
+    private let logger: AblyPlugin.Logger
 
-    internal init(proxied: InternalDefaultRealtimeObjects, coreSDK: CoreSDK) {
+    internal init(proxied: InternalDefaultRealtimeObjects, coreSDK: CoreSDK, logger: AblyPlugin.Logger) {
         self.proxied = proxied
         self.coreSDK = coreSDK
+        self.logger = logger
     }
 
     // MARK: - `RealtimeObjects` protocol
@@ -27,6 +30,7 @@ internal final class PublicDefaultRealtimeObjects: RealtimeObjects {
             creationArgs: .init(
                 coreSDK: coreSDK,
                 delegate: proxied,
+                logger: logger,
             ),
         )
     }
diff --git a/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicObjectsStore.swift b/Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicObjectsStore.swift
@@ -1,3 +1,4 @@
+internal import AblyPlugin
 import Foundation
 
 /// Stores the public objects that wrap the SDK's internal components.
@@ -20,6 +21,7 @@ internal final class PublicObjectsStore: Sendable {
 
     internal struct RealtimeObjectsCreationArgs {
         internal var coreSDK: CoreSDK
+        internal var logger: AblyPlugin.Logger
     }
 
     /// Fetches the cached `PublicDefaultRealtimeObjects` that wraps a given `InternalDefaultRealtimeObjects`, creating a new public object if there isn't already one.
@@ -31,6 +33,7 @@ internal final class PublicObjectsStore: Sendable {
 
     internal struct CounterCreationArgs {
         internal var coreSDK: CoreSDK
+        internal var logger: AblyPlugin.Logger
     }
 
     /// Fetches the cached `PublicDefaultLiveCounter` that wraps a given `InternalDefaultLiveCounter`, creating a new public object if there isn't already one.
@@ -43,6 +46,7 @@ internal final class PublicObjectsStore: Sendable {
     internal struct MapCreationArgs {
         internal var coreSDK: CoreSDK
         internal var delegate: LiveMapObjectPoolDelegate
+        internal var logger: AblyPlugin.Logger
     }
 
     /// Fetches the cached `PublicDefaultLiveMap` that wraps a given `InternalDefaultLiveMap`, creating a new public object if there isn't already one.
@@ -64,27 +68,37 @@ internal final class PublicObjectsStore: Sendable {
             /// Fetches the proxy that wraps `proxied`, creating a new proxy if there isn't already one. Stores a weak reference to the proxy.
             mutating func getOrCreate(
                 proxying proxied: some AnyObject,
+                logger: AblyPlugin.Logger,
+                logObjectType: String,
                 createProxy: () -> Proxy,
             ) -> Proxy {
                 // Remove any entries that are no longer useful
-                removeDeallocatedEntries()
+                removeDeallocatedEntries(logger: logger, logObjectType: logObjectType)
 
                 // Do the get-or-create
                 let proxiedObjectIdentifier = ObjectIdentifier(proxied)
 
                 if let existing = proxiesByProxiedObjectIdentifier[proxiedObjectIdentifier]?.referenced {
+                    logger.log("Reusing existing \(logObjectType) proxy (proxy: \(ObjectIdentifier(existing)), proxied: \(proxiedObjectIdentifier))", level: .debug)
                     return existing
                 }
 
                 let created = createProxy()
                 proxiesByProxiedObjectIdentifier[proxiedObjectIdentifier] = .init(referenced: created)
+                logger.log("Creating new \(logObjectType) proxy (proxy: \(ObjectIdentifier(created)), proxied: \(proxiedObjectIdentifier))", level: .debug)
 
                 return created
             }
 
-            private mutating func removeDeallocatedEntries() {
-                proxiesByProxiedObjectIdentifier = proxiesByProxiedObjectIdentifier.filter { entry in
-                    entry.value.referenced != nil
+            private mutating func removeDeallocatedEntries(logger: AblyPlugin.Logger, logObjectType: String) {
+                var keysToRemove: Set<ObjectIdentifier> = []
+                for (proxiedObjectIdentifier, weakProxyRef) in proxiesByProxiedObjectIdentifier where weakProxyRef.referenced == nil {
+                    logger.log("Clearing unused \(logObjectType) proxy from cache (proxied: \(proxiedObjectIdentifier))", level: .debug)
+                    keysToRemove.insert(proxiedObjectIdentifier)
+                }
+
+                for key in keysToRemove {
+                    proxiesByProxiedObjectIdentifier.removeValue(forKey: key)
                 }
             }
         }
@@ -93,10 +107,15 @@ internal final class PublicObjectsStore: Sendable {
             proxying proxied: InternalDefaultRealtimeObjects,
             creationArgs: RealtimeObjectsCreationArgs,
         ) -> PublicDefaultRealtimeObjects {
-            realtimeObjectsProxies.getOrCreate(proxying: proxied) {
+            realtimeObjectsProxies.getOrCreate(
+                proxying: proxied,
+                logger: creationArgs.logger,
+                logObjectType: "RealtimeObjects",
+            ) {
                 .init(
                     proxied: proxied,
                     coreSDK: creationArgs.coreSDK,
+                    logger: creationArgs.logger,
                 )
             }
         }
@@ -105,10 +124,15 @@ internal final class PublicObjectsStore: Sendable {
             proxying proxied: InternalDefaultLiveCounter,
             creationArgs: CounterCreationArgs,
         ) -> PublicDefaultLiveCounter {
-            counterProxies.getOrCreate(proxying: proxied) {
+            counterProxies.getOrCreate(
+                proxying: proxied,
+                logger: creationArgs.logger,
+                logObjectType: "LiveCounter",
+            ) {
                 .init(
                     proxied: proxied,
                     coreSDK: creationArgs.coreSDK,
+                    logger: creationArgs.logger,
                 )
             }
         }
@@ -117,11 +141,16 @@ internal final class PublicObjectsStore: Sendable {
             proxying proxied: InternalDefaultLiveMap,
             creationArgs: MapCreationArgs,
         ) -> PublicDefaultLiveMap {
-            mapProxies.getOrCreate(proxying: proxied) {
+            mapProxies.getOrCreate(
+                proxying: proxied,
+                logger: creationArgs.logger,
+                logObjectType: "LiveMap",
+            ) {
                 .init(
                     proxied: proxied,
                     coreSDK: creationArgs.coreSDK,
                     delegate: creationArgs.delegate,
+                    logger: creationArgs.logger,
                 )
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,13 @@ public extension ARTRealtimeChannel {`
`18`	`18`	`pluginAPI: Plugin.defaultPluginAPI,`
`19`	`19`	`)`
`20`	`20`
	`21`	`+ let logger = pluginAPI.logger(for: underlyingObjects.channel)`
	`22`	`+`
`21`	`23`	`return PublicObjectsStore.shared.getOrCreateRealtimeObjects(`
`22`	`24`	`proxying: internalObjects,`
`23`	`25`	`creationArgs: .init(`
`24`	`26`	`coreSDK: coreSDK,`
	`27`	`+ logger: logger,`
`25`	`28`	`),`
`26`	`29`	`)`
`27`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,19 @@`
	`1`	`+internal import AblyPlugin`
	`2`	`+`
`1`	`3`	`internal extension InternalLiveMapValue {`
`2`	`4`	`// MARK: - Mapping to public types`
`3`	`5`
`4`	`6`	`struct PublicValueCreationArgs {`
`5`	`7`	`internal var coreSDK: CoreSDK`
`6`	`8`	`internal var mapDelegate: LiveMapObjectPoolDelegate`
	`9`	`+ internal var logger: AblyPlugin.Logger`
`7`	`10`
`8`	`11`	`internal var toCounterCreationArgs: PublicObjectsStore.CounterCreationArgs {`
`9`		`- .init(coreSDK: coreSDK)`
	`12`	`+ .init(coreSDK: coreSDK, logger: logger)`
`10`	`13`	`}`
`11`	`14`
`12`	`15`	`internal var toMapCreationArgs: PublicObjectsStore.MapCreationArgs {`
`13`		`- .init(coreSDK: coreSDK, delegate: mapDelegate)`
	`16`	`+ .init(coreSDK: coreSDK, delegate: mapDelegate, logger: logger)`
`14`	`17`	`}`
`15`	`18`	`}`
`16`	`19`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import Ably`
	`2`	`+internal import AblyPlugin`
`2`	`3`
`3`	`4`	/// Our default implementation of ``LiveMap``.
`4`	`5`	`///`
`@@ -10,11 +11,13 @@ internal final class PublicDefaultLiveMap: LiveMap {`
`10`	`11`
`11`	`12`	`private let coreSDK: CoreSDK`
`12`	`13`	`private let delegate: LiveMapObjectPoolDelegate`
	`14`	`+ private let logger: AblyPlugin.Logger`
`13`	`15`
`14`		`- internal init(proxied: InternalDefaultLiveMap, coreSDK: CoreSDK, delegate: LiveMapObjectPoolDelegate) {`
	`16`	`+ internal init(proxied: InternalDefaultLiveMap, coreSDK: CoreSDK, delegate: LiveMapObjectPoolDelegate, logger: AblyPlugin.Logger) {`
`15`	`17`	`self.proxied = proxied`
`16`	`18`	`self.coreSDK = coreSDK`
`17`	`19`	`self.delegate = delegate`
	`20`	`+ self.logger = logger`
`18`	`21`	`}`
`19`	`22`
`20`	`23`	// MARK: - `LiveMap` protocol
`@@ -24,6 +27,7 @@ internal final class PublicDefaultLiveMap: LiveMap {`
`24`	`27`	`creationArgs: .init(`
`25`	`28`	`coreSDK: coreSDK,`
`26`	`29`	`mapDelegate: delegate,`
	`30`	`+ logger: logger,`
`27`	`31`	`),`
`28`	`32`	`)`
`29`	`33`	`}`
`@@ -43,6 +47,7 @@ internal final class PublicDefaultLiveMap: LiveMap {`
`43`	`47`	`creationArgs: .init(`
`44`	`48`	`coreSDK: coreSDK,`
`45`	`49`	`mapDelegate: delegate,`
	`50`	`+ logger: logger,`
`46`	`51`	`),`
`47`	`52`	`)`
`48`	`53`	`)`
`@@ -63,6 +68,7 @@ internal final class PublicDefaultLiveMap: LiveMap {`
`63`	`68`	`creationArgs: .init(`
`64`	`69`	`coreSDK: coreSDK,`
`65`	`70`	`mapDelegate: delegate,`
	`71`	`+ logger: logger,`
`66`	`72`	`),`
`67`	`73`	`)`
`68`	`74`	`}`