Files
PaperClipAI/ui/src/components/DocumentMarkdownBody.test.tsx
T
DottaandPaperclip cd5f930558 Add shareable image galleries to task documents (#18157)
<!-- entire-trail-link-start -->
https://entire.com/gh/paperclipai/-/trails/247/changes/paperclip/247
<!-- entire-trail-link-end -->

## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Task documents hold plans, reports, and image evidence.
> - Task attachments already have an image gallery.
> - Inline document images had no gallery navigation or image links.
> - This change gives each document a gallery that uses the existing
modal.
> - People can review the image sequence and share a link to one image.

## Linked Issues or Issue Description

**What existing behavior does this improve?**

Image review in task documents, including the side panel and Classic
interface.

**Current behavior**

Inline document images do not open a gallery. People cannot move through
them with arrow keys or share a link to one image.

**Proposed behavior**

Select an image to open the gallery. Use arrow keys or Previous and
Next. The URL records its one-based position, for example
`#document-report&image=2`. Reloading that URL opens the selected image.
Revision links keep their exact saved content.

**Reason and benefit**

People can inspect a document's image evidence in reading order and
share the exact view.

No matching issue was found. The latest 300 open PR titles were checked
for related document gallery work.

## What Changed

- Add a document renderer that collects rendered images in reading
order, including reference-style and repeated images.
- Reuse the gallery modal with optional index-change and focus-return
controls.
- Keep the document owner in the saved tab identity when people switch
between local and other-task documents.
- Match explicit current-task document owners with local document tabs.
Keep review and viewer parameters during gallery navigation.
- Treat another Classic review receipt as a new request while image
navigation retains the selected revision.
- Make inline image controls work with a keyboard. Keep focus in the
modal and restore focus on close.
- Keep document, revision, review, and maximized-view link parameters
during image navigation.
- Fix a Classic revision-cache race found by the browser test. Recheck a
pinned revision when the saved document head changes.
- Update the feature and agent access maps. No new server API or
permission is needed.

## Verification

- Passed 119 focused tests for document galleries, the shared gallery,
document rendering, the revision panel, and hash routing.
- Passed all 3 Chromium journeys: desktop, mobile, and Classic. These
use real uploads and saved document revisions.
- The browser journeys also check explicit current-task owners, review
parameters after reopening, other-task links after tab switches, and a
second Classic review link after Return to latest.
- Browser checks cover keyboard and button navigation, wraparound,
shared-link reload, exact historical content, invalid positions, focus
return and containment, scroll locking, and Escape, Close, and backdrop
dismissal.
- UI typecheck, token gates, map checks, and diff whitespace checks
passed.
- The UI production build passed in the browser harness.
- Earlier browser runs found and then verified the Classic
revision-cache fix. A later build exited 137 while the full test suite
ran. The browser run passed after that suite stopped.
- Full repository typecheck and build could not complete because Cargo
is absent. The full repository test run did not complete within this
sandbox. These checks remain subject to CI.

## Risks

- Image positions follow document reading order. Editing an unpinned
document can change those positions. A revision link retains the saved
sequence.
- The shared modal now uses Radix Escape handling. The existing gallery
tests and nested mobile dialog journey pass.
- No schema change or migration.

## Model Used

OpenAI GPT-6 through Codex. The runtime did not expose a more specific
model ID or context window size. Used reasoning, code editing, shell
commands, and browser automation.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-30 07:52:15 -05:00

134 lines
6.9 KiB
TypeScript

// @vitest-environment jsdom
import { act } from "react";
import { createRoot, type Root } from "react-dom/client";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { MemoryRouter, useLocation, useNavigate } from "react-router-dom";
import { afterEach, describe, expect, it } from "vitest";
import { ThemeProvider } from "@/context/ThemeContext";
import { DocumentMarkdownBody } from "./DocumentMarkdownBody";
(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
let root: Root;
let container: HTMLDivElement;
afterEach(async () => {
await act(async () => root?.unmount());
container?.remove();
});
const body = "![First](/first.png)\n\n![Second][shot]\n\n![Repeated](/first.png)\n\n[shot]: https://example.com/second.png";
function LocationProbe() {
const location = useLocation();
const navigate = useNavigate();
return <><output>{location.pathname}{location.search}{location.hash}</output><button onClick={() => navigate(-1)}>Back</button></>;
}
async function render(hash = "", markdown = body, revisionId?: string, documentIssueId?: string, currentIssueId?: string) {
container = document.createElement("div");
document.body.appendChild(container);
root = createRoot(container);
const client = new QueryClient({ defaultOptions: { queries: { retry: false } } });
await act(async () => {
root.render(<MemoryRouter initialEntries={[`/PAP/issues/example?keep=1${hash}`]}>
<QueryClientProvider client={client}><ThemeProvider>
<DocumentMarkdownBody documentKey="report" revisionId={revisionId} documentIssueId={documentIssueId} currentIssueId={currentIssueId}>{markdown}</DocumentMarkdownBody>
<LocationProbe />
</ThemeProvider></QueryClientProvider>
</MemoryRouter>);
});
}
async function click(selector: string) {
const element = document.querySelector<HTMLElement>(selector)!;
expect(element).not.toBeNull();
await act(async () => element.click());
await act(async () => { await new Promise((resolve) => setTimeout(resolve, 0)); });
}
async function key(key: string) {
await act(async () => document.dispatchEvent(new KeyboardEvent("keydown", { key, bubbles: true, cancelable: true })));
await act(async () => { await new Promise((resolve) => setTimeout(resolve, 0)); });
}
function dialog() { return document.querySelector('[role="dialog"]'); }
describe("document image gallery", () => {
it("opens a clicked occurrence, navigates all rendered images, and updates the URL", async () => {
await render("#document-report&viewer=full&thread=thread-1");
await click('[aria-label="Open image: Repeated"]');
expect(dialog()?.textContent).toContain("3 / 3");
expect(dialog()?.querySelector("img")?.getAttribute("src")).toBe("/first.png");
expect(container.querySelector("output")?.textContent).toBe("/PAP/issues/example?keep=1#document-report&thread=thread-1&viewer=full&image=3");
await key("ArrowRight");
expect(dialog()?.textContent).toContain("1 / 3");
await click('button[title="Next"]');
expect(dialog()?.querySelector("img")?.getAttribute("src")).toBe("https://example.com/second.png");
expect(container.querySelector("output")?.textContent).toContain("image=2");
await key("ArrowLeft");
expect(dialog()?.textContent).toContain("1 / 3");
await click('button[title="Previous"]');
expect(dialog()?.textContent).toContain("3 / 3");
await key("Escape");
expect(dialog()).toBeNull();
expect(container.querySelector("output")?.textContent).not.toContain("image=");
expect(container.querySelector("output")?.textContent).toContain("viewer=full");
expect(document.activeElement?.getAttribute("aria-label")).toBe("Open image: Repeated");
});
it("loads a shared image URL for the exact revision and retains it on close", async () => {
await render("#document-report&revision=old&interaction=review&documentIssue=owner&image=2", body, "old", "owner");
expect(dialog()?.textContent).toContain("2 / 3");
expect(dialog()?.querySelector("a")?.getAttribute("href")).toBe("https://example.com/second.png");
await click('button[title="Close"]');
expect(container.querySelector("output")?.textContent).toContain("#document-report&revision=old&interaction=review&documentIssue=owner");
expect(dialog()).toBeNull();
});
it("opens a saved owner after the URL has changed to another document", async () => {
await render("#document-local&documentIssue=wrong-owner", body, "old", "owner");
await click('[aria-label="Open image: First"]');
expect(dialog()?.textContent).toContain("1 / 3");
expect(container.querySelector("output")?.textContent).toContain("#document-report&revision=old&documentIssue=owner&image=1");
await key("ArrowRight");
expect(container.querySelector("output")?.textContent).toContain("documentIssue=owner&image=2");
});
it("opens an explicit current-task link and keeps review parameters through navigation and reopening", async () => {
await render("#document-report&revision=old&interaction=review&viewer=full&documentIssue=current-task&image=2", body, "old", undefined, "current-task");
expect(dialog()?.textContent).toContain("2 / 3");
await key("ArrowRight");
expect(dialog()?.textContent).toContain("3 / 3");
await click('button[title="Close"]');
expect(dialog()).toBeNull();
await click('[aria-label="Open image: First"]');
expect(dialog()?.textContent).toContain("1 / 3");
const url = container.querySelector("output")?.textContent;
expect(url).toContain("revision=old");
expect(url).toContain("interaction=review");
expect(url).toContain("viewer=full");
expect(url).toContain("documentIssue=current-task");
});
it("does not match another task's saved tab to an implicit current-task link", async () => {
await render("#document-report&revision=old&image=2", body, "old", "other-task", "current-task");
expect(dialog()).toBeNull();
await click('[aria-label="Open image: First"]');
expect(dialog()?.textContent).toContain("1 / 3");
expect(container.querySelector("output")?.textContent).toContain("documentIssue=other-task");
});
it.each(["#document-other&image=1", "#document-report&image=100", "#document-report&image=0", "#document-report&revision=old&image=1"])("does not open an unavailable image target: %s", async (hash) => {
await render(hash);
expect(dialog()).toBeNull();
});
it("opens a single image from the keyboard without navigation controls", async () => {
await render("", "![Only](/only.png)");
const image = container.querySelector("img")!;
await act(async () => {
image.focus();
image.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true, cancelable: true }));
});
expect(dialog()?.textContent).toContain("1 / 1");
expect(dialog()?.querySelector('button[title="Next"]')).toBeNull();
await click('[role="dialog"]');
expect(dialog()).toBeNull();
expect(document.activeElement).toBe(image);
});
});