mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 00:05:49 +02:00
## Thinking Path > - Paperclip is the open source app that people use to manage AI agents for work. > - Product E2E campaigns check user journeys across agent profiles and environments. > - Readers use the campaign history and reports to inspect results and retained evidence. > - The reports showed image summaries, many unselected suites, and a long sticky index. > - Individual case cards also showed routine diagnostics before the visual evidence. > - This pull request adds text summaries, feature filters, folding case indexes, and simpler cards. > - A local preview uses retained public data so designers can change reports without another paid campaign. ## Linked Issues or Issue Description **Current behavior** The report is hard to scan as the journey catalog grows. Suite links can point into hidden results. Case indexes do not show whether a case passed across its configurations. Design changes also need a realistic local preview. **Proposed behavior** Show the selected campaign as text. Link journeys to current feature-map capabilities. Add folding case indexes with status indicators, reliable section links, and a back-to-top control. Keep failed outcomes visible and put routine diagnostics under Test details. Render retained public campaign data with local templates. **Reason and benefit** Readers can find a feature or failed case faster. Designers can iterate against real retained data without starting an application instance or using provider credentials. **Breaking changes** No result schema or grading change. The report stops embedding the generated summary PNG. The publisher still produces that artifact for existing consumers. Related work: #12889 added the existing matrix browser. #12846 concerns the public image publication boundary. This PR changes report presentation and local preview behavior. ## What Changed - Replace image summaries with shared HTML suite summaries on the history and campaign pages. - Show selected executions and preserve missing results for selected cells. - Add explicit journey-to-capability associations, feature filters, and a coverage view with unmapped journeys. - Add folding case indexes, section case lists, and red, green, or amber status indicators across matching configurations. - Fix anchor navigation through filters and add a floating back-to-top control. - Simplify case cards. Keep failure reasons visible. Fold routine checks, billing, and context into Test details. - Add an original-image link to the gallery. - Add a local preview utility with public data caching and offline mode. Document the direct Node command. - Test manifest-listed evidence, rejection of unlisted files and encoded traversal, cache reuse, and offline misses with a real loopback server and a stub downloader. ## Verification - Focused report, history, and preview tests: 75 passed in 6 files. - Report Playwright spec: 4 passed in Chrome with a standalone config that does not start the application server. - `node scripts/check-maps.mjs`: passed. - `git diff --check`: passed. - Manually checked retained campaign reports, feature filters, folding indexes, failure links, card details, gallery links, mobile layout, and keyboard navigation. - `pnpm build`: passed. - `pnpm -r typecheck`: passed. - `pnpm test:e2e:runner:typecheck`: passed. - `pnpm test:run`: stopped after 15 native session database cases failed. The local Postgres package first lacked dynamic-library links. After link hydration, the same cases still failed. A direct `initdb` check then reported `could not create semaphores: No space left on device` and identified the macOS semaphore limit. The complete local suite has not passed. - `pnpm test:e2e:runner:unit`: 3,250 passed, 6 failed, 2 skipped. All six failures reproduced against unchanged `origin/master` report sources with the same installed dependencies. They concern Copilot admission and its Daytona image input, plus the launcher test that runs those assertions. No report or history test failed. - No live provider evaluation was run for this presentation change. - CI on `b1a9c06823` first failed browser shard 3/8. The agent-chat split-handoff test reached cleanup, where cancelling a run returned HTTP 500 from a Postgres deadlock. Cleanup did not restore the experiment setting, and a later test failed its initial setting check. This shard does not contain the report spec. One targeted rerun passed, and that full workflow then passed. This shows recovery; no production fix was made for the deadlock. The later preview-test commit requires its own fresh checks. To review the design, run `node --watch --import ./cli/node_modules/tsx/dist/loader.mjs tests/runner-e2e/preview.ts`. Open the history address printed by the command, then open a campaign. The README covers offline mode and cache refresh. ## Risks - Feature associations use the current map. They describe linked scenarios, not proof that a whole capability is covered. Historical grades remain unchanged. - New or unfamiliar cases remain unmapped until their assertions are inspected. - The preview needs the public history host on first access. Offline mode requires cached files. It binds to the loopback interface and serves manifest-listed public evidence. - Hiding routine diagnostics adds one disclosure step. Failed or incomplete outcomes remain visible. This is report polish. It does not duplicate planned core work in `ROADMAP.md`. ## Model Used OpenAI Codex, GPT-6 family, with reasoning, tool use, code execution, and browser automation. The exact serving model ID and context window are not exposed in this session. ## 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>
347 lines
12 KiB
TypeScript
347 lines
12 KiB
TypeScript
import { renderPublicCampaignSummary } from "./public-summary-image.js";
|
|
import { execFile } from "node:child_process";
|
|
import { promisify } from "node:util";
|
|
import { mkdtemp, mkdir, readFile, rm, writeFile } from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { afterEach, describe, expect, it } from "vitest";
|
|
import { runnerMatrix } from "./catalog.js";
|
|
import { discoverReportCatalog } from "./report-catalog.js";
|
|
import { buildRunnerCampaign } from "./history.js";
|
|
import { renderRunnerE2EDashboard } from "./dashboard.js";
|
|
import { regenerateRunnerDashboard } from "./dashboard-regenerate.js";
|
|
import { journeyCapabilities } from "./journey-features.js";
|
|
import type { RunnerE2EResult } from "./types.js";
|
|
|
|
const temporary: string[] = [];
|
|
afterEach(async () => {
|
|
await Promise.all(
|
|
temporary.splice(0).map((dir) => rm(dir, { recursive: true, force: true })),
|
|
);
|
|
});
|
|
const id = "branch-only-chat.branch-provider.local.conversation";
|
|
const missingId = "branch-only-chat.branch-provider.local.reset";
|
|
function result(): RunnerE2EResult {
|
|
return {
|
|
schema: "paperclip.runner-e2e.result/v2",
|
|
executionId: id,
|
|
suiteId: "branch-only-chat",
|
|
suiteDefinitionHash: "branch-definition",
|
|
profileId: "branch-provider",
|
|
environmentId: "local",
|
|
caseId: "conversation",
|
|
provider: '<img src=x onerror="alert(1)">',
|
|
model: "branch-model",
|
|
runtimeMode: "native",
|
|
attempt: 1,
|
|
status: "passed",
|
|
cleanup: "passed",
|
|
durationMs: 1000,
|
|
startedAt: "2026-09-11T21:00:00.000Z",
|
|
finishedAt: "2026-09-11T21:00:01.000Z",
|
|
screenshots: [
|
|
{
|
|
id: "final-state",
|
|
label: '<script>alert("label")</script>',
|
|
file: "final-state.png",
|
|
publication: "public-runner-fixture",
|
|
},
|
|
],
|
|
};
|
|
}
|
|
function campaign(results: RunnerE2EResult[] = [result()]) {
|
|
return buildRunnerCampaign({
|
|
campaignId: "branch-campaign",
|
|
generatedAt: "2026-09-11T21:01:00.000Z",
|
|
expected: [id, missingId],
|
|
results,
|
|
});
|
|
}
|
|
|
|
describe("trusted report catalog discovery", () => {
|
|
it("shows only the campaign selection while retaining a missing selected result", () => {
|
|
const known = runnerMatrix.find((execution) => execution.id === "core-compatibility.legacy-codex.local.ask-question")!;
|
|
const missing = runnerMatrix.find((execution) => execution.id === "core-compatibility.legacy-codex.local.message-marker")!;
|
|
const page = renderRunnerE2EDashboard({
|
|
title: "Narrow campaign", generatedAt: "2026-10-20T12:00:00Z",
|
|
expected: [known.id, missing.id], catalog: runnerMatrix,
|
|
entries: [{ result: { ...result(), executionId: known.id, suiteId: known.suite.id,
|
|
profileId: known.profile.id, environmentId: known.environment.id, caseId: known.task.id }, valid: true, errors: [] }],
|
|
});
|
|
expect(page).toContain(`data-execution-id="${known.id}"`);
|
|
expect(page).toContain(`data-execution-id="${missing.id}"`);
|
|
expect(page).toContain('class="case case-missing"');
|
|
expect(page).not.toContain('id="suite-first-task"');
|
|
expect(page).not.toContain('data-report-profile="runner-copilot"');
|
|
expect(page).not.toContain('class="suite-nav"');
|
|
expect(page.match(/data-report-case\s/g)).toHaveLength(2);
|
|
expect(page).toContain('data-report-features="questions-and-approvals"');
|
|
expect(page).toContain('title="questions-and-approvals/questions"');
|
|
expect(page).toContain("No mapped journey");
|
|
expect(page).toContain("0/1 passed · 1 missing");
|
|
});
|
|
|
|
it("leaves an unfamiliar journey unmapped even when its case name matches", () => {
|
|
const known = runnerMatrix.find((execution) => execution.id === "core-compatibility.legacy-codex.local.ask-question")!;
|
|
expect(journeyCapabilities(known).map((capability) => capability.id)).toEqual(["questions-and-approvals/questions"]);
|
|
expect(journeyCapabilities({ ...known, suite: { ...known.suite, id: "branch-only" } })).toEqual([]);
|
|
});
|
|
|
|
it("aggregates unknown suites and renders their cases, missing results, and screenshot gallery", () => {
|
|
const summary = campaign();
|
|
expect(summary.suites).toEqual([
|
|
expect.objectContaining({
|
|
suiteId: "branch-only-chat",
|
|
selected: 2,
|
|
executed: 1,
|
|
passed: 1,
|
|
failed: 1,
|
|
complete: false,
|
|
}),
|
|
]);
|
|
const page = renderRunnerE2EDashboard({
|
|
title: "Report",
|
|
generatedAt: summary.generatedAt,
|
|
expected: summary.expected,
|
|
catalog: [],
|
|
campaign: summary,
|
|
entries: [
|
|
{
|
|
result: result(),
|
|
valid: true,
|
|
errors: [],
|
|
evidenceBaseHref: `evidence/${id}/attempt-1`,
|
|
evidenceFiles: ["final-state.png"],
|
|
},
|
|
],
|
|
});
|
|
expect(page).toContain('id="suite-branch-only-chat"');
|
|
expect(page).toContain('class="suite-summary"');
|
|
expect(page).toContain(`data-execution-id="${id}"`);
|
|
expect(page).toContain(`data-execution-id="${missingId}"`);
|
|
expect(page).toContain('class="case case-missing"');
|
|
expect(page).toContain("No result artifact was uploaded");
|
|
expect(page).toContain(
|
|
`data-gallery-href="evidence/${id}/attempt-1/final-state.png"`,
|
|
);
|
|
expect(page).toContain("View gallery · 1");
|
|
expect(page).toContain("<img src=x onerror="alert(1)">");
|
|
expect(page).not.toContain("<img src=x");
|
|
expect(page).not.toContain('<script>alert("label")</script>');
|
|
});
|
|
|
|
it("renders selected branch suites in the public summary image without provider content", () => {
|
|
const page = renderPublicCampaignSummary(campaign());
|
|
expect(page).toContain("<strong>1/2</strong>");
|
|
expect(page).toContain("<span>branch-only-chat</span>");
|
|
expect(page).not.toContain("<strong>0/0</strong>");
|
|
expect(page).not.toContain("onerror");
|
|
expect(page).not.toContain("branch-model");
|
|
});
|
|
|
|
it("retains ordinary catalog metadata and marks no-results branch selections failed", () => {
|
|
const catalog = discoverReportCatalog({
|
|
catalog: runnerMatrix,
|
|
expected: [runnerMatrix[0]!.id],
|
|
results: [],
|
|
});
|
|
expect(catalog).toEqual(runnerMatrix);
|
|
expect(catalog[0]).toBe(runnerMatrix[0]);
|
|
expect(campaign([])).toMatchObject({
|
|
selected: 2,
|
|
executed: 0,
|
|
passed: 0,
|
|
failed: 2,
|
|
suites: [
|
|
expect.objectContaining({ suiteId: "branch-only-chat", failed: 2 }),
|
|
],
|
|
});
|
|
});
|
|
|
|
it("uses known profile metadata in a new suite and rejects forged identities", () => {
|
|
const known = runnerMatrix[0]!;
|
|
const knownProfileId = `branch-only-chat.${known.profile.id}.${known.environment.id}.conversation`;
|
|
expect(
|
|
discoverReportCatalog({
|
|
catalog: runnerMatrix,
|
|
expected: [knownProfileId],
|
|
results: [],
|
|
}).at(-1)?.profile,
|
|
).toBe(known.profile);
|
|
expect(() =>
|
|
discoverReportCatalog({
|
|
catalog: [],
|
|
expected: [id],
|
|
results: [{ ...result(), suiteId: "forged-suite" }],
|
|
}),
|
|
).toThrow("Result identity does not match");
|
|
expect(() =>
|
|
discoverReportCatalog({
|
|
catalog: [],
|
|
expected: ["../../private"],
|
|
results: [],
|
|
}),
|
|
).toThrow("Invalid report execution identity");
|
|
expect(() =>
|
|
discoverReportCatalog({ catalog: [], expected: [id, id], results: [] }),
|
|
).toThrow("must be unique");
|
|
});
|
|
|
|
it("regenerates branch-only cards and gallery from persisted JSON using trusted code", async () => {
|
|
const bundle = await mkdtemp(
|
|
path.join(os.tmpdir(), "branch-report-regenerate-"),
|
|
);
|
|
temporary.push(bundle);
|
|
const evidence = path.join(bundle, "evidence", id, "attempt-1");
|
|
await mkdir(evidence, { recursive: true });
|
|
await writeFile(path.join(evidence, "final-state.png"), "fixture");
|
|
await writeFile(
|
|
path.join(bundle, "normalized-results.json"),
|
|
JSON.stringify({ ...campaign(), suites: [] }),
|
|
);
|
|
await regenerateRunnerDashboard({ bundle, historyFile: null });
|
|
const page = await readFile(path.join(bundle, "index.html"), "utf8");
|
|
expect(page).toContain(`data-execution-id="${id}"`);
|
|
expect(page).toContain(`data-execution-id="${missingId}"`);
|
|
expect(page).toContain(
|
|
`data-gallery-href="evidence/${id}/attempt-1/final-state.png"`,
|
|
);
|
|
const normalized = JSON.parse(
|
|
await readFile(path.join(bundle, "normalized-results.json"), "utf8"),
|
|
);
|
|
expect(normalized.suites).toEqual([
|
|
expect.objectContaining({
|
|
suiteId: "branch-only-chat",
|
|
selected: 2,
|
|
passed: 1,
|
|
failed: 1,
|
|
}),
|
|
]);
|
|
});
|
|
|
|
it("generates an explicit failed result with the correct unknown identity when no artifact exists", async () => {
|
|
const root = await mkdtemp(
|
|
path.join(os.tmpdir(), "branch-report-missing-"),
|
|
);
|
|
temporary.push(root);
|
|
const out = path.join(root, "merged");
|
|
const repo = path.resolve(import.meta.dirname, "../..");
|
|
await promisify(execFile)(
|
|
process.execPath,
|
|
[
|
|
path.join(repo, "cli/node_modules/tsx/dist/cli.mjs"),
|
|
path.join(repo, "tests/runner-e2e/report.ts"),
|
|
],
|
|
{
|
|
cwd: repo,
|
|
env: {
|
|
...process.env,
|
|
PAPERCLIP_RUNNER_E2E_REPORT_ROOT: root,
|
|
PAPERCLIP_RUNNER_E2E_REPORT_OUT: out,
|
|
PAPERCLIP_RUNNER_E2E_EXPECTED_IDS: JSON.stringify([missingId]),
|
|
},
|
|
},
|
|
).catch((error: { code?: number }) => {
|
|
if (error.code !== 1) throw error;
|
|
});
|
|
const normalized = JSON.parse(
|
|
await readFile(path.join(out, "normalized-results.json"), "utf8"),
|
|
);
|
|
expect(normalized.results).toEqual([
|
|
expect.objectContaining({
|
|
executionId: missingId,
|
|
suiteId: "branch-only-chat",
|
|
profileId: "branch-provider",
|
|
caseId: "reset",
|
|
attempt: 0,
|
|
status: "failed",
|
|
}),
|
|
]);
|
|
expect(normalized.suites).toEqual([
|
|
expect.objectContaining({
|
|
suiteId: "branch-only-chat",
|
|
failed: 1,
|
|
executed: 0,
|
|
}),
|
|
]);
|
|
expect(await readFile(path.join(out, "index.html"), "utf8")).toContain(
|
|
`data-execution-id="${missingId}"`,
|
|
);
|
|
});
|
|
it.each([
|
|
"1/../../../escape",
|
|
"<img src=x onerror=alert(1)>",
|
|
-1,
|
|
1.5,
|
|
Infinity,
|
|
])("rejects malformed attempts before report staging: %s", (attempt) => {
|
|
expect(() =>
|
|
campaign([{ ...result(), attempt } as RunnerE2EResult]),
|
|
).toThrow("result.attempt");
|
|
});
|
|
|
|
it("validates nested timing and billing fields before rendering", () => {
|
|
const malicious = {
|
|
...result(),
|
|
turnTimings: [{ turn: "<script>alert(1)</script>" }],
|
|
} as unknown as RunnerE2EResult;
|
|
expect(() => campaign([malicious])).toThrow("result.turnTimings[0].turn");
|
|
const measured = campaign().results[0]!;
|
|
expect(() =>
|
|
campaign([
|
|
{
|
|
...measured,
|
|
billing: {
|
|
...measured.billing!,
|
|
llm: {
|
|
...measured.billing!.llm,
|
|
runCount: "<img>" as unknown as number,
|
|
},
|
|
},
|
|
},
|
|
]),
|
|
).toThrow("result.billing.llm.runCount");
|
|
});
|
|
|
|
it("does not certify a same-sized replacement matrix or changed suite definition", () => {
|
|
const known = runnerMatrix.filter(
|
|
(entry) => entry.suite.id === runnerMatrix[0]!.suite.id,
|
|
);
|
|
const receipts = known.map((entry) => ({
|
|
...result(),
|
|
executionId: entry.id,
|
|
suiteId: entry.suite.id,
|
|
suiteDefinitionHash: entry.suiteDefinitionHash,
|
|
profileId: entry.profile.id,
|
|
environmentId: entry.environment.id,
|
|
caseId: entry.task.id,
|
|
}));
|
|
const build = (results: RunnerE2EResult[]) =>
|
|
buildRunnerCampaign({
|
|
campaignId: "matrix-proof",
|
|
generatedAt: result().finishedAt,
|
|
expected: results.map((item) => item.executionId),
|
|
results,
|
|
});
|
|
expect(build(receipts).suites[0]!.complete).toBe(true);
|
|
const replacement = receipts.map((item, index) =>
|
|
index
|
|
? item
|
|
: {
|
|
...item,
|
|
caseId: "replacement",
|
|
executionId: item.executionId.replace(/[^.]+$/, "replacement"),
|
|
},
|
|
);
|
|
expect(build(replacement).suites[0]!.complete).toBe(false);
|
|
expect(
|
|
build(
|
|
receipts.map((item) => ({
|
|
...item,
|
|
suiteDefinitionHash: "different-definition",
|
|
})),
|
|
).suites[0]!.complete,
|
|
).toBe(false);
|
|
});
|
|
});
|