Files
openchamber/scripts/perf/DOCUMENTATION.md
T
Bohdan Triapitsyn edfc9779cf perf(chat): make session switching feel instant
Switching sessions ran as one synchronous commit: sidebar highlight, URL,
a full timeline remount with markdown re-parse, and around nine requests,
so nothing changed on screen for 150-250ms after the click.

- ChatContainer swaps the timeline on a deferred copy of the selection, so
  the active row, URL, and tab commit first and the timeline renders behind
  them; selection policy keeps reading the live store value.
- The message fetch starts before the selection is published.
- Sidebar rows stop re-rendering on a project switch: directory-scoped sync
  hooks read the runtime context and a subscribable current-directory source
  instead of the directory-bearing context; the grouping builder reads git
  branches through a ref and section caches key the branches they use;
  descendant ids are keyed by content. Rows per switch went from 73 to 8.
- Markdown skips the async re-render when the settled cached blocks are
  already painted, and mounts synchronously once its lazy module is loaded;
  the module is preloaded at boot.
- A timeline reveal gate holds a freshly opened session at opacity 0 while
  any provisional markdown paint catches up (250ms cap), then fades the whole
  timeline in once, so text, tools, and recap appear together.
- Switch fan-out trimmed: knowledge summary deduped, MCP status refreshed only
  when stale, non-repo directories cached by the git repo check, OpenChamber
  defaults cached briefly, agent memory reused for the same project, goal
  text cached, PWA manifest rebuilt after the switch settles.
- Header tabs snap into the active state and keep the title at the same
  height in both states.
- Prefetch on row press; composer focus moved off the commit.

`bun run profile:switch` records ack/content latency, longest task, and
requests per switch, cold and warm, and compares runs against a baseline.
Measured warm switch: ack 228ms to about 40-60ms, content 228ms to about
100-120ms.
2026-08-29 17:01:15 +03:00

8.8 KiB

Performance Measurement Tooling

Owns the unattended performance capture commands and their shared Chrome DevTools Protocol plumbing. Read this before measuring OpenChamber performance or extending these scripts. The methodology rules they enforce come from .agents/skills/performance-engineering/SKILL.md.

Commands

Command Answers
bun run profile:idle What the app does while nobody interacts with it.
bun run profile:session What receiving and rendering a live assistant response costs.
bun run profile:animation What a CSS animation costs, isolated from the app.
bun run profile:switch How long switching sessions from the sidebar takes, cold and warm.
bun run profile:browser A manually driven capture, for interactions that cannot be scripted.

All of them measure a real browser over CDP. Pass --help to any of them for the full option list.

Before Measuring Anything

Measure a production build. A development build's render and bundle behaviour does not represent what users run.

bun run build:ui && bun run build:web
cd <a project directory> && node <repo>/packages/web/bin/cli.js serve --port 4599 --foreground

profile:idle and profile:session need a running server; profile:animation serves its own fixture and needs nothing.

profile:idle

Loads the app, lets it settle, then records a window during which no input is delivered. Everything it reports is therefore work the app performs while the user is doing nothing — the class of regression users notice as fan noise, battery drain, and a permanently busy tab.

Reports per second of idle time: main-thread busy time, script, style recalculation and layout time and counts, DOM node / document / frame / listener growth, heap trajectory including a least-squares growth rate, a CPU sampling profile with self time per function, and attribution of timer, animation-frame and observer work to the call site that scheduled it.

# Baseline, then compare a change against it and fail on a budget.
bun run profile:idle -- --url http://127.0.0.1:4599 --output artifacts/before
bun run profile:idle -- --url http://127.0.0.1:4599 --baseline artifacts/before --budget-cpu 5

Scenario options reach a specific mounted state, because idle cost depends on what is mounted: --session, --tab, --panel <mode>, --expand-projects, --expand-sessions, and --then-tab (navigate away after settling, to measure what a surface keeps doing once the user has left it).

profile:session

Creates a session, opens it in a browser, dispatches a prompt through the supported openchamber session CLI, and records until the session reports itself idle. No input is synthesised; the prompt is the only stimulus.

Streaming is judged by responsiveness, not totals, so the report leads with the long-task distribution, a timeline-trace breakdown naming where time went, running animations, the application's own stream counters, and output-normalised metrics.

bun run profile:session -- --url http://127.0.0.1:4599 --dir <project directory>
# What an idle session costs while a different session is active elsewhere:
bun run profile:session -- --view-session <idle session id> --expand-projects --expand-sessions

