mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-14 08:53:19 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - The board UI sidebar has a Recents list of the tasks a person opened
last
> - The Recents list renders from a local snapshot, but its links had no
warm-up. A click waited for the task-detail code and about nine
first-frame reads
> - Task lists (Inbox, Tasks) already warm a task on hover, press and
click, and #20355 added a batched `chat-bootstrap` read that had no UI
consumer
> - The hosted database is CPU-bound, so a fix must add at most one read
per page load and must not compete with the page's own reads
> - This pull request gives Recents the same open-intent prefetch as
task lists, warms the task-detail code, and preloads the top ten recent
tasks with one `chat-bootstrap` request after the page is idle
> - The benefit is that a click on a recent task shows its chat from
cache, without a wait for the API
## Linked Issues or Issue Description
Refs #20355 (server read this PR consumes). Builds on #20389, #20398 and
#20419.
**Is your feature request related to a problem?**
Opening a task from the sidebar's Recents was slower than opening it
from a task list. The Recents links had no prefetch. The task page
waited for its first-frame reads after the click.
**Describe the solution you'd like**
Recents links use the task lists' open-intent prefetch. When the page is
idle, one batched request loads the first frame of the most recent tasks
into the task page's caches.
**Describe alternatives you've considered**
Per-task prefetch of every recent task. That makes up to ten times nine
requests per page load, which the hosted database cannot afford.
**Additional context**
I searched open PRs and remote branches for "chat-bootstrap" and
"instant task opens". The only related work is the server-side branches
that merged as #20355. There is no other in-flight UI consumer of
`chat-bootstrap`.
## What Changed
- `ui/src/hooks/useIssueNavigationPrefetch.ts`: the open-intent handlers
from `IssueLinkQuicklook` move into one hook (light warm on pass-over;
`history: true` on a resting hover or focus, a mouse or pen press, and a
click). `IssueLinkQuicklook` now uses the hook. Its behavior does not
change.
- `ui/src/components/RecentTaskNavItem.tsx`: one Recents link wrapper
that applies the hook. The classic list (`SidebarRecentTasks`), the
Coordinator task rows and `DesignSidebar` use it. `SidebarNavItem`
accepts the handlers through a new optional `linkHandlers` prop.
- Classic Recents links now open `/issues/<identifier>` (Coordinator
already did). The old UUID link remounted the task page after a redirect
to the identifier route.
- `ui/src/hooks/useRecentTaskOpenWarmup.ts`: when Recents shows a task,
it fires the task-detail code warm-up (`useWarmTaskDetailCode`). After
two frames, a visible tab, no fetching queries and an idle callback, it
sends one `issues/chat-bootstrap?ids=` request for the ten most recent
tasks. It skips tasks whose first frame is cached and fresh. It sends no
request for an empty list or a hidden tab. It sends at most one request
per account per page load. Unmount or an account change aborts the
request.
- `ui/src/lib/issueChatBootstrapCache.ts`: `seedIssueChatBootstrap`
writes each field under the keys the task page reads, for the requested
ref, the id and the identifier: core issue, recent comments, comment
input facts (one batch, through the new `seedIssueIdBatch`), recent
activity, the recent run window (through the new shared
`buildRecentIssueRunWindow`), interactions, attachments, live runs and
active run. An explicit `null` active run is stored. A missing field is
not stored. It does not replace data that is as new or newer, data with
a read in flight, or data with a pending invalidation. Keys whose page
merges observed history (comments, activity, runs, input facts) are
filled only when empty. Items for another company are ignored.
- The seed fills the `?view=core` key, not the full detail key.
`seedIssueDetailCache` is not used: the core payload cannot stand in for
the detail read's related data, and seeding it there would suppress that
read.
- `issuesApi.chatBootstrap` client method.
- `tests/perf/collections/recent-task-open.spec.ts` and its README
section.
## Verification
Local disposable instance (`local_trusted`, production UI build,
embedded PostgreSQL, collection fixture plus 12 comments on each of 8
recent tasks, streamlined UI with the Coordinator sidebar). Journey:
open Projects with 8 Recents, wait for network idle plus 3 s, click a
recent task, measure until its latest comment is on screen. Each run
uses a fresh browser context (empty HTTP cache and storage apart from
Recents). Median of 5 runs, same server and fixture for both arms:
| Arm | Click to first chat frame | Idle page API requests |
| --- | --- | --- |
| `master` (b6f4008f9b), loopback | 227 ms (first run: 249 ms) | 24
(range 21–25) |
| This PR, loopback | 134 ms | 22 (range 21–27) |
| `master`, +150 ms on each API response | 455 ms | 19 |
| This PR, +150 ms on each API response | 135 ms | 20 (+1
`chat-bootstrap`) |
With added latency, the first frame no longer depends on API latency.
- `PAPERCLIP_COLLECTION_PERF_BASE_URL=http://127.0.0.1:<port> pnpm exec
playwright test --config tests/perf/collections/playwright.config.ts
recent-task-open.spec.ts recent-task-summaries.spec.ts`: 5 passed. On
`master` the two assertion cases fail (0 `chat-bootstrap` requests; 10
first-frame reads after the click).
- Reads that still follow a click on a preloaded task: full detail (`GET
/issues/:id`), `work-products`, `documents`, `feedback-votes`,
`tree-control/state`, `tree-holds`, `runner-goal`, `browsers`, and the
`read` mark. The `chat-bootstrap` payload does not cover them. None
gates the chat's first frame (the frame shows at 135 ms while every API
response waits 150 ms).
- Unit tests: `RecentTaskNavItem.test.tsx` (intent levels, href),
`useRecentTaskOpenWarmup.test.tsx` (one request for the top ten, code
warm-up, wait for page reads, hidden tab, fresh entries skipped, once
per account, user isolation, abort on unmount),
`issueChatBootstrapCache.test.ts` (each key in the endpoint shape,
`null` versus missing fields, company isolation, no downgrade of newer,
in-flight or invalidated data, merge keys filled only when empty).
- `ui` Vitest: `src/components src/hooks src/lib src/api` 694 files
passed; `src/pages src/App src/context` 188 files passed. `pnpm
check:token-gates`: clean. `pnpm verify` exits 2 because a `tests/` file
is a global CI input; required CI supplies the broad coverage.
## Risks
- Low to medium. One extra read per page load when Recents has tasks
without a fresh cached first frame. The read starts only after the
page's own queries settle, and the server reads at most two tasks at a
time.
- A live event that arrives while the preload is in flight, for a task
with no cached keys, can leave seeded data up to 30 s old until the next
live event or the next open after the stale time. Inbox hover prefetch
has the same window.
- Classic Recents links now use the identifier route instead of the UUID
route. The task page already redirected UUID links to this route.
- `tests/perf/collections` is a manual suite. CI does not run it.
## Model Used
- Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, in Claude Code with
tool use (shell, file edits, browser automation through Playwright).
Standard context window.
## 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
- [ ] 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>
239 lines
9.2 KiB
TypeScript
239 lines
9.2 KiB
TypeScript
import { createContext, useContext, type ReactNode } from "react";
|
|
import { NavLink } from "@/lib/router";
|
|
import type { IssueNavigationPrefetchHandlers } from "@/hooks/useIssueNavigationPrefetch";
|
|
import { SIDEBAR_SCROLL_RESET_STATE } from "../lib/navigation-scroll";
|
|
import { cn, SIDEBAR_RAIL_HIDDEN_LABEL } from "../lib/utils";
|
|
import { useSidebar } from "../context/SidebarContext";
|
|
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
|
|
import type { LucideIcon } from "lucide-react";
|
|
import { Badge } from "@/components/ui/badge";
|
|
import { TruncatedText } from "./TruncatedText";
|
|
|
|
/**
|
|
* Forces the full-label (non-rail) presentation for any `SidebarNavItem`
|
|
* rendered beneath it, regardless of the global `useSidebar().collapsed` state.
|
|
*
|
|
* Contextual takeover routes replace the global navigation inside the same
|
|
* sidebar shell. The user's saved global collapse preference can still be
|
|
* `collapsed=true`, so this provider keeps contextual navigation readable
|
|
* without mutating that preference.
|
|
*/
|
|
const SidebarNavExpandedContext = createContext(false);
|
|
|
|
export function SidebarNavExpandedProvider({ children }: { children: ReactNode }) {
|
|
return (
|
|
<SidebarNavExpandedContext.Provider value={true}>
|
|
{children}
|
|
</SidebarNavExpandedContext.Provider>
|
|
);
|
|
}
|
|
|
|
export function useSidebarNavExpanded() {
|
|
return useContext(SidebarNavExpandedContext);
|
|
}
|
|
|
|
interface SidebarNavItemProps {
|
|
to: string;
|
|
label: string;
|
|
icon?: LucideIcon;
|
|
/**
|
|
* Pre-rendered icon element for rows whose icon isn't a plain Lucide
|
|
* component (e.g. the agent rows' `AgentIcon`). Takes precedence over `icon`;
|
|
* the caller owns its sizing/color classes.
|
|
*/
|
|
iconNode?: ReactNode;
|
|
end?: boolean;
|
|
className?: string;
|
|
labelClassName?: string;
|
|
badge?: number;
|
|
badgeTone?: "default" | "danger" | "warning";
|
|
/**
|
|
* Accessible noun for the numeric badge when collapsed to the rail, where the
|
|
* count is rendered as a dot (e.g. `badgeLabel="unread"` → "Inbox, 28 unread").
|
|
*/
|
|
badgeLabel?: string;
|
|
textBadge?: string;
|
|
textBadgeTone?: "default" | "amber";
|
|
alert?: boolean;
|
|
liveCount?: number;
|
|
/**
|
|
* Overrides NavLink's own route matching for rows whose active state is
|
|
* computed externally (agent rows match `/agents/:ref` across tab suffixes).
|
|
*/
|
|
active?: boolean;
|
|
/** Rendered after the label, before the right-aligned status cluster. */
|
|
trailing?: ReactNode;
|
|
/** Accessible text for `trailing` status content, surfaced in the collapsed rail (where `trailing` is hidden). */
|
|
trailingLabel?: string;
|
|
/** Rendered inside the right-aligned status cluster, before the live dot. */
|
|
liveAccessory?: ReactNode;
|
|
/** Extra link handlers, such as a task's open-intent prefetch. */
|
|
linkHandlers?: Partial<IssueNavigationPrefetchHandlers>;
|
|
}
|
|
|
|
export function SidebarNavItem({
|
|
to,
|
|
label,
|
|
icon: Icon,
|
|
iconNode,
|
|
end,
|
|
className,
|
|
labelClassName,
|
|
badge,
|
|
badgeTone = "default",
|
|
badgeLabel,
|
|
textBadge,
|
|
textBadgeTone = "default",
|
|
alert = false,
|
|
liveCount,
|
|
active,
|
|
trailing,
|
|
trailingLabel,
|
|
liveAccessory,
|
|
linkHandlers,
|
|
}: SidebarNavItemProps) {
|
|
const { isMobile, setSidebarOpen, collapsed, peeking } = useSidebar();
|
|
// A contextual takeover forces full labels even when the saved global app
|
|
// sidebar preference is collapsed.
|
|
const forceExpanded = useSidebarNavExpanded();
|
|
// The icon-only rail presentation only applies when pinned collapsed and not
|
|
// peeking; a peek/expanded panel — or a contextual takeover — restores
|
|
// the full label + badge.
|
|
const rail = collapsed && !peeking && !forceExpanded;
|
|
|
|
const hasBadge = badge != null && badge > 0;
|
|
const hasLive = liveCount != null && liveCount > 0;
|
|
const showIconSlot = Boolean(iconNode || Icon || alert || (rail && (hasLive || hasBadge)));
|
|
|
|
// Accessible text equivalent for the collapsed dot indicator. The visible
|
|
// label is `sr-only` in the rail, so the count must be surfaced here.
|
|
const railStatusText = hasLive
|
|
? `${liveCount} live`
|
|
: hasBadge
|
|
? `${badge}${badgeLabel ? ` ${badgeLabel}` : ""}`
|
|
: alert
|
|
? "attention needed"
|
|
: undefined;
|
|
const railAriaLabel = !rail || (!railStatusText && !trailingLabel)
|
|
? undefined
|
|
: `${label}${railStatusText ? `, ${railStatusText}` : ""}${trailingLabel ? `, ${trailingLabel}` : ""}`;
|
|
|
|
const link = (
|
|
<NavLink
|
|
to={to}
|
|
state={SIDEBAR_SCROLL_RESET_STATE}
|
|
end={end}
|
|
aria-label={railAriaLabel}
|
|
{...linkHandlers}
|
|
onClick={() => { if (isMobile) setSidebarOpen(false); }}
|
|
className={({ isActive }) =>
|
|
cn(
|
|
// One rhythm and one inset pill highlight: mx-2 floats the row off
|
|
// the sidebar edges, rounded-lg matches the card anchor, px-2 gives
|
|
// the icon breathing room inside the pill. Rows with hover menus
|
|
// (agents/projects) reserve extra right padding via className.
|
|
"flex items-center gap-2.5 mx-2 rounded-lg px-2 py-1.5 pointer-coarse:py-1 text-(length:--text-compact) font-medium transition-colors",
|
|
(active ?? isActive)
|
|
? "bg-sidebar-accent text-sidebar-accent-foreground"
|
|
: "text-foreground/80 hover:bg-sidebar-accent hover:text-sidebar-accent-foreground",
|
|
className,
|
|
)
|
|
}
|
|
>
|
|
{showIconSlot ? (
|
|
<span data-slot="sidebar-nav-icon" className="relative shrink-0">
|
|
{iconNode ?? (Icon ? <Icon className="h-4 w-4" /> : null)}
|
|
{alert && (
|
|
<span
|
|
data-slot="sidebar-icon-alert-badge"
|
|
className="absolute -right-0.5 -top-0.5 h-2 w-2 rounded-full bg-red-500 shadow-(--shadow-sidebar-icon-badge)"
|
|
aria-hidden="true"
|
|
/>
|
|
)}
|
|
{/* Collapsed rail: numeric badge / live count collapse to a dot on the
|
|
icon. The icon markup is untouched so it stays pixel-aligned. */}
|
|
{rail && !alert && hasLive && (
|
|
<span className="absolute -right-0.5 -top-0.5 flex h-2 w-2" aria-hidden="true">
|
|
<span className="animate-pulse absolute inline-flex h-full w-full rounded-full bg-blue-600 dark:bg-blue-400 opacity-75" />
|
|
<span className="relative inline-flex h-2 w-2 rounded-full bg-blue-600 dark:bg-blue-400 shadow-(--shadow-sidebar-icon-badge)" />
|
|
</span>
|
|
)}
|
|
{rail && !alert && !hasLive && hasBadge && (
|
|
<span
|
|
className={cn(
|
|
"absolute -right-0.5 -top-0.5 h-2 w-2 rounded-full shadow-(--shadow-sidebar-icon-badge)",
|
|
badgeTone === "danger"
|
|
? "bg-red-600"
|
|
: badgeTone === "warning"
|
|
? "bg-amber-500"
|
|
: "bg-primary",
|
|
)}
|
|
aria-hidden="true"
|
|
/>
|
|
)}
|
|
</span>
|
|
) : null}
|
|
<TruncatedText className={rail ? SIDEBAR_RAIL_HIDDEN_LABEL : cn("min-w-0 flex-1 truncate", labelClassName)}>{label}</TruncatedText>
|
|
{!rail && trailing}
|
|
{!rail && textBadge && (
|
|
<Badge variant="ghost"
|
|
className={cn(
|
|
"ml-auto px-1.5 text-(length:--text-nano) leading-none",
|
|
textBadgeTone === "amber"
|
|
? "bg-amber-100 text-amber-800 dark:bg-amber-900/30 dark:text-amber-400"
|
|
: "bg-muted text-muted-foreground",
|
|
)}
|
|
>
|
|
{textBadge}
|
|
</Badge>
|
|
)}
|
|
{!rail && (hasLive || liveAccessory) && (
|
|
<span className="ml-auto flex shrink-0 items-center gap-1.5 whitespace-nowrap">
|
|
{liveAccessory}
|
|
{hasLive && (
|
|
<>
|
|
<span className="relative flex h-2 w-2">
|
|
<span className="animate-pulse absolute inline-flex h-full w-full rounded-full bg-blue-600 dark:bg-blue-400 opacity-75" />
|
|
<span className="relative inline-flex rounded-full h-2 w-2 bg-blue-600 dark:bg-blue-400" />
|
|
</span>
|
|
<span className="text-(length:--text-micro) font-medium text-blue-600 dark:text-blue-400">{liveCount} live</span>
|
|
</>
|
|
)}
|
|
</span>
|
|
)}
|
|
{!rail && hasBadge && (
|
|
<Badge variant="ghost"
|
|
aria-label={badgeLabel ? `${badge} ${badgeLabel}` : undefined}
|
|
className={cn(
|
|
"ml-auto px-1.5 leading-none",
|
|
badgeTone === "danger"
|
|
? "bg-red-600/90 text-red-50"
|
|
: badgeTone === "warning"
|
|
? "bg-amber-500/90 text-amber-50"
|
|
: "bg-primary text-primary-foreground",
|
|
)}
|
|
>
|
|
{badge}
|
|
</Badge>
|
|
)}
|
|
</NavLink>
|
|
);
|
|
|
|
if (!rail) return link;
|
|
|
|
// The tooltip wraps a plain block element rather than the NavLink directly:
|
|
// Radix `asChild` (Slot) drops React Router's *function* className, which would
|
|
// strip `flex` off the <a> and render it as a block — the in-flow label would
|
|
// then stack under the icon and the row would grow. Anchoring the tooltip to a
|
|
// wrapper keeps the <a> rendering normally (flex), so the row stays 1:1 with
|
|
// the expanded state and the icon never moves (PAP-10676).
|
|
return (
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<div>{link}</div>
|
|
</TooltipTrigger>
|
|
<TooltipContent side="right">{label}</TooltipContent>
|
|
</Tooltip>
|
|
);
|
|
}
|