paperclip/ui/src/components/IssueSiblingNavigation.test.tsx

131 lines
4 KiB
TypeScript
Raw Normal View History

Add ordered sub-issue navigation (#5938) ## Thinking Path > - Paperclip orchestrates AI-agent companies through company-scoped issues, comments, and execution context. > - The issue detail page is the board surface where operators and agents inspect a task in its parent/child workflow. > - Ordered sub-issues need a low-friction way to move through work without returning to the parent list after every issue. > - Existing issue detail navigation only covered sibling transitions and did not continue into a parent issue's first ordered child. > - This pull request adds ordered previous/next navigation for issue detail views and extends it to continue from a parent or last sibling into the first direct child. > - The benefit is a smoother review/execution path through hierarchical work while preserving hidden issue filtering and dependency-aware ordering. ## What Changed - Added `IssueSiblingNavigation` and route-state handling so issue detail footers can link to previous/next ordered issues. - Extended sub-issue ordering helpers to build navigation from siblings plus direct children, including root-parent and last-sibling-to-first-child cases. - Added page, component, and library tests for ordered sibling navigation, child fallback navigation, hidden issues, and link rendering. - Fixed the quicklook blur/click race Greptile found by deferring close until after portaled link clicks can complete, with a regression test. - Polished the navigation landmark label so it remains accurate when the next target is a direct child rather than a sibling. ## Verification - `pnpm exec vitest run src/components/IssueLinkQuicklook.test.tsx src/lib/issue-detail-subissues.test.ts src/components/IssueSiblingNavigation.test.tsx src/pages/IssueDetail.test.tsx --config vitest.config.ts` from `ui/` - 31 tests passed. - `pnpm --filter @paperclipai/ui typecheck` - passed. - `git diff --check` - passed. - GitHub PR checks on latest head `34046be2` - passed: Greptile Review, verify, e2e, Canary Dry Run, policy, Snyk, and serialized server shards. - Screenshots: not captured in this heartbeat; this PR is a draft and the changed states are covered by focused component/page tests. ## Risks - Low risk; this is a UI navigation addition with no database or API contract changes. - The main behavioral risk is navigation ordering drift if `workflowSort` expectations change later. - The IssueDetail navigation now waits for child issue loading, which avoids stale child fallback links but can delay footer navigation briefly while data loads. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected - check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5 coding agent with repository tool use and shell execution. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-05-13 15:43:51 -05:00
// @vitest-environment jsdom
import { act, type AnchorHTMLAttributes, type ReactNode } from "react";
import { createRoot, type Root } from "react-dom/client";
import type { Issue } from "@paperclipai/shared";
import { afterEach, describe, expect, it, vi } from "vitest";
import { IssueSiblingNavigation } from "./IssueSiblingNavigation";
vi.mock("@/lib/router", () => ({
Link: ({
children,
to,
issueQuicklookAlign,
issueQuicklookSide,
issuePrefetch: _issuePrefetch,
state: _state,
...props
}: AnchorHTMLAttributes<HTMLAnchorElement> & {
to: string;
issueQuicklookAlign?: string;
issueQuicklookSide?: string;
issuePrefetch?: unknown;
state?: unknown;
children?: ReactNode;
}) => (
<a
href={to}
data-quicklook-align={issueQuicklookAlign}
data-quicklook-side={issueQuicklookSide}
{...props}
>
{children}
</a>
),
}));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
function issue(id: string, overrides: Partial<Issue> = {}): Issue {
return {
id,
identifier: `PAP-${id}`,
title: `Sibling ${id}`,
status: "todo",
blockerAttention: null,
createdAt: new Date("2026-05-01T00:00:00.000Z"),
updatedAt: new Date("2026-05-01T00:00:00.000Z"),
...overrides,
} as Issue;
}
let root: Root | null = null;
let container: HTMLDivElement | null = null;
afterEach(() => {
if (root) {
act(() => root?.unmount());
}
root = null;
container?.remove();
container = null;
});
function render(node: ReactNode) {
container = document.createElement("div");
document.body.appendChild(container);
root = createRoot(container);
act(() => root?.render(node));
return container;
}
describe("IssueSiblingNavigation", () => {
it("renders the locked card anatomy for previous and next siblings", () => {
const node = render(
<IssueSiblingNavigation
navigation={{
previous: issue("1", { title: "Previous sibling title" }),
next: issue("3", { title: "Next sibling title" }),
currentIndex: 1,
totalCount: 3,
}}
/>,
);
const nav = node.querySelector("nav");
expect(nav?.getAttribute("aria-label")).toBe("Sub-issue navigation");
expect(nav?.className).toContain("sm:grid-cols-2");
expect(nav?.className).not.toContain("border-t");
const links = Array.from(node.querySelectorAll("a"));
expect(links).toHaveLength(2);
expect(links[0].textContent).toContain("Previous");
expect(links[0].textContent).toContain("PAP-1");
expect(links[0].textContent).toContain("Previous sibling title");
expect(links[0].getAttribute("aria-label")).toBe("Previous sub-issue: PAP-1 - Previous sibling title");
expect(links[0].getAttribute("data-quicklook-align")).toBe("start");
expect(links[1].textContent).toContain("Next");
expect(links[1].textContent).toContain("PAP-3");
expect(links[1].textContent).toContain("Next sibling title");
expect(links[1].getAttribute("aria-label")).toBe("Next sub-issue: PAP-3 - Next sibling title");
expect(links[1].getAttribute("data-quicklook-align")).toBe("end");
expect(links[1].className).toContain("sm:text-right");
expect(links[0].className).toContain("rounded-lg");
expect(links[0].className).toContain("hover:bg-accent/50");
expect(links[0].className).toContain("focus-visible:ring-[3px]");
expect(node.querySelector(".truncate")?.textContent).toBe("Previous sibling title");
});
it("keeps a lone next card in the right desktop column", () => {
const node = render(
<IssueSiblingNavigation
navigation={{
previous: null,
next: issue("2"),
currentIndex: 0,
totalCount: 2,
}}
/>,
);
const links = Array.from(node.querySelectorAll("a"));
expect(links).toHaveLength(1);
expect(links[0].textContent).toContain("Next");
expect(links[0].className).toContain("sm:col-start-2");
expect(node.textContent).not.toContain("Previous");
});
});