diff --git a/docs/help/testing.md b/docs/help/testing.md index a4e8f4b4dfb..c8b034d1c48 100644 --- a/docs/help/testing.md +++ b/docs/help/testing.md @@ -318,79 +318,79 @@ Think of the suites as “increasing realism” (and increasing flakiness/cost): - Untargeted `pnpm test` runs twelve smaller shard configs (`core-unit-fast`, `core-unit-src`, `core-unit-security`, `core-unit-ui`, `core-unit-support`, `core-support-boundary`, `core-contracts`, `core-bundled`, `core-runtime`, `agentic`, `auto-reply`, `extensions`) instead of one giant native root-project process. This cuts peak RSS on loaded machines and avoids auto-reply/extension work starving unrelated suites. - `pnpm test --watch` still uses the native root `vitest.config.ts` project graph, because a multi-shard watch loop is not practical. - `pnpm test`, `pnpm test:watch`, and `pnpm test:perf:imports` route explicit file/directory targets through scoped lanes first, so `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` avoids paying the full root project startup tax. - `pnpm test:changed` expands changed git paths into the same scoped lanes when the diff only touches routable source/test files; config/setup edits still fall back to the broad root-project rerun. - `pnpm check:changed` is the normal smart local gate for narrow work. It classifies the diff into core, core tests, extensions, extension tests, apps, docs, release metadata, and tooling, then runs the matching typecheck/lint/test lanes. Public Plugin SDK and plugin-contract changes include extension validation because extensions depend on those core contracts. Release metadata-only version bumps run targeted version/config/root-dependency checks instead of the full suite, with a guard that rejects package changes outside the top-level version field. - Import-light unit tests from agents, commands, plugins, auto-reply helpers, `plugin-sdk`, and similar pure utility areas route through the `unit-fast` lane, which skips `test/setup-openclaw-runtime.ts`; stateful/runtime-heavy files stay on the existing lanes. - Selected `plugin-sdk` and `commands` helper source files also map changed-mode runs to explicit sibling tests in those light lanes, so helper edits avoid rerunning the full heavy suite for that directory. - `auto-reply` has three dedicated buckets: top-level core helpers, top-level `reply.*` integration tests, and the `src/auto-reply/reply/**` subtree. This keeps the heaviest reply harness work off the cheap status/chunk/token tests. - - - When you change message-tool discovery inputs or compaction runtime - context, keep both levels of coverage. - - Add focused helper regressions for pure routing and normalization - boundaries. - - Keep the embedded runner integration suites healthy: - `src/agents/pi-embedded-runner/compact.hooks.test.ts`, - `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts`, and - `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`. - - Those suites verify that scoped ids and compaction behavior still flow - through the real `run.ts` / `compact.ts` paths; helper-only tests are - not a sufficient substitute for those integration paths. - + + - When you change message-tool discovery inputs or compaction runtime + context, keep both levels of coverage. + - Add focused helper regressions for pure routing and normalization + boundaries. + - Keep the embedded runner integration suites healthy: + `src/agents/pi-embedded-runner/compact.hooks.test.ts`, + `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts`, and + `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`. + - Those suites verify that scoped ids and compaction behavior still flow + through the real `run.ts` / `compact.ts` paths; helper-only tests are + not a sufficient substitute for those integration paths. + - - - Base Vitest config defaults to `threads`. - - The shared Vitest config fixes `isolate: false` and uses the - non-isolated runner across the root projects, e2e, and live configs. - - The root UI lane keeps its `jsdom` setup and optimizer, but runs on the - shared non-isolated runner too. - - Each `pnpm test` shard inherits the same `threads` + `isolate: false` - defaults from the shared Vitest config. - - `scripts/run-vitest.mjs` adds `--no-maglev` for Vitest child Node - processes by default to reduce V8 compile churn during big local runs. - Set `OPENCLAW_VITEST_ENABLE_MAGLEV=1` to compare against stock V8 - behavior. - + + - Base Vitest config defaults to `threads`. + - The shared Vitest config fixes `isolate: false` and uses the + non-isolated runner across the root projects, e2e, and live configs. + - The root UI lane keeps its `jsdom` setup and optimizer, but runs on the + shared non-isolated runner too. + - Each `pnpm test` shard inherits the same `threads` + `isolate: false` + defaults from the shared Vitest config. + - `scripts/run-vitest.mjs` adds `--no-maglev` for Vitest child Node + processes by default to reduce V8 compile churn during big local runs. + Set `OPENCLAW_VITEST_ENABLE_MAGLEV=1` to compare against stock V8 + behavior. + - - - `pnpm changed:lanes` shows which architectural lanes a diff triggers. - - The pre-commit hook runs `pnpm check:changed --staged` after staged - formatting/linting, so core-only commits do not pay extension test cost - unless they touch public extension-facing contracts. Release - metadata-only commits stay on the targeted - version/config/root-dependency lane. - - If the exact staged change set was already validated with - equal-or-stronger gates, use - `scripts/committer --fast "" ` to skip only the - changed-scope hook rerun. Staged format/lint still run. Mention the - completed gates in your handoff. This is also acceptable after an - isolated flaky hook failure is rerun and passes with scoped proof. - - `pnpm test:changed` routes through scoped lanes when the changed paths - map cleanly to a smaller suite. - - `pnpm test:max` and `pnpm test:changed:max` keep the same routing - behavior, just with a higher worker cap. - - Local worker auto-scaling is intentionally conservative and backs off - when the host load average is already high, so multiple concurrent - Vitest runs do less damage by default. - - The base Vitest config marks the projects/config files as - `forceRerunTriggers` so changed-mode reruns stay correct when test - wiring changes. - - The config keeps `OPENCLAW_VITEST_FS_MODULE_CACHE` enabled on supported - hosts; set `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path` if you want - one explicit cache location for direct profiling. - + + - `pnpm changed:lanes` shows which architectural lanes a diff triggers. + - The pre-commit hook runs `pnpm check:changed --staged` after staged + formatting/linting, so core-only commits do not pay extension test cost + unless they touch public extension-facing contracts. Release + metadata-only commits stay on the targeted + version/config/root-dependency lane. + - If the exact staged change set was already validated with + equal-or-stronger gates, use + `scripts/committer --fast "" ` to skip only the + changed-scope hook rerun. Staged format/lint still run. Mention the + completed gates in your handoff. This is also acceptable after an + isolated flaky hook failure is rerun and passes with scoped proof. + - `pnpm test:changed` routes through scoped lanes when the changed paths + map cleanly to a smaller suite. + - `pnpm test:max` and `pnpm test:changed:max` keep the same routing + behavior, just with a higher worker cap. + - Local worker auto-scaling is intentionally conservative and backs off + when the host load average is already high, so multiple concurrent + Vitest runs do less damage by default. + - The base Vitest config marks the projects/config files as + `forceRerunTriggers` so changed-mode reruns stay correct when test + wiring changes. + - The config keeps `OPENCLAW_VITEST_FS_MODULE_CACHE` enabled on supported + hosts; set `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path` if you want + one explicit cache location for direct profiling. + - - - `pnpm test:perf:imports` enables Vitest import-duration reporting plus - import-breakdown output. - - `pnpm test:perf:imports:changed` scopes the same profiling view to - files changed since `origin/main`. - - `pnpm test:perf:changed:bench -- --ref ` compares routed - `test:changed` against the native root-project path for that committed - diff and prints wall time plus macOS max RSS. - - `pnpm test:perf:changed:bench -- --worktree` benchmarks the current - dirty tree by routing the changed file list through - `scripts/test-projects.mjs` and the root Vitest config. - - `pnpm test:perf:profile:main` writes a main-thread CPU profile for - Vitest/Vite startup and transform overhead. - - `pnpm test:perf:profile:runner` writes runner CPU+heap profiles for the - unit suite with file parallelism disabled. - - + + - `pnpm test:perf:imports` enables Vitest import-duration reporting plus + import-breakdown output. + - `pnpm test:perf:imports:changed` scopes the same profiling view to + files changed since `origin/main`. + - `pnpm test:perf:changed:bench -- --ref ` compares routed + `test:changed` against the native root-project path for that committed + diff and prints wall time plus macOS max RSS. + - `pnpm test:perf:changed:bench -- --worktree` benchmarks the current + dirty tree by routing the changed file list through + `scripts/test-projects.mjs` and the root Vitest config. + - `pnpm test:perf:profile:main` writes a main-thread CPU profile for + Vitest/Vite startup and transform overhead. + - `pnpm test:perf:profile:runner` writes runner CPU+heap profiles for the + unit suite with file parallelism disabled. + + ### Stability (gateway)