Repository Public
1// SP Notes Core2// File: Tests/SPNotesSyncTests/RandomConvergenceTests.swift3// Description: Randomised convergence test of the synchronisation engine: seeded, reproducible sequences of edits on two devices4// with random sync points, faults (lost answers, refused requests, network loss) and app restarts. At the end both5// stores and the server must hold the same pages, and every piece of text ever typed must still exist somewhere.6//7// Author: Simon-Pierre Boucher8// Contact: contact@spboucher.ai9import Foundation10import SPNotesAPI11import SPNotesStore12import Testing13@testable import SPNotesSync14@testable import SPNotesTestSupport1516@Suite("Randomised convergence")17struct RandomConvergenceTests {18 /// Every word typed during the scenario is a unique token; content edits only ever ADD text, so each token must survive.19 private final class Scenario: @unchecked Sendable {20 var random: SeededRandom21 var counter = 022 var tokens: [String] = []23 var journal: [String] = []24 init(seed: UInt64) { random = SeededRandom(seed: seed) }2526 func next(_ prefix: String) -> String { counter += 1; return "\(prefix)\(counter)" }27 func token() -> String { let t = next("tk") + "x"; tokens.append(t); return t }28 func roll(_ n: Int) -> Int { Int.random(in: 0..<n, using: &random) }29 func pick<T>(_ items: [T]) -> T? { items.isEmpty ? nil : items[roll(items.count)] }30 func note(_ line: String) { journal.append(line) }31 }3233 /// The fixed seeds of every run, plus `SPN_RANDOM_SEEDS=<n>` extra ones (1000, 1001, …) for a longer hunt.34 static let seeds: [UInt64] = {35 if let only = UInt64(ProcessInfo.processInfo.environment["SPN_RANDOM_ONLY"] ?? "") { return [only] }36 let extra = UInt64(ProcessInfo.processInfo.environment["SPN_RANDOM_SEEDS"] ?? "") ?? 037 return [1, 2, 3, 4, 5, 6, 7, 8, 11, 42, 1234, 99991] + (0..<extra).map { 1000 + $0 }38 }()3940 @Test("random edits, syncs, faults and restarts converge without losing a word", arguments: RandomConvergenceTests.seeds)41 func converge(seed: UInt64) async throws {42 let world = World()43 let fake = world.fake44 let devices = [try world.device("A"), try world.device("B")]45 let s = Scenario(seed: seed)4647 // a common starting point: two folders and three notes48 for i in 0..<2 { try await devices[0].create("Folder \(i)", properties: #"{"folder":true}"#) }49 for _ in 0..<3 { try await devices[0].create(s.next("T"), [(s.next("b"), s.token()), (s.next("b"), s.token())]) }50 for device in devices { #expect(await device.sync() == .completed) }5152 for step in 0..<160 {53 let device = devices[s.roll(2)]54 // sorted on what the scenario controls (ids are random), so that a seed always replays the same story55 let pages = try await device.allPages().sorted { ($0.title, $0.plainText) < ($1.title, $1.plainText) }56 let folders = pages.filter { $0.isFolder && $0.deletedAt == nil }57 let notes = pages.filter { !$0.isFolder }58 let live = notes.filter { $0.deletedAt == nil }59 switch s.roll(100) {60 case 0..<8:61 let parent = s.roll(3) == 0 ? s.pick(folders)?.id : nil62 let id = try await device.create(s.next("T"), [(s.next("b"), s.token())], parent: parent, tags: s.roll(4) == 0 ? ["x"] : [])63 s.note("\(step) \(device.name) create \(id.prefix(6))")64 case 8..<26:65 guard let page = s.pick(notes) else { continue }66 try await device.append(page.id, block: s.next("b"), text: s.token())67 s.note("\(step) \(device.name) append \(page.id.prefix(6))")68 case 26..<44:69 guard let page = s.pick(notes), let block = s.pick(Doc.blocks(page.content)) else { continue }70 try await device.edit(page.id, block: block.id, text: block.text + " " + s.token())71 s.note("\(step) \(device.name) type in \(page.id.prefix(6))#\(block.id)")72 case 44..<50:73 guard let page = s.pick(live) else { continue }74 try await device.setTitle(page.id, s.next("T"))75 s.note("\(step) \(device.name) retitle \(page.id.prefix(6))")76 case 50..<55:77 guard let page = s.pick(live) else { continue }78 _ = try await device.store.setTags(id: page.id, names: ["x", "y", "z"].filter { _ in s.roll(2) == 0 })79 case 55..<59:80 guard let page = s.pick(live) else { continue }81 _ = try await device.store.setPinned(id: page.id, !page.pinned)82 case 59..<63:83 guard let page = s.pick(live) else { continue }84 _ = try await device.store.setFavorite(id: page.id, !page.favorite)85 case 63..<67:86 guard let page = s.pick(live) else { continue }87 _ = try await device.store.move(id: page.id, parentId: s.roll(2) == 0 ? s.pick(folders)?.id : nil)88 case 67..<72:89 guard let page = s.pick(pages.filter { $0.deletedAt == nil }) else { continue }90 _ = try await device.store.trash(id: page.id)91 s.note("\(step) \(device.name) trash \(page.id.prefix(6))")92 case 72..<76:93 guard let page = s.pick(pages.filter { $0.deletedAt != nil }) else { continue }94 _ = try await device.store.restore(id: page.id)95 s.note("\(step) \(device.name) restore \(page.id.prefix(6))")96 case 76..<80:97 guard let conflict = s.pick(try await device.store.conflicts().sorted(by: { $0.server.title < $1.server.title })) else { continue }98 let choice = [ConflictResolution.keepMine, .keepTheirs, .keepBoth][s.roll(3)]99 if s.roll(4) == 0 { fake.inject(.dropResponse, method: "POST", path: "/resolve$") }100 let result = try? await device.engine.resolveConflict(pageId: conflict.pageId, choice: choice)101 s.note("\(step) \(device.name) resolve \(conflict.pageId.prefix(6)) \(choice) → \(String(describing: result))")102 fake.clearFaults()103 case 80..<83:104 try await device.restart()105 s.note("\(step) \(device.name) restart")106 default:107 // a sync, one time out of two with something going wrong108 switch s.roll(10) {109 case 0: fake.inject(.dropResponse, method: "POST", path: "^/api/pages$")110 case 1: fake.inject(.dropResponse, method: "PATCH", path: "^/api/pages/")111 case 2: fake.inject(.dropResponse, method: "PUT", path: "/tags$")112 case 3: fake.inject(.dropResponse, method: s.pick(["DELETE", "POST", "PATCH"]), path: "^/api/pages/", count: 2)113 case 4: fake.inject(.status(500), method: s.pick(["PATCH", "PUT"]), path: "^/api/pages/")114 case 5: fake.inject(.network(.notConnectedToInternet), path: ".*")115 case 6: fake.inject(.network(.timedOut), method: "GET", path: "^/api/sync")116 default: break117 }118 let outcome = await device.sync()119 s.note("\(step) \(device.name) sync → \(outcome)")120 fake.clearFaults()121 }122 }123124 // the dust settles: full syncs, every conflict decided, notes waiting in the server's trash taken out of it125 fake.clearFaults()126 var settled = false127 for _ in 0..<12 where !settled {128 for device in devices {129 #expect(await device.sync() == .completed)130 for page in try await device.allPages() where page.deletedAt != nil && page.isDirty { _ = try await device.store.restore(id: page.id) }131 for conflict in try await device.store.conflicts() {132 let choice = [ConflictResolution.keepMine, .keepTheirs, .keepBoth][s.roll(3)]133 let result = try? await device.engine.resolveConflict(pageId: conflict.pageId, choice: choice)134 s.note("end \(device.name) resolve \(conflict.pageId.prefix(6)) \(choice) → \(String(describing: result))")135 }136 #expect(await device.sync() == .completed)137 }138 settled = true139 for device in devices {140 let status = await device.engine.currentStatus()141 if status.pending != 0 || status.conflicts != 0 { settled = false }142 }143 }144 let trail = s.journal.suffix(60).joined(separator: "\n")145 var stuck: [String] = []146 if !settled {147 for device in devices {148 for page in try await device.allPages() where page.isDirty {149 let server = fake.page(page.id)150 stuck.append("\(device.name) \(page.id.prefix(6)) state=\(page.syncState) error=\(page.syncError ?? "-") create=\(page.needsCreate) content=\(page.dirtyContent) meta=\(page.dirtyMeta) tags=\(page.tagsDirty) trashed=\(page.deletedAt != nil) v\(page.serverVersion) parent=\(page.parentId?.prefix(6) ?? "-") | server: \(server.map { "v\($0.version) trashed=\($0.deletedAt != nil)" } ?? "absent")")151 }152 for op in try await device.store.queuedOps() { stuck.append("\(device.name) op \(op.kind) \(op.targetId?.prefix(6) ?? "-") attempts=\(op.attempts) error=\(op.lastError ?? "-")") }153 }154 }155 #expect(settled, "seed \(seed): the devices never settled\n\(stuck.joined(separator: "\n"))\n\(trail)")156 for device in devices { #expect(await device.sync() == .completed) }157158 // 1. both stores and the server hold the same pages159 for device in devices { try await expectMirror(device) }160161 // 2. no word typed anywhere has vanished: it is in a note, in the server history or in the local versions of a device162 var everything = fake.allPages.map(\.text)163 for page in fake.allPages { everything += fake.history(page.id).map(\.text) }164 for device in devices {165 for page in try await device.allPages() {166 everything.append(page.plainText)167 for info in try await device.store.localVersions(pageId: page.id) {168 if let version = try await device.store.localVersion(id: info.id) { everything.append(Doc.texts(version.content).joined(separator: "\n")) }169 }170 }171 }172 let haystack = everything.joined(separator: "\n")173 let missing = s.tokens.filter { !haystack.contains($0) }174 #expect(missing.isEmpty, "seed \(seed): \(missing.count) of \(s.tokens.count) words are gone: \(missing.prefix(5))\n\(trail)")175 // …and nearly all of them are simply in the notes (the rest is the discarded side of a conflict)176 let liveText = fake.allPages.map(\.text).joined(separator: "\n")177 let live = s.tokens.filter { liveText.contains($0) }.count178 let decisions = s.journal.filter { $0.contains("resolve") }179 #expect(live * 10 >= s.tokens.count * 5, "seed \(seed): only \(live) of \(s.tokens.count) words are in the notes\n\(decisions.joined(separator: "\n"))")180 // 3. no duplicated note: titles of conflict copies aside, every id is unique by construction; block ids stay unique inside a note181 for page in fake.allPages {182 let ids = Doc.blocks(page.content).map(\.id)183 #expect(Set(ids).count == ids.count, "seed \(seed): duplicated block in \(page.id)")184 }185 await world.closeAll()186 }187}188