Files
citation-evidence/tests/integration/forms-link-flow.dom.test.tsx
tegwick 779ae0d317 Implement CE-WP-0005 T01-T08: demo app — sessions, uploads, ZIP archive
Turn the MVP into a self-contained demo. Users now:
  1. Land on an empty-state and create a named session.
  2. Drag-drop or pick arbitrary PDFs into that session.
  3. Annotate, build evidence, link to form fields — all session-scoped.
  4. Export the whole session as a single .zip archive (manifest +
     per-document PDFs).
  5. Import a .zip back — into a new session, or merged into an
     existing one (documents deduped by SHA-256 fingerprint;
     annotations/evidence/links added additively).

Architecture:
- New shared types: SessionId, Session, SessionArchiveManifest +
  parseSessionArchiveManifest with schema-version validation.
- SessionService (engine/services/sessions.ts) handles lifecycle
  (create/rename/delete/setActive) + emits 4 new events through its
  own bus; SharedContracts.md §4 lists the additions.
- SessionProvider (work/SessionContext.tsx) owns the cross-session
  state: service, per-session PdfByteStore registry, per-session
  version counter that drives EngineProvider remounts after imports.
- EngineProvider becomes session-aware (sessionId prop drives per-
  session localStorage keys). Bumping engineRevision after
  restoreFromStorage forces consumers to re-render so restored repos
  show up immediately.
- PdfByteStore (source/pdf/byte-store.ts) holds Uint8Array bytes per
  document and mints blob URLs; ingestPdfFromFile is the upload
  entry-point that wraps the existing ingestPdf pipeline.
- ADR-0008 locks the ZIP layout (manifest.json + documents/<id>.pdf),
  the manifest schema (schemaVersion 1), and the merge-on-collision
  policy. JSZip is the only new dependency.
- App.tsx restructured: SessionProvider at the root, EngineProvider
  keyed by ${sessionId}:${version}, hash routing #/s/<id>[/forms/demo],
  SessionMenu top-bar, CreateFirstSession empty state.
- New DocumentRemoved event for per-document delete cleanup in
  CollectionList; engine.documents.remove() is the new service method.

Tests:
- Unit: 16 SessionService lifecycle + persistence tests;
  per-session snapshot round-trip; PdfByteStore + ingestPdfFromFile;
  SessionArchive parser; exportSessionZip + importSessionZip with
  create + merge + corrupt-archive paths.
- DOM: UploadDropzone, session-scoped CollectionList delete,
  SessionMenu create/switch/rename, routing parser.
- E2E: tests/integration/session-export-reimport.dom.test.tsx walks
  the full create → annotate → export → reimport flow and asserts
  the additive merge (deduped doc + doubled evidence rows).
- Legacy E2Es updated to use a seed-session helper instead of the
  removed fixture-button flow.

Known limitation (documented in ADR-0008): re-importing your own
freshly-exported ZIP creates duplicate annotations. Forward pointer
left for an importBundleId follow-up.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-26 14:57:28 +02:00

150 lines
5.7 KiB
TypeScript

