SPB Git

Repository Public

ParityResearchFixtureTests.swift 17.1 KB 274 lines swift

1// SP Notes Core2// File: Tests/SPNotesAPITests/ParityResearchFixtureTests.swift3// Description: The research models decode the real answers of the scratch backend (group `research`): references,4//              extracts, DOI, BibTeX, experiments, research tasks, overview, feed rows — and the examples of the AI5//              contract for the routes the foundation server does not have (`ai-doc-parity`).6//7// Author: Simon-Pierre Boucher8// Contact: contact@spboucher.ai9import Foundation10import XCTest11@testable import SPNotesAPI1213final class ParityResearchFixtureTests: XCTestCase {14    private let group = "research"1516    func testReferences() throws {17        let created = try NextFixture.decode(ResearchReference.self, group, "ref-create")18        XCTAssertEqual(created.citeKey, "doe2021parity")19        XCTAssertEqual(created.entryType, "article")20        XCTAssertEqual(created.authors, ["Jane Doe", "John Roe"])21        XCTAssertEqual(created.year, 2021)22        XCTAssertEqual(created.journal, "Journal of Housing Finance")23        XCTAssertEqual(created.verified, ReferenceVerification.user)24        XCTAssertTrue(created.bibtex?.hasPrefix("@article{doe2021parity,") ?? false)25        XCTAssertEqual(try created.fields?.decode([String: String].self)["volume"], "12")26        XCTAssertNotNil(created.pageId)27        XCTAssertNotNil(created.rev)28        XCTAssertNil(created.deletedAt)29        XCTAssertNil(created.label, "label and citation only come with ?ids= on a server that has the AI workstream")3031        // The same client id again: 201, no x-existing, nothing overwritten.32        let again = try NextFixture.load(group, "ref-create-again")33        XCTAssertEqual(again.entry.status, 201)34        XCTAssertNil(again.entry.headers["x-existing"])35        XCTAssertEqual(try APIJSON.decoder().decode(ResearchReference.self, from: again.data), created)3637        let minimal = try NextFixture.decode(ResearchReference.self, group, "ref-create-minimal")38        XCTAssertEqual(minimal.authors, [])39        XCTAssertNil(minimal.pageId)40        XCTAssertFalse(minimal.citeKey.isEmpty, "the server derives a cite key")4142        XCTAssertEqual(try NextFixture.decode([ResearchReference].self, group, "ref-list-page").map(\.id), [created.id])43        XCTAssertEqual(Set(try NextFixture.decode([ResearchReference].self, group, "ref-list-library").map(\.id)), [created.id, minimal.id])44        XCTAssertEqual(try NextFixture.decode(ResearchReference.self, group, "ref-get"), created)4546        let patched = try NextFixture.decode(ResearchReference.self, group, "ref-patch")47        XCTAssertEqual(patched.year, 2022)48        XCTAssertNil(patched.journal)49        let fields = try XCTUnwrap(try patched.fields?.decode([String: String].self))50        XCTAssertEqual(fields["volume"], "13")51        XCTAssertEqual(fields["note"], "revised")52        XCTAssertNil(fields["pages"], "an empty value removes a tag")53        XCTAssertGreaterThan(patched.rev ?? 0, created.rev ?? 0)54        // A cite key already taken is de-duplicated silently.55        let renamed = try NextFixture.decode(ResearchReference.self, group, "ref-patch-citekey-taken")56        XCTAssertNotEqual(renamed.citeKey, minimal.citeKey)57        XCTAssertTrue(renamed.citeKey.hasPrefix(minimal.citeKey))5859        let links = try NextFixture.decode(ReferenceLinks.self, group, "ref-links")60        XCTAssertEqual(links.attached?.id, created.pageId)61        XCTAssertEqual(links.attached?.type, "research")62        XCTAssertEqual(links.citing?.count, 0)63        XCTAssertNil(links.pdf)64        XCTAssertNil(try NextFixture.decode(ResearchReference.self, group, "ref-attach-none").attachmentId)65    }6667    func testReferenceErrorsDeleteAndRestore() throws {68        let missing = try NextFixture.error(group, "ref-not-found")69        XCTAssertTrue(missing.isNotFound)70        XCTAssertEqual(missing.code, APIError.NextCode.notFound)71        XCTAssertEqual(try NextFixture.error(group, "ref-bad-id").code, APIError.NextCode.badRequest)72        XCTAssertEqual(try NextFixture.error(group, "ref-validation").status, 400)73        XCTAssertEqual(try NextFixture.error(group, "ref-attach-unknown").code, APIError.NextCode.notFound)74        XCTAssertEqual(try NextFixture.error(group, "ref-verify-no-doi").code, ParityCode.invalidDOI)75        XCTAssertEqual(try NextFixture.error(group, "ref-unknown-action").status, 400)7677        XCTAssertTrue(try NextFixture.decode(OKResult.self, group, "ref-delete").ok)78        XCTAssertTrue(try NextFixture.error(group, "ref-get-deleted").isNotFound, "a deleted reference is not readable by id")79        // Creating again with the id of a deleted reference: the stored (deleted) row comes back, not resurrected.80        let stale = try NextFixture.decode(ResearchReference.self, group, "ref-create-deleted-id")81        XCTAssertNotNil(stale.deletedAt)82        XCTAssertNotEqual(stale.title, "Fixture · after delete")83        let restored = try NextFixture.decode(ResearchReference.self, group, "ref-restore")84        XCTAssertNil(restored.deletedAt)85        XCTAssertEqual(restored.id, stale.id)86        XCTAssertTrue(try NextFixture.decode(OKResult.self, group, "ref-delete-again").ok)87    }8889    func testReferenceFeedRows() throws {90        let feed = try NextFixture.decode(SyncPage.self, group, "feed-references")91        let rows = try XCTUnwrap(feed.entities?[SyncKind.reference]).map { try $0.decode(ResearchReference.self) }92        let live = rows.filter { $0.deletedAt == nil }93        XCTAssertEqual(live.count, 6)94        XCTAssertTrue(rows.allSatisfy { $0.rev != nil && $0.createdAt != nil })95        XCTAssertEqual(live.first { $0.doi != nil && $0.verified == ReferenceVerification.doiVerified }?.citeKey, "fama1970efficient")96        // Observed: a deleted reference gives its cite key back (`key~<id prefix>`) when a new reference takes it, and97        // re-enters the feed with a new rev.98        XCTAssertTrue(rows.filter { $0.deletedAt != nil }.allSatisfy { $0.citeKey.contains("~") })99        let created = try NextFixture.decode(ResearchReference.self, group, "ref-create")100        let after = try NextFixture.decode(SyncPage.self, group, "feed-references-deleted")101        let row = try XCTUnwrap(after.entities?[SyncKind.reference]?.first { $0.id == created.id })102        XCTAssertNotNil(row.deletedAt, "a deleted reference stays in the feed as a row with deletedAt")103        XCTAssertNotNil(try row.decode(ResearchReference.self).deletedAt)104    }105106    func testExtracts() throws {107        let added = try NextFixture.decode(ReferenceExtractChange.self, group, "extract-create")108        let extract = try XCTUnwrap(added.extract)109        XCTAssertEqual(extract.quote, "Prepayment speeds rise when the curve steepens.")110        XCTAssertEqual(extract.page, "p. 7")111        XCTAssertEqual(extract.note, "à citer")112        XCTAssertNotNil(extract.createdAt.flatMap(APIDate.parse))113        XCTAssertEqual(added.extracts.map(\.id), [extract.id])114        XCTAssertEqual(try NextFixture.decode(ReferenceExtractChange.self, group, "extract-create-again").extract?.quote, extract.quote, "same id: never overwritten")115        let patched = try XCTUnwrap(try NextFixture.decode(ReferenceExtractChange.self, group, "extract-patch").extract)116        XCTAssertNil(patched.note)117        XCTAssertEqual(patched.page, "p. 8")118        XCTAssertNotNil(patched.updatedAt)119        XCTAssertEqual(try NextFixture.decode([ReferenceExtract].self, group, "extract-list"), [patched])120        let removed = try NextFixture.decode(ReferenceExtractChange.self, group, "extract-delete")121        XCTAssertEqual(removed.extract, patched, "the removed extract comes back for an undo")122        XCTAssertEqual(removed.extracts, [])123        XCTAssertNil(try NextFixture.decode(ReferenceExtractChange.self, group, "extract-delete-again").extract)124        XCTAssertEqual(try NextFixture.decode(ReferenceExtractChange.self, group, "extract-restore").extracts, [patched])125        XCTAssertEqual(try NextFixture.error(group, "extract-delete-no-id").status, 400)126        // What restore sends back is byte-compatible with what delete returned.127        let body = try APIJSON.encoder().encode(patched)128        XCTAssertEqual(try APIJSON.decoder().decode(ReferenceExtract.self, from: body), patched)129    }130131    func testDOI() throws {132        let preview = try NextFixture.decode(DOILookup.self, group, "doi-lookup")133        XCTAssertEqual(preview.doi, "10.2307/2325486")134        XCTAssertEqual(preview.authors, ["Eugene F. Fama"])135        XCTAssertEqual(preview.year, 1970)136        XCTAssertEqual(preview.journal, "The Journal of Finance")137        XCTAssertEqual(preview.citeKey, "fama1970efficient")138        XCTAssertEqual(try preview.fields?.decode([String: String].self)["volume"], "25")139        XCTAssertNil(preview.duplicate)140141        let added = try NextFixture.decode(DOIAddResult.self, group, "doi-add")142        XCTAssertEqual(try NextFixture.load(group, "doi-add").entry.status, 201)143        XCTAssertFalse(added.duplicate)144        XCTAssertEqual(added.reference.verified, ReferenceVerification.doiVerified)145        XCTAssertEqual(added.reference.doi, preview.doi)146        let duplicate = try NextFixture.decode(DOIAddResult.self, group, "doi-add-duplicate")147        XCTAssertEqual(try NextFixture.load(group, "doi-add-duplicate").entry.status, 200)148        XCTAssertTrue(duplicate.duplicate)149        XCTAssertFalse(duplicate.linked)150        XCTAssertEqual(duplicate.reference.id, added.reference.id)151        let known = try NextFixture.decode(DOILookup.self, group, "doi-lookup-duplicate")152        XCTAssertEqual(known.duplicate?.id, added.reference.id)153        XCTAssertEqual(known.duplicate?.citeKey, "fama1970efficient")154        XCTAssertNil(known.fields)155        XCTAssertEqual(try NextFixture.decode(ResearchReference.self, group, "ref-verify").verified, ReferenceVerification.doiVerified)156157        XCTAssertEqual(try NextFixture.error(group, "doi-missing").code, ParityCode.invalidDOI)158        XCTAssertEqual(try NextFixture.error(group, "doi-invalid").code, ParityCode.invalidDOI)159        let unknown = try NextFixture.error(group, "doi-not-found")160        XCTAssertEqual(unknown.status, 404)161        XCTAssertEqual(unknown.code, ParityCode.doiNotFound)162    }163164    func testBibTeX() throws {165        let dry = try NextFixture.decode(BibTeXImportResult.self, group, "bibtex-dry-run")166        XCTAssertTrue(dry.dryRun)167        XCTAssertEqual(dry.parsed, 3)168        XCTAssertEqual(dry.created, [])169        XCTAssertEqual(dry.wouldCreate.first, BibTeXCandidate(citeKey: "roe2019parity", title: "Fixture: Rents and Rates", year: 2019))170        XCTAssertEqual(dry.counts?.wouldCreate, dry.wouldCreate.count)171172        let real = try NextFixture.decode(BibTeXImportResult.self, group, "bibtex-import")173        XCTAssertFalse(real.dryRun)174        XCTAssertEqual(real.created.count, real.counts?.created)175        XCTAssertEqual(real.created.first?.citeKey, "roe2019parity")176        XCTAssertFalse(real.created.first?.id.isEmpty ?? true)177178        // The same file again: every entry is a duplicate, skipped with its reason.179        let second = try NextFixture.decode(BibTeXImportResult.self, group, "bibtex-import-file-dry-run")180        XCTAssertEqual(second.counts?.skipped, 3)181        XCTAssertEqual(second.skipped.first?.existingKey, "roe2019parity")182        XCTAssertTrue(second.skipped.first?.reason?.contains("same DOI") ?? false)183        XCTAssertEqual(try NextFixture.error(group, "bibtex-empty").code, ParityCode.bibtexEmpty)184185        let export = try NextFixture.load(group, "bib-export-page")186        XCTAssertTrue(export.entry.headers["content-type"]?.hasPrefix("application/x-bibtex") ?? false)187        XCTAssertEqual(export.entry.headers["content-disposition"].flatMap(NotesAPI.filename(fromContentDisposition:)), "fixture-working-paper-parity.bib")188        let text = String(decoding: export.data, as: UTF8.self)189        XCTAssertTrue(text.contains("@article{fama1970efficient,"))190        XCTAssertNil(try NextFixture.load(group, "bib-export-inline").entry.headers["content-disposition"], "inline=1: no attachment header")191        XCTAssertEqual(try NextFixture.error(group, "bib-export-bad-page").status, 400)192    }193194    func testExperimentsTasksAndOverview() throws {195        let created = try NextFixture.decode(ResearchExperiment.self, group, "experiment-create")196        XCTAssertEqual(created.name, "Fixture · GARCH baseline")197        XCTAssertEqual(created.status, ExperimentStatus.running)198        XCTAssertEqual(try created.params?.decode([String: Int].self), ["p": 1, "q": 1])199        XCTAssertEqual(created.datasetRef, "findata://spy/1min")200        XCTAssertNotNil(created.startedAt, "running sets startedAt")201        XCTAssertNil(created.finishedAt)202        let patched = try NextFixture.decode(ResearchExperiment.self, group, "experiment-patch")203        XCTAssertEqual(patched.status, ExperimentStatus.done)204        XCTAssertEqual(try patched.metrics?.decode([String: Double].self), ["qlike": 0.398, "mse": 1.2])205        XCTAssertNil(patched.notes)206        XCTAssertNotNil(patched.finishedAt)207        XCTAssertEqual(try NextFixture.decode([ResearchExperiment].self, group, "experiment-list-page"), [patched])208        XCTAssertTrue(try NextFixture.decode([ResearchExperiment].self, group, "experiment-list").contains(patched))209        XCTAssertEqual(try NextFixture.error(group, "experiment-validation").status, 400)210        XCTAssertTrue(try NextFixture.error(group, "experiment-not-found").isNotFound)211        XCTAssertTrue(try NextFixture.decode(OKResult.self, group, "experiment-delete-again").ok, "deleting twice answers 200")212213        let task = try NextFixture.decode(TaskItem.self, group, "rtask-create")214        XCTAssertEqual(task.status, TaskStatus.doing.rawValue)215        XCTAssertEqual(task.priority, "high")216        XCTAssertEqual(task.project, "wp-parity")217        // Observed: a bare day is stored at 00:00 UTC by the research route (12:00 UTC by /api/tasks).218        XCTAssertEqual(task.dueAt.map(APIDate.string(from:)), "2026-12-05T00:00:00.000Z")219        XCTAssertEqual(try NextFixture.decode([TaskItem].self, group, "rtask-create-bulk").map(\.priority), ["medium", "low"])220        let done = try NextFixture.decode(TaskItem.self, group, "rtask-patch")221        XCTAssertTrue(done.isDone)222        XCTAssertNil(done.dueAt)223        XCTAssertEqual(try NextFixture.decode([TaskItem].self, group, "rtask-list").count, 3)224        XCTAssertNil(try NextFixture.decode(TaskItem.self, group, "rtask-restore").deletedAt)225        XCTAssertEqual(try NextFixture.error(group, "rtask-list-no-page").status, 400)226        XCTAssertTrue(try NextFixture.error(group, "rtask-not-found").isNotFound)227        // GET /api/tasks reads the same tasks, `doing` included in the model.228        let general = try NextFixture.decode([TaskItem].self, group, "tasks-list-doing")229        XCTAssertEqual(general.count, 3)230        XCTAssertNotNil(general.first?.pageTitle)231232        let paper = try NextFixture.decode(Page.self, group, "paper-create")233        XCTAssertEqual(paper.type, "research")234        XCTAssertEqual(paper.section, "research")235        XCTAssertEqual(paper.icon, "🔬")236        XCTAssertEqual(try NextFixture.error(group, "paper-validation").status, 400)237        let overview = try NextFixture.decode([ResearchPaperOverview].self, group, "overview")238        let row = try XCTUnwrap(overview.first { $0.id == paper.id })239        XCTAssertEqual(row.status, PaperStatus.writing)240        XCTAssertEqual(row.venue, "JREFE")241        XCTAssertEqual(row.references, 5)242        XCTAssertEqual(row.experiments, 1)243        XCTAssertEqual(row.experimentsRunning, 0)244        XCTAssertEqual(row.openTasks, 2)245        XCTAssertGreaterThan(row.wordCount ?? 0, 0)246        XCTAssertNotNil(row.lastActivity)247    }248249    /// The additions of the AI workstream: what the foundation server answers, and the contract's examples.250    func testAIWorkstreamAdditions() throws {251        // The foundation server ignores ?ids= and ?projectId=: it answers the whole library.252        let ignored = try NextFixture.load(group, "ref-list-ids")253        XCTAssertNil(ignored.entry.headers["x-missing-ids"])254        XCTAssertEqual(try APIJSON.decoder().decode([ResearchReference].self, from: ignored.data).count,255                       try NextFixture.decode([ResearchReference].self, group, "ref-list-project").count)256        XCTAssertTrue(try NextFixture.error(group, "export-tex").isRouteMissing)257        XCTAssertTrue(try NextFixture.error(group, "export-tex-json").isRouteMissing)258259        let documented = try NextFixture.load("ai-doc-parity", "references-ids")260        let rows = try APIJSON.decoder().decode([ResearchReference].self, from: documented.data)261        XCTAssertEqual(rows.first?.label, "Doe & Roe (2021)")262        XCTAssertTrue(rows.first?.citation?.hasPrefix("Doe, J., & Roe, J. (2021).") ?? false)263        XCTAssertEqual(rows.first?.citeKey, "doe2021prepayment")264        XCTAssertEqual(documented.entry.headers["x-missing-ids"], "00000000-0000-4000-8000-000000000000")265266        let report = try NextFixture.decode(LaTeXExportReport.self, "ai-doc-parity", "export-tex-report")267        XCTAssertEqual(report.pages, 2)268        XCTAssertEqual(report.sections, 1)269        XCTAssertEqual(report.missingKeys, 0)270        XCTAssertEqual(report.unknownNodes, [])271        XCTAssertEqual(try NextFixture.error("ai-doc-parity", "export-tex-bad-id").code, ParityCode.badID)272    }273}274
Files main
Menu

Theme