Encode vector as string for RevisionRecord

Author: cbaker6

Sources/ParseCareKit/Models/PCKClock.swift

@@ -46,8 +46,12 @@ public struct PCKClock: ParseObject {
         return updated
     }
 
-    func decodeClock() throws -> OCKRevisionRecord.KnowledgeVector {
-        guard let data = self.vector?.data(using: .utf8) else {
+    static func decodeVector(_ clock: Self) throws -> OCKRevisionRecord.KnowledgeVector {
+        try decodeVector(clock.vector)
+    }
+
+    static func decodeVector(_ vector: String?) throws -> OCKRevisionRecord.KnowledgeVector {
+        guard let data = vector?.data(using: .utf8) else {
             let errorString = "Could not get data as utf8"
             if #available(iOS 14.0, watchOS 7.0, *) {
                 Logger.clock.error("\(errorString)")
@@ -74,15 +78,22 @@ public struct PCKClock: ParseObject {
         }
     }
 
-    func encodeClock(_ clock: OCKRevisionRecord.KnowledgeVector) -> Self? {
+    static func encodeVector(_ vector: OCKRevisionRecord.KnowledgeVector, for clock: Self) -> Self? {
+        guard let cloudVectorString = encodeVector(vector) else {
+            return nil
+        }
+        var mutableClock = clock
+        mutableClock.vector = cloudVectorString
+        return mutableClock
+    }
+
+    static func encodeVector(_ vector: OCKRevisionRecord.KnowledgeVector) -> String? {
         do {
-            let json = try JSONEncoder().encode(clock)
+            let json = try JSONEncoder().encode(vector)
             guard let cloudVectorString = String(data: json, encoding: .utf8) else {
                 return nil
             }
-            var mutableClock = self
-            mutableClock.vector = cloudVectorString
-            return mutableClock
+            return cloudVectorString
         } catch {
             if #available(iOS 14.0, watchOS 7.0, *) {
                 Logger.clock.error("Clock.encodeClock(): \(error.localizedDescription, privacy: .private).")
@@ -156,7 +167,7 @@ public struct PCKClock: ParseObject {
             switch result {
 
             case .success(let foundVector):
-                completion(foundVector, try? foundVector.decodeClock(), nil)
+                completion(foundVector, try? decodeVector(foundVector), nil)
             case .failure(let error):
                 if !createNewIfNeeded {
                     completion(nil, nil, error)
@@ -169,7 +180,7 @@ public struct PCKClock: ParseObject {
                             updatedVector.create(callbackQueue: ParseRemote.queue) { result in
                                 switch result {
                                 case .success(let savedVector):
-                                    completion(savedVector, try? updatedVector.decodeClock(), nil)
+                                    completion(savedVector, try? decodeVector(updatedVector), nil)
                                 case .failure(let error):
                                     completion(nil, nil, error)
                                 }

Sources/ParseCareKit/Models/PCKRevisionRecord.swift

@@ -42,7 +42,20 @@ struct PCKRevisionRecord: ParseObject, Equatable, Codable {
 
     /// A knowledge vector indicating the last known state of each other device
     /// by the device that authored this revision record.
-    var knowledgeVector: OCKRevisionRecord.KnowledgeVector?
+    var knowledgeVector: OCKRevisionRecord.KnowledgeVector? {
+        get {
+            try? PCKClock.decodeVector(vector)
+        }
+        set {
+            guard let newValue = newValue else {
+                vector = nil
+                return
+            }
+            vector = PCKClock.encodeVector(newValue)
+        }
+    }
+
+    public var vector: String?
 
     var objects: [any PCKVersionable] {
         guard let entities = entities else {
@@ -95,7 +108,7 @@ struct PCKRevisionRecord: ParseObject, Equatable, Codable {
 
     enum CodingKeys: String, CodingKey {
         case objectId, createdAt, updatedAt, className,
-             ACL, knowledgeVector, entities,
+             ACL, vector, entities,
              logicalClock, clock, clockUUID
     }
 
@@ -203,8 +216,7 @@ extension PCKRevisionRecord {
         self.createdAt = try container.decodeIfPresent(Date.self, forKey: .createdAt)
         self.updatedAt = try container.decodeIfPresent(Date.self, forKey: .updatedAt)
         self.ACL = try container.decodeIfPresent(ParseACL.self, forKey: .ACL)
-        self.knowledgeVector = try container.decodeIfPresent(OCKRevisionRecord.KnowledgeVector.self,
-                                                             forKey: .knowledgeVector)
+        self.vector = try container.decodeIfPresent(String.self, forKey: .vector)
         self.entities = try container.decodeIfPresent([PCKEntity].self, forKey: .entities)
         self.clock = try container.decodeIfPresent(PCKClock.self, forKey: .clock)
         self.logicalClock = try container.decodeIfPresent(Int.self, forKey: .logicalClock)
@@ -218,7 +230,7 @@ extension PCKRevisionRecord {
         try container.encodeIfPresent(createdAt, forKey: .createdAt)
         try container.encodeIfPresent(updatedAt, forKey: .updatedAt)
         try container.encodeIfPresent(ACL, forKey: .ACL)
-        try container.encodeIfPresent(knowledgeVector, forKey: .knowledgeVector)
+        try container.encodeIfPresent(vector, forKey: .vector)
         try container.encodeIfPresent(entities, forKey: .entities)
         try container.encodeIfPresent(clock, forKey: .clock)
         try container.encodeIfPresent(logicalClock, forKey: .logicalClock)

Sources/ParseCareKit/ParseRemote.swift

@@ -522,7 +522,7 @@ public class ParseRemote: OCKRemoteSynchronizable {
             }
             cloudVector.merge(with: localClock)
 
-            guard let updatedClock = parseClock.encodeClock(cloudVector) else {
+            guard let updatedClock = PCKClock.encodeVector(cloudVector, for: parseClock) else {
                 await self.remoteStatus.setNotSynchronzing()
                 completion(ParseCareKitError.couldntUnwrapClock)
                 return

Tests/ParseCareKitTests/EncodingCareKitTests.swift

@@ -1266,7 +1266,7 @@ class ParseCareKitTests: XCTestCase {
         let entity = OCKEntity.patient(careKit)
         let remoteUUID = UUID()
         let clock = PCKClock(uuid: remoteUUID)
-        let clockVector = try clock.decodeClock()
+        let clockVector = try PCKClock.decodeVector(clock)
         let logicalClockValue = clockVector.clock(for: remoteUUID)
         let careKitRecord = OCKRevisionRecord(entities: [entity], knowledgeVector: clockVector)
 
@@ -1295,7 +1295,7 @@ class ParseCareKitTests: XCTestCase {
         }
 
         // Test PCKRevisionRecord encoding/decoding to Parse Server
-        let encoded = try ParseCoding.jsonEncoder().encode(parseRecord)
+        let encoded = try ParseCoding.parseEncoder().encode(parseRecord)
         let decoded = try ParseCoding.jsonDecoder().decode(PCKRevisionRecord.self, from: encoded)
         guard let decodedEntities = decoded.entities else {
             XCTFail("Should have unwrapped")