mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-12 14:19:00 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Contributors wait for PR CI before merge, so CI wall-clock time sets the pace of work > - The Runner package Vitest lane is the PR CI critical path. It finishes a median 15.3 minutes after the push > - That lane runs all 311 package test files in one job with 2 workers: 1,381 seconds of serial work and 727 seconds of wall time > - Ten files account for 61% of the time. Vitest's `--shard` splits by file count, not by duration, so it cannot balance this work > - This pull request splits the package files into three lanes balanced by duration, and runs the native server group in its own lane > - The benefit is about 232 seconds of tests per package lane instead of 727 seconds ## Linked Issues or Issue Description **What existing behavior does this improve?** The time that PR CI needs to run the Runner package Vitest tests. **Subsystem affected** CI: the `Verify Paperclip Runner` Vitest lanes in `pr-trusted.yml`, and `packages/paperclip-runner/scripts/run-pr-vitest-lane.mjs`. **Current behavior** The `vitest package` lane takes a median of 13.6 minutes. It is the last job to finish in most PR runs. The lane keeps a 2-worker limit so that Runner and sidecar processes can start within their deadlines. Average CPU use is 29%. **Proposed behavior** Three package lanes each run about one third of the files, balanced by measured duration. Each lane keeps the 2-worker limit. The native server group runs in its own lane, as before. **Reason and benefit** The Runner lane stops being the critical path. More workers per lane would add CPU contention and timeouts, so this change adds lanes instead. The cost is about 3 runner-minutes per run for the extra setup. **Breaking changes** None. The `master` ruleset requires only `ci / verify` and `ci / e2e`, so the new job names do not change required checks. ## What Changed - Add `packages/paperclip-runner/scripts/vitest-package-lanes.mjs`. - It gets the file inventory from `vitest list --filesOnly --json`, so it follows `vitest.config.ts`. - It partitions the files with the `partitionGeneralServerSuites` function from `scripts/general-server-shard.mjs`. - Add `packages/paperclip-runner/scripts/vitest-lane-durations.json`. - It uses the same schema as `scripts/general-server-shard-durations.json`. - It is seeded from CI run 42290920882. It measures 310 of the 311 files. - `run-pr-vitest-lane.mjs` accepts two new arguments: - `--package-lane=K/N` runs one partition. - `--native-server` runs only the native server group. - The `--shard=1/2` and `--shard=2/2` arguments keep their exact behavior for the matrix that master still sends. - `.github/ci-task-matrix.json` and the fallback matrix in `pr-trusted.yml` have three `vitest package (K/3)` lanes and the `vitest native server` lane. The labels keep the `vitest` prefix because `scripts/ci-profile/trace.mjs` matches `Verify Paperclip Runner (vitest`. - Tests: - the lanes cover the inventory exactly once, checked with real `vitest list`; - the old `--shard` commands plan the same commands as before; - the manifest schema is correct; - bad lane arguments are refused. - Update the Runner Vitest lane paragraph in `doc/DEVELOPING.md`. ## Verification - `node --test scripts/__tests__/run-vitest-stable-shard.test.mjs`: 44/44 pass. - `node --test scripts/__tests__/runner-release-crate-cache.test.mjs .github/scripts/tests/ci-plan.test.mjs`, together with the file above: 71/71 pass. - Related workflow, cache, routing and profile tests: 446/446, 153/153 and 14/14 pass. - Local end-to-end run of `GITHUB_WORKFLOW=PR node scripts/run-pr-vitest-lane.mjs --package-lane=3/3` on macOS: - the prep steps ran, and the lane ran 104 of 311 files in 123 seconds; - 2 tests failed: a macOS `kill EPERM` and a 5-second timeout under full local load without the CI worker limit; - both files pass when run alone (35/35 tests). - This PR's own CI runs the matrix from master, so it uses the old `--shard` commands. The new lanes run in CI only after merge. Reviewers can compare the job durations of the first PR runs after the merge. | Lane | Files | Serial estimate | Wall estimate with 2 workers | | --- | --- | --- | --- | | 1/3 | 103 | 464.9 s | ~232 s | | 2/3 | 104 | 465.0 s | ~232 s | | 3/3 | 104 | 465.0 s | ~232 s | ## Risks - The weights come from one CI log and do not include collection or setup time. The balance can be uneven until a refresh measures real lane runs. - Each lane passes its file paths to Vitest as filters, and Vitest matches a filter as a substring of the path. A path that is a substring of another path would run a file in two lanes. No current path does this. If one does, the script prints a warning, and no file is dropped. - Each package lane runs `ensure:eval-build-deps` and `build:rust` again, which adds about 3 runner-minutes per run. - A comment in `scripts/run-vitest-stable.mjs` (about line 110) still says that the last Runner shard runs the native group. A follow-up will correct it. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`) in Claude Code, with tool use and code execution. A Claude sub-agent wrote the change, and the parent session reviewed it and ran the local lane check. ## 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 tests locally and they pass - [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 Paperclip CI gates are green - [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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
64 lines
3.5 KiB
JavaScript
64 lines
3.5 KiB
JavaScript
// Duration-balanced partitions of the Runner package Vitest inventory. The PR
|
|
// workflow runs one partition per job (`--package-lane=K/N`) so the package
|
|
// tests no longer serialize behind two workers in a single job. Vitest owns
|
|
// the inventory: it is listed from vitest.config.ts, never re-globbed here.
|
|
import { spawnSync } from "node:child_process";
|
|
import { createRequire } from "node:module";
|
|
import { dirname, isAbsolute, relative, resolve } from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { loadShardDurations, partitionGeneralServerSuites } from "../../../scripts/general-server-shard.mjs";
|
|
|
|
export const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
|
|
export const laneDurationsPath = resolve(packageRoot, "scripts/vitest-lane-durations.json");
|
|
// Manifest keys are repository-relative, matching the server shard manifests.
|
|
export const repoPrefix = "packages/paperclip-runner/";
|
|
|
|
const toPosix = (value) => value.replaceAll("\\", "/");
|
|
|
|
// Package-relative test files exactly as vitest.config.ts includes them.
|
|
export function listPackageVitestFiles({ env = process.env } = {}) {
|
|
const vitestBin = resolve(dirname(createRequire(resolve(packageRoot, "package.json")).resolve("vitest/package.json")), "vitest.mjs");
|
|
// Listing must not register a CI profile invocation: it runs no tests.
|
|
const listEnv = { ...env, PAPERCLIP_CI_PROFILE: "" };
|
|
// `--json` takes an optional output path: keep it last so it prints to stdout.
|
|
const result = spawnSync(process.execPath, [vitestBin, "list", "--filesOnly", "--json"], {
|
|
cwd: packageRoot,
|
|
encoding: "utf8",
|
|
env: listEnv,
|
|
maxBuffer: 16 * 1024 * 1024,
|
|
});
|
|
if (result.status !== 0) {
|
|
throw new Error(`vitest list failed (${result.status ?? result.signal}): ${result.stderr || result.stdout}`);
|
|
}
|
|
const start = result.stdout.indexOf("[");
|
|
const entries = JSON.parse(result.stdout.slice(start));
|
|
const files = [...new Set(entries.map((entry) => {
|
|
const file = typeof entry === "string" ? entry : entry.file;
|
|
return toPosix(isAbsolute(file) ? relative(packageRoot, file) : file);
|
|
}))].sort((a, b) => a.localeCompare(b));
|
|
if (files.length === 0 || files.some((file) => file.startsWith("../"))) {
|
|
throw new Error(`vitest list returned an unexpected inventory: ${JSON.stringify(files.slice(0, 5))}`);
|
|
}
|
|
return files;
|
|
}
|
|
|
|
// Vitest treats each CLI filter as a case-insensitive substring of the file's
|
|
// root-relative path. A file whose path ends another file's path (src/x.test.ts
|
|
// within devtools/browser/src/x.test.ts) therefore also selects the longer one.
|
|
export function filesMatchedByFilters(filters, inventory) {
|
|
const lowered = filters.map((filter) => filter.toLowerCase());
|
|
return inventory.filter((file) => lowered.some((filter) => file.toLowerCase().includes(filter)));
|
|
}
|
|
|
|
// Splits the package inventory into `laneCount` lanes, heaviest file first,
|
|
// with the deterministic partitioner the general server shards use. Every
|
|
// runner computes the identical partition from the same checkout, so the
|
|
// lanes are a complete, non-overlapping cover of the inventory.
|
|
export function planPackageLanes(files, laneCount, durations = loadShardDurations(laneDurationsPath)) {
|
|
if (!Number.isSafeInteger(laneCount) || laneCount < 1) throw new Error(`Invalid package lane count: ${laneCount}`);
|
|
return partitionGeneralServerSuites(files.map((file) => repoPrefix + file), laneCount, durations).map((lane) => ({
|
|
files: lane.files.map((file) => file.slice(repoPrefix.length)),
|
|
estimatedMs: lane.totalWeight,
|
|
}));
|
|
}
|