mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 15:35:12 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - PR CI selects affected tests before allocating parallel runners. > - Recent audits retained about 96% of test files despite narrow changes. > - Unchanged consumer packages kept full coverage, and source scans confused data fields and message text with runtime loaders. > - File reads need explicit edges that imports alone cannot provide. > - This change follows consumer graphs and known file inputs while retaining unknown effects. > - The AWS CODEOWNERS gate stays in front of runner allocation. ## Linked Issues or Issue Description Refs #18376 and #18362. Narrow source changes still selected most tests because consumer packages kept full coverage and known file reads were treated as arbitrary input. Expected behavior is to retain affected import/file consumers and unknown inputs, then partition only the selected files. The shared storage failure found during the audit was fixed upstream in #18357. The candidate merge ran all 18 managed-skill storage tests successfully in [Linux qualification](https://github.com/paperclipai/paperclip/actions/runs/41140209697/job/124352365547). This branch includes that upstream commit; no additional storage implementation or permanent diagnostic job is included. ## What Changed - Assess every Vitest project in the coarse plan, including unchanged consumer workspaces. - Add dependency edges for statically resolved module-relative filesystem reads and directory listings. Keep unknown paths, writes, escaped APIs, mutable path objects and untracked inputs conservative. - Distinguish data keys, erased types and message strings from runtime globals, loaders and mock bypasses. Retain destructured globals, aliased object reads and mocked filesystem/path resolution. - Normalize `fs` and `node:fs` before recording coverage so a known read cannot hide an unknown one. - Review the Drizzle SQL/schema entry points by hashes of their complete import closures. CommonJS/dynamic loaders reject the fingerprint; drivers and migration readers remain opaque, and dependency updates revoke the review. - Record file input edges and per-test retention reasons in selection audit artifacts. - Add cross-workspace, mixed-import, symlink retargeting, setup-input and dependency-review regression cases. Object-valued URL constants are explicitly opaque with and without mutation. Update the developer guide. - Preserve the AWS CODEOWNERS authorization gate, runner-group restrictions and existing lane ownership. ## Verification - Final head `eedad362e84d6b68f0f048c92db6032e45622c46` passed [complete Actions CI](https://github.com/paperclipai/paperclip/actions/runs/41144233520) on attempt 1. Overall status: 57 successful checks, three intended skips, and one neutral Paperclip review. Both Greptile and Paperclip rated this head 5/5; zero unresolved review threads. - All 17 local selector tests passed: `node --test scripts/ci/test-selection*.test.mjs`. Final [Linux qualification](https://github.com/paperclipai/paperclip/actions/runs/41144233203/job/124365428832) passed all 18 selector/impact tests without skips, plus real workspace selection and cache/routing checks. - Same-tree local comparison against the previous selector at `d331d8481a`: Inbox changes selected 466 rather than 700 files (33% fewer); auth middleware changes selected 2,141 rather than 2,788 files (23% fewer). The sampled plans retained the same 2 and 24 jobs under existing weighted budgets. Final Linux qualification selected 466 files for Inbox and 1,949 for auth/config-test changes; platform-dependent graphs differ, so these are not a Linux before/after comparison. Chat/native Runner lanes retain their existing ownership and are excluded from these counts. - Local `pnpm -r typecheck`, `pnpm build` and `git diff --check` passed. The complete local `pnpm test:run` was attempted and stopped after repeated embedded PostgreSQL startup failures; initdb reported exhausted macOS semaphore capacity. Full Linux CI passed on the final combined tree. - The storage regression was corrected upstream in #18357. [Focused Linux verification](https://github.com/paperclipai/paperclip/actions/runs/41140209697/job/124352365547) ran all 18 managed-skill tests successfully, with no skips; the final full CI run also passed its server lane. ## Risks - Unknown effects must retain their consumers. Regression cases cover mixed builtin spellings, dynamic paths, escaped/mocked APIs, global aliases, reviewed dependency changes and cross-package file reads. - Graph analysis now visits unchanged consumers. Its added work must be included in rollout latency measurements; fewer test files do not by themselves prove shorter end-to-end PR time. - The weighted shard budget deliberately remains unchanged. These samples reduce file execution without reducing allocated jobs. ## Model Used OpenAI Codex, based on GPT-6, with reasoning, repository inspection, code execution and GitHub tools. The exact serving variant and context window are not exposed in this session. No subagents were used. ## 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 — targeted selector suite; full local suite limitation documented above - [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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
128 lines
6.9 KiB
JavaScript
128 lines
6.9 KiB
JavaScript
import { execFileSync } from "node:child_process";
|
|
import { appendFileSync, lstatSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
|
import { fileURLToPath } from "node:url";
|
|
import path from "node:path";
|
|
import assert from "node:assert/strict";
|
|
import { refineTestPlan, selectionDurations } from "./test-selection-plan.mjs";
|
|
import { productInputs } from "../../.github/scripts/ci-inputs.mjs";
|
|
import { mergeDiff } from "../../.github/scripts/ci-diff.mjs";
|
|
|
|
export function selectionEligibility(plan) {
|
|
if (plan?.version !== 1 || plan.mode !== "enabled" || plan.forceReason) return "Full/shadow/forced task plan";
|
|
if (!Array.isArray(plan.changed) || !plan.changed.length) return "Incomplete comparison";
|
|
const changed = productInputs(plan.changed);
|
|
if (!changed.length) return "Documentation-only diff";
|
|
for (const file of changed) {
|
|
// Business modules can contain "config"/"setup" in their names. The graph
|
|
// separately tracks actual setup and configuration dependencies.
|
|
if (!/^(?:ui\/src|server\/src|cli\/src|packages\/.+\/src)\/.+\.[cm]?[jt]sx?$/.test(file)
|
|
|| /(?:^|\/)(?:vite|vitest)\.(?:config|setup)\.[cm]?[jt]sx?$|\.d\.[cm]?ts$/i.test(file)
|
|
|| file.split("/").includes("..")) return `Broad input: ${file}`;
|
|
try {
|
|
if (!lstatSync(file).isFile()) return `Non-regular source: ${file}`;
|
|
} catch { return `Deleted or missing source: ${file}`; }
|
|
}
|
|
return null;
|
|
}
|
|
|
|
function runnerInventory(group) {
|
|
const args = group === "serialized" ? ["--mode", "serialized", "--shard-index", "0", "--shard-count", "1"]
|
|
: ["--mode", "general", "--group", group,
|
|
...(group === "general-server-without-chat" ? ["--shard-index", "0", "--shard-count", "1"] : [])];
|
|
const env = { ...process.env, GITHUB_WORKFLOW: "PR" };
|
|
delete env.PAPERCLIP_CI_TEST_SELECTION;
|
|
return JSON.parse(execFileSync(process.execPath, ["scripts/run-vitest-stable.mjs", ...args, "--dry-run"],
|
|
{ env, encoding: "utf8", maxBuffer: 16 * 1024 * 1024 }));
|
|
}
|
|
|
|
export async function createTestSelection(plan, head) {
|
|
const reason = selectionEligibility(plan);
|
|
if (reason) throw new Error(reason);
|
|
const groups = new Set();
|
|
for (const job of ["general_tests", "verify_serialized_server"]) {
|
|
if (plan.jobs[job].run) for (const entry of plan.jobs[job].matrix.include) groups.add(entry.group ?? "serialized");
|
|
}
|
|
groups.delete("general-chat"); // Keep its line sharding and DB ownership intact.
|
|
const owners = {}, projects = new Set();
|
|
for (const group of groups) {
|
|
const inventory = runnerInventory(group);
|
|
if (group === "serialized" || group === "general-server-without-chat") {
|
|
owners[group] = { "@paperclipai/server": group === "serialized"
|
|
? inventory.selectedSerializedSuites : inventory.selectedGeneralServerSuites };
|
|
projects.add("@paperclipai/server");
|
|
} else {
|
|
owners[group] = Object.fromEntries(inventory.workspaceProjects.map((project) => [project, null]));
|
|
for (const project of inventory.workspaceProjects) projects.add(project);
|
|
}
|
|
}
|
|
const { selectProjectTests } = await import("./vitest-selection-graph.mjs");
|
|
const graphs = [];
|
|
const changed = productInputs(plan.changed);
|
|
for (const project of projects) {
|
|
const graph = await selectProjectTests({ project, changed });
|
|
graphs.push(graph);
|
|
console.log(`${project}: ${graph.selected.length}/${graph.inventory.length} files, ${graph.alwaysRun.length} retained conservatively, ${graph.seconds.toFixed(1)}s`);
|
|
for (const owner of Object.values(owners)) if (owner[project] === null) owner[project] = graph.inventory;
|
|
}
|
|
const covered = new Set(graphs.flatMap((graph) => graph.coveredChanges));
|
|
for (const file of changed) assert.ok(covered.has(file), `Change outside the resolved test graphs: ${file}`);
|
|
const server = graphs.find((graph) => graph.project === "@paperclipai/server");
|
|
if (server) {
|
|
const general = runnerInventory("general-server-without-chat");
|
|
const native = runnerInventory("general-server-native-runner");
|
|
assert.deepEqual([...general.selectedGeneralServerSuites, ...general.selectedSerializedSuites,
|
|
...native.selectedGeneralServerSuites, "server/src/__tests__/chat-channels.integration.test.ts"].sort(),
|
|
server.inventory, "Server inventory must be completely covered by existing lane ownership");
|
|
}
|
|
return { ...refineTestPlan({ plan, head, owners, graphs, durations: selectionDurations() }), graphs };
|
|
}
|
|
|
|
async function main() {
|
|
const plan = JSON.parse(process.env.CI_PLAN || "null");
|
|
const output = (key, value) => {
|
|
if (process.env.GITHUB_OUTPUT) appendFileSync(process.env.GITHUB_OUTPUT, `${key}=${value}\n`);
|
|
};
|
|
if (process.argv.includes("--eligible")) {
|
|
const reason = selectionEligibility(plan);
|
|
console.log(reason ?? "Source diff is eligible for graph selection");
|
|
output("enabled", !reason);
|
|
return;
|
|
}
|
|
const directory = ".ci-test-selection";
|
|
mkdirSync(directory, { recursive: true });
|
|
const git = (...args) => execFileSync("git", args, { encoding: "utf8", maxBuffer: 16 * 1024 * 1024 }).trim();
|
|
let result;
|
|
try {
|
|
const head = git("rev-parse", "HEAD");
|
|
assert.equal(head, process.env.GITHUB_SHA, "Selection must describe the tested merge commit");
|
|
assert.ok(plan.diff, "Missing trusted merge diff");
|
|
const local = mergeDiff(head, plan.diff.prHead);
|
|
assert.deepEqual(local.diff, plan.diff, "Selection must use the trusted merge parents");
|
|
assert.deepEqual(local.changed, [...new Set(plan.changed)].sort(), "Local diff disagrees with the trusted routing diff");
|
|
assert.equal(git("status", "--porcelain", "--untracked-files=normal"), "", "Source inputs changed during dependency setup");
|
|
process.env.NODE_ENV = "test";
|
|
process.env.VITEST = "true";
|
|
result = await createTestSelection(plan, head);
|
|
writeFileSync(`${directory}/manifest.json`, JSON.stringify(result.manifest));
|
|
writeFileSync(`${directory}/audit.json`, JSON.stringify(result.graphs, null, 2));
|
|
output("selected", "true");
|
|
} catch (error) {
|
|
console.warn(`Using the complete task plan: ${error.message}`);
|
|
result = { plan: { ...plan, testSelectionFallback: error.message } };
|
|
output("selected", "false");
|
|
}
|
|
writeFileSync(`${directory}/plan.json`, JSON.stringify(result.plan));
|
|
if (process.env.GITHUB_STEP_SUMMARY) {
|
|
const stats = result.plan.testSelection?.stats;
|
|
appendFileSync(process.env.GITHUB_STEP_SUMMARY, stats
|
|
? ["### Vitest test selection", "", "| Lane | Test files | Jobs |", "| --- | ---: | ---: |",
|
|
...stats.map((s) => `| ${s.group} | ${s.selected}/${s.total} | ${s.jobs}/${s.beforeJobs} |`), "",
|
|
"Filesystem/process/opaque consumers are retained. Chat and native Runner lanes keep their existing ownership.", ""].join("\n")
|
|
: `### Vitest test selection\n\nFull task plan: ${result.plan.testSelectionFallback}\n`);
|
|
}
|
|
}
|
|
|
|
if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
|
|
main().catch((error) => { console.error(error); process.exitCode = 1; });
|
|
}
|