Review feedback

Author: simolus3

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.14.0 (unreleased)
 
 * Add `opDataTyped` and `previousValuesTyped` to `CrudEntry`, providing typed values instead of strings.
+* Make `CrudBatch`, `CrudEntry` and `CrudTransaction` a concrete struct. Note that these can no longer be created in user code.
 
 ## 1.13.1
 

Sources/PowerSync/Protocol/db/CrudBatch.swift

@@ -19,16 +19,9 @@ public struct CrudBatch: Sendable {
     /// Call to remove the changes from the local queue, once successfully uploaded.
     ///
     /// `writeCheckpoint` is optional.
-    public func complete(writeCheckpoint: String?) async throws {
+    public func complete(writeCheckpoint: String? = nil) async throws {
         let lastId = crud.last!.clientId
-        try await completeCrudItems(self.db, lastId)
-    }
-
-    /// Call to remove the changes from the local queue, once successfully uploaded.
-    public func complete() async throws {
-        try await self.complete(
-            writeCheckpoint: nil
-        )
+        try await completeCrudItems(self.db, lastId, writeCheckpoint: writeCheckpoint)
     }
 }
 

Sources/PowerSync/Protocol/db/CrudEntry.swift

@@ -112,7 +112,10 @@ public struct CrudEntry: Sendable {
         }
 
         let decoder = JSONDecoder()
-        let entry = try decoder.decode(CrudJsonEntry.self, from: data.data(using: .utf8)!)
+        guard let jsonData = data.data(using: .utf8) else {
+            throw PowerSyncError.operationFailed(message: "Invalid UTF-8 in CRUD entry")
+        }
+        let entry = try decoder.decode(CrudJsonEntry.self, from: jsonData)
 
         return CrudEntry(
             id: entry.id,
@@ -128,7 +131,9 @@ public struct CrudEntry: Sendable {
     }
 
     private static func jsonValueToString(_ value: JsonValue?) throws -> String? {
-        try value.map { value in
+        // Older versions of the SDK were only able to export these values as strings, so we convert for
+        // backwards compatibility.
+        try value.flatMap { value in
             switch (value) {
             case .string(let value):
                 return value
@@ -139,7 +144,7 @@ public struct CrudEntry: Sendable {
             case .bool(let value):
                 return String(value)
             case .null:
-                return "null"
+                return nil
             case .array(_), .object(_):
                 throw PowerSyncError.operationFailed(message: "Invalid array/object in CRUD data, should be string")
             }

Tests/PowerSyncTests/CrudTests.swift

@@ -318,4 +318,19 @@ final class CrudTests: XCTestCase {
         XCTAssertEqual(write.opData?["name"], "updated_name")
         XCTAssertEqual(write.previousValues?["name"], "user")
     }
+
+    func testCustomWriteCheckpoints() async throws {
+        try await database.execute(
+            sql: "INSERT INTO users (id, name) VALUES (uuid(), 'a')",
+            parameters: []
+        )
+
+        let tx = try await database.getNextCrudTransaction()!
+        try await tx.complete(writeCheckpoint: "123")
+
+        let targetOp = try await database.get("SELECT target_op FROM ps_buckets WHERE name = '$local'") {
+            try $0.getInt(index: 0)
+        }
+        XCTAssertEqual(targetOp, 123)
+    }
 }