Extract LiveObject common mutable state into a new type

Based on TODO

Author: lawrence-forooghian

Sources/AblyLiveObjects/Internal/DefaultLiveCounter.swift

@@ -10,19 +10,19 @@ internal final class DefaultLiveCounter: LiveCounter {
 
     internal var testsOnly_siteTimeserials: [String: String] {
         mutex.withLock {
-            mutableState.siteTimeserials
+            mutableState.liveObject.siteTimeserials
         }
     }
 
     internal var testsOnly_createOperationIsMerged: Bool {
         mutex.withLock {
-            mutableState.createOperationIsMerged
+            mutableState.liveObject.createOperationIsMerged
         }
     }
 
     internal var testsOnly_objectID: String {
         mutex.withLock {
-            mutableState.objectID
+            mutableState.liveObject.objectID
         }
     }
 
@@ -43,7 +43,7 @@ internal final class DefaultLiveCounter: LiveCounter {
         objectID: String,
         coreSDK: CoreSDK
     ) {
-        mutableState = .init(data: data, objectID: objectID)
+        mutableState = .init(liveObject: .init(objectID: objectID), data: data)
         self.coreSDK = coreSDK
     }
 
@@ -119,25 +119,19 @@ internal final class DefaultLiveCounter: LiveCounter {
     // MARK: - Mutable state and the operations that affect it
 
     private struct MutableState {
+        /// The mutable state common to all LiveObjects.
+        internal var liveObject: LiveObjectMutableState
+
         /// The internal data that this map holds, per RTLC3.
         internal var data: Double
 
-        /// The site timeserials for this counter, per RTLC6a.
-        internal var siteTimeserials: [String: String] = [:]
-
-        /// Whether the create operation has been merged, per RTLC6b and RTLC6d2.
-        internal var createOperationIsMerged = false
-
-        /// The "private `objectId` field" of RTO5c1b1a.
-        internal var objectID: String
-
         /// Replaces the internal data of this counter with the provided ObjectState, per RTLC6.
         internal mutating func replaceData(using state: ObjectState) {
             // RTLC6a: Replace the private siteTimeserials with the value from ObjectState.siteTimeserials
-            siteTimeserials = state.siteTimeserials
+            liveObject.siteTimeserials = state.siteTimeserials
 
             // RTLC6b: Set the private flag createOperationIsMerged to false
-            createOperationIsMerged = false
+            liveObject.createOperationIsMerged = false
 
             // RTLC6c: Set data to the value of ObjectState.counter.count, or to 0 if it does not exist
             data = state.counter?.count?.doubleValue ?? 0
@@ -149,7 +143,7 @@ internal final class DefaultLiveCounter: LiveCounter {
                     data += createOpCount
                 }
                 // RTLC6d2: Set the private flag createOperationIsMerged to true
-                createOperationIsMerged = true
+                liveObject.createOperationIsMerged = true
             }
         }
     }

Sources/AblyLiveObjects/Internal/DefaultLiveMap.swift

@@ -21,7 +21,7 @@ internal final class DefaultLiveMap: LiveMap {
 
     internal var testsOnly_objectID: String {
         mutex.withLock {
-            mutableState.objectID
+            mutableState.liveObject.objectID
         }
     }
 
@@ -33,13 +33,13 @@ internal final class DefaultLiveMap: LiveMap {
 
     internal var testsOnly_siteTimeserials: [String: String] {
         mutex.withLock {
-            mutableState.siteTimeserials
+            mutableState.liveObject.siteTimeserials
         }
     }
 
     internal var testsOnly_createOperationIsMerged: Bool {
         mutex.withLock {
-            mutableState.createOperationIsMerged
+            mutableState.liveObject.createOperationIsMerged
         }
     }
 
@@ -76,15 +76,15 @@ internal final class DefaultLiveMap: LiveMap {
         delegate: LiveMapObjectPoolDelegate?,
         coreSDK: CoreSDK
     ) {
-        mutableState = .init(data: data, objectID: objectID, semantics: semantics)
+        mutableState = .init(liveObject: .init(objectID: objectID), data: data, semantics: semantics)
         self.delegate = .init(referenced: delegate)
         self.coreSDK = coreSDK
     }
 
     /// Creates a "zero-value LiveMap", per RTLM4.
     ///
     /// - Parameters:
-    ///   - objectID: The value to use for the "private `objectId` field" of RTO5c1b1b.
+    ///   - objectID: The value to use for the RTLO3a `objectID` property.
     ///   - semantics: The value to use for the "private `semantics` field" of RTO5c1b1b.
     internal static func createZeroValued(
         objectID: String,
@@ -271,21 +271,15 @@ internal final class DefaultLiveMap: LiveMap {
     // MARK: - Mutable state and the operations that affect it
 
     private struct MutableState {
+        /// The mutable state common to all LiveObjects.
+        internal var liveObject: LiveObjectMutableState
+
         /// The internal data that this map holds, per RTLM3.
         internal var data: [String: ObjectsMapEntry]
 
-        /// The "private `objectId` field" of RTO5c1b1b.
-        internal var objectID: String
-
         /// The "private `semantics` field" of RTO5c1b1b.
         internal var semantics: WireEnum<ObjectsMapSemantics>?
 
-        /// The site timeserials for this map, per RTLM6a.
-        internal var siteTimeserials: [String: String] = [:]
-
-        /// Whether the create operation has been merged, per RTLM6b and RTLM6d2.
-        internal var createOperationIsMerged = false
-
         /// Replaces the internal data of this map with the provided ObjectState, per RTLM6.
         ///
         /// - Parameters:
@@ -297,10 +291,10 @@ internal final class DefaultLiveMap: LiveMap {
             coreSDK: CoreSDK,
         ) {
             // RTLM6a: Replace the private siteTimeserials with the value from ObjectState.siteTimeserials
-            siteTimeserials = state.siteTimeserials
+            liveObject.siteTimeserials = state.siteTimeserials
 
             // RTLM6b: Set the private flag createOperationIsMerged to false
-            createOperationIsMerged = false
+            liveObject.createOperationIsMerged = false
 
             // RTLM6c: Set data to ObjectState.map.entries, or to an empty map if it does not exist
             data = state.map?.entries ?? [:]
@@ -332,7 +326,7 @@ internal final class DefaultLiveMap: LiveMap {
                     }
                 }
                 // RTLM6d2: Set the private flag createOperationIsMerged to true
-                createOperationIsMerged = true
+                liveObject.createOperationIsMerged = true
             }
         }
 

Sources/AblyLiveObjects/Internal/LiveObjectMutableState.swift

@@ -0,0 +1,11 @@
+/// This is the equivalent of the `LiveObject` abstract class described in RTLO.
+///
+/// ``DefaultLiveCounter`` and ``DefaultLiveMap`` include it by composition.
+internal struct LiveObjectMutableState {
+    // RTLO3a
+    internal var objectID: String
+    // RTLO3b
+    internal var siteTimeserials: [String: String] = [:]
+    // RTLO3c
+    internal var createOperationIsMerged = false
+}