Skip to content

Perform multiple upserts in a single transaction. #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbrandonw merged 7 commits into from
Sep 15, 2025
Merged

Perform multiple upserts in a single transaction. #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fbb8401
Perform multiple upserts in a single transaction.
mbrandonw Sep 15, 2025
522fa1c
wip
mbrandonw Sep 15, 2025
adfcfc6
Merge remote-tracking branch 'origin/cloudkit' into upsert-in-one-tra…
mbrandonw Sep 15, 2025
10f233b
wip
mbrandonw Sep 15, 2025
1ae31ba
Merge remote-tracking branch 'origin/cloudkit' into upsert-in-one-tra…
mbrandonw Sep 15, 2025
de6fda1
wip
mbrandonw Sep 15, 2025
9d2dc8e
wip
mbrandonw Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 80 additions & 69 deletions Sources/SQLiteData/CloudKit/SyncEngine.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1203,9 +1203,9 @@
for (recordType, recordIDs) in deletedRecordIDsByRecordType {
let recordPrimaryKeys = recordIDs.compactMap(\.recordPrimaryKey)
if let table = tablesByName[recordType] {
func open<T: PrimaryKeyedTable>(_: T.Type) {
withErrorReporting(.sqliteDataCloudKitFailure) {
try userDatabase.write { db in
func open<T: PrimaryKeyedTable & _SendableMetatype>(_: T.Type) async {
await withErrorReporting(.sqliteDataCloudKitFailure) {
try await userDatabase.write { db in
try T
.where {
$0.primaryKey.in(
Expand All @@ -1222,7 +1222,7 @@
}
}
}
open(table)
await open(table)
} else if recordType == CKRecord.SystemType.share {
for recordID in recordIDs {
await withErrorReporting(.sqliteDataCloudKitFailure) {
Expand Down Expand Up @@ -1286,17 +1286,24 @@
case share(CKShare)
case reference(CKShare.Reference)
}
var shares: [ShareOrReference] = []
for record in modifications {
if let share = record as? CKShare {
shares.append(.share(share))
} else {
await upsertFromServerRecord(record)
if let shareReference = record.share {
shares.append(.reference(shareReference))
let shares: [ShareOrReference] =
await withErrorReporting(.sqliteDataCloudKitFailure) {
try await userDatabase.write { db in
var shares: [ShareOrReference] = []
for record in modifications {
if let share = record as? CKShare {
shares.append(.share(share))
} else {
upsertFromServerRecord(record, db: db)
if let shareReference = record.share {
shares.append(.reference(shareReference))
}
}
}
return shares
}
}
}
?? []

await withTaskGroup(of: Void.self) { group in
for share in shares {
Expand Down Expand Up @@ -1524,93 +1531,97 @@
force: Bool = false
) async {
await withErrorReporting(.sqliteDataCloudKitFailure) {
try await userDatabase.write { db in
upsertFromServerRecord(serverRecord, force: force, db: db)
}
}
}

private func upsertFromServerRecord(
_ serverRecord: CKRecord,
force: Bool = false,
db: Database
) {
withErrorReporting(.sqliteDataCloudKitFailure) {
guard let table = tablesByName[serverRecord.recordType]
else {
guard let recordPrimaryKey = serverRecord.recordID.recordPrimaryKey
else { return }
try await userDatabase.write { db in
try SyncMetadata.insert {
SyncMetadata(
recordPrimaryKey: recordPrimaryKey,
recordType: serverRecord.recordType,
parentRecordPrimaryKey: serverRecord.parent?.recordID.recordPrimaryKey,
parentRecordType: serverRecord.parent?.recordID.tableName,
lastKnownServerRecord: serverRecord,
_lastKnownServerRecordAllFields: serverRecord,
share: nil,
try SyncMetadata.insert {
SyncMetadata(
recordPrimaryKey: recordPrimaryKey,
recordType: serverRecord.recordType,
parentRecordPrimaryKey: serverRecord.parent?.recordID.recordPrimaryKey,
parentRecordType: serverRecord.parent?.recordID.tableName,
lastKnownServerRecord: serverRecord,
_lastKnownServerRecordAllFields: serverRecord,
share: nil,
userModificationTime: serverRecord.userModificationTime
)
} onConflict: {
($0.recordPrimaryKey, $0.recordType)
} doUpdate: {
$0.setLastKnownServerRecord(serverRecord)
}
.execute(db)
)
} onConflict: {
($0.recordPrimaryKey, $0.recordType)
} doUpdate: {
$0.setLastKnownServerRecord(serverRecord)
}
.execute(db)
return
}

let metadata = try await metadatabase.read { db in
let metadata =
try SyncMetadata
.where { $0.recordName.eq(serverRecord.recordID.recordName) }
.fetchOne(db)
}
.where { $0.recordName.eq(serverRecord.recordID.recordName) }
.fetchOne(db)
serverRecord.userModificationTime =
metadata?.userModificationTime ?? serverRecord.userModificationTime

func open<T: PrimaryKeyedTable & _SendableMetatype>(_: T.Type) async throws {
func open<T: PrimaryKeyedTable & _SendableMetatype>(_: T.Type) throws {
let columnNames: [String]
if !force, let metadata, let allFields = metadata._lastKnownServerRecordAllFields {
columnNames = try await userDatabase.read { db in
var columnNames = T.TableColumns.writableColumns.map(\.name)
let row = try T.find(#sql("\(bind: metadata.recordPrimaryKey)")).fetchOne(db)
guard let row
else {
reportIssue(
"""
Local database record could not be found for '\(serverRecord.recordID.recordName)'.
"""
)
return columnNames
}
var _columnNames = T.TableColumns.writableColumns.map(\.name)
let row = try T.find(#sql("\(bind: metadata.recordPrimaryKey)")).fetchOne(db)
if let row {
serverRecord.update(
with: allFields,
row: T(queryOutput: row),
columnNames: &columnNames,
columnNames: &_columnNames,
parentForeignKey: foreignKeysByTableName[T.tableName]?.count == 1
? foreignKeysByTableName[T.tableName]?.first
: nil
)
return columnNames
} else {
reportIssue(
"""
Local database record could not be found for '\(serverRecord.recordID.recordName)'.
"""
)
}
columnNames = _columnNames
} else {
columnNames = T.TableColumns.writableColumns.map(\.name)
}

try await userDatabase.write { db in
do {
try #sql(upsert(T.self, record: serverRecord, columnNames: columnNames)).execute(db)
try UnsyncedRecordID.find(serverRecord.recordID).delete().execute(db)
try SyncMetadata
.where { $0.recordName.eq(serverRecord.recordID.recordName) }
.update { $0.setLastKnownServerRecord(serverRecord) }
.execute(db)
} catch {
guard
let error = error as? DatabaseError,
error.resultCode == .SQLITE_CONSTRAINT,
error.extendedResultCode == .SQLITE_CONSTRAINT_FOREIGNKEY
else {
throw error
}
try UnsyncedRecordID.insert(or: .ignore) {
UnsyncedRecordID(recordID: serverRecord.recordID)
}
do {
try #sql(upsert(T.self, record: serverRecord, columnNames: columnNames)).execute(db)
try UnsyncedRecordID.find(serverRecord.recordID).delete().execute(db)
try SyncMetadata
.where { $0.recordName.eq(serverRecord.recordID.recordName) }
.update { $0.setLastKnownServerRecord(serverRecord) }
.execute(db)
} catch {
guard
let error = error as? DatabaseError,
error.resultCode == .SQLITE_CONSTRAINT,
error.extendedResultCode == .SQLITE_CONSTRAINT_FOREIGNKEY
else {
throw error
}
try UnsyncedRecordID.insert(or: .ignore) {
UnsyncedRecordID(recordID: serverRecord.recordID)
}
.execute(db)
}
}
try await open(table)
try open(table)
}
}

Expand Down
12 changes: 6 additions & 6 deletions Tests/SQLiteDataTests/CloudKitTests/SharingTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:00:00.000Z) │
│ userModificationTime: 0 │
│ ) │
├─────────────────────────────────────────────────────────────────────────────────────────┤
│ SyncMetadata( │
Expand Down Expand Up @@ -412,7 +412,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:01:00.000Z) │
│ userModificationTime: 60 │
│ ) │
├─────────────────────────────────────────────────────────────────────────────────────────┤
│ SyncMetadata( │
Expand Down Expand Up @@ -441,7 +441,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:01:00.000Z) │
│ userModificationTime: 60 │
│ ) │
└─────────────────────────────────────────────────────────────────────────────────────────┘
"""
Expand Down Expand Up @@ -1105,7 +1105,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:00:00.000Z) │
│ userModificationTime: 0 │
│ ) │
├──────────────────────────────────────────────────────────────────────────────────────────────┤
│ SyncMetadata( │
Expand Down Expand Up @@ -1134,7 +1134,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:00:00.000Z) │
│ userModificationTime: 0 │
│ ) │
├──────────────────────────────────────────────────────────────────────────────────────────────┤
│ SyncMetadata( │
Expand Down Expand Up @@ -1167,7 +1167,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: true, │
│ userModificationDate: Date(1970-01-01T00:00:00.000Z) │
│ userModificationTime: 0 │
│ ) │
└──────────────────────────────────────────────────────────────────────────────────────────────┘
"""
Expand Down
4 changes: 2 additions & 2 deletions Tests/SQLiteDataTests/CloudKitTests/SyncEngineLifecycleTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: true, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:00:00.000Z) │
│ userModificationTime: 0 │
│ ) │
├───────────────────────────────────────────────────────────────────────────┤
│ SyncMetadata( │
Expand All @@ -312,7 +312,7 @@
│ _isDeleted: false, │
│ hasLastKnownServerRecord: false, │
│ isShared: false, │
│ userModificationDate: Date(1970-01-01T00:01:00.000Z) │
│ userModificationTime: 60 │
│ ) │
└───────────────────────────────────────────────────────────────────────────┘
"""
Expand Down
4 changes: 2 additions & 2 deletions Tests/SQLiteDataTests/Internal/BaseCloudKitTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,8 @@ extension SyncEngine {
convenience init(
container: any CloudContainer,
userDatabase: UserDatabase,
tables: [any PrimaryKeyedTable.Type],
privateTables: [any PrimaryKeyedTable.Type] = [],
tables: [any (PrimaryKeyedTable & _SendableMetatype).Type],
privateTables: [any (PrimaryKeyedTable & _SendableMetatype).Type] = [],
startImmediately: Bool = true
) async throws {
try self.init(
Expand Down