Repository Public
1import CryptoKit2import Foundation34/// What a sync cycle did, for the account screen and for tests.5struct SyncReport: Equatable, Sendable {6 var pulled = 07 var pushed = 08 var conflictsResolved = 09 var changedCollections: Set<String> = []10}1112enum SyncFailure: Error, Equatable, Sendable {13 /// No account key on this device yet (waiting for approval or for the recovery key).14 case keyUnavailable15 /// The key on this device does not match the account's (the server data was reset with another key).16 case keyMismatch17 case notSignedIn18}1920/// Decides what survives when two devices changed the same record.21enum SyncMerge {22 /// Returns the merged JSON and whether it differs from the remote version (and so must be sent back).23 static func merge(collection: String, local: SyncRecord, remoteJSON: Data, remoteModifiedAt: Date) -> (json: Data, modifiedAt: Date, differsFromRemote: Bool) {24 if collection == SyncCollection.history,25 let a = try? SyncDatabase.decoder.decode(HistorySyncItem.self, from: local.json),26 let b = try? SyncDatabase.decoder.decode(HistorySyncItem.self, from: remoteJSON) {27 // Visits are facts from both devices: keep the latest visit and the larger count.28 let newer = a.lastVisit >= b.lastVisit ? a : b29 let merged = HistorySyncItem(url: b.url, title: newer.title.isEmpty ? (a.title.isEmpty ? b.title : a.title) : newer.title,30 lastVisit: max(a.lastVisit, b.lastVisit), visitCount: max(a.visitCount, b.visitCount))31 let json = (try? SyncDatabase.encoder.encode(merged)) ?? remoteJSON32 return (json, max(local.modifiedAt, remoteModifiedAt), merged != b)33 }34 if collection == SyncCollection.searches,35 let a = try? SyncDatabase.decoder.decode(SearchHistoryItem.self, from: local.json),36 let b = try? SyncDatabase.decoder.decode(SearchHistoryItem.self, from: remoteJSON) {37 let merged = SearchHistoryItem(query: b.query, lastUsed: max(a.lastUsed, b.lastUsed), count: max(a.count, b.count))38 let json = (try? SyncDatabase.encoder.encode(merged)) ?? remoteJSON39 return (json, max(local.modifiedAt, remoteModifiedAt), merged != b)40 }41 // Everything else: the most recent edit wins; on a tie the server's version stands.42 if local.modifiedAt > remoteModifiedAt { return (local.json, local.modifiedAt, true) }43 return (remoteJSON, remoteModifiedAt, false)44 }45}4647/// Incremental, end-to-end encrypted synchronization of the local mirror with SP Sync.48/// One cycle = pull everything after the cursor, merge, then push what is dirty. Safe to interrupt at any point:49/// the cursor only advances after a page is applied, and dirty flags only clear when the server confirms.50actor SyncEngine {51 private let database: SyncDatabase52 private let backend: BackendClient53 private let accountKey: @Sendable () -> SymmetricKey?54 private var running = false55 /// Number of records where a local change met a different remote version during the current cycle.56 private var merges = 05758 init(database: SyncDatabase, backend: BackendClient, accountKey: @escaping @Sendable () -> SymmetricKey?) {59 self.database = database60 self.backend = backend61 self.accountKey = accountKey62 }6364 // Wire format65 private struct Envelope: Codable { var k: String; var m: Double; var v: String }66 private struct PullResponse: Decodable, Sendable {67 struct Change: Decodable, Sendable { var collection: String; var id: String; var seq: Int; var deleted: Bool; var payload: String; var keyVersion: Int }68 var changes: [Change]; var next: Int; var latest: Int; var more: Bool69 }70 private struct PushChange: Encodable, Sendable { var collection: String; var id: String; var baseSeq: Int; var deleted: Bool; var payload: String?; var keyVersion: Int }71 private struct PushRequest: Encodable, Sendable { var changes: [PushChange] }72 private struct PushResponse: Decodable, Sendable {73 struct Applied: Decodable, Sendable { var collection: String; var id: String; var seq: Int }74 struct Conflict: Decodable, Sendable { var collection: String; var id: String; var seq: Int; var deleted: Bool; var payload: String; var keyVersion: Int }75 var applied: [Applied]; var conflicts: [Conflict]; var latest: Int76 }77 private struct KeyState: Decodable, Sendable { var initialized: Bool; var keyCheck: String? }7879 @discardableResult80 func sync() async throws -> SyncReport {81 guard !running else { return SyncReport() }82 running = true83 defer { running = false }84 guard let key = accountKey() else { throw SyncFailure.keyUnavailable }8586 // A different verifier means the account's data was re-created with another key: start over rather than mix them.87 let state: KeyState = try await backend.send("GET", "/api/sync/keys")88 guard state.initialized, let check = state.keyCheck else { throw SyncFailure.keyUnavailable }89 guard check == SyncCrypto.keyCheck(key) else { throw SyncFailure.keyMismatch }90 if database.meta("keyCheck") != check {91 database.resetServerState()92 database.setMeta("keyCheck", check)93 }9495 var report = SyncReport()96 merges = 097 try await pull(key: key, into: &report)98 for _ in 0..<4 {99 let conflicts = try await push(key: key, into: &report)100 if conflicts == 0 { break }101 }102 database.setMeta("lastSync", String(Date().timeIntervalSince1970))103 report.conflictsResolved = merges104 return report105 }106107 private func pull(key: SymmetricKey, into report: inout SyncReport) async throws {108 while true {109 try Task.checkCancellation()110 let page: PullResponse = try await backend.send("GET", "/api/sync/pull?since=\(database.cursor)&limit=500")111 for change in page.changes {112 if apply(collection: change.collection, id: change.id, seq: change.seq, deleted: change.deleted, payload: change.payload,113 keyVersion: change.keyVersion, key: key, conflict: false) {114 report.pulled += 1115 report.changedCollections.insert(change.collection)116 }117 }118 database.cursor = page.next119 if !page.more { break }120 }121 }122123 /// Applies one server version. Returns true when local data changed.124 private func apply(collection: String, id: String, seq: Int, deleted: Bool, payload: String, keyVersion: Int, key: SymmetricKey, conflict: Bool) -> Bool {125 if deleted {126 guard let local = database.record(collection, remoteID: id) else { return false }127 // A local edit made after we last saw the record outlives a remote deletion; anything else is removed.128 if local.dirty, !local.deleted, local.serverSeq < seq {129 database.rebase(collection, key: local.key, seq: seq, remoteID: id)130 return false131 }132 database.applyRemoteDeletion(collection, key: local.key)133 return true134 }135 guard let plaintext = try? SyncCrypto.open(payload, collection: collection, id: id, accountKey: key, version: keyVersion),136 let envelope = try? JSONDecoder().decode(Envelope.self, from: plaintext) else {137 return false // unreadable (another key version, corruption): leave local data alone138 }139 let remoteJSON = Data(envelope.v.utf8), remoteDate = Date(timeIntervalSince1970: envelope.m)140 if let local = database.record(collection, key: envelope.k), local.dirty {141 if local.deleted {142 // Local deletion against a remote edit: the more recent action wins.143 if local.modifiedAt >= remoteDate { database.rebase(collection, key: local.key, seq: seq, remoteID: id); return false }144 database.applyRemote(collection, key: envelope.k, json: remoteJSON, modifiedAt: remoteDate, seq: seq, remoteID: id)145 return true146 }147 let merged = SyncMerge.merge(collection: collection, local: local, remoteJSON: remoteJSON, remoteModifiedAt: remoteDate)148 if local.json != remoteJSON { merges += 1 }149 database.applyRemote(collection, key: envelope.k, json: merged.json, modifiedAt: merged.modifiedAt, seq: seq, remoteID: id, dirty: merged.differsFromRemote)150 return merged.json != local.json151 }152 if let local = database.record(collection, key: envelope.k), local.serverSeq >= seq, !conflict { return false }153 database.applyRemote(collection, key: envelope.k, json: remoteJSON, modifiedAt: remoteDate, seq: seq, remoteID: id)154 return true155 }156157 /// Pushes dirty records in batches. Returns the number of conflicts that were merged and re-queued.158 private func push(key: SymmetricKey, into report: inout SyncReport) async throws -> Int {159 var conflictCount = 0160 var attempted = Set<String>()161 while true {162 try Task.checkCancellation()163 let batch = database.dirty(limit: 200).filter { !attempted.contains($0.collection + "\u{0}" + $0.key) }164 guard !batch.isEmpty else { break }165 var byRemote: [String: SyncRecord] = [:]166 var changes: [PushChange] = []167 for record in batch {168 attempted.insert(record.collection + "\u{0}" + record.key)169 let remoteID = record.remoteID ?? SyncCrypto.recordID(for: record.key, collection: record.collection, accountKey: key)170 byRemote[record.collection + "|" + remoteID] = record171 if record.deleted {172 changes.append(PushChange(collection: record.collection, id: remoteID, baseSeq: record.serverSeq, deleted: true, payload: nil, keyVersion: SyncCrypto.keyVersion))173 } else {174 let envelope = Envelope(k: record.key, m: record.modifiedAt.timeIntervalSince1970, v: String(decoding: record.json, as: UTF8.self))175 guard let plaintext = try? JSONEncoder().encode(envelope),176 let sealed = try? SyncCrypto.seal(plaintext, collection: record.collection, id: remoteID, accountKey: key) else { continue }177 changes.append(PushChange(collection: record.collection, id: remoteID, baseSeq: record.serverSeq, deleted: false, payload: sealed, keyVersion: SyncCrypto.keyVersion))178 }179 }180 guard !changes.isEmpty else { break }181 let response: PushResponse = try await backend.send("POST", "/api/sync/push", body: PushRequest(changes: changes))182 for applied in response.applied {183 guard let record = byRemote[applied.collection + "|" + applied.id] else { continue }184 database.markPushed(record, remoteID: applied.id, seq: applied.seq)185 report.pushed += 1186 }187 for conflict in response.conflicts {188 conflictCount += 1189 if apply(collection: conflict.collection, id: conflict.id, seq: conflict.seq, deleted: conflict.deleted, payload: conflict.payload,190 keyVersion: conflict.keyVersion, key: key, conflict: true) {191 report.changedCollections.insert(conflict.collection)192 } else if let record = byRemote[conflict.collection + "|" + conflict.id], database.record(record.collection, key: record.key)?.serverSeq != conflict.seq {193 // Unreadable remote version: our copy is the only usable one, write it on top.194 database.rebase(record.collection, key: record.key, seq: conflict.seq, remoteID: conflict.id)195 }196 }197 }198 return conflictCount199 }200}201