Files
citation-evidence/tests/integration/forms-active-cycling.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

187 lines
6.4 KiB
TypeScript

/**
* CE-WP-0003-T06 integration — focusing a field auto-activates its first
* linked evidence, the chip is marked aria-current, and the ScrollBridge
* fires scrollTo on the viewer with the right annotation.
*
* Flow:
* 1. Review mode: open fixture, inject a selection capture, save the
* evidence item (T09 pattern).
* 2. Switch to Forms mode.
* 3. Stage the saved evidence in the strip.
* 4. Click a field → BindingService creates a link.
* 5. Click the field again → ActiveStateProvider focuses target →
* chip list re-derives → auto-activates first chip → ScrollBridge
* calls scrollTo → mock viewer sees `scrollToAnnotationId`.
*/
// @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 { 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;
}
interface ViewerSnapshot {
pdfUrl: string | null;
scrollToAnnotationId: string | null;
onSelectionCaptured: ViewerProps["onSelectionCaptured"] | null;
storedAnnotationIds: string[];
}
const viewerSnapshot: ViewerSnapshot = {
pdfUrl: null,
scrollToAnnotationId: null,
onSelectionCaptured: null,
storedAnnotationIds: [],
};
vi.mock("@anchor/index", async (importOriginal) => {
const original = await importOriginal<typeof import("@anchor/index")>();
const MockPdfSpikeViewer = (props: ViewerProps) => {
viewerSnapshot.pdfUrl = props.pdfUrl;
viewerSnapshot.scrollToAnnotationId = props.scrollToAnnotationId ?? null;
viewerSnapshot.onSelectionCaptured = props.onSelectionCaptured;
viewerSnapshot.storedAnnotationIds = props.storedAnnotations.map((a) => a.id);
return (
<div
data-testid="mock-pdf-viewer"
data-pdf-url={props.pdfUrl}
data-scroll-to={props.scrollToAnnotationId ?? ""}
/>
);
};
return { ...original, PdfSpikeViewer: MockPdfSpikeViewer };
});
const FIXTURE = manifest.fixtures.find((f) => f.id === "fristsetzung-bezifferung")!;
const SYNTHETIC_CANONICAL = [
"Pre quote.",
FIXTURE.known_good_quote,
"Post quote.",
].join(" ");
// CE-WP-0005: pre-seed a session with the fixture doc; no ingestPdf mock needed.
import { seedSessionWithDoc } from "./helpers/seed-session";
function syntheticCaptureFor(text: string, page: number): PdfSelectionCapture {
return {
kind: "pdf",
text,
page,
rects: [{ x: 0.1, y: 0.2, width: 0.4, height: 0.04 }],
boundingRect: { x: 0.1, y: 0.2, width: 0.4, height: 0.04 },
};
}
async function loadApp() {
const { App } = await import("@app/App");
return render(<App />);
}
function resetSnapshot() {
viewerSnapshot.pdfUrl = null;
viewerSnapshot.scrollToAnnotationId = null;
viewerSnapshot.onSelectionCaptured = null;
viewerSnapshot.storedAnnotationIds = [];
}
describe("FormsApp — active-evidence cycling (CE-WP-0003-T06)", () => {
beforeEach(() => {
resetSnapshot();
globalThis.localStorage?.clear();
if (typeof window !== "undefined") {
history.replaceState(null, "", window.location.pathname);
}
seedSessionWithDoc({
sessionName: "T06-cycling",
documentTitle: FIXTURE.filename,
canonicalText: SYNTHETIC_CANONICAL,
});
});
afterEach(() => {
vi.restoreAllMocks();
cleanup();
});
it("focusing a linked field auto-activates the first evidence and bridges to viewer scroll", { timeout: 15000 }, async () => {
const user = userEvent.setup();
await loadApp();
// --- Review mode: create an evidence item via the captured-selection flow.
// CE-WP-0005: doc pre-seeded — skip fixture click.
await waitFor(() => expect(viewerSnapshot.onSelectionCaptured).not.toBeNull());
await act(async () => {
viewerSnapshot.onSelectionCaptured!(
syntheticCaptureFor(FIXTURE.known_good_quote, FIXTURE.known_good_quote_page),
[{ type: "TextQuoteSelector", exact: FIXTURE.known_good_quote }],
);
});
const textarea = screen.getByPlaceholderText(/Add a one-line comment/);
await user.type(textarea, "Form-cycling test evidence");
await user.click(screen.getByRole("button", { name: /Save evidence/ }));
await screen.findByText(/Form-cycling test evidence/);
// --- Switch to Forms mode.
await user.click(screen.getByRole("button", { name: "Forms" }));
// The evidence should appear in the Forms strip too (it queries by doc).
const stripCard = await screen.findByRole("button", {
name: /Form-cycling test evidence/,
});
// Stage it.
await user.click(stripCard);
// Click the Summary field → link gets created.
const summaryField = screen.getByLabelText("Summary of the matter");
await user.click(summaryField);
// Link chip on Summary now shows "1 evidence"
await waitFor(
() => {
expect(screen.queryByTestId("field-summary-chip")).not.toBeNull();
},
{ timeout: 4000 },
);
// Resetting the previous scrollToAnnotationId so we can detect a *new*
// scroll triggered by chip auto-activation.
viewerSnapshot.scrollToAnnotationId = null;
// Click the Summary field again — this re-focuses the target. The chip
// computed for it should now contain our evidence; the chips' auto-
// activation effect fires setActiveEvidence; ScrollBridge translates
// it to a viewer scroll.
//
// Note: clicking the same field doesn't fire onFocus if it's already
// focused. Move focus elsewhere first, then back.
await user.click(screen.getByLabelText("Disputed amount"));
await user.click(summaryField);
// The chip rendered inside the form pane has aria-current="true".
await waitFor(() => {
const chip = document.querySelector(
'[data-evidence-id][aria-current="true"]',
);
expect(chip).not.toBeNull();
});
// The viewer was asked to scroll to the underlying annotation.
await waitFor(() => {
expect(viewerSnapshot.scrollToAnnotationId).toMatch(/^ann_/);
});
});
});