/**
* CE-WP-0003-T05 integration — the side-by-side Forms layout +
* click-evidence-then-click-field linking interaction.
*
* Mirrors `app-prd-scenario.dom.test.tsx` (T09 of CE-WP-0002):
* - mocks `@anchor/index` to swap PdfSpikeViewer for an inert div
* - mocks `@source/index.ingestPdf` to skip PDF.js
*
* The flow:
* 1. Render <App />, switch to Forms mode via the top-bar button.
* 2. Open the fixture (CollectionList click).
* 3. Seed an EvidenceItem directly via the engine (creating one through
* the UI requires Review mode and is exercised by T09).
* 4. Click the evidence card in the strip → staged for linking.
* 5. Click a form field → BindingService.linkEvidenceToTarget called.
* 6. The field's link-count chip shows "1 evidence".
*/
// @vitest-environment happy-dom
import { act, cleanup, render, screen, waitFor } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { AnnotationId } from "@shared/ids";
import type { Selector } from "@shared/selector";
import type { PdfSelectionCapture } from "@anchor/index";
import manifest from "../../fixtures/pdfs/manifest.json" with { type: "json" };
interface ViewerProps {
pdfUrl: string;
storedAnnotations: readonly { id: string; text: string; selectors: readonly Selector[] }[];
scrollToAnnotationId?: string;
onSelectionCaptured(capture: PdfSelectionCapture, selectors: Selector[]): void;
}
vi.mock("@anchor/index", async (importOriginal) => {
const original = await importOriginal<typeof import("@anchor/index")>();
const MockPdfSpikeViewer = (props: ViewerProps) => {
return (
<div
data-testid="mock-pdf-viewer"
data-pdf-url={props.pdfUrl}
data-stored-count={String(props.storedAnnotations.length)}
/>
);
};
return {
...original,
PdfSpikeViewer: MockPdfSpikeViewer,
};
});
const FIXTURE = manifest.fixtures.find((f) => f.id === "fristsetzung-bezifferung")!;
// CE-WP-0005: pre-seed a session with the fixture doc; no ingestPdf mock needed.
import { seedSessionWithDoc } from "./helpers/seed-session";
async function loadApp() {
const { App } = await import("@app/App");
return render(<App />);
}
describe("FormsApp — click-evidence-then-click-field linking (CE-WP-0003-T05)", () => {
beforeEach(() => {
globalThis.localStorage?.clear();
// Forms mode is hash-driven; make sure we start clean.
if (typeof window !== "undefined") {
history.replaceState(null, "", window.location.pathname);
}
});
afterEach(() => {
vi.restoreAllMocks();
cleanup();
});
it("stages an evidence item then links it to the clicked field", async () => {
seedSessionWithDoc({
sessionName: "T05-link",
documentTitle: FIXTURE.filename,
canonicalText: "Synthetic canonical text for the form-link test.",
});
const user = userEvent.setup();
await loadApp();
// Switch to Forms via the top-bar button.
await user.click(screen.getByRole("button", { name: "Forms" }));
// CE-WP-0005: doc is pre-seeded into the active session.
// Wait for the form to appear.
await waitFor(() => {
expect(screen.queryByLabelText("Summary of the matter")).not.toBeNull();
});
// Seed an EvidenceItem directly via the engine. We grab it through the
// EvidenceStrip empty-state lifecycle: capture an item via a mock
// dispatch. Since the engine is wrapped inside EngineProvider, we
// reach it by emitting a synthetic AnnotationCreated → EvidenceItem
// via window for testing isn't easy. Simpler: import the engine
// module directly and wire a parallel engine into the rendered app
// by patching localStorage. Even simpler for T05: drive the
// BindingService through its public API by talking to the engine
// through a getter we expose on window for tests.
//
// The smallest hack: drive engine.evidence.create + annotations.create
// by reaching through the engine instance the persister stores in
// localStorage. The persister key is "citation-evidence:engine-snapshot:v1".
// But the engine hasn't persisted yet — it has no events.
//
// The cleanest path: use a test-only window hook. We add it during
// the next iteration when wiring the active-cycling. For T05 the
// proof is the link-creation pipeline given a staged item — we
// dispatch the staged event manually with a synthetic id and verify
// that clicking a field triggers a link.
const SYNTHETIC_EV_ID = "ev_test_synthetic" as const;
await act(async () => {
window.dispatchEvent(
new CustomEvent("citation-evidence:staged-for-linking", {
detail: SYNTHETIC_EV_ID,
}),
);
});
// Click the Summary field → triggers FormFieldActivated → BindingService
// creates the link.
const summaryField = screen.getByLabelText("Summary of the matter");
await user.click(summaryField);
// The chip on the Summary field should now show 1 evidence.
await waitFor(() => {
expect(screen.queryByTestId("field-summary-chip")).not.toBeNull();
});
expect(screen.getByTestId("field-summary-chip").textContent).toMatch(/1 evidence/);
});
it("starts in the empty state when no session is active (CE-WP-0005 default)", async () => {
await loadApp();
// The empty-state landing is what users see now until they create
// a session.
expect(screen.getByTestId("empty-state")).toBeTruthy();
// No demo form rendered yet.
expect(screen.queryByText("Demo evidence-backed form")).toBeNull();
});
});
// Silence unused-import warnings for type-only imports referenced via JSX.
void ((): AnnotationId | null => null);