Structurally enforce ID-based deduplication in MockSyncEngineState

Author: jsutula

Sources/SQLiteData/CloudKit/Internal/MockSyncEngine.swift

@@ -136,12 +136,12 @@
   package final class MockSyncEngineState: CKSyncEngineStateProtocol {
     package let changeTag = LockIsolated(0)
     package let _pendingRecordZoneChanges = LockIsolated<
-      OrderedSet<CKSyncEngine.PendingRecordZoneChange>
-    >([]
+      OrderedDictionary<CKRecord.ID, CKSyncEngine.PendingRecordZoneChange>
+    >([:]
     )
     package let _pendingDatabaseChanges = LockIsolated<
-      OrderedSet<CKSyncEngine.PendingDatabaseChange>
-    >([])
+      OrderedDictionary<CKRecordZone.ID, CKSyncEngine.PendingDatabaseChange>
+    >([:])
     private let fileID: StaticString
     private let filePath: StaticString
     private let line: UInt
@@ -160,11 +160,11 @@
     }
 
     package var pendingRecordZoneChanges: [CKSyncEngine.PendingRecordZoneChange] {
-      _pendingRecordZoneChanges.withValue { Array($0) }
+      _pendingRecordZoneChanges.withValue { Array($0.values) }
     }
 
     package var pendingDatabaseChanges: [CKSyncEngine.PendingDatabaseChange] {
-      _pendingDatabaseChanges.withValue { Array($0) }
+      _pendingDatabaseChanges.withValue { Array($0.values) }
     }
 
     package func removePendingChanges() {
@@ -173,40 +173,58 @@
     }
 
     package func add(pendingRecordZoneChanges: [CKSyncEngine.PendingRecordZoneChange]) {
-      self._pendingRecordZoneChanges.withValue { set in
+      self._pendingRecordZoneChanges.withValue { dict in
         for change in pendingRecordZoneChanges {
-          if let id = change.id,
-             let supersededIndex = set.firstIndex(where: { $0.id == id && $0 != change })
-          {
-            set.remove(at: supersededIndex)
+          switch change {
+          case .saveRecord(let id), .deleteRecord(let id):
+            dict.updateValue(change, forKey: id)
+          @unknown default:
+            fatalError("Unsupported pendingRecordZoneChange: \(change)")
           }
-          set.append(change)
         }
       }
     }
 
     package func remove(pendingRecordZoneChanges: [CKSyncEngine.PendingRecordZoneChange]) {
-      self._pendingRecordZoneChanges.withValue {
-        $0.subtract(pendingRecordZoneChanges)
+      self._pendingRecordZoneChanges.withValue { dict in
+        for change in pendingRecordZoneChanges {
+          switch change {
+          case .saveRecord(let id), .deleteRecord(let id):
+            if dict[id] == change { dict.removeValue(forKey: id) }
+          @unknown default:
+            fatalError("Unsupported pendingRecordZoneChange: \(change)")
+          }
+        }
       }
     }
 
     package func add(pendingDatabaseChanges: [CKSyncEngine.PendingDatabaseChange]) {
-      self._pendingDatabaseChanges.withValue { set in
+      self._pendingDatabaseChanges.withValue { dict in
         for change in pendingDatabaseChanges {
-          if let zoneID = change.zoneID,
-            let supersededIndex = set.firstIndex(where: { $0.zoneID == zoneID && $0 != change })
-          {
-            set.remove(at: supersededIndex)
+          switch change {
+          case .saveZone(let zone):
+            dict.updateValue(change, forKey: zone.zoneID)
+          case .deleteZone(let zoneID):
+            dict.updateValue(change, forKey: zoneID)
+          @unknown default:
+            fatalError("Unsupported pendingDatabaseChange: \(change)")
           }
-          set.append(change)
         }
       }
     }
 
     package func remove(pendingDatabaseChanges: [CKSyncEngine.PendingDatabaseChange]) {
-      self._pendingDatabaseChanges.withValue {
-        $0.subtract(pendingDatabaseChanges)
+      self._pendingDatabaseChanges.withValue { dict in
+        for change in pendingDatabaseChanges {
+          switch change {
+          case .saveZone(let zone):
+            if dict[zone.zoneID] == change { dict.removeValue(forKey: zone.zoneID) }
+          case .deleteZone(let zoneID):
+            if dict[zoneID] == change { dict.removeValue(forKey: zoneID) }
+          @unknown default:
+            fatalError("Unsupported pendingDatabaseChange: \(change)")
+          }
+        }
       }
     }
   }

Sources/SQLiteData/CloudKit/SyncEngine.swift

@@ -2092,20 +2092,6 @@
     }
   }
 
-  @available(macOS 14, iOS 17, tvOS 17, watchOS 10, *)
-  extension CKSyncEngine.PendingDatabaseChange {
-    var zoneID: CKRecordZone.ID? {
-      switch self {
-      case .saveZone(let zone):
-        return zone.zoneID
-      case .deleteZone(let zoneID):
-        return zoneID
-      @unknown default:
-        return nil
-      }
-    }
-  }
-
   extension CKRecord.ID {
     var tableName: String? {
       guard

Tests/SQLiteDataTests/CloudKitTests/MockSyncEngineStateTests.swift

@@ -47,7 +47,7 @@
       @Test func crossTypeSupersession_doesNotAffectOtherRecords() {
         state.add(pendingRecordZoneChanges: [.saveRecord(idA), .saveRecord(idB)])
         state.add(pendingRecordZoneChanges: [.deleteRecord(idA)])
-        #expect(state.pendingRecordZoneChanges == [.saveRecord(idB), .deleteRecord(idA)])
+        #expect(state.pendingRecordZoneChanges == [.deleteRecord(idA), .saveRecord(idB)])
       }
     }
 
@@ -91,7 +91,7 @@
       @Test func crossTypeSupersession_doesNotAffectOtherZones() {
         state.add(pendingDatabaseChanges: [.saveZone(zoneA), .saveZone(zoneB)])
         state.add(pendingDatabaseChanges: [.deleteZone(zoneAID)])
-        #expect(state.pendingDatabaseChanges == [.saveZone(zoneB), .deleteZone(zoneAID)])
+        #expect(state.pendingDatabaseChanges == [.deleteZone(zoneAID), .saveZone(zoneB)])
       }
     }
   }

Tests/SQLiteDataTests/Internal/CloudKit+CustomDump.swift

@@ -1,6 +1,7 @@
 #if canImport(CloudKit)
   import CustomDump
   import CloudKit
+  import OrderedCollections
   import SQLiteData
 
   extension CKDatabase.Scope: @retroactive CustomDumpStringConvertible {
@@ -169,13 +170,13 @@
         children: [
           (
             "pendingRecordZoneChanges",
-            _pendingRecordZoneChanges.withValue(\.self)
+            _pendingRecordZoneChanges.withValue { Array($0.values) }
               .sorted(by: comparePendingRecordZoneChange)
               as Any
           ),
           (
             "pendingDatabaseChanges",
-            _pendingDatabaseChanges.withValue(\.self)
+            _pendingDatabaseChanges.withValue { Array($0.values) }
               .sorted(by: comparePendingDatabaseChange) as Any
           ),
         ],

Tests/SQLiteDataTests/Internal/CloudKitTestHelpers.swift

@@ -164,7 +164,7 @@ extension MockSyncEngineState {
     _pendingRecordZoneChanges.withValue {
       expectNoDifference(
         Set(changes),
-        Set($0),
+        Set($0.values),
         fileID: fileID,
         filePath: filePath,
         line: line,
@@ -184,7 +184,7 @@ extension MockSyncEngineState {
     _pendingDatabaseChanges.withValue {
       expectNoDifference(
         Set(changes),
-        Set($0),
+        Set($0.values),
         fileID: fileID,
         filePath: filePath,
         line: line,