SPB Git

Repository Public

FakeBackend+Next.swift 18.3 KB 328 lines swift

1// SP Notes Core2// File: Sources/SPNotesTestSupport/FakeBackend+Next.swift3// Description: The 3.0 part of the in-memory fake backend, written from API-NEXT.md and checked against the scratch4//              instance: /api/meta, the entity change feed (`kinds`), tasks with client-chosen ids, canvases with5//              optimistic versions, opaque rows for the other entity kinds, and scriptable routes for everything the6//              fake does not model (read models, databases, graph…). `apiLevel = 2` turns all of it off: the fake then7//              answers like a 2.x server.8//9// Author: Simon-Pierre Boucher10// Contact: contact@spboucher.ai11import Foundation1213extension FakeBackend {14    /// 3 unless the environment says `SPN_FAKE_API_LEVEL=2` (the whole test suite can be replayed against a 2.x fake).15    static var defaultAPILevel: Int { ProcessInfo.processInfo.environment["SPN_FAKE_API_LEVEL"].flatMap(Int.init) ?? 3 }1617    static let entityKinds = ["task", "database", "database_property", "database_view", "database_row", "edge", "reference", "canvas", "concept"]18    static let features = ["entities", "tasks-v2", "events", "timemachine", "graph-v2", "insights", "canvas", "health", "brief", "query", "zoom", "nodes-v3", "files-range"]19    static let emptyCanvas = Data(#"{"edges":[],"format":"spn-canvas-1","nodes":[],"viewport":{"x":0,"y":0,"zoom":1}}"#.utf8)2021    /// The API level served (3 by default; 2 = a 2.x server).22    public var level: Int { lock.withLock { apiLevel } }23    public func setAPILevel(_ level: Int) { lock.withLock { apiLevel = level } }2425    // MARK: - Scriptable routes2627    /// What a scripted route receives.28    public struct StubRequest: Sendable {29        public var method: String30        public var path: String31        public var query: [String: String]32        public var body: Data33    }3435    /// What a scripted route answers.36    public struct StubResponse: Sendable {37        public var status: Int38        public var body: Data39        public var headers: [String: String]40        public init(status: Int = 200, body: Data, headers: [String: String] = [:]) { self.status = status; self.body = body; self.headers = headers }41        /// A JSON answer from its text.42        public static func json(_ text: String, status: Int = 200, headers: [String: String] = [:]) -> StubResponse {43            StubResponse(status: status, body: Data(text.utf8), headers: headers)44        }45        /// An error body `{error, code}` as the server writes them.46        public static func error(_ status: Int, code: String? = nil, message: String = "Stubbed failure") -> StubResponse {47            var object: [String: Any] = ["error": message]48            if let code { object["code"] = code }49            return StubResponse(status: status, body: FakeBackend.serialize(object))50        }51    }5253    struct CustomRoute {54        var method: String?55        var pattern: NSRegularExpression56        var handler: @Sendable (StubRequest) -> StubResponse?57    }5859    /// Scripts a route the fake does not model (or overrides one it does): the handler is asked first for every60    /// authenticated request whose method and path match; returning nil lets the built-in behaviour run. Session,61    /// Origin, idempotency keys and fault injection still apply.62    public func stub(_ method: String? = nil, path pattern: String, _ handler: @escaping @Sendable (StubRequest) -> StubResponse?) {63        let regex = try! NSRegularExpression(pattern: pattern)64        lock.withLock { customRoutes.append(CustomRoute(method: method, pattern: regex, handler: handler)) }65    }6667    /// Scripts a fixed JSON answer.68    public func stub(_ method: String? = nil, path pattern: String, json text: String, status: Int = 200) {69        stub(method, path: pattern) { _ in .json(text, status: status) }70    }7172    public func clearStubs() { lock.withLock { customRoutes.removeAll() } }7374    func customReply(method: String, path: String, query: [String: String], body: Data) throws -> Reply? {75        for route in customRoutes.reversed() {76            if let m = route.method, m != method { continue }77            guard Self.matches(route.pattern, path) else { continue }78            guard let answer = route.handler(StubRequest(method: method, path: path, query: query, body: body)) else { continue }79            return Reply(status: answer.status, headers: ["Content-Type": "application/json"].merging(answer.headers) { $1 }, body: answer.body)80        }81        return nil82    }8384    // MARK: - 3.0 routes8586    func nextRoute(method: String, parts: [String], query: [String: String], body: Data) throws -> Reply? {87        guard apiLevel >= 3 else { return nil }88        func object() throws -> [String: Any] {89            guard let object = Self.parse(body) as? [String: Any] else { throw HTTPFailure(status: 400, message: "Invalid JSON body") }90            return object91        }92        func uuid(_ text: String) throws -> String {93            guard Self.isUUID(text) else { throw HTTPFailure(status: 400, message: "Validation: Invalid UUID", code: "bad_request") }94            return text.lowercased()95        }96        switch (method, parts[1], parts.count) {97        case ("GET", "meta", 2):98            return json(["api": 3, "version": "3.0.0-fake", "features": Self.features, "serverTime": iso(now())])99100        case ("GET", "tasks", 3):101            guard let task = tasks[try uuid(parts[2])] else { throw HTTPFailure(status: 404, message: "Task not found", code: "not_found") }102            return json(taskRow(task))103104        case ("PATCH", "tasks", 3):105            let id = try uuid(parts[2])106            let b = try object()107            guard var task = tasks[id], task.deletedAt == nil else { throw HTTPFailure(status: 404, message: "Task not found", code: "not_found") }108            if let title = b["title"] as? String {109                let trimmed = title.trimmingCharacters(in: .whitespacesAndNewlines)110                guard !trimmed.isEmpty, trimmed.count <= 500 else { throw HTTPFailure(status: 400, message: "Validation: title") }111                task.title = trimmed112            }113            if b.keys.contains("dueAt") || b.keys.contains("due") { task.dueAt = try taskDue(b) }114            if let status = b["status"] as? String {115                guard ["todo", "doing", "done"].contains(status) else { throw HTTPFailure(status: 400, message: "Validation: status") }116                if status != task.status { task.completedAt = status == "done" ? now() : nil }117                task.status = status118            }119            if let priority = b["priority"] as? String {120                guard ["low", "medium", "high"].contains(priority) else { throw HTTPFailure(status: 400, message: "Validation: priority") }121                task.priority = priority122            }123            if b.keys.contains("project") { task.project = b["project"] as? String }124            if b.keys.contains("pageId") {125                let pageId = b["pageId"] as? String126                if let pageId, pages[pageId] == nil || pages[pageId]?.deletedAt != nil { throw HTTPFailure(status: 400, message: "Unknown page", code: "bad_page") }127                task.pageId = pageId128                if pageId == nil, !b.keys.contains("blockId") { task.blockId = nil }129            }130            if b.keys.contains("blockId") { task.blockId = b["blockId"] as? String }131            task.updatedAt = now()132            task.rev = nextRev()133            tasks[id] = task134            return json(taskRow(task))135136        case ("DELETE", "tasks", 3):137            let id = try uuid(parts[2])138            // idempotent since the hardening pass: an unknown id answers 200 like an already deleted one139            guard var task = tasks[id] else { return json(["ok": true, "deleted": false]) }140            guard task.deletedAt == nil else { return json(["ok": true, "deleted": false]) }141            let stamp = now()142            task.deletedAt = stamp143            task.updatedAt = stamp144            task.rev = nextRev()145            tasks[id] = task146            return json(["ok": true, "deleted": true])147148        case ("GET", "canvases", 3):149            let id = try uuid(parts[2])150            guard let page = pages[id] else { throw HTTPFailure(status: 404, message: "Canvas not found", code: "not_found") }151            guard let canvas = canvases[id] else { throw HTTPFailure(status: 404, message: "This page is not a canvas", code: "not_canvas") }152            return json(["pageId": id, "title": page.title, "data": Self.parse(canvas.data) ?? NSNull(), "version": canvas.version, "rev": canvas.rev, "updatedAt": iso(canvas.updatedAt)])153154        case ("PUT", "canvases", 3):155            let id = try uuid(parts[2])156            let b = try object()157            guard let base = (b["baseVersion"] as? NSNumber)?.intValue else { throw HTTPFailure(status: 400, message: "Validation: baseVersion Invalid input") }158            guard let data = b["data"] as? [String: Any], data["format"] as? String == "spn-canvas-1", data["nodes"] is [Any], data["edges"] is [Any] else {159                throw HTTPFailure(status: 400, message: "Invalid canvas: data.format must be \"spn-canvas-1\"", code: "bad_canvas")160            }161            guard let page = pages[id], page.deletedAt == nil else { throw HTTPFailure(status: 404, message: "Canvas not found", code: "not_found") }162            guard var canvas = canvases[id] else { throw HTTPFailure(status: 404, message: "This page is not a canvas", code: "not_canvas") }163            guard canvas.version == base else {164                throw HTTPFailure(status: 409, message: "This canvas was changed in another session", code: "conflict",165                                  extra: ["server": ["version": canvas.version, "data": Self.parse(canvas.data) ?? NSNull(), "rev": canvas.rev, "updatedAt": iso(canvas.updatedAt)] as [String: Any]])166            }167            let bytes = Self.serialize(data)168            if Self.jsonEqual(bytes, canvas.data) {169                return json(["version": canvas.version, "rev": canvas.rev, "updatedAt": iso(canvas.updatedAt), "unchanged": true])170            }171            saveCanvas(&canvas, data: bytes)172            return json(["version": canvas.version, "rev": canvas.rev, "updatedAt": iso(canvas.updatedAt), "unchanged": false])173174        default:175            return nil176        }177    }178179    /// `dueAt` (ISO datetime) or its alias `due`; a bare `YYYY-MM-DD` is stored at 12:00 UTC of that day.180    func taskDue(_ body: [String: Any]) throws -> Date? {181        let value = body.keys.contains("dueAt") ? body["dueAt"] : body["due"]182        guard let value, !(value is NSNull) else { return nil }183        guard let text = value as? String else { throw HTTPFailure(status: 400, message: "Validation: dueAt") }184        if apiLevel >= 3, text.range(of: #"^\d{4}-\d{2}-\d{2}$"#, options: .regularExpression) != nil, let noon = Self.parseISO(text + "T12:00:00.000Z") { return noon }185        guard let parsed = Self.parseISO(text) else { throw HTTPFailure(status: 400, message: "Validation: date") }186        return parsed187    }188189    /// The row of the feed (API-NEXT §3.1): no `workspaceId`, `rev` last.190    func feedTaskRow(_ task: FakeTask) -> [String: Any] {191        ["id": task.id, "pageId": task.pageId ?? NSNull(), "blockId": task.blockId ?? NSNull(), "title": task.title, "status": task.status, "priority": task.priority,192         "dueAt": task.dueAt.map(iso) ?? NSNull(), "completedAt": task.completedAt.map(iso) ?? NSNull(), "project": task.project ?? NSNull(),193         "createdAt": iso(task.createdAt), "updatedAt": iso(task.updatedAt), "deletedAt": task.deletedAt.map(iso) ?? NSNull(), "rev": task.rev]194    }195196    func canvasFeedRow(_ canvas: FakeCanvas) -> [String: Any] {197        ["id": canvas.pageId, "pageId": canvas.pageId, "data": Self.parse(canvas.data) ?? NSNull(), "version": canvas.version,198         "createdAt": iso(canvas.createdAt), "updatedAt": iso(canvas.updatedAt), "rev": canvas.rev]199    }200201    func entityRow(_ entity: FakeEntity) -> [String: Any] {202        var row = (Self.parse(entity.json) as? [String: Any]) ?? [:]203        row["id"] = entity.id204        if let deletedAt = entity.deletedAt { row["deletedAt"] = iso(deletedAt) } else if row["deletedAt"] == nil, ["task", "database", "database_row", "reference"].contains(entity.kind) { row["deletedAt"] = NSNull() }205        row["rev"] = entity.rev206        return row207    }208209    func createCanvas(pageId: String) {210        let stamp = now()211        canvases[pageId] = FakeCanvas(pageId: pageId, data: Self.emptyCanvas, version: 1, createdAt: stamp, updatedAt: stamp, rev: nextRev())212    }213214    /// A canvas save: version + 1, new revision, and the canvas page moves in the page feed (its `updatedAt`).215    func saveCanvas(_ canvas: inout FakeCanvas, data: Data) {216        canvas.data = data217        canvas.version += 1218        canvas.updatedAt = now()219        canvas.rev = nextRev()220        canvases[canvas.pageId] = canvas221        if var page = pages[canvas.pageId] { page.updatedAt = canvas.updatedAt; store(&page) }222    }223224    // MARK: - Inspection225226    public func canvasData(_ pageId: String) -> Data? { lock.withLock { canvases[pageId]?.data } }227    public func canvasVersion(_ pageId: String) -> Int? { lock.withLock { canvases[pageId]?.version } }228    func canvas(_ pageId: String) -> FakeCanvas? { lock.withLock { canvases[pageId] } }229    /// Every task row, deleted ones included.230    var everyTask: [FakeTask] { lock.withLock { tasks.values.sorted { $0.createdAt < $1.createdAt } } }231    /// The head of the feed when every kind is asked.232    public var entityHead: Int64 { lock.withLock { computeHead(kinds: Set(Self.entityKinds)) } }233234    // MARK: - The web application (3.0)235236    /// Creates a page of type `canvas` with its (empty) canvas row. Returns the page id.237    @discardableResult238    public func webCreateCanvas(id: String? = nil, title: String, parentId: String? = nil, section: String = "notes") -> String {239        lock.withLock {240            var page = makePage(id: id, title: title, parentId: parentId, section: section, type: "canvas", content: nil, icon: nil, properties: [:])241            store(&page)242            createCanvas(pageId: page.id)243            return page.id244        }245    }246247    /// Another session saves the canvas (no version guard, like a web editor that just loaded it).248    public func webSaveCanvas(_ pageId: String, data: Data) {249        lock.withLock {250            guard var canvas = canvases[pageId] else { return }251            saveCanvas(&canvas, data: Self.serialize(Self.parse(data) ?? [:]))252        }253    }254255    @discardableResult256    public func webCreateTask(id: String? = nil, title: String, pageId: String? = nil, dueAt: Date? = nil, priority: String = "medium", status: String = "todo") -> String {257        lock.withLock {258            let stamp = now()259            var task = FakeTask(id: id ?? UUID().uuidString.lowercased(), title: title, status: status, priority: priority, dueAt: dueAt, pageId: pageId, createdAt: stamp, updatedAt: stamp)260            if status == "done" { task.completedAt = stamp }261            task.rev = nextRev()262            tasks[task.id] = task263            return task.id264        }265    }266267    public func webUpdateTask(_ id: String, title: String? = nil, status: String? = nil, priority: String? = nil, dueAt: Date?? = nil) {268        lock.withLock {269            guard var task = tasks[id], task.deletedAt == nil else { return }270            if let title { task.title = title }271            if let status { if status != task.status { task.completedAt = status == "done" ? now() : nil }; task.status = status }272            if let priority { task.priority = priority }273            if let dueAt { task.dueAt = dueAt }274            task.updatedAt = now()275            task.rev = nextRev()276            tasks[id] = task277        }278    }279280    public func webDeleteTask(_ id: String) {281        lock.withLock {282            guard var task = tasks[id], task.deletedAt == nil else { return }283            task.deletedAt = now()284            task.updatedAt = task.deletedAt!285            task.rev = nextRev()286            tasks[id] = task287        }288    }289290    /// Writes (creates or replaces) a row of another entity kind — `database`, `database_property`, `database_view`,291    /// `database_row`, `edge`, `reference`, `concept` — as the server would after any change: next revision.292    public func webPutEntity(kind: String, id: String, json text: String) {293        lock.withLock {294            tombstones[kind + ":" + id] = nil295            entities[kind + ":" + id] = FakeEntity(kind: kind, id: id, json: Data(text.utf8), deletedAt: nil, rev: nextRev())296        }297    }298299    /// Soft delete (the row stays in the feed with `deletedAt`) or permanent deletion (a tombstone).300    public func webDeleteEntity(kind: String, id: String, permanently: Bool = false) {301        lock.withLock {302            let key = kind + ":" + id303            guard var entity = entities[key] else { return }304            if permanently {305                entities[key] = nil306                tombstones[key] = FakeTombstone(id: id, kind: kind, rev: nextRev(), deletedAt: now())307            } else {308                entity.deletedAt = now()309                entity.rev = nextRev()310                entities[key] = entity311            }312        }313    }314315    public func taskTitle(_ id: String) -> String? { lock.withLock { tasks[id].flatMap { $0.deletedAt == nil ? $0.title : nil } } }316317    /// What the server holds, for assertions in app tests (no second API client needed).318    public struct TaskSnapshot: Sendable, Equatable { public var id, title, status, priority: String; public var dueAt: Date?; public var pageId, blockId: String? }319    public struct PageSnapshot: Sendable, Equatable { public var id, title, section: String; public var parentId: String?; public var archived, pinned, trashed, inInbox: Bool; public var tags: [String]; public var text: String; public var version: Int }320    /// The live tasks (soft-deleted ones left out), oldest first.321    public func taskSnapshots() -> [TaskSnapshot] {322        lock.withLock { tasks.values.filter { $0.deletedAt == nil }.sorted { $0.createdAt < $1.createdAt }.map { TaskSnapshot(id: $0.id, title: $0.title, status: $0.status, priority: $0.priority, dueAt: $0.dueAt, pageId: $0.pageId, blockId: $0.blockId) } }323    }324    public func pageSnapshot(_ id: String) -> PageSnapshot? {325        lock.withLock { pages[id].map { PageSnapshot(id: $0.id, title: $0.title, section: $0.section, parentId: $0.parentId, archived: $0.archived, pinned: $0.pinned, trashed: $0.deletedAt != nil, inInbox: $0.inboxAt != nil, tags: $0.tags, text: $0.text, version: $0.version) } }326    }327}328
Files main
Menu

Theme