mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-12 22:56:58 +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>
131 lines
5.7 KiB
JavaScript
131 lines
5.7 KiB
JavaScript
// PR Runner Vitest lanes. `--package-lane=K/N` runs the Kth of N
|
|
// duration-balanced partitions of the package inventory, and `--native-server`
|
|
// runs the native server integration group. Every lane prepares debug
|
|
// fixtures; only the native group also needs release units (see the matrix).
|
|
//
|
|
// The --shard commands stay compatible with master-pinned workflows: under
|
|
// the PR workflow with two shards, the first runs every package test and the
|
|
// second runs the native server group. Local/other callers retain ordinary
|
|
// package sharding. Other PR shard counts keep package shards plus native
|
|
// tests on the final lane, preserving coverage.
|
|
import { spawnSync } from "node:child_process";
|
|
import { dirname, resolve } from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { invocationEnv } from "../../../scripts/ci-profile/record.mjs";
|
|
import { filesMatchedByFilters, listPackageVitestFiles, planPackageLanes } from "./vitest-package-lanes.mjs";
|
|
|
|
const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
|
|
const workspaceRoot = resolve(packageRoot, "../..");
|
|
const args = process.argv.slice(2).filter((value) => value !== "--dry-run");
|
|
const dryRun = process.argv.includes("--dry-run");
|
|
|
|
function fail(message) {
|
|
console.error(`[pr-vitest-lane] ${message}`);
|
|
process.exit(1);
|
|
}
|
|
|
|
const shardArg = args.find((value) => value.startsWith("--shard="));
|
|
const shardMatch = shardArg ? /^--shard=(\d+)\/(\d+)$/.exec(shardArg) : null;
|
|
if (args.filter(value => value.startsWith("--shard=")).length > 1 || (shardArg && !shardMatch)) {
|
|
fail(`unrecognized shard argument: ${shardArg}`);
|
|
}
|
|
if (shardMatch && (Number(shardMatch[1]) < 1 || Number(shardMatch[1]) > Number(shardMatch[2]))) {
|
|
throw new Error(`Invalid shard: ${shardArg}`);
|
|
}
|
|
|
|
const laneArgs = args.filter((value) => value.startsWith("--package-lane"));
|
|
const laneMatch = laneArgs.length === 1 ? /^--package-lane=(\d+)\/(\d+)$/.exec(laneArgs[0]) : null;
|
|
if (laneArgs.length > 1 || (laneArgs.length === 1 && !laneMatch)) {
|
|
fail(`unrecognized package lane argument: ${laneArgs.join(" ")}`);
|
|
}
|
|
const laneIndex = laneMatch ? Number(laneMatch[1]) : null;
|
|
const laneCount = laneMatch ? Number(laneMatch[2]) : null;
|
|
if (laneMatch && (laneCount < 1 || laneIndex < 1 || laneIndex > laneCount)) {
|
|
fail(`invalid package lane: ${laneArgs[0]}`);
|
|
}
|
|
const nativeServerOnly = args.includes("--native-server");
|
|
if ([shardArg, laneMatch, nativeServerOnly].filter(Boolean).length > 1) {
|
|
fail("--shard, --package-lane and --native-server are mutually exclusive");
|
|
}
|
|
if (nativeServerOnly && args.length > 1) {
|
|
fail(`--native-server takes no other arguments: ${args.join(" ")}`);
|
|
}
|
|
|
|
const isFinalShard = !shardArg || shardMatch[1] === shardMatch[2];
|
|
const isPrWorkflow = process.env.GITHUB_WORKFLOW === "PR";
|
|
// Reuse the two existing CI slots: all package files in the first, all native
|
|
// server files in the second. Keeping the old command arguments makes this
|
|
// safe while the trusted workflow still comes from master. Other shard counts
|
|
// and local callers retain ordinary Vitest sharding and the final-lane append.
|
|
const separateWorkloads = isPrWorkflow && shardMatch?.[2] === "2";
|
|
|
|
let runNativeRunnerGroup;
|
|
let runPackageTests;
|
|
let packageArgs;
|
|
let packageLane = null;
|
|
if (laneMatch) {
|
|
const inventory = listPackageVitestFiles();
|
|
const lanes = planPackageLanes(inventory, laneCount);
|
|
const lane = lanes[laneIndex - 1];
|
|
// A filter that also selects a file owned by another lane runs it twice; it
|
|
// never drops coverage, so warn instead of failing the lane.
|
|
const extra = filesMatchedByFilters(lane.files, inventory).filter((file) => !lane.files.includes(file));
|
|
if (extra.length) {
|
|
console.error(`[pr-vitest-lane] package lane ${laneIndex}/${laneCount} filters also select: ${extra.join(", ")}`);
|
|
}
|
|
packageLane = { index: laneIndex, count: laneCount, inventory: inventory.length, estimatedMs: lane.estimatedMs, files: lane.files };
|
|
runNativeRunnerGroup = false;
|
|
// An empty file list would make `vitest run` select the whole inventory.
|
|
runPackageTests = lane.files.length > 0;
|
|
packageArgs = [...args.filter((arg) => arg !== laneArgs[0]), ...lane.files];
|
|
} else if (nativeServerOnly) {
|
|
runNativeRunnerGroup = true;
|
|
runPackageTests = false;
|
|
packageArgs = [];
|
|
} else {
|
|
runNativeRunnerGroup = isPrWorkflow && isFinalShard;
|
|
runPackageTests = !separateWorkloads || !isFinalShard;
|
|
packageArgs = separateWorkloads ? args.filter((arg) => arg !== shardArg) : args;
|
|
}
|
|
|
|
const plannedCommands = [
|
|
{ command: "pnpm", args: ["run", "ensure:eval-build-deps"], cwd: packageRoot },
|
|
{ command: "pnpm", args: ["run", "build:rust"], cwd: packageRoot },
|
|
...(runPackageTests
|
|
? [{ command: "pnpm", args: ["exec", "vitest", "run", ...packageArgs], cwd: packageRoot }]
|
|
: []),
|
|
...(runNativeRunnerGroup
|
|
? [{
|
|
command: "pnpm",
|
|
args: ["test:run:general", "--", "--group", "general-server-native-runner"],
|
|
cwd: workspaceRoot,
|
|
}]
|
|
: []),
|
|
];
|
|
|
|
if (dryRun) {
|
|
console.log(JSON.stringify({
|
|
isPrWorkflow,
|
|
isFinalShard,
|
|
runNativeRunnerGroup,
|
|
runPackageTests,
|
|
...(packageLane ? { packageLane } : {}),
|
|
plannedCommands,
|
|
}, null, 2));
|
|
process.exit(0);
|
|
}
|
|
|
|
if (packageLane) {
|
|
console.log(`[pr-vitest-lane] package lane ${packageLane.index}/${packageLane.count}: ${packageLane.files.length}/${packageLane.inventory} files, estimated ${Math.round(packageLane.estimatedMs / 1000)}s`);
|
|
}
|
|
for (const planned of plannedCommands) {
|
|
const result = spawnSync(planned.command, planned.args, {
|
|
cwd: planned.cwd,
|
|
stdio: "inherit",
|
|
env: planned.args[0] === "exec" && planned.args[1] === "vitest" ? invocationEnv("vitest") : process.env,
|
|
});
|
|
if (result.status !== 0) {
|
|
process.exit(result.status ?? 1);
|
|
}
|
|
}
|