mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-14 00:26:28 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - The board UI reads the company project list in many places: the
sidebar, starred projects, the command palette, the new-task dialog, and
archive-aware pages such as the Mine inbox
> - Active-only consumers read `GET /projects`, and archive-aware ones
read `GET /projects?includeArchived=true`, under two React Query keys
> - A Mine load therefore fetched the same large payload twice (580–590
KB each on our dev instance)
> - The two responses differ only by archived rows; the server's active
list is exactly the rows where `archivedAt` is null
> - This pull request makes every consumer share the
`includeArchived=true` query, and active-only consumers filter it with
`select`
> - The benefit is one project read per page instead of two
## Linked Issues or Issue Description
**What existing behavior does this improve?**
Duplicate project list reads on page load.
**Subsystem affected**
Board UI project queries (`ui/src/lib/company-projects-query.ts` and its
consumers).
**Current behavior**
A cold Mine load sends both `/companies/:id/projects` (sidebar) and
`/companies/:id/projects?includeArchived=true` (inbox).
**Proposed behavior**
One `includeArchived=true` read serves both. Active-only consumers apply
`selectActiveProjects`.
**Reason and benefit**
The project list is one of the largest shell payloads. Reading it once
saves a large response on every page that has both kinds of consumer.
## What Changed
- New `companyProjectsQuery(companyId, { includeArchived? })` in
`ui/src/lib/company-projects-query.ts`. It always uses the
`includeArchived: true` key and fetch. For active-only use it adds a
stable, module-level `select` that keeps rows without `archivedAt`.
- 22 files that read the active list now spread
`companyProjectsQuery(...)`, and so do the plugin SDK project picker and
16 archive-aware pages that wrote the shared key and fetcher inline.
Their `enabled` and other options are unchanged. `OnboardingWizard`'s
one imperative read is unchanged. `pages/Inbox.tsx` already reads the
same key and fetcher, so it shares the entry without an edit.
- Invalidation: project mutations and live events invalidate
`queryKeys.projects.all(companyId)`, which matches the shared key. The
onboarding wizard invalidated the old active-only key; it now
invalidates `projects.all`.
- Tests: new `company-projects-query.test.tsx` (one request for both
consumers, correct filtering, and one refetch after `projects.all`
invalidation). Three existing tests (`CommandPalette`, `CompanyExport`,
`GitHubBotManagement`) now seed or expect the shared key.
- New browser check
`tests/perf/collections/shared-project-list.spec.ts`: after the Mine
inbox read completes, the page has sent no active-only project request.
## Verification
- `pnpm verify` passes.
- `ui`: the consumer suites (`CoordinatorSidebar`, `SidebarProjects`,
`SidebarStarredProjects`, `CommandPalette`, `NewIssueDialog`,
`AgentWorkPanels`, `CoordinatorNeedsYou`, `IssueDetail`,
`ProjectDetail`, `Projects`, `CompanyExport`, `ChatExecutionDefaults`,
`GatewaysList`, `Search`, `IssueProperties`, `persisted-query-cache`)
pass.
- Browser check:
`PAPERCLIP_COLLECTION_PERF_BASE_URL=http://127.0.0.1:<port> pnpm exec
playwright test --config tests/perf/collections/playwright.config.ts
shared-project-list.spec.ts`. It passes on this branch and fails on
`master`.
## Risks
- A page that needs only active projects now downloads archived rows
too. For most companies that is a small difference; the duplicate read
it removes is a full copy.
- The server does not order either list, and consumers sort for display,
so filtering on the client keeps behavior.
## Model Used
- Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, via Claude Code with
tool use (shell, file edits, browser). 1M-token context window. Extended
thinking was off.
## 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
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
502 lines
15 KiB
TypeScript
502 lines
15 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import type { KeyboardEventHandler, ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { CommandPalette } from "./CommandPalette";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
|
|
function act(callback: () => void | Promise<void>) {
|
|
let result: void | Promise<void> | undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
return result;
|
|
}
|
|
|
|
const companyState = vi.hoisted(() => ({
|
|
selectedCompanyId: "company-1",
|
|
}));
|
|
|
|
const dialogState = vi.hoisted(() => ({
|
|
openNewIssue: vi.fn(),
|
|
openNewAgent: vi.fn(),
|
|
}));
|
|
|
|
const sidebarState = vi.hoisted(() => ({
|
|
isMobile: false,
|
|
setSidebarOpen: vi.fn(),
|
|
}));
|
|
|
|
const mockIssuesApi = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
listLabels: vi.fn(),
|
|
}));
|
|
|
|
const mockAgentsApi = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
}));
|
|
|
|
const mockProjectsApi = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
}));
|
|
|
|
const mockInstanceSettingsApi = vi.hoisted(() => ({
|
|
getExperimental: vi.fn(),
|
|
}));
|
|
|
|
const mockAuthApi = vi.hoisted(() => ({
|
|
getSession: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => companyState,
|
|
}));
|
|
|
|
vi.mock("../context/DialogContext", () => ({
|
|
useDialog: () => dialogState,
|
|
useDialogActions: () => dialogState,
|
|
}));
|
|
|
|
vi.mock("../context/SidebarContext", () => ({
|
|
useSidebar: () => sidebarState,
|
|
}));
|
|
|
|
const navigateState = vi.hoisted(() => ({
|
|
navigate: vi.fn(),
|
|
}));
|
|
const locationState = vi.hoisted(() => ({
|
|
location: { pathname: "/", search: "", hash: "" },
|
|
}));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
useNavigate: () => navigateState.navigate,
|
|
useLocation: () => locationState.location,
|
|
}));
|
|
|
|
vi.mock("../api/issues", () => ({
|
|
issuesApi: mockIssuesApi,
|
|
}));
|
|
|
|
vi.mock("../api/agents", () => ({
|
|
agentsApi: mockAgentsApi,
|
|
}));
|
|
|
|
vi.mock("../api/projects", () => ({
|
|
projectsApi: mockProjectsApi,
|
|
}));
|
|
|
|
vi.mock("../api/instanceSettings", () => ({
|
|
instanceSettingsApi: mockInstanceSettingsApi,
|
|
}));
|
|
|
|
vi.mock("../api/auth", () => ({
|
|
authApi: mockAuthApi,
|
|
}));
|
|
|
|
vi.mock("./Identity", () => ({
|
|
Identity: ({ name }: { name: string }) => <span>{name}</span>,
|
|
}));
|
|
|
|
vi.mock("@/components/ui/command", () => ({
|
|
CommandDialog: ({ open, children }: { open: boolean; children: ReactNode }) => (open ? <div>{children}</div> : null),
|
|
CommandEmpty: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
CommandGroup: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
CommandInput: ({
|
|
value,
|
|
onValueChange,
|
|
onKeyDown,
|
|
}: {
|
|
value: string;
|
|
onValueChange: (value: string) => void;
|
|
onKeyDown?: KeyboardEventHandler<HTMLInputElement>;
|
|
}) => (
|
|
<div>
|
|
<input
|
|
aria-label="Command search"
|
|
value={value}
|
|
onChange={(event) => onValueChange(event.currentTarget.value)}
|
|
onKeyDown={onKeyDown}
|
|
/>
|
|
<button type="button" aria-label="Set query" onClick={() => onValueChange("pull/3303")} />
|
|
</div>
|
|
),
|
|
CommandItem: ({
|
|
children,
|
|
onSelect,
|
|
"data-testid": testId,
|
|
}: {
|
|
children: ReactNode;
|
|
onSelect?: () => void;
|
|
"data-testid"?: string;
|
|
}) => (
|
|
<button data-testid={testId} onClick={onSelect}>
|
|
{children}
|
|
</button>
|
|
),
|
|
CommandList: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
CommandSeparator: () => <hr />,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function flush() {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
});
|
|
}
|
|
|
|
async function waitForAssertion(assertion: () => void, attempts = 20) {
|
|
let lastError: unknown;
|
|
for (let attempt = 0; attempt < attempts; attempt += 1) {
|
|
try {
|
|
assertion();
|
|
return;
|
|
} catch (error) {
|
|
lastError = error;
|
|
await flush();
|
|
}
|
|
}
|
|
throw lastError;
|
|
}
|
|
|
|
function renderWithQueryClient(
|
|
node: ReactNode,
|
|
container: HTMLDivElement,
|
|
seedQueryClient?: (queryClient: QueryClient) => void,
|
|
) {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: {
|
|
queries: {
|
|
retry: false,
|
|
},
|
|
},
|
|
});
|
|
seedQueryClient?.(queryClient);
|
|
|
|
act(() => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
{node}
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
|
|
return { root, queryClient };
|
|
}
|
|
|
|
describe("CommandPalette", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
dialogState.openNewIssue.mockReset();
|
|
dialogState.openNewAgent.mockReset();
|
|
sidebarState.setSidebarOpen.mockReset();
|
|
mockIssuesApi.list.mockReset();
|
|
mockIssuesApi.listLabels.mockReset();
|
|
mockAgentsApi.list.mockReset();
|
|
mockProjectsApi.list.mockReset();
|
|
mockInstanceSettingsApi.getExperimental.mockReset();
|
|
mockAuthApi.getSession.mockReset();
|
|
navigateState.navigate.mockReset();
|
|
locationState.location.pathname = "/";
|
|
locationState.location.search = "";
|
|
locationState.location.hash = "";
|
|
mockIssuesApi.list.mockResolvedValue([]);
|
|
mockIssuesApi.listLabels.mockResolvedValue([]);
|
|
mockAgentsApi.list.mockResolvedValue([]);
|
|
mockProjectsApi.list.mockResolvedValue([]);
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableExperimentalFileViewer: false,
|
|
});
|
|
mockAuthApi.getSession.mockResolvedValue({ user: { id: "user-1" }, session: { userId: "user-1" } });
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
});
|
|
|
|
it("includes routine execution issues in search queries", async () => {
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
const setQueryButton = container.querySelector('button[aria-label="Set query"]');
|
|
expect(setQueryButton).not.toBeNull();
|
|
|
|
act(() => {
|
|
setQueryButton!.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(mockIssuesApi.list).toHaveBeenCalledWith("company-1", {
|
|
q: "pull/3303",
|
|
limit: 10,
|
|
includeRoutineExecutions: true,
|
|
});
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("hides the issue file viewer command by default", async () => {
|
|
locationState.location.pathname = "/issues/PAP-1";
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(container.textContent).toContain("Create new task");
|
|
});
|
|
expect(container.textContent).not.toContain("Open file in this issue");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("shows the issue file viewer command when the experimental flag is enabled", async () => {
|
|
locationState.location.pathname = "/issues/PAP-1";
|
|
mockInstanceSettingsApi.getExperimental.mockResolvedValue({
|
|
enableExperimentalFileViewer: true,
|
|
});
|
|
const { root } = renderWithQueryClient(
|
|
<CommandPalette />,
|
|
container,
|
|
(queryClient) => {
|
|
queryClient.setQueryData(queryKeys.instance.experimentalSettings, {
|
|
enableExperimentalFileViewer: true,
|
|
});
|
|
},
|
|
);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(container.textContent).toContain("Open file in this issue");
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("offers a Search-all command when the query is non-empty and routes Enter to /search when no issues match", async () => {
|
|
mockIssuesApi.list.mockResolvedValue([]);
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
const input = container.querySelector('input[aria-label="Command search"]') as HTMLInputElement;
|
|
expect(input).not.toBeNull();
|
|
|
|
act(() => {
|
|
const nativeSetter = Object.getOwnPropertyDescriptor(HTMLInputElement.prototype, "value")!.set!;
|
|
nativeSetter.call(input, "auth flake");
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
const searchAllButton = container.querySelector(
|
|
'button[data-testid="command-search-all"]',
|
|
) as HTMLButtonElement | null;
|
|
expect(searchAllButton).not.toBeNull();
|
|
expect(searchAllButton!.textContent).toContain("auth flake");
|
|
});
|
|
|
|
act(() => {
|
|
input.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(navigateState.navigate).toHaveBeenCalledWith("/search?q=auth+flake");
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("promotes matching projects above the Tasks group when typing", async () => {
|
|
const projects = [
|
|
{ id: "p1", urlKey: "mobile", name: "Mobile App", description: "iOS client", archivedAt: null },
|
|
{ id: "p2", urlKey: "billing", name: "Billing Service", description: null, archivedAt: null },
|
|
];
|
|
mockProjectsApi.list.mockResolvedValue(projects);
|
|
mockIssuesApi.list.mockImplementation((_companyId: string, opts?: { q?: string }) =>
|
|
Promise.resolve(opts?.q ? [{ id: "i1", identifier: "ENG-9", title: "Fix login" }] : []),
|
|
);
|
|
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container, (queryClient) => {
|
|
// Seed the caches so the already-loaded data is available synchronously —
|
|
// this harness's flush model doesn't reliably propagate fresh async fetches.
|
|
queryClient.setQueryData(queryKeys.projects.list("company-1", { includeArchived: true }), projects);
|
|
queryClient.setQueryData(queryKeys.issues.search("company-1", "mob", undefined, 10), [
|
|
{ id: "i1", identifier: "ENG-9", title: "Fix login" },
|
|
]);
|
|
});
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
const input = container.querySelector('input[aria-label="Command search"]') as HTMLInputElement;
|
|
act(() => {
|
|
const nativeSetter = Object.getOwnPropertyDescriptor(HTMLInputElement.prototype, "value")!.set!;
|
|
nativeSetter.call(input, "mob");
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
const match = container.querySelector('button[data-testid="command-project-match"]');
|
|
expect(match).not.toBeNull();
|
|
expect(match!.textContent).toContain("Mobile App");
|
|
});
|
|
|
|
// Non-matching project is excluded from the typeahead results.
|
|
expect(container.textContent).not.toContain("Billing Service");
|
|
|
|
// The promoted project renders above the fold — before the Tasks group.
|
|
await waitForAssertion(() => {
|
|
const text = container.textContent ?? "";
|
|
expect(text).toContain("Fix login");
|
|
expect(text.indexOf("Mobile App")).toBeLessThan(text.indexOf("Fix login"));
|
|
});
|
|
|
|
// Selecting the promoted project navigates to its URL.
|
|
act(() => {
|
|
container
|
|
.querySelector('button[data-testid="command-project-match"]')!
|
|
.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
await waitForAssertion(() => {
|
|
expect(navigateState.navigate).toHaveBeenCalledWith("/projects/mobile");
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("navigates to /search when the user clicks the Search-all command", async () => {
|
|
mockIssuesApi.list.mockResolvedValue([]);
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
const input = container.querySelector('input[aria-label="Command search"]') as HTMLInputElement;
|
|
act(() => {
|
|
const nativeSetter = Object.getOwnPropertyDescriptor(HTMLInputElement.prototype, "value")!.set!;
|
|
nativeSetter.call(input, "deflake");
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
|
|
let searchAllButton: HTMLButtonElement | null = null;
|
|
await waitForAssertion(() => {
|
|
searchAllButton = container.querySelector(
|
|
'button[data-testid="command-search-all"]',
|
|
) as HTMLButtonElement | null;
|
|
expect(searchAllButton).not.toBeNull();
|
|
});
|
|
|
|
act(() => {
|
|
searchAllButton!.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(navigateState.navigate).toHaveBeenCalledWith("/search?q=deflake");
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders quick-filter chips and inserts them into the palette query", async () => {
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
const chips = Array.from(container.querySelectorAll('button[data-testid="command-filter-chip"]'));
|
|
expect(chips.map((chip) => chip.textContent)).toEqual(
|
|
expect.arrayContaining([
|
|
expect.stringContaining("assignee:me"),
|
|
expect.stringContaining("is:open"),
|
|
expect.stringContaining("updated:>7d"),
|
|
]),
|
|
);
|
|
});
|
|
|
|
act(() => {
|
|
container.querySelector('button[data-testid="command-filter-chip"]')!.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
|
|
const input = container.querySelector('input[aria-label="Command search"]') as HTMLInputElement;
|
|
await waitForAssertion(() => {
|
|
expect(input.value).toBe("assignee:me");
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("parses operators for lightweight issue search but keeps filters for command-enter handoff", async () => {
|
|
mockIssuesApi.list.mockResolvedValue([]);
|
|
const { root } = renderWithQueryClient(<CommandPalette />, container);
|
|
|
|
act(() => {
|
|
document.dispatchEvent(new KeyboardEvent("keydown", { key: "k", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
const input = container.querySelector('input[aria-label="Command search"]') as HTMLInputElement;
|
|
act(() => {
|
|
const nativeSetter = Object.getOwnPropertyDescriptor(HTMLInputElement.prototype, "value")!.set!;
|
|
nativeSetter.call(input, "auth status:blocked updated:>7d");
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(mockIssuesApi.list).toHaveBeenCalledWith("company-1", {
|
|
q: "auth",
|
|
limit: 10,
|
|
includeRoutineExecutions: true,
|
|
});
|
|
});
|
|
|
|
act(() => {
|
|
input.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", metaKey: true, bubbles: true }));
|
|
});
|
|
|
|
await waitForAssertion(() => {
|
|
expect(navigateState.navigate).toHaveBeenCalledWith("/search?q=auth&status=blocked&updatedWithin=7d");
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
});
|