paperclip/ui/src/context/ToastContext.tsx
Dotta 6b7f6ce4b8
[codex] Split PR #4692 UI/QoL updates (#4701)
## 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>
2026-04-28 17:18:58 -05:00

197 lines
4.9 KiB
TypeScript

import {
createContext,
useCallback,
useContext,
useEffect,
useMemo,
useRef,
useState,
type ReactNode,
} from "react";
export type ToastTone = "info" | "success" | "warn" | "error";
export interface ToastAction {
label: string;
href: string;
}
export interface ToastInput {
id?: string;
dedupeKey?: string;
title: string;
body?: string;
tone?: ToastTone;
ttlMs?: number;
action?: ToastAction;
}
export interface ToastItem {
id: string;
title: string;
body?: string;
tone: ToastTone;
ttlMs: number;
action?: ToastAction;
createdAt: number;
}
interface ToastActionsContextValue {
pushToast: (input: ToastInput) => string | null;
dismissToast: (id: string) => void;
clearToasts: () => void;
}
interface ToastContextValue extends ToastActionsContextValue {
toasts: ToastItem[];
}
const DEFAULT_TTL_BY_TONE: Record<ToastTone, number> = {
info: 4000,
success: 3500,
warn: 8000,
error: 10000,
};
const MIN_TTL_MS = 1500;
const MAX_TTL_MS = 15000;
const MAX_TOASTS = 5;
const DEDUPE_WINDOW_MS = 3500;
const DEDUPE_MAX_AGE_MS = 20000;
const ToastStateContext = createContext<ToastItem[] | null>(null);
const ToastActionsContext = createContext<ToastActionsContextValue | null>(null);
function normalizeTtl(value: number | undefined, tone: ToastTone) {
const fallback = DEFAULT_TTL_BY_TONE[tone];
if (typeof value !== "number" || !Number.isFinite(value)) return fallback;
return Math.max(MIN_TTL_MS, Math.min(MAX_TTL_MS, Math.floor(value)));
}
function generateToastId() {
return `toast_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`;
}
export function ToastProvider({ children }: { children: ReactNode }) {
const [toasts, setToasts] = useState<ToastItem[]>([]);
const timersRef = useRef(new Map<string, number>());
const dedupeRef = useRef(new Map<string, number>());
const clearTimer = useCallback((id: string) => {
const handle = timersRef.current.get(id);
if (handle !== undefined) {
window.clearTimeout(handle);
timersRef.current.delete(id);
}
}, []);
const dismissToast = useCallback(
(id: string) => {
clearTimer(id);
setToasts((prev) => prev.filter((toast) => toast.id !== id));
},
[clearTimer],
);
const clearToasts = useCallback(() => {
for (const handle of timersRef.current.values()) {
window.clearTimeout(handle);
}
timersRef.current.clear();
setToasts([]);
}, []);
const pushToast = useCallback(
(input: ToastInput) => {
const now = Date.now();
const tone = input.tone ?? "info";
const ttlMs = normalizeTtl(input.ttlMs, tone);
const dedupeKey =
input.dedupeKey ?? input.id ?? `${tone}|${input.title}|${input.body ?? ""}|${input.action?.href ?? ""}`;
for (const [key, ts] of dedupeRef.current.entries()) {
if (now - ts > DEDUPE_MAX_AGE_MS) {
dedupeRef.current.delete(key);
}
}
const lastSeen = dedupeRef.current.get(dedupeKey);
if (lastSeen && now - lastSeen < DEDUPE_WINDOW_MS) {
return null;
}
dedupeRef.current.set(dedupeKey, now);
const id = input.id ?? generateToastId();
clearTimer(id);
setToasts((prev) => {
const nextToast: ToastItem = {
id,
title: input.title,
body: input.body,
tone,
ttlMs,
action: input.action,
createdAt: now,
};
const withoutCurrent = prev.filter((toast) => toast.id !== id);
return [nextToast, ...withoutCurrent].slice(0, MAX_TOASTS);
});
const timeout = window.setTimeout(() => {
dismissToast(id);
}, ttlMs);
timersRef.current.set(id, timeout);
return id;
},
[clearTimer, dismissToast],
);
useEffect(() => () => {
for (const handle of timersRef.current.values()) {
window.clearTimeout(handle);
}
timersRef.current.clear();
}, []);
const actions = useMemo<ToastActionsContextValue>(
() => ({
pushToast,
dismissToast,
clearToasts,
}),
[pushToast, dismissToast, clearToasts],
);
return (
<ToastActionsContext.Provider value={actions}>
<ToastStateContext.Provider value={toasts}>{children}</ToastStateContext.Provider>
</ToastActionsContext.Provider>
);
}
export function useToastState() {
const context = useContext(ToastStateContext);
if (!context) {
throw new Error("useToastState must be used within a ToastProvider");
}
return context;
}
export function useToastActions() {
const context = useContext(ToastActionsContext);
if (!context) {
throw new Error("useToastActions must be used within a ToastProvider");
}
return context;
}
export function useOptionalToastActions() {
return useContext(ToastActionsContext);
}
export function useToast() {
const toasts = useToastState();
const actions = useToastActions();
return useMemo<ToastContextValue>(() => ({ toasts, ...actions }), [toasts, actions]);
}