Files
PaperClipAI/ui/src/components/task-chat/TaskMessageScroller.test.tsx
T
DottaandPaperclip d38cdf261a perf(ui): speed up Tasks and Inbox startup (#18492)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Tasks and Inbox are the main entry points for that work.
> - Earlier changes made their data reads and row counts smaller.
> - Those changes remain, but shared controls now pull in the whole
task-detail bundle.
> - A cold open can also read a remembered organization before selecting
the one in the URL.
> - This pull request separates collection code and selects the
addressed organization first.
> - It warms task code after collection paint, so the next task open
stays fast.

## Linked Issues or Issue Description

Refs #17756, #18323, #16849, #17041, #17983, #17960, #18461.

**What happened?**

Tasks and Inbox still use their optimized index reads and row budgets.
However, small shared controls and hooks were placed in the task-detail
chunk. A collection had to download that whole chunk. The HTML also
preloaded it on every route. The original production profile loaded
about 6.5 MB of decoded JavaScript before useful rows, or 1.9 MB
transferred with compression.

Company bootstrap could select a different remembered organization
before Layout selected the URL's organization. This started unnecessary
company reads. A retained multi-company browser fixture reproduced two
attention-count requests for different companies.

**Expected behavior**

Show correctly scoped, stable collection rows without waiting for
task-detail code. Keep compact reads, bounded rendering, direct task
preloading, immediate New Task input, and fast follow-on navigation.

**Steps to reproduce**

1. Use a production UI build with Coordinator enabled and two active
organizations.
2. Remember one organization, then cold-open Tasks or Mine in the other.
3. Inspect startup script and company requests before the first useful
row.

The baseline UI revision is `91fdf02e95`. This is a UI change. It has no
API, schema, migration, or authorization changes.

## What Changed

- Group the static collection dependency trees above the task-detail
group. Keep the existing startup and task grouping strategy.
- Preload task detail and its static dependency closure early on direct
task and agent-chat URLs. Keep collection aliases out of that preload.
- Fetch the immutable task chunk at low priority after a collection
paints, or on a same-origin task-link hint. After a successful immutable
response is fully read, module-preload the cached chunk so it can
compile without executing. A failed HTTP probe skips module preload.
- Prefer an addressed active organization during bootstrap. Preserve
manual selection, archived-company handling, and account-scoped company
lists.
- Preserve a task reading anchor when a programmatic scroll event
reports an unchanged offset during restore reflow. Strengthen the Back
journey to wait for a completed collection navigation.
- Add production-browser checks for delayed indexes, correct company
scope, stable row geometry, failed speculation, and early direct-task
preload. Update collection verification notes and the feature map.

## Verification

Final source: `e402ab7fc6`; baseline UI: `91fdf02e95`.

- All **234 focused unit cases** and **44 production-browser journeys**
passed on the final source: 33 task journeys and 11 collection journeys.
Coverage includes compact history, saved cards, draft persistence,
avatar continuity, failed-probe recovery, delayed data, pagination, deep
links, desktop/mobile and reading-position restoration through Back.
Desktop and mobile screenshots were inspected.
- Workspace typecheck, full production build, map checks, token gates
and diff checks passed. The default local `pnpm test:run` still stops
before executing tests because the existing chat-test line selector
reports `No test found` (1,816 skipped). This is not a passed full local
test suite. Focused tests and remote CI remain separate evidence.
- Greptile reviewed the exact final commit at **5/5**, with zero open
review threads. Final code CI passed. The complete check inventory is
**55 successful, 3 skipped, 1 neutral**. The neutral result is the
separate Paperclip Review: its agent finished without completing an
assessment, so it is not a passing review score.

Five alternating baseline/candidate pairs per scenario, Chromium
151.0.7922.34, 1440×900, 4× CPU, 50ms latency, approximately 9Mbps down
/ 1.5Mbps up. Cold cases use fresh browser contexts with normal cache
writes enabled; warm cases use the same context and normal application
query cache. Both previews use the server's immutable hashed-asset cache
policy and uncached HTML, with real local feature settings and no
request interception. All task-owned builds and suites were stopped
during timing; other host activity was uncontrolled. Readiness requires
useful rows and editable search, or the readable task thread and
editable composer, followed by two animation frames.

| Journey | Baseline median (range) | PR median (range) | Median paired
saving |
| --- | --- | --- | --- |
| Cold Tasks | 3239 ms (3189–3333) | 2545 ms (2441–2682) | +752 ms |
| Cold Inbox | 3207 ms (3203–3268) | 2679 ms (2502–3062) | +541 ms |
| Warm Inbox | 717 ms (701–917) | 760 ms (745–768) | -47 ms |
| Warm Tasks | 1150 ms (1126–1207) | 1136 ms (1119–1174) | +18 ms |
| First task click | 943 ms (932–1008) | 1007 ms (976–1098) | -74 ms |
| Back to Tasks | 584 ms (568–617) | 566 ms (559–575) | +10 ms |
| Cold direct task control | 3389 ms (3377–3402) | 3415 ms (3395–3896) |
-13 ms |

All five pairs improved for each cold collection. The signed saving is
baseline minus candidate for each pair; it is distinct from the
difference of medians. Warm navigation is broadly similar. First task
click was 74ms slower by median paired difference. Direct-task median
paired difference was 13ms slower, with one slower 3.90s candidate
sample retained in the range; this is not a claimed direct-task speedup.

Completed script transfers by collection readiness fell from about
**1.91MB to 1.14MB** (Tasks), and **1.90MB to 1.14MB** (Inbox). Task
code warms after rows paint. At the test bandwidth, the removed 0.77MB
critical transfer represents roughly 0.65s of download time; CPU and
network overlap, so their savings are not added. Unthrottled loopback
API control medians stayed about 17–18ms in both variants. All 30 cold
samples had zero browser errors.

Rejected experiments remain separate: automatic splitting produced over
200 startup requests; disabling recursive grouping slowed direct tasks;
HTTP-only warming improved collection startup but slowed first task
opens. The final correction preloads direct dependencies and compiles
successfully cached code after paint. Routing disables HTTP caching, so
intercepted runs were kept as diagnostic evidence rather than used for
warm-cache acceptance; see [Playwright's cache
behavior](https://playwright.dev/docs/api/class-page#page-route). Vite
preview's default asset `no-cache` policy was also corrected to match
the shipped server before final measurement.


## Risks

- Bundle placement affects shared consumers. Browser checks cover
collections and task navigation; the full PR checks also cover other
routes.
- Code warming still transfers the task chunk if the user stays on a
populated collection. It moves that download past first paint and does
not execute it. This is a startup latency improvement, not a claim that
all eventual bytes disappear.
- A direct click before warming finishes still loads code on demand.
Direct task and chat URLs retain early module preload.
- Local browser evidence does not establish a deployed staging speedup.
This PR does not merge or deploy itself.

## Model Used

OpenAI GPT-6 (Codex), with reasoning, tool use and local code execution.
The context-window size is not exposed in this environment.

## 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 the relevant tests locally and they pass (234 unit
cases and 44 browser journeys; the full-command limitation is documented
above)
- [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
- [x] All code CI gates are green (the separate Paperclip Review is
neutral because its agent did not complete an assessment)
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-31 22:12:41 -05:00

670 lines
26 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
// @vitest-environment jsdom
import { flushSync } from "react-dom";
import { createRoot, type Root } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { TaskMessageScroller } from "./TaskMessageScroller";
import { TaskChatScrollNavigation } from "./scroll-navigation";
const PILL_SELECTOR = 'button[aria-label="Scroll to latest"]';
/**
* jsdom has no layout, so scroll geometry is faked per element: scrollHeight /
* clientHeight are pinned and scrollTop is backed by a plain variable.
*/
function fakeGeometry(el: HTMLElement, { scrollHeight = 1000, clientHeight = 400, clamp = false } = {}) {
let scrollTop = 0;
Object.defineProperty(el, "scrollHeight", { value: scrollHeight, configurable: true });
Object.defineProperty(el, "clientHeight", { value: clientHeight, configurable: true });
Object.defineProperty(el, "scrollTop", {
get: () => scrollTop,
set: (v: number) => {
scrollTop = clamp ? Math.max(0, Math.min(v, el.scrollHeight - el.clientHeight)) : v;
},
configurable: true,
});
}
function fakeResizableGeometry(
el: HTMLElement,
{ scrollHeight = 1000, clientHeight = 400 } = {},
) {
let currentClientHeight = clientHeight;
let scrollTop = 0;
Object.defineProperty(el, "scrollHeight", {
value: scrollHeight,
configurable: true,
});
Object.defineProperty(el, "clientHeight", {
get: () => currentClientHeight,
configurable: true,
});
Object.defineProperty(el, "scrollTop", {
get: () => scrollTop,
set: (value: number) => {
scrollTop = value;
},
configurable: true,
});
return {
setClientHeight(value: number) {
currentClientHeight = value;
},
};
}
/**
* Scroll/wheel are continuous-priority events, so React flushes the resulting
* state updates asynchronously — wait a macrotask after dispatching.
*/
function flushEvents() {
return new Promise<void>((resolve) => {
setTimeout(resolve);
});
}
describe("TaskMessageScroller", () => {
let container: HTMLDivElement;
let root: Root;
function render(contentKey: unknown = 0) {
flushSync(() => {
root.render(
<TaskMessageScroller contentKey={contentKey}>
<div>messages</div>
</TaskMessageScroller>,
);
});
}
function scroller(): HTMLDivElement {
return container.querySelector<HTMLDivElement>('[data-testid="task-chat-scroller"]')!;
}
function pill(): HTMLButtonElement | null {
return container.querySelector<HTMLButtonElement>(PILL_SELECTOR);
}
/**
* Wait for the pill to reach a state, rather than for a fixed number of turns.
* `flushEvents` yields exactly one macrotask, which is enough on an idle
* machine and not when the suite runs many workers in parallel — React
* flushes continuous-priority updates asynchronously, so the DOM read can
* land before the state does. Sites that dereference `pill()!` turn that into
* a hard failure rather than a retry.
*/
async function waitForPill(present: boolean): Promise<void> {
await vi.waitFor(() =>
present ? expect(pill()).not.toBeNull() : expect(pill()).toBeNull(),
);
}
/** Set scrollTop and fire a scroll event, like a user or the browser would. */
async function scrollTo(el: HTMLElement, top: number) {
el.scrollTop = top;
el.dispatchEvent(new Event("scroll", { bubbles: true }));
await flushEvents();
}
async function dispatch(el: HTMLElement, event: Event) {
el.dispatchEvent(event);
await flushEvents();
}
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
root = createRoot(container);
});
afterEach(() => {
flushSync(() => root.unmount());
container.remove();
document.documentElement.style.removeProperty("--motion-scrollbar-idle-delay");
vi.useRealTimers();
vi.unstubAllGlobals();
});
it("loads one older page on upward scroll, keeps the status slot, and pauses after failure", async () => {
let release!: () => void;
const load = vi.fn(() => new Promise<void>(resolve => { release = resolve; }));
const history = { hasMore: true, loading: false, error: false, load };
const update = (tick: number) => flushSync(() => root.render(
<TaskMessageScroller contentKey={tick} scrollingHistory={{ ...history }}><div>saved messages</div></TaskMessageScroller>,
));
update(0);
fakeGeometry(scroller());
update(1);
expect(load).not.toHaveBeenCalled();
await scrollTo(scroller(), 400);
expect(load).not.toHaveBeenCalled();
await scrollTo(scroller(), 150);
expect(load).toHaveBeenCalledTimes(1);
await scrollTo(scroller(), 100);
scroller().dispatchEvent(new WheelEvent("wheel", { bubbles: true, deltaY: -100 }));
await flushEvents();
expect(load).toHaveBeenCalledTimes(1);
const status = container.querySelector('[data-testid="chat-history-status"]');
history.loading = true;
update(2);
expect(container.querySelector('[data-testid="chat-history-status"]')).toBe(status);
expect(status?.textContent).toBe("Loading earlier messages…");
release();
await flushEvents();
history.loading = false;
history.error = true;
update(3);
await scrollTo(scroller(), 50);
expect(load).toHaveBeenCalledTimes(1);
expect(status?.textContent).toContain("Earlier messages couldn’t load.");
(status?.querySelector('button') as HTMLButtonElement).click();
expect(load).toHaveBeenCalledTimes(2);
release();
await flushEvents();
history.error = false;
history.hasMore = false;
update(4);
await scrollTo(scroller(), 0);
expect(load).toHaveBeenCalledTimes(2);
});
it("follows a late image resize in the message body after the history status", () => {
const observers: { targets: Set<Element>; resize: () => void }[] = [];
vi.stubGlobal("ResizeObserver", class {
targets = new Set<Element>();
constructor(callback: ResizeObserverCallback) { observers.push({ targets: this.targets, resize: () => callback([], this as unknown as ResizeObserver) }); }
observe(target: Element) { this.targets.add(target); }
disconnect() {}
});
const update = (tick: number) => flushSync(() => root.render(
<TaskMessageScroller contentKey={tick} scrollingHistory={{ hasMore: true, loading: false, load: vi.fn() }}><div data-testid="image-body">image content</div></TaskMessageScroller>,
));
update(0); fakeGeometry(scroller(), { clamp: true }); update(1);
const body = container.querySelector('[data-testid="image-body"]')!;
Object.defineProperty(scroller(), "scrollHeight", { value: 1400, configurable: true });
for (const observer of observers) if (observer.targets.has(body)) observer.resize();
expect(scroller().scrollTop).toBe(1000);
});
it("retains the reading anchor when a resize scroll event precedes the next width reflow", async () => {
const resize: (() => void)[] = [];
vi.stubGlobal("ResizeObserver", class {
constructor(callback: ResizeObserverCallback) { resize.push(() => callback([], this as unknown as ResizeObserver)); }
observe() {}
disconnect() {}
});
let width = 400, rowTop = 100;
flushSync(() => root.render(<TaskMessageScroller contentKey="width-transition">
<div ref={node => {
if (!node) return;
const viewport = node.parentElement!;
fakeGeometry(viewport, { clamp: true });
Object.defineProperty(viewport, "clientWidth", { get: () => width, configurable: true });
viewport.getBoundingClientRect = () => ({ top: 0, bottom: 400 } as DOMRect);
}}>
<div data-thread-anchor="reading-row" ref={node => {
if (node) node.getBoundingClientRect = () => ({ top: rowTop - scroller().scrollTop, bottom: rowTop + 100 - scroller().scrollTop, height: 100 } as DOMRect);
}}>Saved reply</div>
</div>
</TaskMessageScroller>));
await scrollTo(scroller(), 150);
width = 500; rowTop = 80;
for (const callback of resize) callback();
expect(scroller().scrollTop).toBe(130);
rowTop = 70;
await dispatch(scroller(), new Event("scroll", { bubbles: true }));
for (const callback of resize) callback();
expect(scroller().scrollTop).toBe(120);
width = 600; rowTop = 60;
await dispatch(scroller(), new Event("scroll", { bubbles: true }));
for (const callback of resize) callback();
expect(rowTop - scroller().scrollTop).toBe(-50);
expect(pill()).not.toBeNull();
});
it("retains upward intent when content reconciles before the scroll event", async () => {
const load = vi.fn();
const update = (tick: number) => flushSync(() => root.render(
<TaskMessageScroller contentKey={tick} scrollingHistory={{ hasMore: true, loading: false, load }}><div>saved messages</div></TaskMessageScroller>,
));
update(0); fakeGeometry(scroller()); update(1);
await scrollTo(scroller(), 400);
scroller().dispatchEvent(new WheelEvent("wheel", { bubbles: true, deltaY: -1000 }));
scroller().scrollTop = 0;
update(2);
await dispatch(scroller(), new Event("scroll", { bubbles: true }));
expect(load).toHaveBeenCalledTimes(1);
});
it("holds a short conversation when an upward wheel gesture loads history", async () => {
const load = vi.fn().mockResolvedValue(undefined);
const update = (tick: number) => flushSync(() => root.render(
<TaskMessageScroller contentKey={tick} scrollingHistory={{ hasMore: true, loading: false, load }}><div>short conversation</div></TaskMessageScroller>,
));
update(0);
fakeGeometry(scroller(), { scrollHeight: 200, clientHeight: 400, clamp: true });
update(1);
await scrollTo(scroller(), 0);
scroller().dispatchEvent(new WheelEvent("wheel", { bubbles: true, deltaY: -100 }));
await flushEvents();
expect(load).toHaveBeenCalledTimes(1);
Object.defineProperty(scroller(), "scrollHeight", { value: 1200, configurable: true });
update(2);
expect(scroller().scrollTop).toBe(0);
});
it("pages short conversations with touch and keyboard gestures", async () => {
const load = vi.fn().mockResolvedValue(undefined);
const update = (tick: number) => flushSync(() => root.render(
<TaskMessageScroller contentKey={tick} scrollingHistory={{ hasMore: true, loading: false, load }}><div>short conversation</div></TaskMessageScroller>,
));
update(0); fakeGeometry(scroller(), { scrollHeight: 200, clientHeight: 400, clamp: true }); update(1);
await scrollTo(scroller(), 0);
const touch = (type: string, y: number) => {
const event = new Event(type, { bubbles: true });
Object.defineProperty(event, "touches", { value: [{ clientY: y }] });
scroller().dispatchEvent(event);
};
touch("touchstart", 100); touch("touchmove", 200); touch("touchmove", 250);
await flushEvents();
expect(load).toHaveBeenCalledTimes(1);
scroller().dispatchEvent(new KeyboardEvent("keydown", { bubbles: true, key: "Home" }));
await flushEvents();
expect(load).toHaveBeenCalledTimes(2);
});
it("does not measure historical rows on each streaming update while following the bottom", () => {
let initialized = false;
let rowMeasurements = 0;
const update = (tick: number) => flushSync(() => root.render(
<TaskMessageScroller contentKey={tick}>
<div ref={(node) => {
if (node && !initialized) {
fakeGeometry(node.parentElement!, { scrollHeight: 20000, clientHeight: 400 });
initialized = true;
}
}}>
{Array.from({ length: 200 }, (_, index) => <div key={index} data-thread-anchor={`history-${index}`} ref={(node) => {
if (node) node.getBoundingClientRect = () => {
rowMeasurements++;
const top = index * 100 - scroller().scrollTop;
return { top, bottom: top + 100, height: 100 } as DOMRect;
};
}}>History {index}</div>)}
<p>Live response {tick}</p>
</div>
</TaskMessageScroller>,
));
update(0);
rowMeasurements = 0;
for (let tick = 1; tick <= 30; tick++) update(tick);
expect(container.textContent).toContain("Live response 30");
expect(scroller().scrollTop).toBe(20000);
expect(rowMeasurements).toBe(0);
});
it("applies same-task hash changes and restores each history entry without remounting", async () => {
let initialized = false;
function navigate(key: string, hash: string, restore = false) {
flushSync(() => root.render(
<TaskChatScrollNavigation.Provider value={{ key, hash, restore }}>
<TaskMessageScroller contentKey="unchanged">
<div ref={(node) => {
if (node && !initialized) {
fakeGeometry(node.parentElement!);
initialized = true;
}
}}>
{[100, 500].map((top, index) => <div key={index} id={`nav-comment-${index}`} data-thread-anchor={`nav-comment-${index}`} ref={(node) => {
if (node) node.getBoundingClientRect = () => ({ top: top - scroller().scrollTop, bottom: top + 100 - scroller().scrollTop, height: 100 } as DOMRect);
}}>Comment {index}</div>)}
</div>
</TaskMessageScroller>
</TaskChatScrollNavigation.Provider>,
));
}
navigate("desktop-entry-one", "#nav-comment-0");
const viewport = scroller();
expect(viewport.scrollTop).toBe(100);
await scrollTo(viewport, 150);
navigate("desktop-entry-two", "#nav-comment-1");
expect(scroller()).toBe(viewport);
expect(viewport.scrollTop).toBe(500);
navigate("desktop-entry-one", "#nav-comment-0", true);
expect(viewport.scrollTop).toBe(150);
navigate("desktop-entry-one", "#nav-comment-1", true);
expect(viewport.scrollTop).toBe(500);
});
it.each([[false, "none"], [false, "wheel"], [false, "pointer"], [true, "none"], [true, "wheel"], [true, "pointer"]] as const)("positions a late hash target unless the reader moved on (restore=%s, readerMoved=%s)", async (restore, readerMoved) => {
let initialized = false;
const show = (targetReady: boolean) => flushSync(() => root.render(
<TaskChatScrollNavigation.Provider value={{ key: `late-target-${restore}-${readerMoved}`, hash: "#late-target", restore }}>
<TaskMessageScroller contentKey={targetReady}>
<div ref={node => {
if (node && !initialized) { fakeGeometry(node.parentElement!, { clamp: true }); initialized = true; }
}}>
Saved conversation
{targetReady ? <div id="late-target" data-thread-anchor="late-target" ref={node => {
if (node) node.getBoundingClientRect = () => ({ top: 100 - scroller().scrollTop, bottom: 200 - scroller().scrollTop, height: 100 } as DOMRect);
}}>Linked comment</div> : null}
</div>
</TaskMessageScroller>
</TaskChatScrollNavigation.Provider>,
));
show(false);
if (readerMoved !== "none") {
await scrollTo(scroller(), 300);
await dispatch(scroller(), readerMoved === "wheel" ? new WheelEvent("wheel", { bubbles: true, deltaY: -100 }) : new Event("pointerdown", { bubbles: true }));
}
show(true);
expect(scroller().scrollTop).toBe(readerMoved === "none" ? 100 : 300);
});
it("does not replace a saved reading position with a hidden route's geometry", async () => {
function mount(restore: boolean) {
flushSync(() => root.render(
<TaskChatScrollNavigation.Provider value={{ key: "hidden-route-entry", hash: "", restore }}>
<TaskMessageScroller contentKey="saved-thread">
<div ref={(node) => { if (node) fakeGeometry(node.parentElement!); }}>Saved messages</div>
</TaskMessageScroller>
</TaskChatScrollNavigation.Provider>,
));
}
mount(false);
const viewport = scroller();
await scrollTo(viewport, 150);
Object.defineProperty(viewport, "clientHeight", { value: 0, configurable: true });
await scrollTo(viewport, 0);
flushSync(() => root.render(null));
mount(true);
expect(scroller().scrollTop).toBe(150);
});
it("restores bottom-follow on Back after the viewport and message heights change", () => {
const configured = new WeakSet<HTMLElement>();
function mount(restore: boolean, scrollHeight: number, clientHeight: number) {
flushSync(() => root.render(
<TaskChatScrollNavigation.Provider value={{ key: "rotated-bottom-entry", hash: "", restore }}>
<TaskMessageScroller contentKey={scrollHeight}>
<div ref={(node) => {
const viewport = node?.parentElement;
if (viewport && !configured.has(viewport)) {
fakeGeometry(viewport, { scrollHeight, clientHeight });
let top = 0;
Object.defineProperty(viewport, "scrollTop", {
configurable: true,
get: () => top,
set: (value: number) => {
top = Math.max(0, Math.min(value, viewport.scrollHeight - viewport.clientHeight));
},
});
configured.add(viewport);
}
}}>Latest response</div>
</TaskMessageScroller>
</TaskChatScrollNavigation.Provider>,
));
}
mount(false, 1000, 400);
flushSync(() => root.render(null));
// Rotation changed wrapping and the available message viewport while away.
mount(true, 2000, 500);
expect(scroller().scrollTop).toBe(1500);
expect(pill()).toBeNull();
Object.defineProperty(scroller(), "scrollHeight", { value: 2400, configurable: true });
mount(true, 2400, 500);
expect(scroller().scrollTop).toBe(1900);
});
it("renders children inside the scroll container, pill hidden, scrolled to bottom on mount", () => {
render();
const el = scroller();
expect(el.textContent).toContain("messages");
expect(pill()).toBeNull();
// Mount effect pins to the bottom.
expect(el.scrollTop).toBe(el.scrollHeight);
});
it("extends only the streamlined scroll box through the page gutter", () => {
render();
const el = scroller();
const frame = el.parentElement;
expect(frame?.className).toBe("relative min-h-0 flex-1");
expect(el.classList).toContain("-right-4");
expect(el.classList).toContain("pr-4");
expect(el.classList).toContain("md:-right-6");
expect(el.classList).toContain("md:pr-6");
expect(el.classList).not.toContain("right-0");
});
it("shows the scrollbar only while scroll activity is recent", () => {
vi.useFakeTimers();
document.documentElement.style.setProperty("--motion-scrollbar-idle-delay", "600ms");
render();
const el = scroller();
fakeGeometry(el);
expect(el.className).toContain("scrollbar-while-scrolling");
expect(el.getAttribute("data-scroll-active")).toBeNull();
el.scrollTop = 100;
el.dispatchEvent(new Event("scroll", { bubbles: true }));
expect(el.getAttribute("data-scroll-active")).toBe("true");
vi.advanceTimersByTime(599);
expect(el.getAttribute("data-scroll-active")).toBe("true");
vi.advanceTimersByTime(1);
expect(el.getAttribute("data-scroll-active")).toBeNull();
});
it("contains horizontal overflow so no scrollbar appears above the composer", () => {
render();
expect(scroller().classList).toContain("overflow-x-hidden");
expect(scroller().classList).toContain("overflow-y-auto");
});
it("auto-follows content instantly while pinned", async () => {
render(1);
const el = scroller();
fakeGeometry(el);
await scrollTo(el, 600); // bottom: 1000 - 600 - 400 = 0 → pinned
await waitForPill(false); // pinned state settled before content grows
render(2);
expect(el.scrollTop).toBe(1000);
expect(pill()).toBeNull();
});
it("holds position and shows the icon-only pill when scrolled up", async () => {
render(1);
const el = scroller();
fakeGeometry(el);
await scrollTo(el, 100); // 500px from bottom → unpinned
await waitForPill(true);
const btn = pill();
expect(btn).not.toBeNull();
expect(btn!.className).toContain("tc-scroll-pill-in");
expect(btn!.className).toContain("size-8");
expect(btn!.className).toContain("bottom-7");
expect(btn!.className).not.toContain("bottom-3");
expect(btn!.className).not.toContain("-translate-x-1/2");
// Icon-only: no visible text.
expect(btn!.textContent).toBe("");
// New content must not yank the held position.
render(2);
expect(el.scrollTop).toBe(100);
});
it("follows a shrinking viewport while pinned so a growing composer cannot cover the latest text", async () => {
let triggerResize = () => {};
vi.stubGlobal(
"ResizeObserver",
class {
constructor(callback: ResizeObserverCallback) {
triggerResize = () =>
callback([], this as unknown as ResizeObserver);
}
observe() {}
disconnect() {}
},
);
render();
const el = scroller();
const geometry = fakeResizableGeometry(el);
triggerResize();
await scrollTo(el, 600);
geometry.setClientHeight(200);
triggerResize();
expect(el.scrollTop).toBe(el.scrollHeight);
expect(pill()).toBeNull();
});
it("holds a reader's position when the composer grows while they are scrolled up", async () => {
let triggerResize = () => {};
vi.stubGlobal(
"ResizeObserver",
class {
constructor(callback: ResizeObserverCallback) {
triggerResize = () =>
callback([], this as unknown as ResizeObserver);
}
observe() {}
disconnect() {}
},
);
render();
const el = scroller();
const geometry = fakeResizableGeometry(el);
triggerResize();
await scrollTo(el, 100);
await waitForPill(true);
geometry.setClientHeight(200);
triggerResize();
expect(el.scrollTop).toBe(100);
expect(pill()).not.toBeNull();
});
it("small drifts within the pin threshold do not show the pill", async () => {
render();
const el = scroller();
fakeGeometry(el);
await scrollTo(el, 560); // 40px from bottom, threshold is 48
expect(pill()).toBeNull();
});
it("clicking the pill smooth-scrolls, ignores intermediate scroll events, re-pins on arrival", async () => {
vi.stubGlobal("matchMedia", vi.fn().mockReturnValue({ matches: false }));
render(1);
const el = scroller();
fakeGeometry(el);
const scrollToSpy = vi.fn();
el.scrollTo = scrollToSpy as unknown as typeof el.scrollTo;
await scrollTo(el, 100);
await waitForPill(true);
const btn = pill()!;
btn.click();
await flushEvents();
expect(scrollToSpy).toHaveBeenCalledWith({ top: 1000, behavior: "smooth" });
// Intermediate glide positions fire scroll events; they must not unpin
// (i.e. the easing flag swallows them and the pill state stays put).
await scrollTo(el, 250);
await scrollTo(el, 400);
expect(pill()).not.toBeNull();
// Arrival within the threshold re-pins and hides the pill (immediately
// here: no matchMedia in jsdom → reduced-motion/unmount-now path).
vi.stubGlobal("matchMedia", vi.fn().mockReturnValue({ matches: true }));
await scrollTo(el, 600);
expect(pill()).toBeNull();
// Re-pinned: content growth follows instantly again.
render(2);
expect(el.scrollTop).toBe(1000);
});
it("finishes following at the new bottom when content changes during the latest glide", async () => {
vi.stubGlobal("matchMedia", vi.fn().mockReturnValue({ matches: false }));
render(1);
const el = scroller();
fakeGeometry(el);
el.scrollTo = vi.fn() as unknown as typeof el.scrollTo;
await scrollTo(el, 100);
await waitForPill(true);
pill()!.click();
await flushEvents();
await scrollTo(el, 250);
render(2);
expect(el.scrollTop).toBe(1000);
});
it("a wheel gesture during the glide cancels easing and stays unpinned", async () => {
vi.stubGlobal("matchMedia", vi.fn().mockReturnValue({ matches: false }));
render(1);
const el = scroller();
fakeGeometry(el);
el.scrollTo = vi.fn() as unknown as typeof el.scrollTo;
await scrollTo(el, 100);
await waitForPill(true);
pill()!.click();
await flushEvents();
await dispatch(el, new Event("wheel", { bubbles: true }));
// Easing cancelled → user is unpinned, pill visible, content holds.
expect(pill()).not.toBeNull();
render(2);
expect(el.scrollTop).toBe(100);
// Scroll events far from the bottom now behave normally (still unpinned).
await scrollTo(el, 200);
expect(pill()).not.toBeNull();
});
it("plays the exit animation before unmounting when motion is enabled", async () => {
vi.stubGlobal(
"matchMedia",
vi.fn().mockReturnValue({ matches: false }), // motion allowed
);
render();
const el = scroller();
fakeGeometry(el);
await scrollTo(el, 100);
await vi.waitFor(() => expect(pill()?.className).toContain("tc-scroll-pill-in"));
// Scrolling back to the bottom starts the exit animation but keeps the
// pill mounted until animationend.
await scrollTo(el, 600);
await vi.waitFor(() => expect(pill()?.className).toContain("tc-scroll-pill-out"));
const exiting = pill();
expect(exiting).not.toBeNull();
// jsdom has no window.AnimationEvent, so React's vendor-prefix detection
// maps onAnimationEnd to "webkitAnimationEnd" here (real browsers get the
// unprefixed event).
await dispatch(exiting!, new Event("webkitAnimationEnd", { bubbles: true }));
await waitForPill(false);
});
it("unmounts immediately on hide under prefers-reduced-motion", async () => {
vi.stubGlobal(
"matchMedia",
vi.fn().mockReturnValue({ matches: true }), // reduce
);
render();
const el = scroller();
fakeGeometry(el);
await scrollTo(el, 100);
await waitForPill(true);
await scrollTo(el, 600);
await waitForPill(false); // no animationend needed
});
});