mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-22 16:25:58 +00:00
d1c455acf7
Replaces the dozen ad-hoc measure-*/profile-* scripts (each reinventing the CDP client — 4 different copies — plus its own arg parsing, stats, output path, and none with a baseline) with one framework under scripts/perf/: - lib/cdp.mjs one CDP client + target discovery + typing + CPU-profile wrapper + DOM selectors - lib/stats.mjs percentiles, histograms, CPU-profile self-time ranking - lib/baseline.mjs load/compare/update baseline + regression gate (new capability) - lib/launch.mjs attach, OR spawn a fully ISOLATED instance - scenarios/* one module per measurement, registered in scenarios/index.mjs - run.mjs / serve.mjs, baseline.json, README.md Isolation solves the long-standing measurement blocker: a running `hgui` held the Electron single-instance lock, so a second instance quit. `--spawn` / `perf:serve` launch with their own --user-data-dir (separate lock scope), their own HERMES_HOME (separate backend/sessions, config seeded from ~/.hermes so it reaches a chat view without onboarding), and their own --remote-debugging-port. Synthetic scenarios drive $messages via window.__PERF_DRIVE__, so no LLM credits. Scenario -> sunset script mapping: stream <- measure-synthetic-stream, profile-synth-stream, profile-long-stream stream --real <- measure-real-stream, profile-real-stream keystroke <- measure-latency, profile-typing, leak-typing transcript <- (new: long-transcript mount cost) submit <- measure-submit, measure-jump session-switch <- profile-session-switch profile-switch <- measure-profile-switch CPU profiling is now a cross-cutting --cpuprofile flag, not 5 separate scripts. CI-tier scenarios (stream, keystroke, transcript) need no backend/credits and are gated against baseline.json (seed values; re-capture with --update-baseline on a reference device). Backend-tier scenarios are report-only. perf-probe.tsx gains loadTranscript() for the transcript scenario. No core files touched; isolation is via CLI args, not env-gated app changes. Verified: node --check all modules, tsc, eslint, and a unit smoke of the stats + regression-gate logic. The end-to-end GUI run (which opens a window) is left to run interactively via `npm run perf -- --spawn`.
75 lines
3.5 KiB
Markdown
75 lines
3.5 KiB
Markdown
# Desktop perf harness
|
|
|
|
One systematized way to measure desktop rendering/interaction performance,
|
|
diff it against a committed baseline, and fail on regressions. It replaces the
|
|
dozen one-off `measure-*` / `profile-*` scripts that each reinvented the CDP
|
|
client, arg parsing, stats, and output (and never had a baseline).
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Isolated instance (recommended) — no running app or LLM credits needed.
|
|
# Its own --user-data-dir + HERMES_HOME means it never collides with `hgui`.
|
|
npm run perf -- --spawn
|
|
|
|
# Or: launch an isolated instance once, attach repeatedly (faster iteration).
|
|
npm run perf:serve # leaves an instance on :9222
|
|
npm run perf # attaches, runs the CI suite, gates on baseline
|
|
|
|
# One scenario, with a CPU profile:
|
|
npm run perf -- stream --cpuprofile --tokens 800
|
|
|
|
# Re-capture the baseline on your reference device, then commit baseline.json:
|
|
npm run perf -- --update-baseline
|
|
```
|
|
|
|
## Why isolation matters
|
|
|
|
The measurement this harness exists to run was historically blocked: a running
|
|
`hgui` holds the Electron single-instance lock, so a second instance quit
|
|
immediately. `--spawn` / `perf:serve` launch with their own `--user-data-dir`
|
|
(separate lock scope), their own `HERMES_HOME` (separate backend + sessions),
|
|
and their own `--remote-debugging-port`. Synthetic scenarios drive `$messages`
|
|
directly via `window.__PERF_DRIVE__`, so no LLM credits are spent.
|
|
|
|
## Scenarios
|
|
|
|
| scenario | tier | measures | replaces |
|
|
|---|---|---|---|
|
|
| `stream` | ci | streaming longtasks, frame p95/p99, mutation cadence | measure-synthetic-stream, profile-synth-stream, profile-long-stream |
|
|
| `stream --real` | backend | same, from a real LLM stream | measure-real-stream, profile-real-stream |
|
|
| `keystroke` | ci | composer keystroke → paint latency | measure-latency, profile-typing, leak-typing |
|
|
| `transcript` | ci | large-transcript mount + paint cost | (new) |
|
|
| `submit` | backend | Enter → cleared → user msg painted, scroll jump | measure-submit, measure-jump |
|
|
| `session-switch` | backend | route → first-paint → settle | profile-session-switch |
|
|
| `profile-switch` | backend | rail click → sidebar settled | measure-profile-switch |
|
|
|
|
`ci` scenarios need no backend/credits and are gated against `baseline.json`.
|
|
`backend` scenarios need a live backend (and `--spawn` or a real session) and
|
|
are report-only.
|
|
|
|
CPU profiling is a cross-cutting `--cpuprofile` flag on any scenario (it wraps
|
|
the run in `Profiler.start/stop` and prints a top-self-time table), replacing
|
|
every standalone `profile-*` script.
|
|
|
|
## Adding a scenario
|
|
|
|
Create `scenarios/<name>.mjs` exporting `{ name, tier, description, run(cdp, opts) }`
|
|
where `run` returns `{ metrics, detail }` (metrics = flat numbers, lower is
|
|
better), then register it in `scenarios/index.mjs`. If it's `ci`, add a
|
|
`baseline.json` entry (or run `--update-baseline`).
|
|
|
|
## Layout
|
|
|
|
- `lib/cdp.mjs` — the one CDP client + target discovery + typing + CPU-profile wrapper + DOM selectors.
|
|
- `lib/stats.mjs` — percentiles, histograms, CPU-profile self-time ranking.
|
|
- `lib/baseline.mjs` — load/compare/update the baseline + regression gate.
|
|
- `lib/launch.mjs` — attach, or spawn a fully isolated instance.
|
|
- `scenarios/` — one module per measurement.
|
|
- `run.mjs` — entrypoint. `serve.mjs` — standalone isolated launcher.
|
|
|
|
## Not migrated (kept as dev utilities)
|
|
|
|
`eval.mjs`, `reload.mjs`, `reload-renderer.mjs`, `probe-renderer.mjs`,
|
|
`probe-thread.mjs`, `click-session.mjs`, `diag-*.mjs` are interactive dev
|
|
helpers, not benchmarks. They can adopt `lib/cdp.mjs` in a follow-up.
|