forked from farhoodlabs/paperclip
6b7f6ce4b8
## Thinking Path > - Paperclip orchestrates AI agents through a company-scoped control plane. > - The affected surface is the board UI for issue threads, issue lists, routines, dialogs, navigation, and issue review indicators. > - Closed PR #4692 bundled backend, schema, docs, workflow, and UI/QoL work into one oversized change set. > - Greptile could not keep reviewing that broad PR because it exceeded the 100-file review limit and mixed unrelated concerns. > - This pull request extracts the UI/QoL slice into a fresh branch under the review limit while leaving workflow and lockfile churn out. > - The benefit is a focused review path for the board UI performance and workflow improvements without reopening the oversized PR. ## What Changed - Added long issue-thread virtualization, scroll-container binding, anchor preservation, latest-comment jump targeting, and related regression/perf fixtures. - Improved issue list scalability with scroll-based loading, server offset parameters, and pagination-focused UI tests. - Reduced new issue dialog typing churn and split dialog action subscriptions so broad layout/nav surfaces avoid unnecessary renders. - Added routine variables help and routine description mention options for users, agents, and projects. - Added productivity review badge/link UI and fixed the badge to use Paperclip's company-prefixed router link. - Kept the split PR below Greptile's review limit and excluded `.github/workflows/pr.yml` and `pnpm-lock.yaml`. ## Verification - `pnpm install --no-frozen-lockfile` in the clean worktree to install `@tanstack/react-virtual` locally without committing lockfile churn. - `pnpm --filter @paperclipai/ui exec vitest run --config vitest.config.ts src/components/IssueChatThread.test.tsx src/components/IssuesList.test.tsx src/components/NewIssueDialog.test.tsx src/pages/Routines.test.tsx src/pages/Issues.test.tsx` passed: 5 files, 83 tests. - `pnpm --filter @paperclipai/ui typecheck` passed. - `git diff --check origin/master..HEAD` passed. - Split-scope checks: 53 changed files; no `.github/workflows/pr.yml`; no `pnpm-lock.yaml`. - Screenshots were not captured in this heartbeat; the changes are primarily virtualization, routing, pagination, and editor behavior covered by focused regression tests. ## Risks - Moderate UI risk because issue-thread virtualization changes scroll behavior on long conversations; regression tests cover anchor jumps, latest-comment targeting, row metadata, and short-thread fallback. - Moderate integration risk because the issue-list offset parameter and productivity review field depend on matching API behavior. - Dependency risk: the UI package adds `@tanstack/react-virtual` while repository policy keeps `pnpm-lock.yaml` out of PRs, so CI must resolve dependency changes through the repo's normal lockfile policy. > 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, tool-enabled local repository and GitHub workflow. Exact runtime context window was not exposed by the harness. ## 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>
254 lines
6.5 KiB
TypeScript
254 lines
6.5 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { Layout } from "./Layout";
|
|
|
|
const mockHealthApi = vi.hoisted(() => ({
|
|
get: vi.fn(),
|
|
}));
|
|
|
|
const mockInstanceSettingsApi = vi.hoisted(() => ({
|
|
getGeneral: vi.fn(),
|
|
}));
|
|
|
|
const mockNavigate = vi.hoisted(() => vi.fn());
|
|
const mockSetSelectedCompanyId = vi.hoisted(() => vi.fn());
|
|
const mockSetSidebarOpen = vi.hoisted(() => vi.fn());
|
|
let currentPathname = "/PAP/dashboard";
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Outlet: () => <div>Outlet content</div>,
|
|
useLocation: () => ({ pathname: currentPathname, search: "", hash: "", state: null }),
|
|
useNavigate: () => mockNavigate,
|
|
useNavigationType: () => "PUSH",
|
|
useParams: () => ({ companyPrefix: "PAP" }),
|
|
}));
|
|
|
|
vi.mock("./CompanyRail", () => ({
|
|
CompanyRail: () => <div>Company rail</div>,
|
|
}));
|
|
|
|
vi.mock("./Sidebar", () => ({
|
|
Sidebar: () => <div>Main company nav</div>,
|
|
}));
|
|
|
|
vi.mock("./InstanceSidebar", () => ({
|
|
InstanceSidebar: () => <div>Instance sidebar</div>,
|
|
}));
|
|
|
|
vi.mock("./CompanySettingsSidebar", () => ({
|
|
CompanySettingsSidebar: () => <div>Company settings sidebar</div>,
|
|
}));
|
|
|
|
vi.mock("./BreadcrumbBar", () => ({
|
|
BreadcrumbBar: () => <div>Breadcrumbs</div>,
|
|
}));
|
|
|
|
vi.mock("./PropertiesPanel", () => ({
|
|
PropertiesPanel: () => null,
|
|
}));
|
|
|
|
vi.mock("./CommandPalette", () => ({
|
|
CommandPalette: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewIssueDialog", () => ({
|
|
NewIssueDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewProjectDialog", () => ({
|
|
NewProjectDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewGoalDialog", () => ({
|
|
NewGoalDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./NewAgentDialog", () => ({
|
|
NewAgentDialog: () => null,
|
|
}));
|
|
|
|
vi.mock("./KeyboardShortcutsCheatsheet", () => ({
|
|
KeyboardShortcutsCheatsheet: () => null,
|
|
}));
|
|
|
|
vi.mock("./ToastViewport", () => ({
|
|
ToastViewport: () => null,
|
|
}));
|
|
|
|
vi.mock("./MobileBottomNav", () => ({
|
|
MobileBottomNav: () => null,
|
|
}));
|
|
|
|
vi.mock("./WorktreeBanner", () => ({
|
|
WorktreeBanner: () => null,
|
|
}));
|
|
|
|
vi.mock("./DevRestartBanner", () => ({
|
|
DevRestartBanner: () => null,
|
|
}));
|
|
|
|
vi.mock("./SidebarAccountMenu", () => ({
|
|
SidebarAccountMenu: () => <div>Account menu</div>,
|
|
}));
|
|
|
|
vi.mock("../context/DialogContext", () => ({
|
|
useDialog: () => ({
|
|
openNewIssue: vi.fn(),
|
|
openOnboarding: vi.fn(),
|
|
}),
|
|
useDialogActions: () => ({
|
|
openNewIssue: vi.fn(),
|
|
openOnboarding: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/PanelContext", () => ({
|
|
usePanel: () => ({
|
|
togglePanelVisible: vi.fn(),
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({
|
|
companies: [{ id: "company-1", issuePrefix: "PAP", name: "Paperclip" }],
|
|
loading: false,
|
|
selectedCompany: { id: "company-1", issuePrefix: "PAP", name: "Paperclip" },
|
|
selectedCompanyId: "company-1",
|
|
selectionSource: "manual",
|
|
setSelectedCompanyId: mockSetSelectedCompanyId,
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/SidebarContext", () => ({
|
|
useSidebar: () => ({
|
|
sidebarOpen: true,
|
|
setSidebarOpen: mockSetSidebarOpen,
|
|
toggleSidebar: vi.fn(),
|
|
isMobile: false,
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../hooks/useKeyboardShortcuts", () => ({
|
|
useKeyboardShortcuts: () => undefined,
|
|
}));
|
|
|
|
vi.mock("../hooks/useCompanyPageMemory", () => ({
|
|
useCompanyPageMemory: () => undefined,
|
|
}));
|
|
|
|
vi.mock("../api/health", () => ({
|
|
healthApi: mockHealthApi,
|
|
}));
|
|
|
|
vi.mock("../api/instanceSettings", () => ({
|
|
instanceSettingsApi: mockInstanceSettingsApi,
|
|
}));
|
|
|
|
vi.mock("../lib/company-selection", () => ({
|
|
shouldSyncCompanySelectionFromRoute: () => false,
|
|
}));
|
|
|
|
vi.mock("../lib/instance-settings", () => ({
|
|
DEFAULT_INSTANCE_SETTINGS_PATH: "/instance/settings/general",
|
|
normalizeRememberedInstanceSettingsPath: (value: string | null | undefined) =>
|
|
value ?? "/instance/settings/general",
|
|
}));
|
|
|
|
vi.mock("../lib/main-content-focus", () => ({
|
|
scheduleMainContentFocus: () => () => undefined,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function flushReact() {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
|
|
describe("Layout", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
currentPathname = "/PAP/dashboard";
|
|
mockHealthApi.get.mockResolvedValue({
|
|
status: "ok",
|
|
deploymentMode: "authenticated",
|
|
deploymentExposure: "private",
|
|
version: "1.2.3",
|
|
});
|
|
mockInstanceSettingsApi.getGeneral.mockResolvedValue({
|
|
keyboardShortcuts: false,
|
|
});
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("does not render the deployment explainer in the shared layout", async () => {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(mockHealthApi.get).toHaveBeenCalled();
|
|
expect(container.textContent).toContain("Breadcrumbs");
|
|
expect(container.textContent).toContain("Outlet content");
|
|
expect(container.textContent).not.toContain("Authenticated private");
|
|
expect(container.textContent).not.toContain(
|
|
"Sign-in is required and this instance is intended for private-network access.",
|
|
);
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders the company settings sidebar on company settings routes", async () => {
|
|
currentPathname = "/PAP/company/settings/access";
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<Layout />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("Company settings sidebar");
|
|
expect(container.textContent).not.toContain("Instance sidebar");
|
|
expect(container.textContent).not.toContain("Main company nav");
|
|
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|