mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-13 15:55:46 +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>
374 lines
15 KiB
TypeScript
374 lines
15 KiB
TypeScript
import { companyProjectsQuery } from "@/lib/company-projects-query";
|
|
import { QueryErrorState, useQueryView } from "@/components/QueryView";
|
|
import { useShowAgentCreatedTasks } from "../hooks/useShowAgentCreatedTasks";
|
|
import { useCoordinatorWorkspaceEnabled } from "../hooks/useCoordinatorWorkspaceEnabled";
|
|
import { CoordinatorTaskViews } from "./CoordinatorTaskViews";
|
|
import { useDesignSandbox } from "../context/DesignSandboxContext";
|
|
import { DesignSandboxTasks } from "./DesignSandboxTasks";
|
|
import { useEffect, useMemo, useCallback, useRef, useState } from "react";
|
|
import type { ReactNode } from "react";
|
|
import { useLocation, useNavigate, useSearchParams } from "@/lib/router";
|
|
import { useInfiniteQuery, useQuery } from "@tanstack/react-query";
|
|
import { issuesApi } from "../api/issues";
|
|
import { agentsApi } from "../api/agents";
|
|
import { heartbeatsApi } from "../api/heartbeats";
|
|
import { useCompany } from "../context/CompanyContext";
|
|
import { useBreadcrumbs } from "../context/BreadcrumbContext";
|
|
import { collectLiveIssueIds } from "../lib/liveIssueIds";
|
|
import { usePublishSharedQueryData, useSharedPollingQuery } from "@/hooks/useSharedPolling";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import { createIssueDetailLocationState } from "../lib/issueDetailBreadcrumb";
|
|
import { EmptyState } from "../components/EmptyState";
|
|
import { IssuesList } from "../components/IssuesList";
|
|
import { readIssueSortParams, type IssueSort } from "../lib/issue-sort";
|
|
import { TaskViewsMenu } from "../components/TaskViewsMenu";
|
|
import { Button } from "@/components/ui/button";
|
|
import { CircleDot, Plus } from "lucide-react";
|
|
import type { Issue } from "@paperclipai/shared";
|
|
import { useStreamlinedUiEnabled } from "../hooks/useStreamlinedUiEnabled";
|
|
import { useCombinedInboxTasksEnabled } from "../hooks/useCombinedInboxTasksEnabled";
|
|
import { useDialogActions } from "../context/DialogContext";
|
|
import { useInboxBadge } from "../hooks/useInboxBadge";
|
|
import { Inbox } from "./Inbox";
|
|
import {
|
|
ORGANIZATION_SCOPED_PARAMS,
|
|
TASK_VIEW_PARAM,
|
|
loadLastTaskView,
|
|
normalizeTaskViewKey,
|
|
resolveInitialTaskView,
|
|
saveLastTaskView,
|
|
taskView,
|
|
type TaskViewKey,
|
|
} from "../lib/task-views";
|
|
import { useUpdateIssueMutation } from "../hooks/useUpdateIssueMutation";
|
|
|
|
const WORKSPACE_FILTER_ISSUE_LIMIT = 1000;
|
|
const ISSUES_PAGE_SIZE = 100;
|
|
export const ISSUES_ROW_PRESENTATION = "task" as const;
|
|
export const ISSUES_TOOLBAR_PRESENTATION = "collection" as const;
|
|
|
|
export function resolveIssuesPresentation(streamlinedUiEnabled: boolean) {
|
|
return streamlinedUiEnabled
|
|
? { rowPresentation: ISSUES_ROW_PRESENTATION, toolbarPresentation: ISSUES_TOOLBAR_PRESENTATION }
|
|
: { rowPresentation: "legacy" as const, toolbarPresentation: "legacy" as const };
|
|
}
|
|
|
|
export function getNextIssuesPageOffset(
|
|
loadedPageSize: number,
|
|
currentOffset: number,
|
|
pageSize: number = ISSUES_PAGE_SIZE,
|
|
): number | undefined {
|
|
return loadedPageSize >= pageSize ? currentOffset + pageSize : undefined;
|
|
}
|
|
|
|
export function mergeIssuePagesStable<T extends { id: string }>(pages: T[][]): T[] {
|
|
const seenIssueIds = new Set<string>();
|
|
const merged: T[] = [];
|
|
|
|
for (const page of pages) {
|
|
for (const issue of page) {
|
|
if (seenIssueIds.has(issue.id)) continue;
|
|
seenIssueIds.add(issue.id);
|
|
merged.push(issue);
|
|
}
|
|
}
|
|
|
|
return merged;
|
|
}
|
|
|
|
export function buildIssuesSearchUrl(currentHref: string, search: string): string | null {
|
|
const url = new URL(currentHref);
|
|
const currentSearch = url.searchParams.get("q") ?? "";
|
|
if (currentSearch === search) return null;
|
|
|
|
if (search.length > 0) {
|
|
url.searchParams.set("q", search);
|
|
} else {
|
|
url.searchParams.delete("q");
|
|
}
|
|
|
|
return `${url.pathname}${url.search}${url.hash}`;
|
|
}
|
|
|
|
/**
|
|
* Tasks — the single task surface after PAP-670 merged Inbox into it.
|
|
*
|
|
* This component only resolves `?view=` to a view and hands off: My-work views
|
|
* render the inbox list, organization views render the task collection. Both
|
|
* get the same Views control in their toolbar, so the switch reads as one page.
|
|
*/
|
|
export function Issues() {
|
|
const designSandbox = useDesignSandbox();
|
|
const { enabled: streamlinedUiEnabled } = useStreamlinedUiEnabled();
|
|
const { enabled: combinedInboxTasksEnabled } = useCombinedInboxTasksEnabled();
|
|
const { enabled: coordinatorEnabled } = useCoordinatorWorkspaceEnabled();
|
|
// The merged surface is Combined Inbox + Task List only. With the flag off, and always in
|
|
// the legacy shell, Tasks is the plain task list and Inbox keeps its pages.
|
|
return designSandbox ? <DesignSandboxTasks /> : coordinatorEnabled ? <CoordinatorTaskViews /> : streamlinedUiEnabled && combinedInboxTasksEnabled ? <StreamlinedTasks /> : <OrganizationIssues />;
|
|
}
|
|
|
|
function StreamlinedTasks() {
|
|
const navigate = useNavigate();
|
|
const [searchParams, setSearchParams] = useSearchParams();
|
|
const { selectedCompanyId } = useCompany();
|
|
const { openNewIssue } = useDialogActions();
|
|
const inboxBadge = useInboxBadge(selectedCompanyId);
|
|
|
|
const requestedView = searchParams.get(TASK_VIEW_PARAM);
|
|
const hasOrganizationScopedParam = ORGANIZATION_SCOPED_PARAMS.some(
|
|
(param) => (searchParams.get(param) ?? "").length > 0,
|
|
);
|
|
// Read the stored view once per mount so a later write can't yank the view
|
|
// out from under the user mid-session.
|
|
const [lastUsedView] = useState<TaskViewKey>(() => loadLastTaskView());
|
|
const view = resolveInitialTaskView(requestedView, hasOrganizationScopedParam, lastUsedView);
|
|
const definition = taskView(view);
|
|
|
|
// Make the resolved view addressable without dropping the params that
|
|
// brought the user here — and correct a requested view that was overridden
|
|
// (an inbox view carrying an organization filter opens All tasks).
|
|
useEffect(() => {
|
|
if (normalizeTaskViewKey(requestedView) === view) return;
|
|
setSearchParams((current) => {
|
|
const next = new URLSearchParams(current);
|
|
next.set(TASK_VIEW_PARAM, view);
|
|
return next;
|
|
}, { replace: true });
|
|
}, [requestedView, view, setSearchParams]);
|
|
|
|
const selectView = useCallback((next: TaskViewKey) => {
|
|
saveLastTaskView(next);
|
|
// A view switch starts clean: the previous view's search and filters are
|
|
// its own, not the new view's.
|
|
navigate(`/issues?${TASK_VIEW_PARAM}=${next}`);
|
|
}, [navigate]);
|
|
|
|
const viewsMenu = (
|
|
<TaskViewsMenu value={view} onChange={selectView} badgeCount={inboxBadge.inbox} />
|
|
);
|
|
|
|
if (definition.surface === "inbox") {
|
|
return (
|
|
<Inbox
|
|
tab={definition.inboxTab}
|
|
surfaceLabel="Tasks"
|
|
toolbarContext={(
|
|
<div className="flex min-w-0 items-center gap-2">
|
|
{viewsMenu}
|
|
<Button size="sm" variant="outline" aria-label="New Task" onClick={() => openNewIssue()}>
|
|
<Plus className="h-4 w-4 sm:mr-1" />
|
|
<span className="hidden sm:inline">New Task</span>
|
|
</Button>
|
|
</div>
|
|
)}
|
|
/>
|
|
);
|
|
}
|
|
|
|
return <OrganizationIssues toolbarContext={viewsMenu} initialStatuses={definition.statuses} />;
|
|
}
|
|
|
|
function OrganizationIssues({
|
|
toolbarContext,
|
|
initialStatuses,
|
|
}: { toolbarContext?: ReactNode; initialStatuses?: string[] } = {}) {
|
|
const { enabled: streamlinedUiEnabled } = useStreamlinedUiEnabled();
|
|
const issuesPresentation = resolveIssuesPresentation(streamlinedUiEnabled);
|
|
const { selectedCompanyId } = useCompany();
|
|
const { setBreadcrumbs } = useBreadcrumbs();
|
|
const location = useLocation();
|
|
const [searchParams, setSearchParams] = useSearchParams();
|
|
const fetchNextPageInFlightRef = useRef(false);
|
|
|
|
const urlSearch = searchParams.get("q") ?? "";
|
|
const [searchOverride, setSearchOverride] = useState<{ search: string; locationSearch: string } | null>(null);
|
|
const syncedSearch = useMemo(() => {
|
|
if (typeof window !== "undefined" && searchOverride?.locationSearch === window.location.search) {
|
|
return searchOverride.search;
|
|
}
|
|
return urlSearch;
|
|
}, [searchOverride, urlSearch, location.search]);
|
|
const showAgentCreatedTasks = useShowAgentCreatedTasks(selectedCompanyId, "paperclip:issues-view");
|
|
const sort = useMemo(() => readIssueSortParams(searchParams), [searchParams]);
|
|
const includeBlockedBy = sort?.sortField === "workflow";
|
|
const serverSortField = sort?.sortField === "created" ? "created" : "updated";
|
|
const serverSortDir = sort?.sortField === "created" || sort?.sortField === "updated" ? sort.sortDir : "desc";
|
|
const handleSortChange = useCallback((nextSort: IssueSort) => {
|
|
setSearchParams(current => {
|
|
const next = new URLSearchParams(current);
|
|
if (syncedSearch) next.set("q", syncedSearch);
|
|
else next.delete("q");
|
|
next.set("sortField", nextSort.sortField);
|
|
next.set("sortDir", nextSort.sortDir);
|
|
return next;
|
|
}, { replace: true });
|
|
}, [setSearchParams, syncedSearch]);
|
|
const routineTasksOnly = searchParams.get("originKind") === "routine_execution";
|
|
const includeAgentCreatedTasks = showAgentCreatedTasks || routineTasksOnly;
|
|
const originKind = routineTasksOnly ? "routine_execution" : undefined;
|
|
const handleRoutineTasksOnlyChange = useCallback((checked: boolean) => {
|
|
setSearchParams(current => {
|
|
const next = new URLSearchParams(current);
|
|
if (syncedSearch) next.set("q", syncedSearch);
|
|
else next.delete("q");
|
|
if (checked) next.set("originKind", "routine_execution");
|
|
else next.delete("originKind");
|
|
return next;
|
|
}, { replace: true });
|
|
}, [setSearchParams, syncedSearch]);
|
|
const participantAgentId = searchParams.get("participantAgentId") ?? undefined;
|
|
const initialWorkspaces = searchParams.getAll("workspace").filter((workspaceId) => workspaceId.length > 0);
|
|
const workspaceIdFilter = initialWorkspaces.length === 1 ? initialWorkspaces[0] : undefined;
|
|
const handleSearchChange = useCallback((search: string) => {
|
|
const nextUrl = buildIssuesSearchUrl(window.location.href, search);
|
|
if (!nextUrl) {
|
|
setSearchOverride(null);
|
|
return;
|
|
}
|
|
window.history.replaceState(window.history.state, "", nextUrl);
|
|
setSearchOverride({ search, locationSearch: window.location.search });
|
|
}, []);
|
|
|
|
const { data: agents } = useQuery({
|
|
queryKey: queryKeys.agents.list(selectedCompanyId!),
|
|
queryFn: () => agentsApi.list(selectedCompanyId!),
|
|
enabled: !!selectedCompanyId,
|
|
});
|
|
|
|
const { data: projects } = useQuery({
|
|
...companyProjectsQuery(selectedCompanyId!, { includeArchived: true }),
|
|
enabled: !!selectedCompanyId,
|
|
});
|
|
|
|
const liveRunsQueryKey = queryKeys.liveRuns(selectedCompanyId!);
|
|
const sharedLiveRuns = useSharedPollingQuery({
|
|
companyId: selectedCompanyId,
|
|
resourceKey: "live-runs",
|
|
queryKey: liveRunsQueryKey,
|
|
enabled: !!selectedCompanyId,
|
|
// Event-sourced via LiveUpdatesProvider (GitHub issue 9627); no interval poll needed.
|
|
refetchInterval: false,
|
|
leaderOnly: true,
|
|
});
|
|
const { data: liveRuns, dataUpdatedAt: liveRunsUpdatedAt } = useQuery({
|
|
queryKey: liveRunsQueryKey,
|
|
queryFn: () => heartbeatsApi.liveRunsForCompany(selectedCompanyId!),
|
|
enabled: sharedLiveRuns.enabled,
|
|
refetchInterval: sharedLiveRuns.refetchInterval,
|
|
});
|
|
usePublishSharedQueryData(sharedLiveRuns, liveRuns, liveRunsUpdatedAt);
|
|
|
|
const issueLinkState = useMemo(
|
|
() =>
|
|
createIssueDetailLocationState(
|
|
"Tasks",
|
|
`${location.pathname}${location.search}${location.hash}`,
|
|
"issues",
|
|
),
|
|
[location.pathname, location.search, location.hash],
|
|
);
|
|
|
|
useEffect(() => {
|
|
setBreadcrumbs([{ label: "Tasks" }]);
|
|
}, [setBreadcrumbs]);
|
|
|
|
const issuePageSize = workspaceIdFilter ? WORKSPACE_FILTER_ISSUE_LIMIT : ISSUES_PAGE_SIZE;
|
|
|
|
const issuesQuery = useInfiniteQuery({
|
|
queryKey: [
|
|
...queryKeys.issues.list(selectedCompanyId!),
|
|
"participant-agent",
|
|
participantAgentId ?? "__all__",
|
|
"workspace",
|
|
workspaceIdFilter ?? "__all__",
|
|
streamlinedUiEnabled ? "index" : "compact",
|
|
"with-routine-executions",
|
|
includeAgentCreatedTasks,
|
|
originKind,
|
|
"infinite",
|
|
issuePageSize,
|
|
serverSortField,
|
|
serverSortDir,
|
|
includeBlockedBy,
|
|
],
|
|
queryFn: ({ pageParam, signal }) => issuesApi.listCompact(selectedCompanyId!, {
|
|
projection: streamlinedUiEnabled ? "index" : undefined,
|
|
participantAgentId,
|
|
workspaceId: workspaceIdFilter,
|
|
includeRoutineExecutions: true,
|
|
includeAgentCreatedTasks,
|
|
originKind,
|
|
limit: issuePageSize,
|
|
offset: pageParam,
|
|
sortField: serverSortField,
|
|
sortDir: serverSortDir,
|
|
includeBlockedBy: includeBlockedBy || undefined,
|
|
}, { signal }),
|
|
initialPageParam: 0,
|
|
getNextPageParam: (lastPage, _allPages, lastPageParam) =>
|
|
getNextIssuesPageOffset(lastPage.length, lastPageParam, issuePageSize),
|
|
enabled: !!selectedCompanyId,
|
|
placeholderData: (previousData) => previousData,
|
|
});
|
|
|
|
const { data: issuePages, isFetchingNextPage, hasNextPage, fetchNextPage } = issuesQuery;
|
|
const issuesView = useQueryView(issuesQuery);
|
|
const issues = useMemo(() => mergeIssuePagesStable(issuePages?.pages ?? []) as Issue[], [issuePages]);
|
|
const liveIssueIds = useMemo(() => collectLiveIssueIds(liveRuns, issues), [issues, liveRuns]);
|
|
const hasMoreServerIssues = syncedSearch.trim().length === 0
|
|
&& hasNextPage === true;
|
|
const loadMoreServerIssues = useCallback(() => {
|
|
if (!hasNextPage || isFetchingNextPage || fetchNextPageInFlightRef.current) return;
|
|
fetchNextPageInFlightRef.current = true;
|
|
void fetchNextPage({ cancelRefetch: false }).finally(() => {
|
|
fetchNextPageInFlightRef.current = false;
|
|
});
|
|
}, [fetchNextPage, hasNextPage, isFetchingNextPage]);
|
|
|
|
// Optimistic, rolls back with a readable toast, and resends after an outage.
|
|
const updateIssue = useUpdateIssueMutation({ companyId: selectedCompanyId });
|
|
|
|
if (!selectedCompanyId) {
|
|
return (
|
|
<EmptyState
|
|
icon={CircleDot}
|
|
message={streamlinedUiEnabled
|
|
? "Select an organization to view tasks."
|
|
: "Select a company to view tasks."}
|
|
/>
|
|
);
|
|
}
|
|
|
|
if (issuesView.kind === "error") return <QueryErrorState size="page" error={issuesView.error} action="load tasks" onRetry={issuesView.retry} retrying={issuesView.isFetching} />;
|
|
|
|
return (
|
|
<IssuesList
|
|
issues={issues ?? []}
|
|
isLoading={issuesView.kind === "loading" || issuesView.kind === "reconnecting"}
|
|
isLoadingMoreIssues={isFetchingNextPage}
|
|
agents={agents}
|
|
projects={projects}
|
|
liveIssueIds={liveIssueIds}
|
|
viewStateKey="paperclip:issues-view"
|
|
rowPresentation={issuesPresentation.rowPresentation}
|
|
toolbarPresentation={issuesPresentation.toolbarPresentation}
|
|
issueLinkState={issueLinkState}
|
|
initialAssignees={searchParams.get("assignee") ? [searchParams.get("assignee")!] : undefined}
|
|
initialWorkspaces={initialWorkspaces.length > 0 ? initialWorkspaces : undefined}
|
|
initialStatuses={initialStatuses}
|
|
toolbarContext={toolbarContext}
|
|
initialSearch={syncedSearch}
|
|
onSearchChange={handleSearchChange}
|
|
enableAgentCreatedVisibilityFilter
|
|
routineTasksOnly={routineTasksOnly}
|
|
onRoutineTasksOnlyChange={handleRoutineTasksOnlyChange}
|
|
sort={sort}
|
|
onSortChange={handleSortChange}
|
|
hasMoreIssues={hasMoreServerIssues}
|
|
onLoadMoreIssues={loadMoreServerIssues}
|
|
onUpdateIssue={(id, data) => updateIssue.mutate({ id, data })}
|
|
searchFilters={participantAgentId || workspaceIdFilter || originKind || includeBlockedBy ? { participantAgentId, workspaceId: workspaceIdFilter, originKind, ...(includeBlockedBy ? { includeBlockedBy: true } : {}) } : undefined}
|
|
/>
|
|
);
|
|
}
|