Replaces the app-local copies of the extracted storage core with the IndieSync 0.1.0 package (pinned from the new tag): ICloudFileManager -> DocumentFileStore + TombstoneStore, ICloudFileMonitor -> MetadataObserver (batched events with the content-date churn gate), and the shared ULID / DocumentCoder / Tombstone / VersionedDocument pieces. SyncEngine stays app-specific and is rewired onto the package types; documents rename currentSchema -> currentSchemaVersion to adopt the package protocol. ULID.make() remains as a shim minting the string form the app keys on. Behavior-preserving: identical JSON bytes (same coder config), same stub wire format (kind encodes as the same strings), same soft-delete ordering, same 30-day prune. WorkoutDocument keeps its local-calendar month bucketing rather than adopting TimeBucketedLayout's UTC paths -- changing derivation would strand existing files. The watch target links the package too (ULID + DocumentCoder via Shared); iOS, watchOS, and widget targets all build.
385 lines
16 KiB
Swift
385 lines
16 KiB
Swift
import Foundation
|
|
import IndieSync
|
|
import SwiftData
|
|
import Observation
|
|
import os
|
|
|
|
enum ICloudStatus: Equatable {
|
|
case checking
|
|
case available
|
|
case unavailable
|
|
}
|
|
|
|
/// Orchestrates the iCloud Drive file layer and the SwiftData cache. iCloud is
|
|
/// the sole source of truth: every save/delete writes files only; the metadata
|
|
/// observer (and the connect-time reconcile) is the sole mutator of the cache.
|
|
@Observable
|
|
@MainActor
|
|
final class SyncEngine {
|
|
nonisolated static let containerIdentifier = "iCloud.dev.rzen.indie.Workouts"
|
|
|
|
private(set) var iCloudStatus: ICloudStatus = .checking
|
|
private(set) var isSyncing = false
|
|
|
|
/// Last non-fatal sync failure, surfaced for the UI to render. Cleared on the
|
|
/// next successful write or full reconcile.
|
|
private(set) var lastSyncError: String?
|
|
|
|
/// Called after the cache changes (local or remote). The watch bridge uses
|
|
/// this to push fresh state to the watch.
|
|
var onCacheChanged: (() -> Void)?
|
|
|
|
/// Called when a completed workout is persisted. The HealthKit writer uses this to
|
|
/// schedule an estimated Health workout if nothing recorded it.
|
|
var onWorkoutCompleted: ((WorkoutDocument) -> Void)?
|
|
|
|
/// Called when a workout carrying watch-recorded metrics is persisted, so the
|
|
/// writer can cancel any pending phone estimate for it.
|
|
var onWatchMetricsArrived: ((String) -> Void)?
|
|
|
|
private let log = Logger(subsystem: "dev.rzen.indie.Workouts", category: "sync")
|
|
private let modelContainer: ModelContainer
|
|
private var store: DocumentFileStore?
|
|
private var tombstones: TombstoneStore?
|
|
private var monitor: MetadataObserver?
|
|
private var monitorTask: Task<Void, Never>?
|
|
private var connectAttempt = 0
|
|
|
|
/// How long `connect()` keeps polling for a still-provisioning iCloud
|
|
/// container before falling to the end-of-the-line gate. Deliberately long
|
|
/// (~10 min): as long as the user is signed into iCloud, a container that's
|
|
/// slow to come online should never be misreported as unavailable. Impatient
|
|
/// users bail sooner via the connecting screen's escape hatch (28s).
|
|
private static let connectTimeoutSeconds: TimeInterval = 600
|
|
|
|
private var context: ModelContext { modelContainer.mainContext }
|
|
|
|
init(container: ModelContainer) {
|
|
self.modelContainer = container
|
|
}
|
|
|
|
// MARK: - Connection (deferred, patient)
|
|
|
|
func connect() async {
|
|
guard iCloudStatus != .available else { return }
|
|
connectAttempt += 1
|
|
let attempt = connectAttempt
|
|
iCloudStatus = .checking
|
|
log.info("connect[\(attempt)]: resolving container \(Self.containerIdentifier, privacy: .public)")
|
|
|
|
// Definitive failure first: if the user isn't signed into iCloud at all,
|
|
// no container is ever coming — go straight to the end-of-the-line gate
|
|
// rather than spinning. (Signed-in-but-Drive-off still reports a token;
|
|
// that case falls through to the patient poll below and the escape hatch.)
|
|
let signedIn = await Task.detached {
|
|
FileManager.default.ubiquityIdentityToken != nil
|
|
}.value
|
|
guard attempt == connectAttempt else { return }
|
|
guard signedIn else {
|
|
log.error("connect[\(attempt)]: not signed into iCloud → unavailable")
|
|
iCloudStatus = .unavailable
|
|
return
|
|
}
|
|
|
|
// Signed in, but the container may still be provisioning — common right
|
|
// after enabling iCloud Drive. Keep polling patiently: we'd rather hold the
|
|
// spinner than misreport a working account as unavailable. We only give up
|
|
// after a considerable timeout; the user can bail sooner via the connecting
|
|
// screen's escape hatch (which bumps connectAttempt and stops this loop).
|
|
var resolved: URL?
|
|
let deadline = Date().addingTimeInterval(Self.connectTimeoutSeconds)
|
|
while resolved == nil {
|
|
let url = await Task.detached {
|
|
FileManager.default.url(forUbiquityContainerIdentifier: Self.containerIdentifier)
|
|
}.value
|
|
guard attempt == connectAttempt else { return }
|
|
if let url {
|
|
resolved = url
|
|
break
|
|
}
|
|
if Date() >= deadline {
|
|
log.error("connect[\(attempt)]: container still nil after \(Int(Self.connectTimeoutSeconds))s → unavailable")
|
|
iCloudStatus = .unavailable
|
|
return
|
|
}
|
|
log.info("connect[\(attempt)]: container nil — still provisioning, retrying")
|
|
try? await Task.sleep(for: .seconds(2))
|
|
guard attempt == connectAttempt else { return }
|
|
}
|
|
guard let containerURL = resolved else { return }
|
|
log.info("connect[\(attempt)]: container URL = \(containerURL.path, privacy: .public)")
|
|
|
|
let store = DocumentFileStore(root: containerURL.appendingPathComponent("Documents", isDirectory: true))
|
|
|
|
// Safety net only: prepareDirectories is a local op that effectively never
|
|
// blocks, but if the first container file op ever wedges we don't want an
|
|
// eternal spinner. This is generous — it isn't the connect path's clock.
|
|
let safety = Task { [weak self] in
|
|
try? await Task.sleep(for: .seconds(30))
|
|
guard let self, !Task.isCancelled else { return }
|
|
if self.iCloudStatus == .checking, attempt == self.connectAttempt {
|
|
self.log.error("connect[\(attempt)]: prepareDirectories wedged 30s → unavailable")
|
|
self.iCloudStatus = .unavailable
|
|
}
|
|
}
|
|
log.info("connect[\(attempt)]: preparing directories…")
|
|
await store.prepareDirectories(["Splits", "Workouts", "Stubs"])
|
|
safety.cancel()
|
|
guard attempt == connectAttempt else { return }
|
|
|
|
self.store = store
|
|
self.tombstones = TombstoneStore(store: store)
|
|
iCloudStatus = .available
|
|
log.info("connect[\(attempt)]: directories ready → available")
|
|
WorkoutsModelContainer.persistCurrentIdentityToken()
|
|
|
|
await reconcile()
|
|
startMonitoring(documentsURL: store.rootURL)
|
|
cleanupOldStubs()
|
|
}
|
|
|
|
/// Invoked from the connecting screen when the user chooses not to keep
|
|
/// waiting. Bumps `connectAttempt` to stop the in-flight poll loop, then drops
|
|
/// to the end-of-the-line gate (with its Try Again).
|
|
func abandonWaiting() {
|
|
guard iCloudStatus == .checking else { return }
|
|
connectAttempt += 1
|
|
iCloudStatus = .unavailable
|
|
log.info("connect: abandoned by user → unavailable")
|
|
}
|
|
|
|
// MARK: - Monitoring
|
|
|
|
private func startMonitoring(documentsURL: URL) {
|
|
monitorTask?.cancel()
|
|
let monitor = MetadataObserver(documentsURL: documentsURL)
|
|
self.monitor = monitor
|
|
monitor.start()
|
|
monitorTask = Task { [weak self] in
|
|
for await batch in monitor.events() {
|
|
await self?.handle(batch)
|
|
}
|
|
}
|
|
}
|
|
|
|
private func handle(_ batch: [FileChangeEvent]) async {
|
|
for event in batch {
|
|
switch event {
|
|
case .added(let path), .modified(let path):
|
|
if path.hasPrefix("Stubs/") {
|
|
deleteCachedEntity(id: idFromStubPath(path))
|
|
} else {
|
|
await importFile(relativePath: path)
|
|
}
|
|
case .removed(let path):
|
|
if !path.hasPrefix("Stubs/") {
|
|
deleteCachedEntity(jsonRelativePath: path)
|
|
}
|
|
}
|
|
}
|
|
do { try context.save() } catch { report("Cache save failed", error) }
|
|
onCacheChanged?()
|
|
}
|
|
|
|
/// Apply a workout received from the watch. iCloud Drive stays the source of
|
|
/// truth (we write the file), but we also upsert the cache directly here.
|
|
///
|
|
/// The phone's own edits drive a local view copy, so they don't need this — but a
|
|
/// watch-originated change has nothing else refreshing the phone UI, and a
|
|
/// same-process file overwrite doesn't reliably wake the `NSMetadataQuery`
|
|
/// observer. Upserting the doc we just wrote keeps cache and file consistent (the
|
|
/// observer re-applies idempotently if it does fire) and lets open phone screens
|
|
/// reflect watch progress live.
|
|
func ingestFromWatch(_ doc: WorkoutDocument) async {
|
|
await save(workout: doc)
|
|
CacheMapper.upsertWorkout(doc, relativePath: doc.relativePath, into: context)
|
|
do { try context.save() } catch { report("Cache save failed", error) }
|
|
onCacheChanged?()
|
|
}
|
|
|
|
// MARK: - Public CRUD (write path: files only)
|
|
|
|
func save(split doc: SplitDocument) async {
|
|
guard let store else { return }
|
|
do {
|
|
try await store.write(doc, to: doc.relativePath)
|
|
lastSyncError = nil
|
|
} catch {
|
|
report("Failed to save split", error)
|
|
}
|
|
// Cache updates reactively via the monitor.
|
|
}
|
|
|
|
func save(workout doc: WorkoutDocument) async {
|
|
guard let store else { return }
|
|
do {
|
|
try await store.write(doc, to: doc.relativePath)
|
|
lastSyncError = nil
|
|
} catch {
|
|
report("Failed to save workout", error)
|
|
}
|
|
// Drive the HealthKit writer: a watch-recorded doc cancels any pending estimate;
|
|
// a completed doc (re)considers an estimate (the writer dedupes on metrics).
|
|
if doc.metrics?.source == .watch { onWatchMetricsArrived?(doc.id) }
|
|
if doc.status == WorkoutStatus.completed.rawValue { onWorkoutCompleted?(doc) }
|
|
}
|
|
|
|
func delete(split: Split) async {
|
|
await softDelete(id: split.id, kind: "split", livePath: split.jsonRelativePath)
|
|
}
|
|
|
|
func delete(workout: Workout) async {
|
|
await softDelete(id: workout.id, kind: "workout", livePath: workout.jsonRelativePath)
|
|
}
|
|
|
|
/// Writes a tombstone stub then removes the live file. Other devices learn of
|
|
/// the delete via the stub even if they were offline for the file removal.
|
|
private func softDelete(id: String, kind: String, livePath: String) async {
|
|
guard let store, let tombstones else { return }
|
|
do {
|
|
try await tombstones.writeTombstone(Tombstone(id: id, deletedAt: Date(), kind: kind))
|
|
try await store.remove(at: livePath)
|
|
lastSyncError = nil
|
|
} catch {
|
|
report("Failed to delete \(id)", error)
|
|
}
|
|
}
|
|
|
|
// MARK: - Import / reconcile
|
|
|
|
private func importFile(relativePath: String) async {
|
|
guard let store, let tombstones else { return }
|
|
let data: Data
|
|
do {
|
|
data = try await store.readData(from: relativePath)
|
|
} catch {
|
|
// Includes eviction-download timeouts — log loudly, never silently
|
|
// treat an unreadable file as absent. The next monitor event or
|
|
// reconcile retries it.
|
|
log.error("import: read failed for \(relativePath, privacy: .public): \(error)")
|
|
report("Failed to read \(relativePath)", error)
|
|
return
|
|
}
|
|
|
|
if relativePath.hasPrefix("Splits/") {
|
|
guard let doc = try? DocumentCoder.decode(SplitDocument.self, from: data), doc.isReadable else { return }
|
|
if await tombstones.stubExists(id: doc.id) { try? await store.remove(at: relativePath); return }
|
|
CacheMapper.upsertSplit(doc, relativePath: relativePath, into: context)
|
|
} else if relativePath.hasPrefix("Workouts/") {
|
|
guard let doc = try? DocumentCoder.decode(WorkoutDocument.self, from: data), doc.isReadable else { return }
|
|
if await tombstones.stubExists(id: doc.id) { try? await store.remove(at: relativePath); return }
|
|
CacheMapper.upsertWorkout(doc, relativePath: relativePath, into: context)
|
|
}
|
|
}
|
|
|
|
/// Full sync against the current file set — imports new/changed files and
|
|
/// prunes entities whose file is gone or tombstoned. Runs on connect so
|
|
/// changes accumulated while the app was closed are picked up.
|
|
private func reconcile() async {
|
|
guard let store, let tombstones else { return }
|
|
isSyncing = true
|
|
defer { isSyncing = false }
|
|
|
|
// IDs from stub filenames, not stub contents — an evicted stub must
|
|
// still count as a tombstone or the deleted record resurrects.
|
|
let tombstoned = await tombstones.listStubIDs()
|
|
let dataFiles = await store.list().filter { !$0.hasPrefix("Stubs/") }
|
|
|
|
var liveSplitIDs = Set<String>()
|
|
var liveWorkoutIDs = Set<String>()
|
|
var unreadablePaths = Set<String>()
|
|
|
|
for path in dataFiles {
|
|
let data: Data
|
|
do {
|
|
data = try await store.readData(from: path)
|
|
} catch {
|
|
// A failed read (eviction-download timeout, coordination error)
|
|
// is not proof the record is gone — remember the path so the
|
|
// prune below keeps its cache entity. Skipping silently here is
|
|
// how evicted records used to vanish on storage-constrained
|
|
// devices.
|
|
log.error("reconcile: read failed for \(path, privacy: .public): \(error)")
|
|
report("Failed to read \(path)", error)
|
|
unreadablePaths.insert(path)
|
|
continue
|
|
}
|
|
if path.hasPrefix("Splits/") {
|
|
guard let doc = try? DocumentCoder.decode(SplitDocument.self, from: data), doc.isReadable else { continue }
|
|
if tombstoned.contains(doc.id) { try? await store.remove(at: path); continue }
|
|
CacheMapper.upsertSplit(doc, relativePath: path, into: context)
|
|
liveSplitIDs.insert(doc.id)
|
|
} else if path.hasPrefix("Workouts/") {
|
|
guard let doc = try? DocumentCoder.decode(WorkoutDocument.self, from: data), doc.isReadable else { continue }
|
|
if tombstoned.contains(doc.id) { try? await store.remove(at: path); continue }
|
|
CacheMapper.upsertWorkout(doc, relativePath: path, into: context)
|
|
liveWorkoutIDs.insert(doc.id)
|
|
}
|
|
}
|
|
|
|
// Prune cache entities no longer backed by a live file — but never for
|
|
// a path that failed to read this pass (it may just be un-downloadable
|
|
// right now; pruning would make an eviction look like a deletion).
|
|
if let splits = try? context.fetch(FetchDescriptor<Split>()) {
|
|
for s in splits where !liveSplitIDs.contains(s.id) && !unreadablePaths.contains(s.jsonRelativePath) {
|
|
context.delete(s)
|
|
}
|
|
}
|
|
if let workouts = try? context.fetch(FetchDescriptor<Workout>()) {
|
|
for w in workouts where !liveWorkoutIDs.contains(w.id) && !unreadablePaths.contains(w.jsonRelativePath) {
|
|
context.delete(w)
|
|
}
|
|
}
|
|
do {
|
|
try context.save()
|
|
// A fully clean pass supersedes any earlier failure; a pass with
|
|
// unreadable files keeps its own report visible.
|
|
if unreadablePaths.isEmpty { lastSyncError = nil }
|
|
} catch {
|
|
report("Cache save failed", error)
|
|
}
|
|
onCacheChanged?()
|
|
}
|
|
|
|
// MARK: - Cache deletes
|
|
|
|
private func deleteCachedEntity(id: String) {
|
|
if let s = CacheMapper.fetchSplit(id: id, in: context) { context.delete(s) }
|
|
if let w = CacheMapper.fetchWorkout(id: id, in: context) { context.delete(w) }
|
|
}
|
|
|
|
private func deleteCachedEntity(jsonRelativePath path: String) {
|
|
if let splits = try? context.fetch(FetchDescriptor<Split>(predicate: #Predicate { $0.jsonRelativePath == path })) {
|
|
splits.forEach(context.delete)
|
|
}
|
|
if let workouts = try? context.fetch(FetchDescriptor<Workout>(predicate: #Predicate { $0.jsonRelativePath == path })) {
|
|
workouts.forEach(context.delete)
|
|
}
|
|
}
|
|
|
|
private func idFromStubPath(_ path: String) -> String {
|
|
(path as NSString).lastPathComponent.replacingOccurrences(of: ".json", with: "")
|
|
}
|
|
|
|
// MARK: - Maintenance
|
|
|
|
private func cleanupOldStubs() {
|
|
guard let tombstones else { return }
|
|
Task.detached(priority: .utility) {
|
|
// Downloads evicted stubs to read their deletedAt, prunes past the
|
|
// 30-day grace period.
|
|
try? await tombstones.prune()
|
|
}
|
|
}
|
|
|
|
// MARK: - Error Reporting
|
|
|
|
/// Record a non-fatal sync failure: log it and publish it as `lastSyncError`
|
|
/// for the UI to render. Replaces silent `try?` / print-only handling.
|
|
private func report(_ message: String, _ error: Error? = nil) {
|
|
let full = error.map { "\(message): \($0.localizedDescription)" } ?? message
|
|
print("[Sync] \(full)")
|
|
lastSyncError = full
|
|
}
|
|
}
|