SPB Git

Repository Public

EntityConvergenceTests.swift 14.7 KB 243 lines swift

1// SP Notes Core2// File: Tests/SPNotesSyncTests/EntityConvergenceTests.swift3// Description: Randomised convergence of the 2.0 sync paths: seeded, reproducible sequences of task and canvas edits on two4//              devices (plus the web), with random sync points, faults (lost answers, refused requests, server errors,5//              network loss) and app restarts in the middle of the queue. At the end both stores and the server hold the6//              same tasks and canvases, no task is duplicated, every task not deleted by somebody still exists, and no7//              canvas card that nobody removed has disappeared.8//9// Author: Simon-Pierre Boucher10// Contact: contact@spboucher.ai11import Foundation12import SPNotesAPI13import SPNotesDocument14import SPNotesStore15import Testing16@testable import SPNotesSync17@testable import SPNotesTestSupport1819@Suite("Randomised convergence — tasks and canvases (2.0)")20struct EntityConvergenceTests {21    private final class Scenario: @unchecked Sendable {22        var random: SeededRandom23        var counter = 024        var journal: [String] = []25        /// Every task ever created (by a device or by the web) and the ones somebody deleted.26        var created = Set<String>()27        var deleted = Set<String>()28        /// Every title ever given to a task.29        var titles: [String: Set<String>] = [:]30        /// Cards ever added to a canvas, and the ones somebody removed.31        var cards: [String: Set<String>] = [:]32        var removedCards: [String: Set<String>] = [:]33        init(seed: UInt64) { random = SeededRandom(seed: seed) }3435        func next(_ prefix: String) -> String { counter += 1; return "\(prefix)\(counter)" }36        func roll(_ n: Int) -> Int { Int.random(in: 0..<n, using: &random) }37        func pick<T>(_ items: [T]) -> T? { items.isEmpty ? nil : items[roll(items.count)] }38        func note(_ line: String) { journal.append(line) }39        func uuid() -> String {40            // Reproducible ids (the scenario sorts on them).41            let hex = (0..<32).map { _ in "0123456789abcdef".randomElement(using: &random)! }42            let s = String(hex)43            return "\(s.prefix(8))-\(s.dropFirst(8).prefix(4))-4\(s.dropFirst(13).prefix(3))-8\(s.dropFirst(17).prefix(3))-\(s.dropFirst(20).prefix(12))"44        }45    }4647    static let seeds: [UInt64] = {48        if let only = UInt64(ProcessInfo.processInfo.environment["SPN_RANDOM_ONLY"] ?? "") { return [only] }49        let extra = UInt64(ProcessInfo.processInfo.environment["SPN_RANDOM_SEEDS"] ?? "") ?? 050        return [1, 2, 3, 4, 5, 6, 7, 8, 11, 42, 1234, 99991] + (0..<extra).map { 1000 + $0 }51    }()5253    @Test("random task and canvas edits, syncs, faults and restarts converge; nothing is duplicated or lost", arguments: EntityConvergenceTests.seeds)54    func converge(seed: UInt64) async throws {55        let world = World(apiLevel: 3)56        let fake = world.fake57        let devices = [try world.device("A"), try world.device("B")]58        let s = Scenario(seed: seed)5960        // a common starting point: one page, two canvases, three tasks61        let page = try await devices[0].create("Projet", [("b1", "texte")], id: s.uuid())62        var canvasIds: [String] = []63        for i in 0..<2 {64            let id = s.uuid()65            let card = s.next("c")66            try await devices[0].canvases.create(title: "Carte \(i)", document: Canvas.document([Canvas.node(card, s.next("w"))]), id: id)67            canvasIds.append(id)68            s.cards[id, default: []].insert(card)69        }70        for _ in 0..<3 {71            let title = s.next("T")72            let task = try await devices[0].tasks.create(title: title, pageId: s.roll(2) == 0 ? page : nil, id: s.uuid())73            s.created.insert(task.id); s.titles[task.id, default: []].insert(title)74        }75        for device in devices { #expect(await device.sync() == .completed) }7677        for step in 0..<170 {78            let device = devices[s.roll(2)]79            let tasks = try await device.tasks.list(.all).sorted { $0.id < $1.id }80            switch s.roll(100) {81            case 0..<10:82                let title = s.next("T")83                let task = try await device.tasks.create(title: title, dueDay: s.roll(3) == 0 ? "2026-12-0\(1 + s.roll(9))" : nil,84                                                         priority: [.low, .medium, .high][s.roll(3)], pageId: s.roll(3) == 0 ? page : nil, id: s.uuid())85                s.created.insert(task.id); s.titles[task.id, default: []].insert(title)86                s.note("\(step) \(device.name) task create \(task.id.prefix(6))")87            case 10..<22:88                guard let task = s.pick(tasks) else { continue }89                let title = s.next("T")90                try await device.tasks.update(id: task.id, TaskEdit(title: title))91                s.titles[task.id, default: []].insert(title)92                s.note("\(step) \(device.name) task retitle \(task.id.prefix(6)) → \(title)")93            case 22..<32:94                guard let task = s.pick(tasks) else { continue }95                try await device.tasks.update(id: task.id, TaskEdit(status: [.todo, .doing, .done][s.roll(3)]))96                s.note("\(step) \(device.name) task status \(task.id.prefix(6))")97            case 32..<40:98                guard let task = s.pick(tasks) else { continue }99                let edit = s.roll(2) == 0 ? TaskEdit(priority: [.low, .medium, .high][s.roll(3)])100                                           : TaskEdit(dueAt: s.roll(3) == 0 ? .null : .value(Date(timeIntervalSince1970: 1_800_000_000 + Double(s.roll(1000)) * 3600)))101                try await device.tasks.update(id: task.id, edit)102                s.note("\(step) \(device.name) task fields \(task.id.prefix(6))")103            case 40..<45:104                guard let task = s.pick(tasks) else { continue }105                try await device.tasks.delete(id: task.id)106                s.deleted.insert(task.id)107                s.note("\(step) \(device.name) task delete \(task.id.prefix(6))")108            case 45..<49:109                // the web application110                if s.roll(2) == 0 {111                    let title = s.next("T")112                    let id = fake.webCreateTask(id: s.uuid(), title: title)113                    s.created.insert(id); s.titles[id, default: []].insert(title)114                    s.note("\(step) web task create \(id.prefix(6))")115                } else if let task = s.pick(fake.allTasks.sorted(by: { $0.id < $1.id })) {116                    let title = s.next("T")117                    fake.webUpdateTask(task.id, title: title)118                    s.titles[task.id, default: []].insert(title)119                    s.note("\(step) web task retitle \(task.id.prefix(6))")120                }121            case 49..<62:122                guard let id = s.pick(canvasIds), try await device.store.canvas(pageId: id) != nil else { continue }123                let card = s.next("c")124                try await device.editCanvas(id) { $0.nodes.append(Canvas.node(card, s.next("w"), x: Double(s.roll(900)), y: Double(s.roll(900)))) }125                s.cards[id, default: []].insert(card)126                s.note("\(step) \(device.name) canvas \(id.prefix(6)) + \(card)")127            case 62..<72:128                guard let id = s.pick(canvasIds), let document = try? await device.canvasDocument(id), let card = s.pick(document.nodes.map(\.id).sorted()) else { continue }129                let moveOnly = s.roll(2) == 0130                let word = s.next("w")131                let x = Double(s.roll(900))132                try await device.editCanvas(id) { document in133                    guard let index = document.nodes.firstIndex(where: { $0.id == card }) else { return }134                    if moveOnly { document.nodes[index].x = x } else { document.nodes[index].text = (document.nodes[index].text ?? "") + " " + word }135                }136                s.note("\(step) \(device.name) canvas \(id.prefix(6)) edit \(card)")137            case 72..<76:138                guard let id = s.pick(canvasIds), let document = try? await device.canvasDocument(id), document.nodes.count >= 2 else { continue }139                let ids = document.nodes.map(\.id).sorted()140                let from = ids[s.roll(ids.count)], to = ids[s.roll(ids.count)]141                guard from != to else { continue }142                let edge = s.next("e")143                try await device.editCanvas(id) { $0.edges.append(CanvasEdge(id: edge, from: from, to: to)) }144            case 76..<79:145                guard let id = s.pick(canvasIds), let document = try? await device.canvasDocument(id), document.nodes.count > 1, let card = s.pick(document.nodes.map(\.id).sorted()) else { continue }146                try await device.editCanvas(id) { document in147                    document.nodes.removeAll { $0.id == card }148                    document.edges.removeAll { $0.from == card || $0.to == card }149                }150                s.removedCards[id, default: []].insert(card)151                s.note("\(step) \(device.name) canvas \(id.prefix(6)) − \(card)")152            case 79..<82:153                guard let conflict = s.pick(try await device.canvases.conflicts().sorted(by: { $0.pageId < $1.pageId })) else { continue }154                // The proposed merge keeps every card either side still has (the edited one when the other side removed it).155                do { try await device.canvases.resolve(conflict, .merged(conflict.merge.merged)) } catch RepositoryError.stale { continue }156                s.note("\(step) \(device.name) canvas \(conflict.pageId.prefix(6)) resolve (\(conflict.merge.conflicts.count) conflicts)")157            case 82..<86:158                try await device.restart()159                s.note("\(step) \(device.name) restart")160            default:161                switch s.roll(12) {162                case 0: fake.inject(.dropResponse, method: "POST", path: "^/api/tasks$")163                case 1: fake.inject(.dropResponse, method: "PATCH", path: "^/api/tasks/")164                case 2: fake.inject(.dropResponse, method: "DELETE", path: "^/api/tasks/")165                case 3: fake.inject(.dropResponse, method: "PUT", path: "^/api/canvases/")166                case 4: fake.inject(.status(500), method: s.pick(["POST", "PATCH", "PUT"]), path: "^/api/(tasks|canvases)")167                case 5: fake.inject(.network(.notConnectedToInternet), path: ".*")168                case 6: fake.inject(.network(.timedOut), method: "GET", path: "^/api/sync")169                case 7: fake.inject(.network(.networkConnectionLost), path: "^/api/(tasks|canvases)", count: 1 + s.roll(3))170                case 8: fake.inject(.status(503), path: "^/api/tasks", count: 2)171                default: break172                }173                let outcome = await device.sync()174                s.note("\(step) \(device.name) sync → \(outcome)")175                fake.clearFaults()176                // What waited in backoff because of an injected failure is allowed to go at the next cycle.177                try await device.store.expediteEntityOps()178            }179        }180181        // the dust settles182        fake.clearFaults()183        var settled = false184        for _ in 0..<12 where !settled {185            for device in devices {186                try await device.store.expediteEntityOps()187                #expect(await device.sync() == .completed)188                for conflict in try await device.canvases.conflicts() {189                    do { try await device.canvases.resolve(conflict, .merged(conflict.merge.merged)) } catch RepositoryError.stale { continue }190                    s.note("end \(device.name) canvas \(conflict.pageId.prefix(6)) resolve")191                }192                #expect(await device.sync() == .completed)193            }194            settled = true195            for device in devices {196                let status = await device.engine.currentStatus()197                if status.pending != 0 || status.canvasConflicts != 0 || status.rejected != 0 { settled = false }198            }199        }200        let trail = s.journal.suffix(70).joined(separator: "\n")201        var stuck: [String] = []202        if !settled {203            for device in devices {204                for op in try await device.store.entityOps() { stuck.append("\(device.name) op \(op.op) \(op.entityId.prefix(6)) \(op.state) attempts=\(op.attempts) error=\(op.lastError ?? "-")") }205                for id in canvasIds { if let c = try await device.store.canvas(pageId: id), c.dirty { stuck.append("\(device.name) canvas \(id.prefix(6)) v\(c.version) conflict=\(c.hasConflict) error=\(c.syncError ?? "-")") } }206            }207        }208        #expect(settled, "seed \(seed): the devices never settled\n\(stuck.joined(separator: "\n"))\n\(trail)")209        for device in devices { #expect(await device.sync() == .completed) }210211        // 1. both devices mirror the server212        for device in devices {213            try await expectTaskMirror(device)214            for id in canvasIds { try await expectCanvasMirror(device, id) }215            try await expectMirror(device)216        }217        // 2. tasks: no duplicate, every task nobody deleted exists with a title somebody gave it, deleted ones are gone218        let everyTask = fake.everyTask219        #expect(Set(everyTask.map(\.id)).count == everyTask.count)220        #expect(Set(everyTask.map(\.id)) == s.created, "seed \(seed): the server knows exactly the tasks that were created\n\(trail)")221        for task in everyTask {222            if s.deleted.contains(task.id) {223                #expect(task.deletedAt != nil, "seed \(seed): task \(task.id.prefix(6)) was deleted by a device\n\(trail)")224            } else {225                #expect(task.deletedAt == nil, "seed \(seed): task \(task.id.prefix(6)) was never deleted\n\(trail)")226                #expect(s.titles[task.id]?.contains(task.title) == true, "seed \(seed): task \(task.id.prefix(6)) has a title nobody typed: \(task.title)")227            }228        }229        // 3. canvases: no card that nobody removed has disappeared; no card or edge is duplicated; every edge has its two ends230        for id in canvasIds {231            let document = try #require(Canvas.parse(fake.canvasData(id)))232            let present = Set(document.nodes.map(\.id))233            #expect(present.count == document.nodes.count, "seed \(seed): duplicated card in \(id.prefix(6))")234            #expect(Set(document.edges.map(\.id)).count == document.edges.count, "seed \(seed): duplicated edge in \(id.prefix(6))")235            let expected = (s.cards[id] ?? []).subtracting(s.removedCards[id] ?? [])236            let missing = expected.subtracting(present)237            #expect(missing.isEmpty, "seed \(seed): cards \(missing.sorted()) of canvas \(id.prefix(6)) are gone although nobody removed them\n\(trail)")238            for edge in document.edges { #expect(present.contains(edge.from) && present.contains(edge.to), "seed \(seed): dangling edge \(edge.id) in \(id.prefix(6))") }239        }240        await world.closeAll()241    }242}243
Files main
Menu

Theme