Repository Public
1// SP Notes Core2// File: Tests/SPNotesAPITests/NextTimelineFixtureTests.swift3// Description: The journal and time machine models decode the real answers of the scratch backend (group `timeline`,4// recorded by Scripts/recorders/timeline.py): events and their paging, page / project states at a date,5// restoring a history entry and its 409.6//7// Author: Simon-Pierre Boucher8// Contact: contact@spboucher.ai9import Foundation10import XCTest11@testable import SPNotesAPI1213final class NextTimelineFixtureTests: XCTestCase {14 func testEventPaging() throws {15 let first = try NextFixture.decode(EventPage.self, "timeline", "events-page")16 XCTAssertEqual(first.events.count, 3, "limit=3")17 let cursor = try XCTUnwrap(first.nextCursor)18 XCTAssertFalse(cursor.isEmpty)19 let second = try NextFixture.decode(EventPage.self, "timeline", "events-page-next")20 XCTAssertFalse(second.events.isEmpty)21 XCTAssertTrue(Set(first.events.map(\.id)).isDisjoint(with: second.events.map(\.id)), "a page never repeats an event")22 let all = first.events + second.events23 XCTAssertEqual(all.map(\.at), all.map(\.at).sorted(by: >), "newest first across pages")24 XCTAssertEqual(Set(all.compactMap(\.pageId)).count, 1, "pageId scope")25 XCTAssertTrue(all.allSatisfy { $0.pageTitle == "Fixture · temps · journal" })26 XCTAssertTrue(all.allSatisfy { $0.actor == EventActor.user && $0.device == "SP Notes · Mac" }, "the device label comes from the User-Agent")27 }2829 func testEventKindsAndData() throws {30 let page = try NextFixture.decode(EventPage.self, "timeline", "events-project")31 XCTAssertNil(page.nextCursor, "everything fits in limit=200")32 let kinds = Set(page.events.map(\.kind))33 XCTAssertTrue(kinds.isSubset(of: Set(EventKind.all)), "\(kinds.subtracting(EventKind.all))")34 XCTAssertTrue(kinds.isSuperset(of: [EventKind.pageCreated, EventKind.pageRenamed, EventKind.pageEdited, EventKind.pageVersion, EventKind.pageArchived,35 EventKind.pageUnarchived, EventKind.tagAdded, EventKind.linkAdded, EventKind.referenceLinked,36 EventKind.relationCreated, EventKind.relationRemoved, EventKind.taskCreated, EventKind.taskCompleted]), "\(kinds)")3738 let renamed = try XCTUnwrap(page.events.first { $0.kind == EventKind.pageRenamed })39 XCTAssertEqual(renamed.entityKind, "page")40 XCTAssertEqual(renamed.entityId, renamed.pageId)41 XCTAssertEqual(renamed.dataString("from"), "Fixture · temps · données")42 XCTAssertEqual(renamed.dataString("to"), "Fixture · temps · données v2")43 XCTAssertEqual(renamed.family, "page")4445 let tag = try XCTUnwrap(page.events.first { $0.kind == EventKind.tagAdded })46 XCTAssertEqual(tag.entityKind, "tag")47 XCTAssertEqual(tag.entityId, "fixture-temps", "the entity id of a tag is its name")48 XCTAssertEqual(tag.summary, "fixture-temps")4950 let removed = try XCTUnwrap(page.events.first { $0.kind == EventKind.relationRemoved })51 XCTAssertEqual(removed.entityKind, "edge")52 XCTAssertEqual(removed.dataString("relationId"), removed.entityId)53 XCTAssertEqual(removed.dataString("relType"), RelationType.partOf)54 XCTAssertEqual(removed.summary, "Fixture · temps · journal — part_of → Fixture · temps · projet")5556 let version = try XCTUnwrap(page.events.first { $0.kind == EventKind.pageVersion && $0.dataString("reason") == "manual" })57 XCTAssertEqual(version.entityKind, "page_version")58 struct VersionData: Decodable { var version: Int; var reason: String }59 XCTAssertEqual(try XCTUnwrap(version.data).decode(VersionData.self).version, 2)6061 let link = try XCTUnwrap(page.events.first { $0.kind == EventKind.linkAdded })62 XCTAssertNotNil(link.dataString("sourceBlockId"))63 XCTAssertEqual(link.dataString("toTitle"), "Fixture · temps · données")64 let cited = try XCTUnwrap(page.events.first { $0.kind == EventKind.referenceLinked })65 XCTAssertEqual(cited.entityKind, "reference")66 XCTAssertEqual(cited.dataString("via"), "citation")67 let done = try XCTUnwrap(page.events.first { $0.kind == EventKind.taskCompleted })68 XCTAssertEqual(done.summary, "Fixture · tâche du journal")69 XCTAssertEqual(done.data, RawJSON.emptyObject)7071 let filtered = try NextFixture.decode(EventPage.self, "timeline", "events-project-kinds")72 XCTAssertFalse(filtered.events.isEmpty)73 XCTAssertTrue(filtered.events.allSatisfy { $0.family == "relation" || $0.family == "task" || $0.kind == EventKind.pageRenamed }, "families and exact kinds")74 let range = try NextFixture.decode(EventPage.self, "timeline", "events-range")75 XCTAssertTrue(range.events.contains { $0.kind == EventKind.pageEdited })76 XCTAssertFalse(range.events.contains { $0.kind == EventKind.pageCreated }, "the creation is before `from`")77 XCTAssertLessThanOrEqual(try NextFixture.decode(EventPage.self, "timeline", "events-workspace").events.count, 5)7879 // After the purge the journal survives, without the page's current title.80 let purged = try NextFixture.decode(EventPage.self, "timeline", "events-purged-page")81 let last = try XCTUnwrap(purged.events.first)82 XCTAssertEqual(last.kind, EventKind.pagePurged)83 XCTAssertNil(last.pageTitle)84 XCTAssertNotNil(last.summary, "the title at the time of the event is kept")85 }8687 func testEventErrors() throws {88 let kinds = try NextFixture.error("timeline", "events-bad-kinds")89 XCTAssertEqual(kinds.status, 400)90 XCTAssertEqual(kinds.code, APIError.NextCode.badKinds)91 XCTAssertEqual(kinds.validKinds, EventKind.all, "the 30 kinds, in the server's order")92 let cursor = try NextFixture.error("timeline", "events-bad-cursor")93 XCTAssertEqual(cursor.code, APIError.NextCode.badCursor)94 XCTAssertNil(cursor.validKinds)95 XCTAssertEqual(try NextFixture.error("timeline", "events-both-scopes").code, APIError.NextCode.badRequest)96 XCTAssertEqual(try NextFixture.error("timeline", "events-bad-date").code, APIError.NextCode.badRequest)97 let missing = try NextFixture.error("timeline", "events-project-not-found")98 XCTAssertTrue(missing.isNotFound)99 XCTAssertFalse(missing.isRouteMissing)100 }101102 func testTimeMachinePage() throws {103 let now = try NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-page-now")104 XCTAssertNotNil(now.scope?.pageId)105 XCTAssertNil(now.scope?.projectId)106 XCTAssertNotNil(now.journalSince)107 let current = try XCTUnwrap(now.pages.first)108 XCTAssertEqual(now.pages.count, 1)109 XCTAssertEqual(current.id, now.scope?.pageId)110 XCTAssertEqual(current.source, TimeMachineSource.current)111 XCTAssertEqual(current.exact, true)112 XCTAssertTrue(current.existed)113 XCTAssertEqual(current.version, 3)114 XCTAssertNil(current.versionId, "nothing to restore: it is the present state")115 XCTAssertEqual(current.changedSince, false)116 XCTAssertEqual(current.title, "Fixture · temps · données v2")117 XCTAssertEqual(current.currentTitle, current.title)118 XCTAssertTrue(try XCTUnwrap(current.content).string.contains("Deuxième version"), "content included for a page scope")119 XCTAssertEqual(current.properties, RawJSON.emptyObject)120 XCTAssertNotNil(current.parentId)121 XCTAssertNil(current.trashedAt)122 XCTAssertEqual(Set(now.relations.map(\.kind)), [RelationKind.link, RelationKind.relation])123 let relation = try XCTUnwrap(now.relations.first { $0.kind == RelationKind.relation })124 XCTAssertEqual(relation.relType, RelationType.supports)125 XCTAssertEqual(relation.fromId, current.id)126 XCTAssertEqual(relation.toTitle, "Fixture · temps · journal")127 XCTAssertNotNil(relation.createdAt)128129 let middle = try NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-page-middle")130 let old = try XCTUnwrap(middle.pages.first)131 XCTAssertEqual(old.source, TimeMachineSource.version)132 XCTAssertEqual(old.exact, false)133 XCTAssertEqual(old.version, 1)134 XCTAssertEqual(old.changedSince, true)135 XCTAssertEqual(old.currentVersion, 3)136 XCTAssertTrue(try XCTUnwrap(old.content).string.contains("Première version"))137 XCTAssertEqual(old.wordCount, 4)138 let versions = try NextFixture.decode([PageVersionSummary].self, "timeline", "versions")139 XCTAssertEqual(old.versionId, versions.first { $0.version == 1 }?.id, "versionId is the id of a history entry")140 XCTAssertLessThanOrEqual(try XCTUnwrap(old.versionAt), middle.at, "the nearest entry at or before the date")141142 let bare = try NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-page-no-content")143 XCTAssertNil(bare.pages.first?.content, "content=0")144 XCTAssertNil(bare.pages.first?.properties)145 XCTAssertEqual(bare.pages.first?.versionId, old.versionId)146147 let before = try NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-page-before")148 let unborn = try XCTUnwrap(before.pages.first)149 XCTAssertFalse(unborn.existed)150 XCTAssertEqual(unborn.source, TimeMachineSource.none)151 XCTAssertNil(unborn.version)152 XCTAssertNil(unborn.versionAt)153 XCTAssertNil(unborn.wordCount)154 XCTAssertTrue(before.relations.isEmpty)155 }156157 func testTimeMachineProject() throws {158 let middle = try NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-project-middle")159 XCTAssertNotNil(middle.scope?.projectId)160 XCTAssertEqual(middle.pages.first?.id, middle.scope?.projectId, "the root first")161 XCTAssertEqual(middle.pages.map(\.title), ["Fixture · temps · projet", "Fixture · temps · données", "Fixture · temps · journal"])162 XCTAssertTrue(middle.pages.allSatisfy { $0.content == nil }, "content omitted for a project scope")163 XCTAssertEqual(middle.pages.map(\.source), [TimeMachineSource.current, TimeMachineSource.version, TimeMachineSource.none])164 XCTAssertNil(middle.pages[0].parentId)165 XCTAssertEqual(middle.pages[1].parentId, middle.pages[0].id)166167 let reference = try XCTUnwrap(middle.references.first)168 XCTAssertEqual(reference.title, "Fixture · Time series analysis")169 XCTAssertEqual(reference.authors, ["Hamilton, James D."])170 XCTAssertEqual(reference.year, 1994)171 XCTAssertNotNil(reference.citeKey)172 XCTAssertTrue(middle.relations.contains { $0.kind == RelationKind.cites && $0.targetKind == GraphEntityKind.reference && $0.toId == reference.id })173 // The relation deleted after `middle` existed then, but its row is gone: it is only known through `removedSince`.174 XCTAssertFalse(middle.relations.contains { $0.relType == RelationType.partOf })175 let removed = try XCTUnwrap(middle.removedSince.first)176 XCTAssertEqual(middle.removedSince.count, 1)177 XCTAssertEqual(removed.kind, EventKind.relationRemoved)178 XCTAssertGreaterThan(removed.at, middle.at)179 XCTAssertEqual(removed.dataString("relType"), RelationType.partOf)180 XCTAssertNil(removed.actor, "removedSince carries a short form of the event")181182 let now = try NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-project-content")183 XCTAssertTrue(now.pages.allSatisfy { $0.content != nil && $0.source == TimeMachineSource.current }, "content=1")184 XCTAssertTrue(now.removedSince.isEmpty)185 XCTAssertFalse(now.relations.contains { $0.relType == RelationType.partOf }, "deleted before the date")186 }187188 func testTimeMachineErrors() throws {189 for name in ["timemachine-no-at", "timemachine-no-scope", "timemachine-both-scopes"] {190 let error = try NextFixture.error("timeline", name)191 XCTAssertEqual(error.status, 400, name)192 XCTAssertEqual(error.code, APIError.NextCode.badRequest, name)193 }194 XCTAssertEqual(try NextFixture.error("timeline", "timemachine-not-found").code, APIError.NextCode.notFound)195 }196197 func testRestore() throws {198 // A stale baseVersion: the standard page conflict with the server copy; nothing was written.199 let conflict = try NextFixture.error("timeline", "restore-conflict")200 XCTAssertTrue(conflict.isConflict)201 let copy = try XCTUnwrap(conflict.serverCopy)202 XCTAssertEqual(copy.version, 3)203 XCTAssertEqual(copy.title, "Fixture · temps · données v2")204 XCTAssertTrue(copy.content.string.contains("Deuxième version"))205 XCTAssertNil(conflict.canvasConflict, "not a canvas conflict")206207 let restored = try NextFixture.decode(HistoryRestoreResult.self, "timeline", "restore")208 XCTAssertTrue(restored.ok)209 XCTAssertEqual(restored.version, 4)210 XCTAssertEqual(restored.restored, 1)211 let byNumber = try NextFixture.decode(HistoryRestoreResult.self, "timeline", "restore-by-number")212 XCTAssertEqual(byNumber.version, 5, "the version number is accepted in place of the entry id")213 XCTAssertEqual(byNumber.restored, 1)214215 let after = try XCTUnwrap(NextFixture.decode(TimeMachineSnapshot.self, "timeline", "timemachine-page-after-restore").pages.first)216 XCTAssertEqual(after.version, 5)217 XCTAssertEqual(after.title, "Fixture · temps · données", "the restored title")218 XCTAssertTrue(try XCTUnwrap(after.content).string.contains("Première version"))219220 let missing = try NextFixture.error("timeline", "restore-not-found")221 XCTAssertEqual(missing.status, 404)222 XCTAssertEqual(missing.code, APIError.NextCode.notFound)223 let malformed = try NextFixture.error("timeline", "restore-bad-id")224 XCTAssertEqual(malformed.status, 400)225 XCTAssertEqual(malformed.code, APIError.NextCode.badRequest)226 }227}228