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
> - The chat evaluation lane runs each chat case in a paid runner and
keeps the private evidence of each attempt in a bounded private archive
> - A failed attempt keeps its Playwright trace and video, and the
bundle has a 256 MB allowance
> - Playwright's HTML reporter copies each attachment into
`html-report/data/<sha1>.<ext>`, and the same bytes also stay in
`playwright-output/`
> - The bundle holds the original tree and the packaged tree, so a 30 MB
trace used about 125 MB of the allowance before the blob report copies
> - Large failed attempts went over the allowance, and then all of their
private evidence was lost
> - This pull request removes the `playwright-output/` copy only when
the HTML report holds the identical bytes
> - A second gap lost the whole merged campaign report of failed cells:
the report copied trace viewer font, SVG and manifest files to a place
where the trusted seal refuses them
> - This pull request stops that copy, and it names a refused report
carrier with a closed category
> - The benefit is that large failed attempts keep their evidence, the
merged report is kept, and the HTML report and its trace viewer still
open the trace
## Linked Issues or Issue Description
**What happened**
Failed chat evaluation attempts with large Playwright traces lost all of
their private evidence. The bundle went over the 256 MB private evidence
allowance. For example, the failed `tasks.organize-open-work` cell made
a 254 MB bundle. That bundle held the same 30.7 MB trace four times
(`playwright-output/.../trace.zip` and `html-report/data/<sha1>.zip`, in
both the original tree and the packaged tree), plus two blob report
copies. Larger traces went over the limit, and then the transfer refused
the whole bundle.
Also, the merged campaign report of a failed cell was refused with
`refusal: unsupported-packaged-evidence-carrier` (for example
`runs-adapters.inspect-failed-run`, run 42431162923). The cell's
evidence manifest lists its trace viewer files
`html-report/trace/codicon.*.ttf`, `playwright-logo.svg` and
`manifest.webmanifest`. `report.ts` copied them to
`normalized/evidence/<id>/attempt-1/html-report/trace/`. The
generated-report seal accepts trace viewer files only under
`html/trace/`, so it refused these three files and lost the whole
report. I reproduced this from the retained cell archive: a merge of its
blob report passes the seal rule, and the three normalized copies are
the only files that fail it.
**Expected behavior**
A failed attempt keeps its trace, and the trace uses as little of the
allowance as possible. The HTML report and the trace viewer still open
the trace for a person who downloads the bundle. The merged report of a
failed cell is kept. If the seal refuses a carrier, the refusal names
its category, not its path. No privacy, integrity or size check changes.
**Steps to reproduce**
1. Dispatch `runner-full-stack-e2e.yml` with `cadence=manual` for a
private chat case that fails with a large trace, for example
`chat-features.runner-opencode.local.tasks.organize-open-work`.
2. Download `manual-cell-<sha256(executionId)>.zip` from the private
history bucket.
3. List the archive. The trace bytes are in `playwright-output/` and in
`html-report/data/` in both `originals/` and `sealed-results/`.
4. For the report refusal: look at the "Retain complete manual merged
evidence only in restricted storage" step of the same run. It prints
`refusal: unsupported-packaged-evidence-carrier` and no
`manual-report.zip` is retained.
## What Changed
- Add `tests/runner-e2e/private-report-copies.ts` with
`dropDuplicatePlaywrightOutput`. It removes a `playwright-output/` file
only when `html-report/data/<sha1 of content><ext>` is a regular file
(not a symlink) with the same size and the same SHA-256. It writes the
removed paths, their kept paths and digests to
`snapshots/playwright-output-copies.json`.
- The function does nothing when the cell has a framework JSON report
(`framework-report.json` or `snapshots/playwright-framework.json`),
because that report registers `playwright-output/` attachments by path.
It also does nothing when `playwright-output`, `html-report` or
`html-report/data` is missing or is a symlink.
- Call it in the private manual branch of `tests/runner-e2e/launch.ts`,
before packaging and before both seals. Both evidence trees then keep
one HTML report copy of each trace and video.
- The HTML report, its trace viewer assets and the blob report do not
change.
- `tests/runner-e2e/report.ts` does not stage a cell file into
`normalized/evidence/` when its type is one the generated-report seal
refuses (the same `isStandardEvidenceFile("html-report/...")` rule). The
merged report has its own authenticated trace viewer under
`html/trace/`. The cell archive still keeps the files.
- `tests/runner-e2e/manual-private-transfer.ts` adds
`assertGeneratedReportCarriers`, which runs before the report seal. It
throws a fixed message per closed category (`font`, `svg`,
`webmanifest`, `image`, `source map`, `no extension`, `other`, `trace
viewer asset`, `trace viewer bytes`), so the refusal line names, for
example, `unsupported-generated-report-carrier-font`. It never names a
path, and the seal stays the authority.
- No change to the target-checked trusted files
(`manual-private-handoff.ts`, `manual-private-retention.ts`,
`manual-private-report-assets.ts`), so candidate branches do not need an
update. No change to the limits or the secret scans.
## Verification
- `vitest run --config tests/runner-e2e/vitest.config.ts
tests/runner-e2e/private-report-copies.test.ts
tests/runner-e2e/manual-private-cell-report-assets.test.ts
tests/runner-e2e/private-framework-report.test.ts
tests/runner-e2e/manual-private-handoff.test.ts`: 79 passed.
- The new tests use a real failed Playwright run with the HTML, JUnit
and blob reporters and a real retained trace. They show these things:
- Only the duplicate `playwright-output/` files are removed. The HTML
report and blob report bytes do not change.
- The deduplicated cell passes `packageEvidence`,
`sealStandardOriginalEvidence`, `sealManualResultEvidence`, the trusted
`validateSealedOriginals` and `validateSealedInventory`, the strict
archive pack and unpack, and `stageSealedPrivateCell`.
- A tampered or symlinked HTML report copy keeps the original file.
- Framework JSON cells and symlinked data directories are not changed.
- `vitest run --config tests/runner-e2e/vitest.config.ts manual-private
private-report private-refusal private-framework generated-report
report`: 25 files, 311 passed.
- `generated-report-carriers.test.ts` shows each refused carrier gets
its closed category code, the code has no path, and the real seal
refuses the same tree. `report.test.ts` shows the font, SVG and manifest
are not staged and the other files are.
- A new test runs the real launcher private branch from `launch.ts`. It
shows that the sealed originals keep one trace copy, in
`html-report/data/`.
- Live run: I applied the commit to a branch from
`chat-eval/master-candidate` (`chat-eval/case-evidence-dedupe`) and
dispatched
`chat-features.runner-opencode.local.tasks.organize-open-work` (run
42432263920). I will add the bundle size result in a comment.
## Risks
- Low risk. The change runs only in the private manual evidence branch.
It removes a file only after a full content comparison with the kept
copy. If a check fails, the file stays.
- A person who wants the trace must open `html-report/data/<sha1>.zip`
(the HTML report links to it), not `playwright-output/<test>/trace.zip`.
The receipt in `snapshots/playwright-output-copies.json` names the new
location.
- `report.ts` and `manual-private-transfer.ts` run from the master
checkout in the report job, so the report fix takes effect only after
merge. The normalized per-cell HTML report copy no longer has the viewer
font, logo and manifest. The merged report under `html/` and the cell
archive keep a complete viewer.
- The blob report still has a compressed copy of the trace, and the
bundle still holds the original and the packaged tree. A trace over
about 60 MB can still go over the allowance. This change does not fix
that case.
> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.
## Model Used
- Anthropic Claude Opus 5.5 (`claude-opus-5-5`), run in Claude Code with
tool use (shell, file editing, GitHub CLI and AWS CLI).
## 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>
148 lines
11 KiB
TypeScript
148 lines
11 KiB
TypeScript
import { afterAll, afterEach, beforeAll, expect, it } from "vitest";
|
|
import { execFile } from "node:child_process";
|
|
import { createHash } from "node:crypto";
|
|
import { createRequire } from "node:module";
|
|
import { cp, lstat, mkdir, mkdtemp, readdir, readFile, realpath, rm, symlink, writeFile } from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { promisify } from "node:util";
|
|
import { copySharedEvidence } from "./shared-evidence.js";
|
|
import { packageEvidence } from "./evidence.js";
|
|
import { sealManualResultEvidence, sealStandardOriginalEvidence, type ManualPrivateHandoff } from "./manual-private-handoff.js";
|
|
import { inspectCellReportProducer, privateCellEvidenceOwner, type CellReportProducerIdentity } from "./manual-private-report-assets.js";
|
|
import { stageSealedPrivateCell, validateSealedInventory, validateSealedOriginals } from "./manual-private-transfer.js";
|
|
import { MANUAL_PRIVATE_EXECUTIONS, MANUAL_PRIVATE_PROTOCOL, manualCellKind } from "./manual-private-retention.js";
|
|
import { archivePrivateEvidence } from "./private-history.js";
|
|
import { dropDuplicatePlaywrightOutput, PRIVATE_REPORT_COPIES_RECEIPT } from "./private-report-copies.js";
|
|
|
|
const sha1 = (value: Buffer) => createHash("sha1").update(value).digest("hex");
|
|
const roots: string[] = [];
|
|
const temporaryRoot = await realpath(os.tmpdir());
|
|
let reporter: string, producerRoot: string, producer: CellReportProducerIdentity;
|
|
|
|
async function files(root: string, relative = ""): Promise<string[]> {
|
|
const found: string[] = [];
|
|
for (const item of await readdir(path.join(root, relative), { withFileTypes: true })) {
|
|
const name = relative ? `${relative}/${item.name}` : item.name;
|
|
if (item.isDirectory()) found.push(...await files(root, name)); else found.push(name);
|
|
}
|
|
return found.sort();
|
|
}
|
|
async function bytesOf(root: string) {
|
|
let total = 0;
|
|
for (const name of await files(root)) total += (await lstat(path.join(root, name))).size;
|
|
return total;
|
|
}
|
|
|
|
beforeAll(async () => {
|
|
producerRoot = await mkdtemp(path.join(temporaryRoot, "synthetic-report-copies-"));
|
|
reporter = path.join(producerRoot, "reporter"); const tests = path.join(producerRoot, "node-tests");
|
|
await Promise.all([mkdir(reporter), mkdir(tests)]);
|
|
const require = createRequire(import.meta.url), pkg = require.resolve("@playwright/test/package.json"), entry = require.resolve("@playwright/test");
|
|
await writeFile(path.join(tests, "failure.spec.cjs"), `const {test,expect}=require(${JSON.stringify(entry)});test('synthetic retained failure',async({},info)=>{await info.attach('synthetic-video',{body:Buffer.from('synthetic video bytes'),contentType:'video/webm'});expect('actual wrong outcome').toBe('expected outcome');});`);
|
|
const config = path.join(tests, "isolated.config.cjs");
|
|
// The same reporter set as the private chat lane: HTML, JUnit and blob.
|
|
await writeFile(config, `module.exports=${JSON.stringify({ testDir: tests, testMatch: "failure.spec.cjs", workers: 1, outputDir: path.join(reporter, "playwright-output"), use: { trace: "retain-on-failure" }, reporter: [["html", { outputFolder: path.join(reporter, "html-report"), open: "never" }], ["junit", { outputFile: path.join(reporter, "junit.xml") }], ["blob", { outputDir: path.join(reporter, "blob-report") }]] })};`);
|
|
const failed = await promisify(execFile)(process.execPath, [path.join(path.dirname(pkg), "cli.js"), "test", "--config", config], { cwd: tests, timeout: 30_000, maxBuffer: 1024 * 1024, env: { PATH: process.env.PATH, CI: "1", NODE_OPTIONS: "", NODE_PATH: "", PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: "1" } }).then(() => false, error => { expect(error.code).toBe(1); return true; });
|
|
expect(failed).toBe(true);
|
|
producer = await inspectCellReportProducer();
|
|
}, 30_000);
|
|
afterEach(async () => { await Promise.all(roots.splice(0).map(root => rm(root, { recursive: true, force: true }))); });
|
|
afterAll(async () => { await rm(producerRoot, { recursive: true, force: true }); });
|
|
|
|
async function fixture() {
|
|
const root = await mkdtemp(path.join(temporaryRoot, "synthetic-private-copies-")); roots.push(root);
|
|
const id = MANUAL_PRIVATE_EXECUTIONS[0]!, cell = path.join(root, "capture/cases/activity.agent-feedback"); await mkdir(cell, { recursive: true });
|
|
await copySharedEvidence(reporter, cell, path.join(root, "controller"), []);
|
|
await writeFile(path.join(cell, "result.json"), '{"status":"failed","failureClass":"assertion"}');
|
|
const context = { root, private: true, protocol: MANUAL_PRIVATE_PROTOCOL, workflowSha: "a".repeat(40), targetSha: "b".repeat(40), runId: "123", attempt: "1", executionIds: [id], cellReportProducer: producer } as ManualPrivateHandoff;
|
|
const prefix = `gha-123-1-${id}/chat-features/runner-opencode/local/activity.agent-feedback/attempt-1`;
|
|
return { root, id, cell, context, prefix, upload: path.join(root, "results", prefix) };
|
|
}
|
|
async function traceOf(cell: string) {
|
|
const outputs = (await files(cell)).filter(name => /^playwright-output\/[^/]+\/trace\.zip$/.test(name));
|
|
expect(outputs).toHaveLength(1);
|
|
return { relative: outputs[0]!, bytes: await readFile(path.join(cell, outputs[0]!)) };
|
|
}
|
|
|
|
it("drops only playwright-output copies the HTML report already holds, leaving the HTML report and blob report unchanged", async () => {
|
|
const f = await fixture(), trace = await traceOf(f.cell);
|
|
const keptAt = `html-report/data/${sha1(trace.bytes)}.zip`;
|
|
expect(await readFile(path.join(f.cell, keptAt))).toEqual(trace.bytes);
|
|
const before = await files(f.cell), reports = before.filter(name => /^(?:html-report|blob-report)\//.test(name));
|
|
const reportBytes = await Promise.all(reports.map(name => readFile(path.join(f.cell, name))));
|
|
const dropped = await dropDuplicatePlaywrightOutput(f.cell);
|
|
expect(dropped.map(row => row.path)).toContain(trace.relative);
|
|
expect(dropped.find(row => row.path === trace.relative)).toMatchObject({ keptAt, bytes: trace.bytes.length });
|
|
// Every dropped file has its exact bytes at the recorded HTML report path.
|
|
for (const row of dropped) expect(sha1(await readFile(path.join(f.cell, row.keptAt)))).toBe(path.basename(row.keptAt, path.extname(row.keptAt)));
|
|
const after = await files(f.cell);
|
|
expect(after.filter(name => name.endsWith("trace.zip"))).toEqual([]);
|
|
expect(after).toContain(keptAt);
|
|
expect(await Promise.all(reports.map(name => readFile(path.join(f.cell, name))))).toEqual(reportBytes);
|
|
// Files the HTML report does not copy, such as the run bookkeeping, stay.
|
|
expect(after).toContain("playwright-output/.last-run.json");
|
|
expect(JSON.parse(await readFile(path.join(f.cell, PRIVATE_REPORT_COPIES_RECEIPT), "utf8")).dropped).toEqual(dropped);
|
|
});
|
|
|
|
it("keeps every validator accepting the deduplicated cell through package, both seals, trusted transfer, archive and report staging", async () => {
|
|
const f = await fixture(), trace = await traceOf(f.cell);
|
|
const keptAt = `html-report/data/${sha1(trace.bytes)}.zip`;
|
|
const originalBytes = await bytesOf(f.cell);
|
|
const dropped = await dropDuplicatePlaywrightOutput(f.cell);
|
|
const receiptBytes = (await lstat(path.join(f.cell, PRIVATE_REPORT_COPIES_RECEIPT))).size;
|
|
expect(originalBytes - await bytesOf(f.cell) + receiptBytes).toBe(dropped.reduce((sum, row) => sum + row.bytes, 0));
|
|
const owner = await privateCellEvidenceOwner(f.context, f.id);
|
|
const evidence = await packageEvidence({ privateDir: f.cell, uploadDir: f.upload, secrets: [], expectPassScreenshot: false, privateCell: { owner, layout: "original" } });
|
|
expect(evidence.leaks).toEqual([]);
|
|
const original = await sealStandardOriginalEvidence({ context: f.context, executionId: f.id, source: f.cell, evidence, secrets: [], expectPassScreenshot: false });
|
|
await sealManualResultEvidence(f.context, []);
|
|
const originalDir = path.join(f.root, "originals", manualCellKind(f.id)), finalDir = path.join(f.root, "sealed-results/html-report");
|
|
expect((await validateSealedOriginals(f.root, f.id, f.context)).inventorySha256).toBe(original.inventorySha256);
|
|
const final = await validateSealedInventory(finalDir, "../result-evidence-inventory.json", undefined, "standard", f.context);
|
|
for (const tree of [original.files.map((row: { path: string }) => row.path), final.files.map((row: { path: string }) => row.path.slice(f.prefix.length + 1))]) {
|
|
expect(tree).toContain(keptAt);
|
|
expect(tree).toContain(PRIVATE_REPORT_COPIES_RECEIPT);
|
|
expect(tree.filter((name: string) => name.endsWith("trace.zip"))).toEqual([]);
|
|
expect(tree.some((name: string) => /^blob-report\/.+\.zip$/.test(name))).toBe(true);
|
|
}
|
|
expect(await readFile(path.join(originalDir, keptAt))).toEqual(trace.bytes);
|
|
const bundle = path.join(f.root, "bundle"); await mkdir(bundle);
|
|
await cp(path.join(f.root, "originals"), path.join(bundle, "originals"), { recursive: true });
|
|
await cp(path.join(f.root, "sealed-results"), path.join(bundle, "sealed-results"), { recursive: true });
|
|
await writeFile(path.join(bundle, "identity.json"), JSON.stringify(f.context));
|
|
const zip = path.join(f.root, "retained.zip"), restored = path.join(f.root, "restored");
|
|
await archivePrivateEvidence("pack", bundle, zip); await archivePrivateEvidence("unpack", zip, restored);
|
|
const downloaded = { ...f.context, root: restored };
|
|
expect((await validateSealedOriginals(restored, f.id, downloaded)).complete).toBe(true);
|
|
const selected = path.join(f.root, "selected"); await mkdir(selected);
|
|
await stageSealedPrivateCell(restored, selected, f.id, downloaded);
|
|
const staged = path.join(selected, manualCellKind(f.id), f.prefix);
|
|
expect(await readFile(path.join(staged, keptAt))).toEqual(trace.bytes);
|
|
});
|
|
|
|
it("keeps the playwright-output file when the HTML report copy is missing, differs, or is not a regular file", async () => {
|
|
const f = await fixture(), trace = await traceOf(f.cell), keptAt = path.join(f.cell, `html-report/data/${sha1(trace.bytes)}.zip`);
|
|
const tampered = Buffer.from(trace.bytes); tampered[tampered.length - 1] ^= 1;
|
|
await writeFile(keptAt, tampered);
|
|
expect((await dropDuplicatePlaywrightOutput(f.cell)).map(row => row.path)).not.toContain(trace.relative);
|
|
expect(await readFile(path.join(f.cell, trace.relative))).toEqual(trace.bytes);
|
|
await rm(path.join(f.cell, PRIVATE_REPORT_COPIES_RECEIPT), { force: true });
|
|
await rm(keptAt); await symlink(path.join(f.cell, trace.relative), keptAt);
|
|
expect((await dropDuplicatePlaywrightOutput(f.cell)).map(row => row.path)).not.toContain(trace.relative);
|
|
expect(await readFile(path.join(f.cell, trace.relative))).toEqual(trace.bytes);
|
|
});
|
|
|
|
it("leaves trees alone when the HTML data directory is a symlink or the framework JSON reporter owns playwright-output", async () => {
|
|
const linked = await fixture(), data = path.join(linked.cell, "html-report/data"), moved = path.join(linked.root, "moved-data");
|
|
await cp(data, moved, { recursive: true }); await rm(data, { recursive: true }); await symlink(moved, data);
|
|
const linkedBefore = await files(linked.cell);
|
|
expect(await dropDuplicatePlaywrightOutput(linked.cell)).toEqual([]);
|
|
expect(await files(linked.cell)).toEqual(linkedBefore);
|
|
const framework = await fixture();
|
|
await writeFile(path.join(framework.cell, "framework-report.json"), "{}");
|
|
const frameworkBefore = await files(framework.cell);
|
|
expect(await dropDuplicatePlaywrightOutput(framework.cell)).toEqual([]);
|
|
expect(await files(framework.cell)).toEqual(frameworkBefore);
|
|
});
|