Skip to content

README.md

Latest commit

 

History

History
44 lines (30 loc) · 3.16 KB

README.md

File metadata and controls

44 lines (30 loc) · 3.16 KB
Raw

CodeBurn performance harness (Phase 0)

Measure → change → measure. This directory is the hill: one command per metric, pinned baselines, and an append-only iteration log.

It extends the release-acceptance ledger from #1164. It does not replace that runner. scripts/release-acceptance/run.mjs stays the SHA/package gate. These scripts emit the timings.csv template shape and wait-path numbers a hostile reviewer can re-run in one command.

What is measured

Metric Command What the number is What it is not
Cold start (wait-path) run-metric.mjs --metric cold-start-cli One-shot status --format menubar-json argv Desktop/Menu Bar already spawn Installed window show / flame in the menu bar
Session parse --metric session-parse Cold parse of the synthetic fixture; MB/s and ms A large real corpus
Incremental re-parse --metric incremental-reparse Append two JSONL lines on the same inode, then re-run Rewrite / inode change
Period switch --metric period-switch Warm serve --stdio 7D/30D p50/p95 Installed Desktop 250 ms p95 on the live corpus
Dock/TUI interactions --metric dock-tui-proxy Overview-refresh and view-switch wait path Capacity Dock hover (native, never spawns this argv) or TTY TUI keys
Memory --metric memory RSS after cold load; optional --idle-ms 3600000 Packaged app RSS

Historical receipt, not this fixture: installed Desktop 0.9.21, live corpus, 2026-08-27, 7D useful summary 18286.98 ms after 30 s idle. Spec target: 250 ms p95 ready summary, zero raw reads on unchanged generation. That receipt came from an installed-app audit run that is not published, so treat the number as historical context rather than something you can re-derive from this repo.

One-command reproduction

HOME_DIR=$(mktemp -d /tmp/codeburn-perf-XXXX)
node scripts/perf/gen-fixture.mjs --home "$HOME_DIR" --target-mb 30
node scripts/perf/run-metric.mjs --metric all --home "$HOME_DIR"

Or npm run perf:all -- --home "$HOME_DIR". To pin a new phase, paste the run's summary.json numbers into perf/BASELINES.md by hand — pinning happens once per phase and does not need a script.

The fixture is synthetic (fake /work/... paths, lorem tool payloads). Do not copy real session files into the repo or a PR. Generated bytes live under the isolated HOME, which is gitignored.

Isolation

Matches scripts/upgrade-path/run.mjs cliEnv(): isolated HOME / USERPROFILE / APPDATA / LOCALAPPDATA / CODEBURN_CACHE_DIR. The generator refuses to write under the real home.

Iteration contract

  1. Attack one baseline row.
  2. Branch perf/<metric>-<short-name> from current main.
  3. One change. Measure with this harness.
  4. Draft PR with before, after, command, fixture. Never merge from this lane.
  5. Append perf/ITERATION-LOG.md (kept or reverted).

Product files this harness must not touch: src/parser.ts, src/session-cache.ts, src/dashboard.tsx, app/electron/main.ts, app/electron/cli.ts, mac/Sources/CodeBurnMenubar/**. Those surfaces have in-flight or just-landed quality work (PRs 1159–1171, open #1149/#1062/#940).