Files
PaperClipAI/ui/src/context/SidebarContext.tsx
T
DottaandPaperclip e68188c438 fix: upstream deployed document-comment, routine-annotation, workspace & board-polling fixes (#8536)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - This change touches several already-shipped subsystems —
document-comment annotations, the selected-agent Conference Room chat
surface, routine description annotations, workspace-operation tracking,
and the board polling/inbox UI
> - A batch of incremental fixes and two small backend additions had
accumulated on a local mainline and were deployed to a live instance,
but never landed upstream — so each `origin/master` sync kept
re-diverging
> - Leaving them un-upstreamed means the same delta has to be re-merged
on every sync and risks being lost or silently reverted
> - This pull request rebases that delta cleanly on top of current
`origin/master` (preserving recent upstream work such as reusable
sandbox leases and the relation-list collapse controls) and brings it up
for review
> - The benefit is that mainline and the deployed instance converge, and
these fixes/additions get normal review + CI + Greptile coverage

## Linked Issues or Issue Description

No single GitHub issue tracks this; it is a bundle of bug fixes and two
small feature additions. Following the issue-template fields:

**Bug fixes (what was wrong → what this does):**
- Document comments rendered out of document order, didn't live-update
across clients, swallowed save failures, and lost the markdown text
selection on re-render. Now: doc-order sort, live updates, surfaced
save-failure state, stable selection across re-renders.
- The board polling hot path returned oversized payloads on every poll.
Now: an opt-in `summary` projection trims the heartbeat-run list
payload.
- Assorted UI fixes: sidebar nav peek/streamlining edge cases, markdown
file-viewer re-mount/line-height issues on iOS Safari, inbox badge/skill
deep-link tab selection, and `⌘.` work-mode cycling on iOS.

**Feature additions:**
- `workspace_operations.issue_id` — associate a workspace operation with
the issue that triggered it (new migration `0106`, schema, service,
shared type).
- Routine **description annotations** — comment threads on a routine's
description document, mirroring issue document annotations (new
migration `0107`, `routine_documents` schema, routes/service,
editable-sections UI).
- Selected-agent **Conference Room chat** surface wiring and live
issue-thread updates.

**Related PR:** #8229 (`feat(control-plane): add annotation and
workspace controls`, draft) covers overlapping
annotation/workspace-control territory — flagging it so a reviewer can
reconcile the two rather than double-merging.

## What Changed

- `feat(workspace)`: `workspace_operations.issue_id` migration +
schema/service/type; issue workspace property controls reconciled with
upstream's evolved "Service" row.
- `feat(routines)`: routine description annotations —
`routine_documents` schema, migration `0107`, routes/service,
`editable-sections` UI.
- `fix(document-comments)`: doc-order sort, live updates, save-failure
surfacing, stable markdown selection (+ storybook story, rerender test).
- `feat(chat)`: selected-agent Conference Room chat surface and live
issue-thread updates (`LiveUpdatesProvider`, `issue-chat-messages`,
interactions service).
- `perf(board)`: opt-in `summary` projection for the board
polling/heartbeat-run list payload, plus assorted sidebar / file-viewer
/ inbox / IssueProperties UI fixes.

Organized into 5 logical commits. Migrations are numbered incrementally
after upstream's latest (`0105`) — `0106` then `0107`, no journal
collision.

## Verification

- Built by 3-way merging the deployed delta onto current
`origin/master`; the only merge conflict (`IssueProperties.test.tsx`,
two adjacent test blocks) was resolved in favor of upstream's evolved
"green service link above the workspace row" layout, which matches the
merged component's rendered output.
- Confirmed recent upstream work is preserved post-merge: reusable
sandbox lease teardown (`#8513`), the IssueProperties relation-list
collapse controls, and the sidebar streamlined-nav default.
- Confirmed the net diff vs `origin/master` is exactly the intended
feature delta (65 files) and that overlapping server files (`issues.ts`,
`agents.ts`, `heartbeat.ts`) only add feature code without disturbing
upstream logic.
- This delta is already running on a live deployed instance.
- Full typecheck/test suite + Greptile to run in CI (see checklist).

## Risks

- Two new migrations (`0106`, `0107`). Both are additive (new table /
new nullable column) and ordered after upstream's `0105`; no data
backfill, low risk. If another migration-bearing PR merges first,
renumber before merge.
- Largest blast radius is in the merged overlapping UI/service files;
covered by the existing test suites for those files plus CI.
- Overlaps thematically with draft PR #8229 — reviewers should reconcile
rather than merge both blindly.

## Model Used

Claude Opus 4.8 (`claude-opus-4-8`), extended thinking, with tool use
(git, shell). Agentic coding workflow.

## 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)
- [ ] 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

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-06-23 09:00:14 -05:00

221 lines
8.0 KiB
TypeScript

import {
createContext,
useCallback,
useContext,
useEffect,
useMemo,
useState,
type ReactNode,
} from "react";
interface SidebarContextValue {
// Mobile drawer + back-compat (existing behavior, unchanged).
sidebarOpen: boolean;
setSidebarOpen: (open: boolean) => void;
toggleSidebar: () => void;
isMobile: boolean;
// Pinned desktop mode: expanded | collapsed. Desktop-only.
collapsed: boolean;
setCollapsed: (next: boolean) => void;
toggleCollapsed: () => void;
// True while a secondary sidebar forces the rail: the collapse is locked, so
// the expand/toggle affordance must be hidden/inert. Desktop-only.
collapseLocked: boolean;
// Ephemeral peek (hover flyout). Only meaningful on desktop, collapsed,
// hover-capable pointer. Never persisted.
peeking: boolean;
setPeeking: (next: boolean) => void;
// Hard, ephemeral collapse forced by an active secondary sidebar (settings,
// plugin `routeSidebar`, …). HIGHER precedence than the user pin — the rule
// is "a secondary sidebar always collapses the primary" — but it never
// mutates the persisted pin, so leaving the route restores the preference.
// Wired by Layout (PAP-10694).
forceCollapsed: boolean;
setForceCollapsed: (next: boolean) => void;
// Route-requested collapse: a route may *default* the app sidebar to
// collapsed. LOWER precedence than an explicit user pin. Wired by routes via
// RequestCollapsedSidebar.
routeRequestsCollapsed: boolean;
setRouteRequestsCollapsed: (next: boolean) => void;
}
const SidebarContext = createContext<SidebarContextValue | null>(null);
const MOBILE_BREAKPOINT = 768;
const COLLAPSED_STORAGE_KEY = "paperclip.sidebar.collapsed";
const PEEK_POINTER_QUERY = "(hover: hover) and (pointer: fine)";
// Tri-state read of the persisted user pin:
// true → pinned collapsed ("1")
// false → pinned expanded ("0")
// null → no pin (fall through to route request, then global default)
// Read synchronously in the state initializer so first paint matches the
// persisted mode (mirrors the `paperclip.sidebar.width` pattern in
// ResizableSidebarPane and avoids an expand→collapse flash).
function readStoredCollapsed(): boolean | null {
if (typeof window === "undefined") return null;
try {
const stored = window.localStorage.getItem(COLLAPSED_STORAGE_KEY);
if (stored === "1") return true;
if (stored === "0") return false;
return null;
} catch {
return null;
}
}
function writeStoredCollapsed(value: boolean) {
if (typeof window === "undefined") return;
try {
window.localStorage.setItem(COLLAPSED_STORAGE_KEY, value ? "1" : "0");
} catch {
// Storage can be unavailable in private contexts; pinning should still
// work for the current session.
}
}
function readPointerCanPeek(): boolean {
if (typeof window === "undefined" || typeof window.matchMedia !== "function") {
return false;
}
try {
return window.matchMedia(PEEK_POINTER_QUERY).matches;
} catch {
return false;
}
}
export function SidebarProvider({ children }: { children: ReactNode }) {
const [isMobile, setIsMobile] = useState(() => window.innerWidth < MOBILE_BREAKPOINT);
const [sidebarOpen, setSidebarOpen] = useState(() => window.innerWidth >= MOBILE_BREAKPOINT);
// `null` = unpinned; an explicit user pin takes precedence over route request.
const [userCollapsed, setUserCollapsed] = useState<boolean | null>(() => readStoredCollapsed());
const [routeRequestsCollapsed, setRouteRequestsCollapsed] = useState(false);
const [forceCollapsed, setForceCollapsed] = useState(false);
const [rawPeeking, setRawPeeking] = useState(false);
const [pointerCanPeek, setPointerCanPeek] = useState(() => readPointerCanPeek());
useEffect(() => {
const mql = window.matchMedia(`(max-width: ${MOBILE_BREAKPOINT - 1}px)`);
const onChange = (e: MediaQueryListEvent) => {
setIsMobile(e.matches);
setSidebarOpen(!e.matches);
};
mql.addEventListener("change", onChange);
return () => mql.removeEventListener("change", onChange);
}, []);
useEffect(() => {
if (typeof window.matchMedia !== "function") return;
const mql = window.matchMedia(PEEK_POINTER_QUERY);
// Latch on only — see the runtime detection below for why this never flips
// back to false.
const onChange = (e: MediaQueryListEvent) => {
if (e.matches) setPointerCanPeek(true);
};
mql.addEventListener("change", onChange);
return () => mql.removeEventListener("change", onChange);
}, []);
// iPadOS Safari does not flip the `(hover: hover) and (pointer: fine)` media
// query when a trackpad/mouse is attached, so the query above stays false even
// though a real cursor is driving the UI — and hover-peek never triggers
// (PAP-10725). Detect a fine pointer at runtime instead: a genuine
// mouse/trackpad emits pointer events with `pointerType: "mouse"`, whereas
// touch reports "touch" and the Pencil reports "pen", so this never enables on
// touch-only input. Treat peek capability as a one-way latch — once a cursor
// has been seen we keep peek available for the session.
useEffect(() => {
if (pointerCanPeek || typeof window.PointerEvent !== "function") return;
const onPointer = (e: PointerEvent) => {
if (e.pointerType === "mouse") setPointerCanPeek(true);
};
window.addEventListener("pointerover", onPointer, { passive: true });
window.addEventListener("pointermove", onPointer, { passive: true });
return () => {
window.removeEventListener("pointerover", onPointer);
window.removeEventListener("pointermove", onPointer);
};
}, [pointerCanPeek]);
// Precedence (highest wins): forced (active secondary sidebar) > explicit user
// pin > route request > default expanded. The force is ephemeral and never
// touches the persisted pin, so dropping it restores the user's preference.
const pinnedOrRequested = userCollapsed !== null ? userCollapsed : routeRequestsCollapsed;
const desktopCollapsed = forceCollapsed || pinnedOrRequested;
// Collapsed/peek are desktop-only; mobile always uses the drawer. The user
// pin is preserved across the breakpoint and reapplies on the desktop side.
const collapsed = isMobile ? false : desktopCollapsed;
// While forced, the pin is locked: the expand/toggle affordance is inert.
const collapseLocked = !isMobile && forceCollapsed;
// Peek only applies when collapsed on a hover-capable pointer.
const peeking = rawPeeking && collapsed && pointerCanPeek;
const setCollapsed = useCallback((next: boolean) => {
setUserCollapsed(next);
writeStoredCollapsed(next);
}, []);
const toggleCollapsed = useCallback(() => {
// While a secondary sidebar forces the rail, the toggle is locked: it must
// neither expand the rail nor mutate the persisted preference.
if (forceCollapsed) return;
setCollapsed(!pinnedOrRequested);
}, [forceCollapsed, pinnedOrRequested, setCollapsed]);
const setPeeking = useCallback((next: boolean) => {
setRawPeeking(next);
}, []);
const toggleSidebar = useCallback(() => setSidebarOpen((v) => !v), []);
const value = useMemo<SidebarContextValue>(
() => ({
sidebarOpen,
setSidebarOpen,
toggleSidebar,
isMobile,
collapsed,
setCollapsed,
toggleCollapsed,
collapseLocked,
peeking,
setPeeking,
forceCollapsed,
setForceCollapsed,
routeRequestsCollapsed,
setRouteRequestsCollapsed,
}),
[
sidebarOpen,
setSidebarOpen,
toggleSidebar,
isMobile,
collapsed,
setCollapsed,
toggleCollapsed,
collapseLocked,
peeking,
setPeeking,
forceCollapsed,
setForceCollapsed,
routeRequestsCollapsed,
setRouteRequestsCollapsed,
],
);
return <SidebarContext.Provider value={value}>{children}</SidebarContext.Provider>;
}
export function useSidebar() {
const ctx = useContext(SidebarContext);
if (!ctx) {
throw new Error("useSidebar must be used within SidebarProvider");
}
return ctx;
}