SPB Git

Repository Public

LiveNextTimelineTests.swift 9.2 KB 151 lines swift

1// SP Notes Core2// File: Tests/SPNotesAPITests/LiveNextTimelineTests.swift3// Description: Live tests of the events journal, the time machine and the restoration of a history entry against the4//              SCRATCH backend. Skipped without SPN_LIVE_URL / SPN_LIVE_TOKEN.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import Foundation9import XCTest10@testable import SPNotesAPI1112final class LiveNextTimelineTests: XCTestCase {13    func testJournalPagingAndFilters() async throws {14        let live = try await LiveNext.make()15        try await live.require(ServerFeature.events)16        let api = live.api17        let root = try await live.page(self, "journal projet", section: .projects)18        let page = try await live.page(self, "journal page", parentId: root.id, section: .projects, content: LiveNext.document("Un."))19        _ = try await api.setPageTags(pageID: page.id, tags: ["live-journal"])20        _ = try await api.patchPage(id: page.id, PagePatch(title: "Live · journal page renommée", baseVersion: 1))21        let task = try await api.createTaskIdempotent(TaskDraft(title: "Live · tâche du journal", pageId: page.id, id: NotesAPI.newID())).value22        addTeardownBlock { _ = try? await api.removeTask(id: task.id) }23        _ = try await api.updateTask(id: task.id, TaskChanges(status: .done))2425        // Walk the journal of the page two events at a time.26        var seen: [KnowledgeEvent] = []27        var cursor: String?28        var calls = 029        repeat {30            let answer = try await api.events(JournalQuery(pageId: page.id, limit: 2, cursor: cursor))31            XCTAssertLessThanOrEqual(answer.events.count, 2)32            seen += answer.events33            cursor = answer.nextCursor34            calls += 135        } while cursor != nil && calls < 5036        XCTAssertGreaterThan(calls, 2, "several pages were needed")37        XCTAssertEqual(Set(seen.map(\.id)).count, seen.count, "no event twice")38        XCTAssertEqual(seen.map(\.at), seen.map(\.at).sorted(by: >))39        let kinds = Set(seen.map(\.kind))40        XCTAssertTrue(kinds.isSuperset(of: [EventKind.pageCreated, EventKind.pageRenamed, EventKind.tagAdded, EventKind.taskCreated, EventKind.taskCompleted]), "\(kinds)")41        XCTAssertTrue(seen.allSatisfy { $0.pageId == page.id && $0.pageTitle == "Live · journal page renommée" }, "pageTitle is the current title")42        XCTAssertTrue(seen.allSatisfy { $0.actor == EventActor.user && $0.device == "SP Notes · Mac" })43        let renamed = try XCTUnwrap(seen.first { $0.kind == EventKind.pageRenamed })44        XCTAssertEqual(renamed.dataString("to"), "Live · journal page renommée")4546        // Project scope and kind families.47        let project = try await api.events(JournalQuery(projectId: root.id, kinds: [EventKind.family("task"), EventKind.pageCreated], limit: 200))48        XCTAssertNil(project.nextCursor)49        XCTAssertEqual(project.events.filter { $0.kind == EventKind.pageCreated }.count, 2, "the root and its sub-page")50        XCTAssertEqual(Set(project.events.filter { $0.family == "task" }.map(\.entityId)), [task.id])51        XCTAssertTrue(project.events.allSatisfy { $0.family == "task" || $0.kind == EventKind.pageCreated })5253        // Dates.54        let future = try await api.events(JournalQuery(pageId: page.id, from: Date().addingTimeInterval(3600)))55        XCTAssertTrue(future.events.isEmpty)56        let past = try await api.events(JournalQuery(pageId: page.id, to: Date().addingTimeInterval(-3600)))57        XCTAssertTrue(past.events.isEmpty)5859        // Errors.60        let badKinds = await captureAPIError { try await api.events(JournalQuery(kinds: ["unicorn.seen"])) }61        XCTAssertEqual(badKinds?.code, APIError.NextCode.badKinds)62        XCTAssertEqual(badKinds?.validKinds, EventKind.all)63        let badCursor = await captureAPIError { try await api.events(JournalQuery(cursor: "not-a-cursor")) }64        XCTAssertEqual(badCursor?.code, APIError.NextCode.badCursor)65        let both = await captureAPIError { try await api.events(JournalQuery(pageId: page.id, projectId: root.id)) }66        XCTAssertEqual(both?.code, APIError.NextCode.badRequest)67        let unknown = await captureAPIError { try await api.events(JournalQuery(projectId: NotesAPI.newID())) }68        XCTAssertEqual(unknown?.isNotFound, true)69    }7071    func testTimeMachineAndRestore() async throws {72        let live = try await LiveNext.make()73        try await live.require(ServerFeature.timeMachine)74        let api = live.api75        let before = Date().addingTimeInterval(-5)76        let root = try await live.page(self, "machine projet", section: .projects)77        let page = try await live.page(self, "machine page", parentId: root.id, section: .projects, content: LiveNext.document("Première version."))78        let relation = try await api.createRelation(RelationDraft(fromId: page.id, toId: root.id, relType: RelationType.partOf)).value79        try await Task.sleep(nanoseconds: 1_100_000_000)80        let middle = Date()81        try await Task.sleep(nanoseconds: 100_000_000)82        // A save with a reason takes a history entry holding the first version.83        let saved = try await api.patchPage(id: page.id, PagePatch(content: LiveNext.document("Deuxième version."), versionReason: "manual", baseVersion: 1))84        XCTAssertEqual(saved.version, 2)85        _ = try await api.deleteRelation(id: relation.id)8687        // Now: the present state, exact.88        let now = try await api.timeMachine(pageID: page.id, at: Date())89        let current = try XCTUnwrap(now.pages.first)90        XCTAssertEqual(current.source, TimeMachineSource.current)91        XCTAssertEqual(current.exact, true)92        XCTAssertEqual(current.version, 2)93        XCTAssertTrue(current.content?.string.contains("Deuxième version.") ?? false)94        XCTAssertNil(current.versionId)9596        // Before the edit: the history entry.97        let then = try await api.timeMachine(pageID: page.id, at: middle)98        let old = try XCTUnwrap(then.pages.first)99        XCTAssertTrue(old.existed)100        XCTAssertEqual(old.version, 1)101        XCTAssertEqual(old.changedSince, true)102        XCTAssertTrue(old.content?.string.contains("Première version.") ?? false)103        XCTAssertTrue([TimeMachineSource.version, TimeMachineSource.versionAfter].contains(old.source), old.source)104        let entry = try XCTUnwrap(old.versionId)105        let versions = try await api.pageVersions(pageID: page.id)106        XCTAssertTrue(versions.contains { $0.id == entry && $0.version == 1 })107        // The relation deleted since then is reported.108        XCTAssertTrue(then.removedSince.contains { $0.kind == EventKind.relationRemoved && $0.dataString("relationId") == relation.id })109        XCTAssertFalse(now.removedSince.contains { $0.dataString("relationId") == relation.id })110111        // Before the creation.112        let unborn = try await api.timeMachine(pageID: page.id, at: before, includeContent: false)113        XCTAssertEqual(unborn.pages.first?.existed, false)114        XCTAssertEqual(unborn.pages.first?.source, TimeMachineSource.none)115        XCTAssertNil(unborn.pages.first?.content)116117        // Project scope.118        let project = try await api.timeMachine(projectID: root.id, at: Date())119        XCTAssertEqual(project.scope?.projectId, root.id)120        XCTAssertEqual(project.pages.map(\.id), [root.id, page.id], "the root first")121        XCTAssertTrue(project.pages.allSatisfy { $0.content == nil }, "no content by default for a project")122        let withContent = try await api.timeMachine(projectID: root.id, at: Date(), includeContent: true)123        XCTAssertTrue(withContent.pages.allSatisfy { $0.content != nil })124125        // Restore: a stale baseVersion is refused with the server copy; the right one goes through.126        let conflict = await captureAPIError { try await api.restoreHistoryEntry(pageID: page.id, versionID: entry, baseVersion: 1) }127        guard case .conflict(let server, _)? = conflict else { return XCTFail("expected a conflict, got \(String(describing: conflict))") }128        XCTAssertEqual(server.version, 2)129        XCTAssertTrue(server.content.string.contains("Deuxième version."))130        let untouched = try await api.pageHead(id: page.id)131        XCTAssertEqual(untouched.version, 2, "nothing was written")132133        let restored = try await api.restoreHistoryEntry(pageID: page.id, versionID: entry, baseVersion: 2)134        XCTAssertTrue(restored.ok)135        XCTAssertEqual(restored.version, 3)136        XCTAssertEqual(restored.restored, 1)137        let detail = try await api.page(id: page.id)138        XCTAssertTrue(detail.page.content.string.contains("Première version."))139        XCTAssertEqual(detail.page.version, 3)140        let after = try await api.pageVersions(pageID: page.id)141        XCTAssertGreaterThan(after.count, versions.count, "the state before the restoration is kept in the history")142143        let missing = await captureAPIError { try await api.restoreHistoryEntry(pageID: page.id, versionID: NotesAPI.newID()) }144        XCTAssertEqual(missing?.code, APIError.NextCode.notFound)145        let malformed = await captureAPIError { try await api.restoreHistoryEntry(pageID: page.id, versionID: "zz") }146        XCTAssertEqual(malformed?.status, 400)147        let noScope = await captureAPIError { try await api.timeMachine(pageID: NotesAPI.newID(), at: Date()) }148        XCTAssertEqual(noScope?.isNotFound, true)149    }150}151
Files main
Menu

Theme