This command calls a real model. Use a cheap one; --model overrides the configured selection.

profile:animation

Serves an isolated fixture and measures each animation variant directly, so a comparison takes seconds instead of an application rebuild plus a streamed response.

bun run profile:animation
bun run profile:animation -- --variant border-color --count 8

Measured on this repository's fixture, at any element count from 1 to 32:

Animated property Style recalculations/sec Layouts/sec
none 0 0
transform (rotate, translate, scale) 0 0
opacity, filter 0 0
rotate (the individual property) 60 0
background-position 60 0
border-color 60 0
box-shadow 60 0
width 60 60

Animate transform and opacity. Anything else recalculates style on every frame for as long as the animation runs, and geometry properties add layout on top. Note that rotate: 360deg is not equivalent to transform: rotate(360deg) in cost.

Add a variant to animation-fixture.html to measure a property or technique that is not listed.

profile:switch

Clicks sidebar session rows with real mouse input and measures, per click, the two moments a user feels: ack, when the clicked row is highlighted as active (the first visible reaction), and content, when the timeline shows messages that were not on screen before. It also reports the longest main-thread task inside each switch and every request the switch triggered, so fan-out regressions show up next to the latency they cause.

Every session in the plan is visited twice. The first visit is usually cold (a network round trip for messages); the second is warm, served from the in-memory session store. They have different budgets and are reported separately.

bun run profile:switch -- --url http://127.0.0.1:4599 --output artifacts/switch-before
bun run profile:switch -- --url http://127.0.0.1:4599 --baseline artifacts/switch-before --budget-ack 32 --budget-content 100

--sessions a,b,c picks the rows to click; the default is the first rows in the sidebar, so pass explicit ids to compare runs across days. The row must be present in the sidebar; the command fails rather than measuring a click on nothing.

Reading The Results

Every run writes a JSON summary next to any raw capture, so results can be compared later without re-running:

  • profile:idleidle-summary.json, cpu-profile.cpuprofile
  • profile:sessionsession-summary.json, cpu-profile.cpuprofile

--baseline <directory> prints a per-metric delta table against a previous run of the same command. --budget-* options make the command exit non-zero, so the same invocation works as an investigation tool and as a regression gate.

Artifacts can reveal project paths and endpoint names. They are gitignored; do not publish them without review.

Validity Guarantees

These commands fail loudly rather than reporting a clean result, because each of these failure modes once produced a confident, wrong "everything is fast":

  • Throttled renderer. Chrome stops producing frames and throttles timers for windows it considers backgrounded or occluded. Launch flags disable that, and every run measures frame liveness and warns when the renderer was not producing frames.
  • Missing trace data. RunTask is only emitted under the disabled-by-default timeline category. A capture without it would report zero long tasks; the missing-task case is reported instead.
  • A scenario that never ran. A session belonging to a directory the browser is not viewing renders nothing and produces a perfectly quiet profile. profile:session verifies both new message elements in the DOM and message-list render counters before believing a quiet result.

Preserve this property when extending these scripts. A metric reading zero must be a measurement, never a disabled instrument.

Methodology Rules

  • Never report an "after" without a "before" on the identical scenario and build. Rebuild the unchanged version and re-run it, however inconvenient. Expect plausible fixes to change nothing.
  • A sampling profiler cannot explain native work. Self time in (program) only means the time was not in interpreted JavaScript. Use the trace breakdown, which names parsing, style, layout, layerization, paint and raster.
  • Normalise when the workload varies. Assistant responses differ in length between runs, so per-second totals are not comparable; profile:session reports output-normalised metrics for this reason.
  • Revert what you cannot measure. A change that does not move its target metric is unvalidated complexity, not a small win.
  • Reproduction may need production scale you do not have. A threshold effect is invisible below its threshold. Compare the reporter's scale against yours on the dimension the code keys on before concluding a bug is absent.

Module Layout

File Responsibility
cdp.mjs Chrome launch, target discovery, minimal CDP client. Owns the anti-throttling launch flags.
metrics.mjs Metric derivations shared by the profilers: growth rates, percentiles, long-task and trace-event summaries.
cpu-profile.mjs Aggregates Profiler.stop() output into self time per function.
idle-probe.mjs Page-side instrumentation installed before application code runs; attributes scheduled work to the call site that scheduled it. Must never change observable behaviour.
scenario.mjs Shared scenario setup, currently sidebar expansion. Setup always runs before the measured window.
animation-fixture.html Isolated animation variants for profile:animation.