mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-28 12:04:41 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Paperclip Runner needs repeatable evaluation contracts. > - Evaluation code must stay separate from provider launch and production orchestration. > - Offline fixtures need stable compatibility, scoring, traceability, and report rules. > - Published Runner consumers need only the supported evaluation contract surface. > - This pull request adds offline evaluation tooling and a workspace-private matrix kernel. > - The benefit is deterministic evaluation without credentials or paid provider calls. ## Linked Issues or Issue Description Refs #11297 This pull request extracts the offline evaluation unit from the earlier aggregate Runner work. ## What Changed - Add a workspace-private, provider-neutral evaluation matrix kernel. - Add the public `@paperclipai/paperclip-runner/evals` compatibility and native execution contracts. - Add fail-closed runnerd artifact and protocol compatibility checks. - Add deterministic workflow catalogs, scoring, traceability, and report generation. - Add sanitized Codex, OpenCode, and ACPX fixtures. - Add package-boundary and clean-consumer checks. - Add the eval package manifest to the Docker dependency stage. - Add the generated protocol fixture digest without changing the lockfile. ## Verification GitHub Actions must run: - Runner TypeScript and Rust type checks. - Runner unit and protocol tests. - Evaluation kernel tests. - Workflow traceability checks. - Clean-consumer and package-boundary checks. - Repository test, type-check, build, policy, and security gates. No local test command was run. The repository owner requested GitHub-only verification. ## Risks This is a large greenfield review surface with 51 files. The code does not launch a live provider or load credentials. Package and protocol drift fail closed. The workspace lockfile remains under the existing CI-owned process. ## Model Used OpenAI Codex with the GPT-5 agent model. The work used high reasoning, repository inspection, tool use, and parallel code review. ## 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 - [ ] 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
91 lines
3.6 KiB
TypeScript
91 lines
3.6 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
|
|
import type { EvalBundle } from "./eval-bundle.js";
|
|
import type { EvalObservation } from "./eval-scoring.js";
|
|
import { buildEvalSliceReport, renderEvalSliceMarkdown } from "./eval-slice.js";
|
|
|
|
function bundle(): EvalBundle {
|
|
return {
|
|
schema: "paperclip.runner.eval-bundle.v1",
|
|
provider: { runtime: "runnerd", transport: "codex-app-server", protocolVersion: "prp.v1" },
|
|
model: { id: "gpt-5-codex" },
|
|
launchContext: { workingDirectoryClass: "ephemeral-fixture", scenarioId: "slice", turnTimeoutMs: 60_000 },
|
|
promptPolicy: { id: "exact-single-call", callTemplate: "Call {op}.", restraintTemplate: "No tools." },
|
|
grants: ["discovery:tasks:read"],
|
|
runner: { package: "@paperclipai/paperclip-runner", binary: "paperclip-runnerd", version: "0.0.0" },
|
|
controlPlaneAdapter: { kind: "mock", contract: "paperclip.capability.control-plane.v1" },
|
|
faultInjection: [],
|
|
};
|
|
}
|
|
|
|
const trace = { runId: "r", sessionId: "s", turnId: "t", itemId: "i", receiptIds: ["rc"], terminalPresent: true };
|
|
|
|
function green(caseId: string): EvalObservation {
|
|
return {
|
|
caseId,
|
|
controlPlaneOwned: false,
|
|
expectedCalls: ["finish_task"],
|
|
observedCalls: ["finish_task"],
|
|
forbiddenCalls: ["checkout_task"],
|
|
finalState: { expected: "mutated", observed: "mutated" },
|
|
authorization: { expected: "allowed", observed: "allowed" },
|
|
trace,
|
|
};
|
|
}
|
|
|
|
function gateFail(caseId: string): EvalObservation {
|
|
return { ...green(caseId), observedCalls: ["finish_task", "checkout_task"] };
|
|
}
|
|
|
|
describe("buildEvalSliceReport", () => {
|
|
it("aggregates scorecards and content-addresses the bundle", () => {
|
|
const report = buildEvalSliceReport(bundle(), [green("a"), gateFail("b")]);
|
|
expect(report.bundle.id).toMatch(/^evb-[0-9a-f]{16}$/);
|
|
expect(report.aggregate.caseCount).toBe(2);
|
|
expect(report.aggregate.passed).toBe(1);
|
|
expect(report.aggregate.gateFailures).toBe(1);
|
|
expect(report.aggregate.dimensionMeans.semantic_outcome).toBe(1);
|
|
// Every scorecard carries the report bundle id.
|
|
for (const entry of report.cases) expect(entry.scorecard.bundleId).toBe(report.bundle.id);
|
|
});
|
|
|
|
it("is deterministic", () => {
|
|
const a = buildEvalSliceReport(bundle(), [green("a")]);
|
|
const b = buildEvalSliceReport(bundle(), [green("a")]);
|
|
expect(JSON.stringify(a)).toBe(JSON.stringify(b));
|
|
});
|
|
|
|
it("refuses to build a report from a secret-carrying bundle", () => {
|
|
const leaky = { ...bundle(), grants: ["not-a-grant"] };
|
|
expect(() => buildEvalSliceReport(leaky, [green("a")])).toThrow();
|
|
});
|
|
|
|
it("does not persist free-form bundle declarations", () => {
|
|
const candidate = bundle();
|
|
candidate.promptPolicy.callTemplate = "Unique instructions that stay in memory.";
|
|
const report = buildEvalSliceReport(candidate, [green("a")]);
|
|
const serialized = JSON.stringify(report);
|
|
|
|
expect(report.bundle.declaration.promptPolicy.callTemplateSha256).toMatch(
|
|
/^sha256:[0-9a-f]{64}$/,
|
|
);
|
|
expect(serialized).not.toContain(candidate.promptPolicy.callTemplate);
|
|
});
|
|
|
|
it("scans the final serialized report before returning it", () => {
|
|
const observation = green("Bearer abcdef0123456789abcdef");
|
|
expect(() => buildEvalSliceReport(bundle(), [observation])).toThrow(/bearer-token/);
|
|
});
|
|
});
|
|
|
|
describe("renderEvalSliceMarkdown", () => {
|
|
it("renders an inspectable table with no secrets", () => {
|
|
const md = renderEvalSliceMarkdown(buildEvalSliceReport(bundle(), [green("a"), gateFail("b")]));
|
|
expect(md).toContain("Runner eval slice");
|
|
expect(md).toContain("| a |");
|
|
expect(md).toContain("| b |");
|
|
expect(md).toContain("FAIL");
|
|
expect(md).not.toContain("sk-");
|
|
});
|
|
});
|