// @vitest-environment jsdom import { act as reactAct } from "react"; import type { ComponentProps } from "react"; import { flushSync } from "react-dom"; import { createRoot } from "react-dom/client"; import { QueryClient, QueryClientProvider } from "@tanstack/react-query"; import type { DocumentRevision, Issue, IssueDocument } from "@paperclipai/shared"; import { ISSUE_CONTINUATION_SUMMARY_DOCUMENT_KEY } from "@paperclipai/shared"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { IssueDocumentsSection } from "./IssueDocumentsSection"; import { queryKeys } from "../lib/queryKeys"; const mockIssuesApi = vi.hoisted(() => ({ listDocuments: vi.fn(), listDocumentRevisions: vi.fn(), restoreDocumentRevision: vi.fn(), upsertDocument: vi.fn(), lockDocument: vi.fn(), unlockDocument: vi.fn(), deleteDocument: vi.fn(), getDocument: vi.fn(), })); const markdownEditorMockState = vi.hoisted(() => ({ emitMountEmptyChange: false, })); // eslint-disable-next-line @typescript-eslint/no-explicit-any (globalThis as any).IS_REACT_ACT_ENVIRONMENT = true; async function act(callback: () => T | Promise): Promise { if (typeof reactAct === "function") { return await (reactAct(callback) as T | Promise); } let result: T | Promise | undefined; flushSync(() => { result = callback(); }); const resolved = await result; await new Promise((resolve) => setTimeout(resolve, 0)); flushSync(() => {}); return resolved as T; } vi.mock("../api/issues", () => ({ issuesApi: mockIssuesApi, })); vi.mock("../hooks/useAutosaveIndicator", () => ({ useAutosaveIndicator: () => ({ state: "idle", markDirty: vi.fn(), reset: vi.fn(), runSave: async (save: () => Promise) => save(), }), })); vi.mock("@/lib/router", () => ({ useLocation: () => ({ hash: "" }), })); vi.mock("./MarkdownBody", () => ({ MarkdownBody: ({ children, className, externalReferences, }: { children: string; className?: string; externalReferences?: Record; }) => (
{children}
), })); vi.mock("./MarkdownEditor", async () => { const React = await import("react"); return { MarkdownEditor: ({ value, onChange, placeholder, contentClassName }: { value: string; onChange?: (value: string) => void; placeholder?: string; contentClassName?: string; }) => { React.useEffect(() => { if (!markdownEditorMockState.emitMountEmptyChange) return; onChange?.(""); }, []); return (
{value || placeholder || ""}
); }, }; }); vi.mock("@/components/ui/button", () => ({ Button: ({ children, onClick, type = "button", ...props }: ComponentProps<"button">) => ( ), })); vi.mock("@/components/ui/input", () => ({ Input: (props: ComponentProps<"input">) => , })); vi.mock("@/components/ui/dropdown-menu", async () => { return { DropdownMenu: ({ children }: { children: React.ReactNode }) =>
{children}
, DropdownMenuTrigger: ({ children }: { children: React.ReactNode }) => <>{children}, DropdownMenuContent: ({ children }: { children: React.ReactNode }) =>
{children}
, DropdownMenuItem: ({ children, onClick, onSelect, disabled }: { children: React.ReactNode; onClick?: () => void; onSelect?: () => void; disabled?: boolean; }) => ( ), DropdownMenuLabel: ({ children }: { children: React.ReactNode }) =>
{children}
, DropdownMenuRadioGroup: ({ children }: { children: React.ReactNode }) =>
{children}
, DropdownMenuRadioItem: ({ children, onSelect, disabled }: { children: React.ReactNode; onSelect?: () => void; disabled?: boolean; }) => ( ), DropdownMenuSeparator: () =>
, }; }); const localStorageEntries = new Map(); function ensureLocalStorageMock() { if ( typeof window.localStorage?.getItem === "function" && typeof window.localStorage?.setItem === "function" && typeof window.localStorage?.removeItem === "function" && typeof window.localStorage?.clear === "function" ) { return; } Object.defineProperty(window, "localStorage", { configurable: true, value: { getItem: (key: string) => localStorageEntries.get(key) ?? null, setItem: (key: string, value: string) => { localStorageEntries.set(key, value); }, removeItem: (key: string) => { localStorageEntries.delete(key); }, clear: () => { localStorageEntries.clear(); }, }, }); } function deferred() { let resolve!: (value: T) => void; const promise = new Promise((res) => { resolve = res; }); return { promise, resolve }; } async function flush() { await act(async () => { await new Promise((resolve) => setTimeout(resolve, 0)); }); } function createIssueDocument(overrides: Partial = {}): IssueDocument { return { id: "document-1", companyId: "company-1", issueId: "issue-1", key: "plan", title: "Plan", format: "markdown", body: "", latestRevisionId: "revision-4", latestRevisionNumber: 4, createdByAgentId: null, createdByUserId: "user-1", updatedByAgentId: null, updatedByUserId: "user-1", lockedAt: null, lockedByAgentId: null, lockedByUserId: null, createdAt: new Date("2026-03-31T12:00:00.000Z"), updatedAt: new Date("2026-03-31T12:05:00.000Z"), ...overrides, }; } function createRevision(overrides: Partial = {}): DocumentRevision { return { id: "revision-3", companyId: "company-1", documentId: "document-1", issueId: "issue-1", key: "plan", revisionNumber: 3, title: "Plan", format: "markdown", body: "Restored plan body", changeSummary: null, createdByAgentId: null, createdByUserId: "user-1", createdAt: new Date("2026-03-31T11:00:00.000Z"), ...overrides, }; } function createIssue(): Issue { return { id: "issue-1", identifier: "PAP-807", companyId: "company-1", projectId: null, projectWorkspaceId: null, goalId: null, parentId: null, title: "Plan rendering", description: null, status: "in_progress", workMode: "standard", priority: "medium", reviewPolicy: null, assigneeAgentId: null, assigneeUserId: null, responsibleUserId: null, createdByAgentId: null, createdByUserId: "user-1", issueNumber: 807, requestDepth: 0, billingCode: null, assigneeAdapterOverrides: null, executionWorkspaceId: null, executionWorkspacePreference: null, executionWorkspaceSettings: null, checkoutRunId: null, executionRunId: null, executionAgentNameKey: null, executionLockedAt: null, startedAt: null, completedAt: null, cancelledAt: null, hiddenAt: null, labels: [], labelIds: [], planDocument: createIssueDocument(), documentSummaries: [createIssueDocument()], legacyPlanDocument: null, createdAt: new Date("2026-03-31T12:00:00.000Z"), updatedAt: new Date("2026-03-31T12:05:00.000Z"), }; } describe("IssueDocumentsSection", () => { let container: HTMLDivElement; beforeEach(() => { container = document.createElement("div"); document.body.appendChild(container); ensureLocalStorageMock(); window.localStorage.clear(); vi.clearAllMocks(); markdownEditorMockState.emitMountEmptyChange = false; }); afterEach(() => { container.remove(); }); it("keeps system handoff documents out of the normal document surface", async () => { const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([ createIssueDocument({ key: "plan", body: "# Plan" }), createIssueDocument({ id: "document-handoff", key: ISSUE_CONTINUATION_SUMMARY_DOCUMENT_KEY, title: "Continuation Summary", body: "# Handoff", }), ]); await act(async () => { root.render( , ); }); await flush(); await flush(); expect(container.textContent).toContain("# Plan"); expect(container.textContent).not.toContain("# Handoff"); expect(container.querySelector(`#document-${ISSUE_CONTINUATION_SUMMARY_DOCUMENT_KEY}`)).toBeNull(); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("copies document bodies through the plain HTTP clipboard fallback", async () => { const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false }, mutations: { retry: false }, }, }); const writeText = vi.fn(async () => {}); const execCommand = vi.fn(() => true); const originalClipboard = Object.getOwnPropertyDescriptor(navigator, "clipboard"); const originalSecureContext = Object.getOwnPropertyDescriptor(window, "isSecureContext"); const originalExecCommand = Object.getOwnPropertyDescriptor(document, "execCommand"); Object.defineProperty(navigator, "clipboard", { configurable: true, value: { writeText }, }); Object.defineProperty(window, "isSecureContext", { configurable: true, value: false, }); Object.defineProperty(document, "execCommand", { configurable: true, value: execCommand, }); mockIssuesApi.listDocuments.mockResolvedValue([ createIssueDocument({ body: "# Copy over HTTP" }), ]); try { await act(async () => { root.render( , ); }); await flush(); await flush(); const copyButton = container.querySelector('button[title="Copy document"]'); expect(copyButton).toBeTruthy(); await act(async () => { copyButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); expect(writeText).not.toHaveBeenCalled(); expect(execCommand).toHaveBeenCalledWith("copy"); expect(container.querySelector('button[title="Copied"]')).toBeTruthy(); } finally { await act(async () => { root.unmount(); }); queryClient.clear(); if (originalClipboard) { Object.defineProperty(navigator, "clipboard", originalClipboard); } else { delete (navigator as { clipboard?: Clipboard }).clipboard; } if (originalSecureContext) { Object.defineProperty(window, "isSecureContext", originalSecureContext); } else { delete (window as { isSecureContext?: boolean }).isSecureContext; } if (originalExecCommand) { Object.defineProperty(document, "execCommand", originalExecCommand); } else { delete (document as { execCommand?: (command: string) => boolean }).execCommand; } } }); it("locks documents from the document header action", async () => { const unlockedDocument = createIssueDocument({ body: "Draftable plan body", lockedAt: null, }); const lockedDocument = createIssueDocument({ body: "Draftable plan body", lockedAt: new Date("2026-03-31T12:06:00.000Z"), lockedByUserId: "user-1", updatedAt: new Date("2026-03-31T12:06:00.000Z"), }); const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments .mockResolvedValueOnce([unlockedDocument]) .mockResolvedValue([lockedDocument]); mockIssuesApi.lockDocument.mockResolvedValue(lockedDocument); await act(async () => { root.render( , ); }); await flush(); await flush(); const lockButton = container.querySelector('button[title="Lock document"]'); expect(lockButton).toBeTruthy(); await act(async () => { lockButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); await flush(); expect(mockIssuesApi.lockDocument).toHaveBeenCalledWith("issue-1", "plan"); expect(container.querySelector('button[title="Unlock document"]')).toBeTruthy(); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("hides direct edit and delete actions for locked documents", async () => { const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([ createIssueDocument({ body: "Locked plan body", lockedAt: new Date("2026-03-31T12:06:00.000Z"), lockedByUserId: "user-1", }), ]); await act(async () => { root.render( , ); }); await flush(); await flush(); expect(container.textContent).toContain("Locked plan body"); expect(container.textContent).not.toContain("Edit document"); expect(container.textContent).not.toContain("Delete document"); expect(container.querySelector('button[title="Unlock document"]')).toBeTruthy(); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("shows revision authors with names and avatars in the revision history menu", async () => { const currentDocument = createIssueDocument({ body: "Current plan body", latestRevisionId: "revision-agent", latestRevisionNumber: 4, updatedByAgentId: "agent-1", updatedByUserId: null, updatedAt: new Date("2026-03-31T12:05:00.000Z"), }); const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([currentDocument]); queryClient.setQueryData( queryKeys.issues.documentRevisions(issue.id, "plan"), [ createRevision({ id: "revision-agent", revisionNumber: 4, body: "Current plan body", createdByAgentId: "agent-1", createdByUserId: null, createdAt: new Date("2026-03-31T12:05:00.000Z"), }), createRevision({ id: "revision-user", revisionNumber: 3, body: "Board-written plan body", createdByAgentId: null, createdByUserId: "user-1", createdAt: new Date("2026-03-31T11:00:00.000Z"), }), ], ); await act(async () => { root.render( , ); }); await flush(); await flush(); const revisionButton = Array.from(container.querySelectorAll("button")) .find((button) => button.textContent?.includes("rev 4")); expect(revisionButton).toBeTruthy(); await act(async () => { revisionButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); await flush(); expect(document.body.textContent).toContain("CodexCoder"); expect(document.body.textContent).toContain("Dotta"); expect(document.body.textContent).not.toContain("• agent"); expect(document.body.querySelectorAll('[data-slot="avatar"], [data-slot="agent-avatar"]').length).toBeGreaterThanOrEqual(2); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("shows the restored document body immediately after a revision restore", async () => { const blankLatestDocument = createIssueDocument({ body: "", latestRevisionId: "revision-4", latestRevisionNumber: 4, }); const restoredDocument = createIssueDocument({ body: "Restored plan body", latestRevisionId: "revision-5", latestRevisionNumber: 5, updatedAt: new Date("2026-03-31T12:06:00.000Z"), }); const pendingDocuments = deferred(); const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments .mockResolvedValueOnce([blankLatestDocument]) .mockImplementation(() => pendingDocuments.promise); mockIssuesApi.restoreDocumentRevision.mockResolvedValue(restoredDocument); queryClient.setQueryData( queryKeys.issues.documentRevisions(issue.id, "plan"), [ createRevision({ id: "revision-4", revisionNumber: 4, body: "", createdAt: new Date("2026-03-31T12:05:00.000Z") }), createRevision(), ], ); await act(async () => { root.render( , ); }); await flush(); await flush(); expect(container.textContent).not.toContain("Restored plan body"); const revisionButtons = Array.from(container.querySelectorAll("button")); const historicalRevisionButton = revisionButtons.find((button) => button.textContent?.includes("rev 3")); expect(historicalRevisionButton).toBeTruthy(); await act(async () => { historicalRevisionButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); expect(container.textContent).toContain("Viewing revision 3"); expect(container.textContent).toContain("Restored plan body"); const restoreButton = Array.from(container.querySelectorAll("button")) .find((button) => button.textContent?.includes("Restore this revision")); expect(restoreButton).toBeTruthy(); await act(async () => { restoreButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); await flush(); expect(mockIssuesApi.restoreDocumentRevision).toHaveBeenCalledWith("issue-1", "plan", "revision-3"); expect(container.textContent).toContain("Restored plan body"); expect(container.textContent).not.toContain("Viewing revision 3"); pendingDocuments.resolve([restoredDocument]); await flush(); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("returns from a historical preview when the current revision only exists in derived state", async () => { const currentDocument = createIssueDocument({ body: "Current plan body", latestRevisionId: "revision-4", latestRevisionNumber: 4, updatedAt: new Date("2026-03-31T12:05:00.000Z"), }); const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([currentDocument]); queryClient.setQueryData( queryKeys.issues.documentRevisions(issue.id, "plan"), [ createRevision({ id: "revision-3", revisionNumber: 3, body: "Historical plan body", createdAt: new Date("2026-03-31T11:00:00.000Z"), }), ], ); await act(async () => { root.render( , ); }); await flush(); await flush(); expect(container.textContent).toContain("Current plan body"); const revisionButtons = Array.from(container.querySelectorAll("button")); const historicalRevisionButton = revisionButtons.find((button) => button.textContent?.includes("rev 3")); expect(historicalRevisionButton).toBeTruthy(); await act(async () => { historicalRevisionButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); expect(container.textContent).toContain("Viewing revision 3"); expect(container.textContent).toContain("Historical plan body"); const currentRevisionButton = Array.from(container.querySelectorAll("button")) .find((button) => button.textContent?.includes("rev 4")); expect(currentRevisionButton).toBeTruthy(); await act(async () => { currentRevisionButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); expect(container.textContent).not.toContain("Viewing revision 3"); expect(container.textContent).toContain("Current plan body"); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("returns from a historical preview when fetched history is newer than the document summary", async () => { const staleDocument = createIssueDocument({ body: "Original plan body", latestRevisionId: "revision-2", latestRevisionNumber: 2, updatedAt: new Date("2026-03-31T12:00:00.000Z"), }); const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([staleDocument]); queryClient.setQueryData( queryKeys.issues.documentRevisions(issue.id, "plan"), [ createRevision({ id: "revision-3", revisionNumber: 3, body: "Current plan body", createdAt: new Date("2026-03-31T12:05:00.000Z"), }), createRevision({ id: "revision-2", revisionNumber: 2, body: "Original plan body", createdAt: new Date("2026-03-31T12:00:00.000Z"), }), ], ); await act(async () => { root.render( , ); }); await flush(); await flush(); expect(container.textContent).toContain("Current plan body"); const revisionButtons = Array.from(container.querySelectorAll("button")); const historicalRevisionButton = revisionButtons.find((button) => button.textContent?.includes("rev 2")); expect(historicalRevisionButton).toBeTruthy(); await act(async () => { historicalRevisionButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); expect(container.textContent).toContain("Viewing revision 2"); expect(container.textContent).toContain("Original plan body"); const currentRevisionButton = Array.from(container.querySelectorAll("button")) .find((button) => button.textContent?.includes("rev 3")); expect(currentRevisionButton).toBeTruthy(); await act(async () => { currentRevisionButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); expect(container.textContent).not.toContain("Viewing revision 2"); expect(container.textContent).toContain("Current plan body"); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("ignores mount-time editor change noise before a document is actively being edited", async () => { markdownEditorMockState.emitMountEmptyChange = true; const document = createIssueDocument({ body: "Loaded plan body", }); const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([document]); await act(async () => { root.render( , ); }); await flush(); await flush(); expect(container.textContent).toContain("Loaded plan body"); expect(container.textContent).not.toContain("Markdown body"); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("forwards externalReferences to the rendered document body so URL decoration applies", async () => { const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false }, mutations: { retry: false }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([ createIssueDocument({ body: "Linked work: https://github.com/example/repo/pull/99", }), ]); await act(async () => { root.render( , ); }); await flush(); await flush(); const markdownBodies = Array.from( container.querySelectorAll('[data-testid="markdown-body"]'), ) as HTMLElement[]; expect(markdownBodies.length).toBeGreaterThan(0); const rendered = markdownBodies.find((element) => (element.textContent ?? "").includes("Linked work"), ); expect(rendered?.getAttribute("data-external-reference-keys")) .toContain("https://github.com/example/repo/pull/99"); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("wraps the documents header actions so mobile layouts do not overflow", async () => { const issue = createIssue(); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false, }, mutations: { retry: false, }, }, }); mockIssuesApi.listDocuments.mockResolvedValue([createIssueDocument()]); await act(async () => { root.render( )} /> , ); }); await flush(); await flush(); const heading = container.querySelector("h3"); expect(heading).toBeTruthy(); expect(heading?.parentElement?.className).toContain("flex-wrap"); expect(heading?.nextElementSibling?.className).toContain("flex-wrap"); await act(async () => { root.unmount(); }); queryClient.clear(); }); it("renders and locks documents for a non-issue document subject", async () => { const caseDocument = createIssueDocument({ id: "case-document-1", issueId: "case-1", key: "body", title: "Body", body: "Reusable case document body", latestRevisionId: "case-revision-2", latestRevisionNumber: 2, updatedByAgentId: "agent-1", updatedByUserId: null, }); const lockedCaseDocument = { ...caseDocument, lockedAt: new Date("2026-03-31T12:06:00.000Z"), lockedByUserId: "user-1", updatedAt: new Date("2026-03-31T12:06:00.000Z"), }; const listDocuments = vi.fn() .mockResolvedValueOnce([caseDocument]) .mockResolvedValue([lockedCaseDocument]); const setDocumentLock = vi.fn().mockResolvedValue(lockedCaseDocument); const root = createRoot(container); const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false }, mutations: { retry: false }, }, }); await act(async () => { root.render( ["cases", "revisions", "case-1", key], listDocuments, listDocumentRevisions: vi.fn().mockResolvedValue([]), getDocument: vi.fn().mockResolvedValue(caseDocument), upsertDocument: vi.fn().mockResolvedValue(caseDocument), deleteDocument: vi.fn().mockResolvedValue({ ok: true }), restoreDocumentRevision: vi.fn().mockResolvedValue(caseDocument), setDocumentLock, hideSystemDocuments: false, legacyPlanDocument: null, annotations: null, }} canDeleteDocuments canManageDocumentLocks /> , ); }); await flush(); await flush(); expect(listDocuments).toHaveBeenCalled(); expect(container.textContent).toContain("Reusable case document body"); expect(container.textContent).toContain("body"); const lockButton = container.querySelector('button[title="Lock document"]'); expect(lockButton).toBeTruthy(); await act(async () => { lockButton?.dispatchEvent(new MouseEvent("click", { bubbles: true })); }); await flush(); expect(setDocumentLock).toHaveBeenCalledWith("body", true); expect(container.querySelector('button[title="Unlock document"]')).toBeTruthy(); await act(async () => { root.unmount(); }); queryClient.clear(); }); });