mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-17 21:34:48 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Dependabot pull requests that change `pnpm-lock.yaml` are the only way, other than the lockfile refresh, that lock content changes > - #19356 let a verified Dependabot lockfile pass CI. The server's reporting-lock policy test skips when `PAPERCLIP_CI_PR_AUTHOR` is `dependabot[bot]`, and the lockfile refresh renews the proof after the merge > - #19537 then made the Runner support suite a required check. That job does not set `PAPERCLIP_CI_PR_AUTHOR`, and the suite's own reviewed-lock checks have no Dependabot skip > - So every Dependabot lockfile pull request fails `ci / Runner support suite` and `ci / verify`. The last one that merged, #17364, merged before #19537 > - This pull request gives the support suite the same Dependabot skip as the server test > - The benefit is that Dependabot dependency updates can merge again, with the same lock trust rules as before ## Linked Issues or Issue Description Refs #19356, #19537, #19614, #17172, #19575. Rebased onto `master` after #21943, which fixed the unrelated `qualify_test_selection` failure that a CI file change triggers. **What happened?** Dependabot pull request #17172 changes `pnpm-lock.yaml`. `ci / Runner support suite` fails in four test files, and `ci / verify` fails because of it: - `prepare-report-lock.test.ts` > installs only the reviewed dependency correction (4 cases): the committed lock hash is not in `report-lock.json`. - `source-sdk-public-type.test.ts`: the shared setup throws "Committed SDK reference lock is not reviewed". - `source-sdk-evidence.test.ts` > seals a normal producer-certified reviewed-reference SDK: the same error. - `source-sdk-public-inputs.test.mjs` > the committed SDK public source pins match this checkout's committed tree: `pnpm-lock.yaml` is stale in `source-sdk-public-inputs.json`. A Dependabot pull request may not change `report-lock.json`, `report-lock.patch` or the SDK pins. `lockfile-trust.mjs` rejects that change, and `refresh-lockfile.yml` renews those files after the merge. So the pull request can never pass. **Expected behavior** A verified Dependabot lockfile passes the Runner support suite, as it already passes the server's reporting-lock policy test. Other authors keep every check. **Steps to reproduce** 1. Open a Dependabot pull request that changes `pnpm-lock.yaml`, such as #17172. 2. Let CI run. `ci / Runner support suite` fails in the four files above. ## What Changed - `.github/workflows/pr-trusted.yml`: the `verify_runner_e2e_support` job sets `PAPERCLIP_CI_PR_AUTHOR` from the pull request author, like the general test job. - `tests/runner-e2e/prepare-report-lock.test.ts`, `source-sdk-evidence.test.ts`, `source-sdk-public-inputs.test.mjs`: the test cases that need a reviewed committed lock skip when `PAPERCLIP_CI_PR_AUTHOR` is `dependabot[bot]`. This uses the same check as `server/scripts/reporting-lock-policy.test.mjs`. The other cases in these files still run. - `tests/runner-e2e/vitest.config.ts`: on a Dependabot pull request, the suite excludes `source-sdk-public-type.test.ts`. Its shared `beforeAll` prepares the reviewed SDK reference, so every case in the file needs a reviewed lock. - `tests/runner-e2e/source-sdk-public-type.ts`: the installed TypeScript, Babel parser and Zod package hash checks move into an exported `verifySdkProofPackages`, which `verifySdkPublicSource` calls. The lockfile refresh renews the lock and source pins after a merge, but keeps these package hashes. - `tests/runner-e2e/source-sdk-proof-packages.test.ts` (new): runs `verifySdkProofPackages` against the installed packages on every pull request, including Dependabot ones, and checks that a changed package pin is rejected. So a Dependabot update of one of those packages still fails until its pins are reviewed. ## Verification - Red, then green, with a real Dependabot lock: I committed the `pnpm-lock.yaml` and `package.json` changes of #17172 on top of this branch in a local commit (not pushed). Then I ran `node node_modules/vitest/vitest.mjs run --config tests/runner-e2e/vitest.config.ts` on the four files: - Without `PAPERCLIP_CI_PR_AUTHOR`: 4 files failed and the same 6 tests failed as in CI. - With `PAPERCLIP_CI_PR_AUTHOR=dependabot[bot]`: 3 files passed, 33 tests passed and 6 skipped. `source-sdk-public-type.test.ts` was excluded. - On this branch with master's lock: `pnpm test:e2e:runner:unit` passed (Vitest: 687 files, 11640 tests; node tests passed). - `node --test .github/scripts/tests/*.test.mjs`: 808 passed. - After the package check change: the five affected files (`source-sdk-proof-packages`, `source-sdk-public-type`, `source-sdk-evidence`, `source-sdk-public-inputs`, `prepare-report-lock`) pass, 71 tests. `tsc --noEmit -p tests/runner-e2e/tsconfig.json` passes. - `pr.yml` calls `pr-trusted.yml@master`, so this pull request's own CI does not use the new job variable. The first Dependabot pull request after the merge checks it. ## Risks - A Dependabot update of TypeScript, the Babel parser or Zod still fails the suite until a maintainer reviews the new package pins. That is deliberate. - On a Dependabot pull request, the suite no longer checks the committed lock against the reviewed proof. The policy job still requires that the lock comes from a verified Dependabot commit (`lockfile-trust.mjs pr`), and the lockfile refresh still admits the lock and renews the proof and the SDK pins after the merge. That is the same trust as #19356. - `PAPERCLIP_CI_PR_AUTHOR` is the pull request author from the GitHub event. A contributor cannot set it to `dependabot[bot]`. Other commits pushed to a Dependabot branch are still checked by the policy job. - No runtime code changes. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, used through Claude Code with tool use and code execution. ## 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 - [ ] All Paperclip CI gates are green - [ ] 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>
159 lines
12 KiB
JavaScript
159 lines
12 KiB
JavaScript
import { strict as assert } from "node:assert";
|
|
import { execFileSync } from "node:child_process";
|
|
import { createHash } from "node:crypto";
|
|
import { mkdir, mkdtemp, readFile, realpath, rm, symlink, writeFile } from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { afterEach, test } from "vitest";
|
|
import { fileURLToPath } from "node:url";
|
|
import { isSdkPublicInput, staleSdkPublicInputs, staleSdkPublicInputsInWorkingTree, staleSdkPublicInputsMessage, synchronizeSdkPublicInputs } from "./source-sdk-public-inputs.mjs";
|
|
|
|
const registry = "tests/runner-e2e/source-sdk-public-inputs.json";
|
|
const pendingDependabotLock = process.env.PAPERCLIP_CI_PR_AUTHOR === "dependabot[bot]";
|
|
const reportLock = "tests/runner-e2e/report-lock.json";
|
|
const reportPolicy = (inputSha256, outputSha256) => `${JSON.stringify({ inputSha256, outputSha256, patchSha256: "0".repeat(64), basis: "synthetic" }, null, 2)}\n`;
|
|
const commit = (root, message) => { git(root, "add", "-A"); git(root, "-c", "user.name=Synthetic unit", "-c", "user.email=synthetic@example.invalid", "commit", "-qm", message); return git(root, "rev-parse", "HEAD").trim(); };
|
|
const roots = [];
|
|
const digest = bytes => createHash("sha256").update(bytes).digest("hex");
|
|
const blob = bytes => createHash("sha1").update(`blob ${Buffer.byteLength(bytes)}\0`).update(bytes).digest("hex");
|
|
const git = (root, ...args) => execFileSync("git", ["-c", "core.hooksPath=/dev/null", "-c", "commit.gpgsign=false", ...args], { cwd: root, encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] });
|
|
async function put(root, file, bytes) { await mkdir(path.dirname(path.join(root, file)), { recursive: true }); await writeFile(path.join(root, file), bytes); }
|
|
async function fixture() {
|
|
const root = await realpath(await mkdtemp(path.join(os.tmpdir(), "sdk-input-sync-"))); roots.push(root);
|
|
const files = ["package.json", "packages/plugins/sdk/package.json", "packages/plugins/sdk/tsconfig.json",
|
|
"packages/shared/package.json", "packages/shared/tsconfig.json", "pnpm-lock.yaml", "scripts/ensure-plugin-build-deps.mjs",
|
|
"tsconfig.base.json", "tsconfig.json", "packages/shared/src/schema.ts", "packages/plugins/sdk/src/types.ts"];
|
|
for (const file of files) await put(root, file, `synthetic original ${file}\n`);
|
|
const baseline = { inputs: Object.fromEntries(files.map(file => [file, blob(`synthetic stale ${file}\n`)])),
|
|
lockSha256: digest("synthetic authenticated restored lock"), compilerPackageSha256: "a".repeat(64),
|
|
parserPackageSha256: "b".repeat(64), parserEntrySha256: "c".repeat(64),
|
|
zodPackageSha256: "d".repeat(64), zodEntrySha256: "e".repeat(64), zodTypeFiles: { "index.d.cts": "f".repeat(64) } };
|
|
await put(root, registry, `${JSON.stringify(baseline, null, 2)}\n`);
|
|
// The reviewed report-lock policy: committed lock in, authenticated restored lock out.
|
|
await put(root, reportLock, reportPolicy(digest("synthetic original pnpm-lock.yaml\n"), baseline.lockSha256));
|
|
git(root, "init", "-q"); git(root, "add", ".");
|
|
git(root, "-c", "user.name=Synthetic unit", "-c", "user.email=synthetic@example.invalid", "commit", "-qm", "synthetic source");
|
|
return { root, baseline, revision: git(root, "rev-parse", "HEAD").trim() };
|
|
}
|
|
afterEach(async () => { await Promise.all(roots.splice(0).map(root => rm(root, { recursive: true, force: true }))); });
|
|
|
|
test("synchronizes the committed source graph, preserves every runtime pin and is idempotent", async () => {
|
|
const { root, baseline } = await fixture();
|
|
await put(root, "packages/shared/src/added.ts", "synthetic added source\n");
|
|
git(root, "add", "."); git(root, "-c", "user.name=Synthetic unit", "-c", "user.email=synthetic@example.invalid", "commit", "-qm", "additional source");
|
|
const revision = git(root, "rev-parse", "HEAD").trim();
|
|
assert.equal((await synchronizeSdkPublicInputs(root, revision)).changed, true);
|
|
assert.deepEqual(JSON.parse(await readFile(path.join(root, registry), "utf8")), baseline, "check does not write");
|
|
const changed = await synchronizeSdkPublicInputs(root, revision, { write: true });
|
|
const updated = JSON.parse(await readFile(path.join(root, registry), "utf8"));
|
|
assert.equal(updated.inputs["packages/shared/src/added.ts"], blob("synthetic added source\n"));
|
|
for (const [file, pin] of Object.entries(updated.inputs)) assert.equal(pin, git(root, "rev-parse", `${revision}:${file}`).trim());
|
|
const { inputs: oldInputs, ...runtime } = baseline, { inputs: newInputs, ...afterRuntime } = updated;
|
|
assert.deepEqual(afterRuntime, runtime); assert.equal(changed.runtimePinsChanged, false);
|
|
assert.equal(changed.registrySha256, digest(await readFile(path.join(root, registry))));
|
|
assert.equal((await synchronizeSdkPublicInputs(root, revision)).changed, false);
|
|
});
|
|
for (const mutation of ["dirty", "missing", "extra", "symlink", "registry", "revision"]) {
|
|
test(`refuses ${mutation} source custody without writing the registry`, async () => {
|
|
const { root, revision } = await fixture();
|
|
const target = path.join(root, "packages/shared/src/schema.ts");
|
|
if (mutation === "dirty") await writeFile(target, "uncommitted synthetic source");
|
|
if (mutation === "missing") await rm(target);
|
|
if (mutation === "extra") await put(root, "packages/shared/src/uncommitted.ts", "uncommitted");
|
|
if (mutation === "symlink") { await rm(target); await symlink("../package.json", target); }
|
|
if (mutation === "registry") { const current = JSON.parse(await readFile(path.join(root, registry), "utf8")); current.parserEntrySha256 = "0".repeat(64); await writeFile(path.join(root, registry), JSON.stringify(current)); }
|
|
const before = await readFile(path.join(root, registry));
|
|
await assert.rejects(synchronizeSdkPublicInputs(root, mutation === "revision" ? "0".repeat(40) : revision, { write: true }));
|
|
assert.deepEqual(await readFile(path.join(root, registry)), before);
|
|
});
|
|
}
|
|
test("admits only the separately pinned restored lock overlay without changing its identities", async () => {
|
|
const { root, baseline, revision } = await fixture();
|
|
await writeFile(path.join(root, "pnpm-lock.yaml"), "synthetic authenticated restored lock");
|
|
await synchronizeSdkPublicInputs(root, revision, { write: true });
|
|
const updated = JSON.parse(await readFile(path.join(root, registry), "utf8"));
|
|
assert.equal(updated.lockSha256, baseline.lockSha256);
|
|
assert.equal(updated.inputs["pnpm-lock.yaml"], git(root, "rev-parse", `${revision}:pnpm-lock.yaml`).trim());
|
|
await writeFile(path.join(root, "pnpm-lock.yaml"), "unknown lock overlay");
|
|
await assert.rejects(synchronizeSdkPublicInputs(root, revision));
|
|
});
|
|
|
|
// A lockfile refresh rewrites the lock and report-lock.json together (#20615).
|
|
// The sync carries the new reviewed output hash into lockSha256; nothing else.
|
|
test("a lockfile refresh moves lockSha256 to the committed reviewed report-lock output", async () => {
|
|
const { root, baseline, revision: first } = await fixture();
|
|
await synchronizeSdkPublicInputs(root, first, { write: true });
|
|
commit(root, "synced");
|
|
const refreshed = "synthetic refreshed pnpm-lock.yaml\n";
|
|
await put(root, "pnpm-lock.yaml", refreshed);
|
|
await put(root, reportLock, reportPolicy(baseline.lockSha256, digest(refreshed)));
|
|
const revision = commit(root, "lockfile refresh");
|
|
assert.deepEqual(await staleSdkPublicInputs(root), [
|
|
{ file: "pnpm-lock.yaml", change: "changed" },
|
|
{ file: `${reportLock} outputSha256`, change: "lockSha256 changed" },
|
|
]);
|
|
const result = await synchronizeSdkPublicInputs(root, revision, { write: true });
|
|
assert.equal(result.lockPinChanged, true); assert.equal(result.runtimePinsChanged, false);
|
|
const updated = JSON.parse(await readFile(path.join(root, registry), "utf8"));
|
|
assert.equal(updated.lockSha256, digest(refreshed));
|
|
assert.equal(updated.inputs["pnpm-lock.yaml"], blob(refreshed));
|
|
const { inputs: _old, lockSha256: _oldLock, ...runtime } = baseline, { inputs: _new, lockSha256: _newLock, ...afterRuntime } = updated;
|
|
assert.deepEqual(afterRuntime, runtime);
|
|
assert.deepEqual(await staleSdkPublicInputs(root), []);
|
|
});
|
|
test("refuses a committed lock that the report-lock policy does not review", async () => {
|
|
const { root } = await fixture();
|
|
await put(root, "pnpm-lock.yaml", "synthetic unreviewed lock\n");
|
|
const revision = commit(root, "unreviewed lock");
|
|
const before = await readFile(path.join(root, registry));
|
|
await assert.rejects(synchronizeSdkPublicInputs(root, revision, { write: true }), /not reviewed by tests\/runner-e2e\/report-lock\.json/);
|
|
assert.deepEqual(await readFile(path.join(root, registry)), before);
|
|
});
|
|
|
|
// The pins only prove the SDK public types while they match the committed
|
|
// source. A PR that edits packages/shared/src (or another pinned input) without
|
|
// refreshing them breaks every SDK-dependent Runner cell before its server
|
|
// starts, so fail here, cheaply, with the inputs and the fix command.
|
|
test.skipIf(pendingDependabotLock)("the committed SDK public source pins match this checkout's committed tree", async () => {
|
|
const root = fileURLToPath(new URL("../..", import.meta.url));
|
|
const stale = await staleSdkPublicInputs(root);
|
|
assert.deepEqual(stale, [], staleSdkPublicInputsMessage(stale));
|
|
});
|
|
// pnpm verify reads the working tree, so an uncommitted or unpushed edit to a
|
|
// pinned input is reported locally instead of failing the Runner support suite in CI.
|
|
test("the working-tree drift guard sees uncommitted and untracked pinned inputs", async () => {
|
|
const { root, revision } = await fixture();
|
|
await synchronizeSdkPublicInputs(root, revision, { write: true }); commit(root, "resync");
|
|
assert.deepEqual(await staleSdkPublicInputsInWorkingTree(root), []);
|
|
await put(root, "packages/shared/src/schema.ts", "uncommitted synthetic edit\n");
|
|
await put(root, "packages/shared/src/untracked.ts", "untracked synthetic source\n");
|
|
await put(root, "packages/shared/src/ignored.ts", "ignored synthetic source\n"); await put(root, ".gitignore", "packages/shared/src/ignored.ts\n");
|
|
const stale = await staleSdkPublicInputsInWorkingTree(root);
|
|
assert.deepEqual(stale, [{ file: "packages/shared/src/schema.ts", change: "changed" }, { file: "packages/shared/src/untracked.ts", change: "unpinned" }]);
|
|
assert.match(staleSdkPublicInputsMessage(stale), /packages\/shared\/src\/schema\.ts \(changed\).*source-sdk-public-inputs\.mjs \$\(git rev-parse HEAD\) --write/);
|
|
assert.deepEqual(await staleSdkPublicInputs(root), [], "the committed-tree guard is unaffected by uncommitted edits");
|
|
git(root, "checkout", "--", "packages/shared/src/schema.ts");
|
|
await rm(path.join(root, "packages/shared/src/untracked.ts"));
|
|
// The reviewed restored lock overlay in the working tree is not drift; any other lock edit is.
|
|
await writeFile(path.join(root, "pnpm-lock.yaml"), "synthetic authenticated restored lock");
|
|
assert.deepEqual(await staleSdkPublicInputsInWorkingTree(root), []);
|
|
await writeFile(path.join(root, "pnpm-lock.yaml"), "synthetic unreviewed lock edit\n");
|
|
assert.deepEqual(await staleSdkPublicInputsInWorkingTree(root), [{ file: "pnpm-lock.yaml", change: "changed" }]);
|
|
// Committing the reviewed output lock without a registry refresh is drift: CI's committed-tree guard reports it, so must this one.
|
|
await writeFile(path.join(root, "pnpm-lock.yaml"), "synthetic authenticated restored lock"); commit(root, "commit reviewed output lock");
|
|
assert.deepEqual(await staleSdkPublicInputs(root), [{ file: "pnpm-lock.yaml", change: "changed" }]);
|
|
assert.deepEqual(await staleSdkPublicInputsInWorkingTree(root), [{ file: "pnpm-lock.yaml", change: "changed" }]);
|
|
assert.equal(isSdkPublicInput("packages/shared/src/types/heartbeat.ts"), true);
|
|
assert.equal(isSdkPublicInput("pnpm-lock.yaml"), true);
|
|
assert.equal(isSdkPublicInput("server/src/index.ts"), false);
|
|
});
|
|
test("the drift guard names changed, unpinned and removed inputs and clears after a resync", async () => {
|
|
const { root, revision } = await fixture();
|
|
assert.deepEqual((await staleSdkPublicInputs(root)).map(row => row.change), Array(11).fill("changed"));
|
|
await synchronizeSdkPublicInputs(root, revision, { write: true });
|
|
assert.deepEqual(await staleSdkPublicInputs(root), []);
|
|
await put(root, "packages/shared/src/added.ts", "synthetic added source\n"); await rm(path.join(root, "packages/plugins/sdk/src/types.ts"));
|
|
git(root, "add", "-A"); git(root, "-c", "user.name=Synthetic unit", "-c", "user.email=synthetic@example.invalid", "commit", "-qm", "drift");
|
|
assert.deepEqual(await staleSdkPublicInputs(root), [{ file: "packages/plugins/sdk/src/types.ts", change: "removed" }, { file: "packages/shared/src/added.ts", change: "unpinned" }]);
|
|
});
|