Files
PaperClipAI/tests/runner-e2e/eval-otlp-relay.test.ts
T
DottaandPaperclip 3bd709df8b Operationalize Product E2E accounting, tracing, and scheduling (#17009)
## Thinking Path

> - Paperclip manages agents and the work they perform.
> - Product E2E tests exercise real agents, tools, setup and cleanup.
> - Repeated runs need retained costs and traces, including failed
attempts.
> - A passing retry must not hide earlier spending or feedback.
> - Recurring work also needs admission limits, private reports and
failure detection.
> - This change supplies those controls while keeping paid activation
behind existing gates.

## Linked Issues or Issue Description

Refs #16996 and #17158. This is the consolidated landing of the reviewed
eval operations stack: #17019, #17024, #17025, #17027, #17030, #17033,
#17035, #17038, #17043, #17044, #17048, #17050, #17051, #17092, #17096,
#17100, #17107, #17109, #17112, #17115, #17117, #17121, #17123, #17127,
#17130, #17133, #17134, #17137, #17140, #17143, #17154. The repository
permits squash merges only. A local rehearsal showed that squashing each
slice into master causes repeated conflicts in dependent slices. This PR
preserves their commits and lands their combined implementation in one
reviewed integration. Superseded slices will close after this merge.

## What Changed

- Retain every attempt's cost receipt, including setup, failures,
interruptions and retries. Separate reported amounts, estimates, missing
costs and reserved capacity in reports and dashboards.
- Add bounded request admission, exact model pricecards, gateway error
accounting, cache policy and reconciliation evidence. Refuse unsupported
routes and requests that cannot fit the allowance.
- Integrate Braintrust gateway traces and OTLP correlation, with secret
filtering and experiment imports. Record phase timing, including setup,
feedback capture and cleanup.
- Collect complaint and suggestion evidence after each attempt,
including recovery after failures. Retain explicit review dispositions
independently from the product grade.
- Add gated daily and weekly selections, measured forecasts,
setup/readiness checks, wall-time limits and retained monitor
notifications. Include declared non-model overhead in admission while
reporting the existing subscription separately.
- Keep recurring history private, bound uploads and retention, and use
isolated archive environments. Keep public publication an explicit
operation. Report and publication jobs install only the committed
lockfile, with scripts disabled and isolated stores; stale pins fail
closed.
- Integrate current master, preserve its Product E2E journey billing and
privacy checks, and test that shared setup receipts do not double-count
estimated agent usage. Preserve upstream fixture repairs.

## Verification

- Complete integration baseline
`0649a5ce7544ab20825c2183d2f421157db49f24` includes master
`a3e1d915a7110a4e115b46396a3f79e6dfb4d05e` and every original stack head
as ancestors.
- On that integration baseline, `pnpm test:e2e:runner:unit`: 4,012
Vitest tests passed, two skipped, across 193 files; all 137 Node
source-contract tests passed.
- Focused billing and Product E2E journey contract checks: 24 tests
passed. They cover estimates, unknown receipts, single-owner setup
costs, browser-only execution and private publication guards.
- Monitor and workflow wiring: all 96 Node tests passed. `node
scripts/check-token-gates.mjs`: all gates clean.
- `pnpm test:e2e:runner:typecheck` passes after the standard Runner
TypeScript build refreshed local declarations. The first attempt
rejected the new master `runner_prepared_launch` union member because
this checkout retained an older generated declaration; the source union
already contained that member.
- Current head `492b0708a1c531a023d9ac10f0f3dc6383cc1754` removes
dependency re-resolution from archive-authorized reporting jobs after
the security scan flagged it. All 15 workflow-security tests pass after
updating the old two-install assertion.
- Hosted [CI run
39965460180](https://github.com/paperclipai/paperclip/actions/runs/39965460180)
passes on the current repaired head, including typecheck, build, general
tests, Runner checks, browser shards and canary dry run. Greptile is 5/5
on this exact head with no unresolved threads. The security scan passes
after the fixed lockfile-resolution thread was resolved.
- Paperclip Review returned a terminal neutral check but an incomplete
0-file assessment on the repaired head: its platform blocked both diff
responses as prompt-injection content. This is not a successful code
review. No bypass or fabricated pass was attempted; current-head
Greptile, security and hosted CI are independent gates.
- No paid test, reservation release or recurring-run activation
accompanies this landing. Live route qualification and invoice
reconciliation remain separate evidence.

<details>
<summary>Retained earlier validation failures</summary>

Earlier broad local runs had two 15-second test timeouts (CLI poll
cadence and Retry validation), one embedded-database setup timeout, and
later PostgreSQL semaphore exhaustion. The exact timed-out tests passed
separately without larger timeouts; the broad-run causes were not
established. Those local failures remain distinct from subsequent hosted
CI results. The independent #17158 fix records its Muse fixture
collision, its UUID correction and hosted verification. Local Muse
execution was also blocked by macOS embedded-PostgreSQL startup. No
historical failure is treated as a successful paid qualification.

</details>

## Risks

- Admission is a local control, not a provider invoice cap. Missing
provider receipts or resource charges retain unknown amounts and holds;
estimates do not become billed dollars.
- The bounded path admits only documented local suites and provider
routes. Ordinary legacy or separate Runner protocol campaigns have
different controls. Merging this code does not qualify additional
routes.
- Recurrence still needs the existing enable gates and current
qualification/allowance evidence. Archive permissions and resources must
match the documented private-environment contract.
- Legacy reports may lack complete attempt or phase evidence. Reports
preserve that limitation and do not infer zero usage from missing data.

## Model Used

OpenAI GPT-6 through Codex, with reasoning, repository tools and code
execution. The exact deployment variant and context-window size are not
exposed by 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 (targeted checks;
full-suite host limitation disclosed 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>
2026-10-23 07:18:37 -07:00

259 lines
17 KiB
TypeScript

import { afterEach, expect, it, vi } from "vitest";
import { mkdtemp, open, readFile, rm, stat } from "node:fs/promises";
import { createRequire } from "node:module";
import { tmpdir } from "node:os";
import path from "node:path";
import { createServer } from "node:http";
import { once } from "node:events";
import { gzipSync } from "node:zlib";
import { setTimeout as delay } from "node:timers/promises";
import { EVAL_OTLP_LIMITS, startEvalOtlpRelay } from "./eval-otlp-relay.js";
import { EvalAttemptTrace, exportBraintrustAttemptParent } from "./braintrust.js";
import { evalOtlpRejected, evalOtlpResponse } from "./eval-otlp-payload.js";
import { evalOtlpSchema } from "./eval-otlp-schema.js";
const projectId = "11111111-1111-4111-8111-111111111111", apiKey = "upstream-private-fixture";
const protobuf = createRequire(new URL("../../server/package.json", import.meta.url))("protobufjs") as typeof import("../../server/node_modules/protobufjs/index.js");
const message = (field: number, ...parts: Uint8Array[]) => Buffer.from(protobuf.Writer.create().uint32(field * 8 + 2).bytes(Buffer.concat(parts)).finish());
const roots: string[] = [], closers: Array<() => Promise<void>> = [];
afterEach(async () => { await Promise.allSettled(closers.splice(0).map(close => close()));
await Promise.all(roots.splice(0).map(root => rm(root, { recursive: true, force: true }))); vi.restoreAllMocks(); });
async function fixture(overrides: Partial<Parameters<typeof startEvalOtlpRelay>[0]> = {}) {
const root = await mkdtemp(path.join(tmpdir(), "eval-otlp-")); roots.push(root);
const policy = { projectId, apiKey, campaignId: "campaign", attemptId: "attempt", receiptPath: path.join(root, "receipts.jsonl"),
deadlineAt: Date.now() + 60_000, ...overrides };
const relay = await startEvalOtlpRelay(policy); closers.push(relay.close);
const send = (body = "{}", headers: Record<string, string> = {}, endpoint = "/v1/traces") => fetch(relay.baseUrl + endpoint, {
method: "POST", headers: { authorization: `Bearer ${relay.token}`, "content-type": "application/json", ...headers }, body,
});
const records = async () => (await readFile(policy.receiptPath, "utf8")).trim().split("\n").map(line => JSON.parse(line));
return { relay, policy, send, records };
}
it("forwards real attempt protobuf over HTTP using only the controller credential and retains body-free receipts", async () => {
const received: Array<{ authorization?: string; parent?: string; body: Buffer }> = [];
const server = createServer(async (req, res) => {
const chunks: Buffer[] = []; for await (const chunk of req) chunks.push(Buffer.from(chunk));
received.push({ authorization: req.headers.authorization, parent: req.headers["x-bt-parent"] as string, body: Buffer.concat(chunks) });
res.writeHead(200, { "content-type": "application/x-protobuf" }); res.end();
});
server.listen(0, "127.0.0.1"); await once(server, "listening");
closers.push(async () => { server.closeAllConnections(); await new Promise<void>(resolve => server.close(() => resolve())); });
const address = server.address(); if (!address || typeof address === "string") throw new Error("fixture_bind_failed");
const upstream = vi.fn<typeof fetch>((url, init) => {
expect(String(url)).toBe("https://api.braintrust.dev/otel/v1/traces");
expect(init?.redirect).toBe("error");
return fetch(`http://127.0.0.1:${address.port}`, init);
});
const f = await fixture({ transport: upstream });
const trace = new EvalAttemptTrace({ projectId, apiKey: f.relay.token, endpointBaseUrl: f.relay.baseUrl },
{ campaignId: "campaign", attemptId: "attempt", executionId: "fixture.local", provider: "fixture", model: "fixture", environment: "local" });
trace.phase("setup");
expect(await trace.export({ failed: false, runIds: [], cleanup: "passed", complaints: 0, suggestions: 0 })).toMatchObject({ status: "accepted" });
expect(received).toHaveLength(1);
expect(received[0]).toMatchObject({ authorization: `Bearer ${apiKey}`, parent: `project_id:${projectId}` });
expect(received[0]!.body.toString()).toContain("paperclip.eval.attempt");
expect(received[0]!.body.toString()).not.toContain(f.relay.token);
await f.relay.close();
const records = await f.records();
expect(records.map(row => row.type)).toEqual(["policy", "admitted", "outcome", "closed"]);
expect(records[2]).toMatchObject({ outcome: "accepted", dispatched: true, httpStatus: 200, rejectedRecords: 0 });
expect(records[3]).toMatchObject({ admittedRequests: 1, admittedBytes: received[0]!.body.length,
attemptedForwardBytes: received[0]!.body.length, acceptedRequests: 1, incompleteRequests: 0 });
expect(JSON.stringify(records)).not.toMatch(/upstream-private-fixture|paperclip.eval.attempt/);
expect((await stat(f.policy.receiptPath)).mode & 0o777).toBe(0o600);
await expect(startEvalOtlpRelay(f.policy)).rejects.toMatchObject({ code: "EEXIST" });
});
it("refuses token, endpoint, header and payload routing bypasses before contacting Braintrust", async () => {
const upstream = vi.fn<typeof fetch>(async () => new Response(null, { status: 200 }));
const f = await fixture({ transport: upstream });
expect((await f.send("{}", { authorization: `Bearer ${apiKey}` })).status).toBe(401);
expect((await f.send("{}", {}, "/../api/project")).status).toBe(404);
expect((await f.send("{}", {}, "/v1/traces?target=other")).status).toBe(404);
expect((await f.send("{}", { "x-bt-parent": "project_name:another" })).status).toBe(400);
for (const attributes of [
{ resourceSpans: [{ resource: { attributes: [{ key: "braintrust.parent", value: { stringValue: "project_id:22222222-2222-4222-8222-222222222222" } }] } }] },
{ resourceSpans: [{ scopeSpans: [{ spans: [{ attributes: [{ key: "braintrust.parent", value: { stringValue: "experiment_id:private" } }] }] }] }] },
]) expect((await f.send(JSON.stringify(attributes))).status).toBe(400);
expect(upstream).not.toHaveBeenCalled();
const parent = exportBraintrustAttemptParent({ projectId, spanId: "1234567890abcdef", traceId: "abcdef0123456789abcdef0123456789" });
expect((await f.send("{}", { "x-bt-parent": parent })).status).toBe(200);
expect(upstream.mock.calls[0]?.[1]?.headers).toMatchObject({ "x-bt-parent": parent });
});
it("counts decompressed payload bytes and refuses a compressed body above its allowance", async () => {
const upstream = vi.fn<typeof fetch>(async () => new Response(null, { status: 200 }));
const f = await fixture({ transport: upstream, limits: { ...EVAL_OTLP_LIMITS, maxRequestBytes: 1024 } });
const body = JSON.stringify({ resourceLogs: [{ resource: { attributes: [{ key: "test", value: { stringValue: "private-content-canary" } }] } }] });
const request = (bytes: Buffer) => fetch(f.relay.baseUrl + "/v1/logs", { method: "POST", body: Buffer.from(bytes),
headers: { authorization: `Bearer ${f.relay.token}`, "content-type": "application/json", "content-encoding": "gzip" } });
expect((await request(gzipSync(body))).status).toBe(200);
expect((await request(gzipSync(JSON.stringify({ payload: "x".repeat(2048) })))).status).toBe(400);
expect(upstream).toHaveBeenCalledTimes(1);
expect(Buffer.from(upstream.mock.calls[0]![1]!.body as Uint8Array).toString()).toBe(body);
const records = await f.records();
expect(records[1]).toMatchObject({ signal: "logs", bodyBytes: Buffer.byteLength(body), wireBytes: gzipSync(body).length });
expect(JSON.stringify(records)).not.toContain("private-content-canary");
});
it("rejects protobuf routing metadata and ambiguous singular fields before forwarding", async () => {
const upstream = vi.fn<typeof fetch>(async () => new Response(null, { status: 200 }));
const f = await fixture({ transport: upstream });
const attribute = message(1, Buffer.from("braintrust.parent"));
const foreign = message(2, message(1, Buffer.from("project_id:22222222-2222-4222-8222-222222222222")));
const local = message(2, message(1, Buffer.from(`project_id:${projectId}`)));
const resource = message(1, message(1, attribute, foreign));
const bodies = [
message(1, resource),
message(1, resource, message(1)),
message(1, message(1, message(1, attribute, foreign, local))),
message(1, message(2, message(2, message(9, attribute, foreign)))),
message(1, message(2, message(1, message(3, attribute, foreign)))),
];
for (const body of bodies) {
const response = await fetch(f.relay.baseUrl + "/v1/traces", { method: "POST", body: Buffer.from(body),
headers: { authorization: `Bearer ${f.relay.token}`, "content-type": "application/x-protobuf" } });
expect(response.status).toBe(400);
}
expect(upstream).not.toHaveBeenCalled();
});
it("canonicalizes duplicate JSON keys and refuses conflicting parent value aliases", async () => {
const upstream = vi.fn<typeof fetch>(async () => new Response(null, { status: 200 }));
const f = await fixture({ transport: upstream });
const foreign = "project_id:22222222-2222-4222-8222-222222222222";
const body = `{"resourceSpans":[{"resource":{"attributes":[{"key":"braintrust.parent","value":{"stringValue":"${foreign}","stringValue":"project_id:${projectId}"}}]}}]}`;
expect((await f.send(body)).status).toBe(200);
expect(Buffer.from(upstream.mock.calls[0]![1]!.body as Uint8Array).toString()).not.toContain(foreign);
const ambiguous = JSON.stringify({ resourceSpans: [{ resource: { attributes: [{ key: "braintrust.parent",
value: { stringValue: `project_id:${projectId}`, string_value: foreign } }] } }] });
expect((await f.send(ambiguous)).status).toBe(400);
expect(upstream).toHaveBeenCalledTimes(1);
});
it("does not dispatch when durable admission fails", async () => {
const upstream = vi.fn<typeof fetch>(async () => new Response(null, { status: 200 }));
const f = await fixture({ transport: upstream });
const handle = await open(path.join(path.dirname(f.policy.receiptPath), "fixture"), "w");
const sync = vi.spyOn(Object.getPrototypeOf(handle), "sync").mockRejectedValueOnce(new Error("fixture_disk_failure"));
try {
expect((await f.send()).status).toBe(503);
expect((await f.send()).status).toBe(503);
expect(upstream).not.toHaveBeenCalled();
await expect(f.relay.close()).rejects.toThrow("fixture_disk_failure");
} finally { sync.mockRestore(); await handle.close(); }
});
it("bounds simultaneous exports without retrying the refused request", async () => {
let entered!: () => void, release!: () => void;
const active = new Promise<void>(resolve => { entered = resolve; });
const wait = new Promise<void>(resolve => { release = resolve; });
const upstream = vi.fn<typeof fetch>(async () => { entered(); await wait; return new Response(null, { status: 200 }); });
const f = await fixture({ transport: upstream, limits: { ...EVAL_OTLP_LIMITS, maxConcurrent: 1 } });
const first = f.send(); await active;
try { expect((await f.send()).status).toBe(429); } finally { release(); }
expect((await first).status).toBe(200);
expect(upstream).toHaveBeenCalledTimes(1);
});
it.each(["count", "bytes"])("retains failed attempts against the %s allowance without retrying or resetting", async kind => {
const upstream = vi.fn<typeof fetch>(async () => new Response("private-vendor-error", { status: 503 }));
const f = await fixture({ transport: upstream, limits: { ...EVAL_OTLP_LIMITS,
...(kind === "count" ? { maxRequests: 1 } : { maxTotalBytes: 3 }) } });
const first = await f.send(); expect(first.status).toBe(502); expect(await first.text()).not.toContain("private-vendor-error");
expect((await f.send()).status).toBe(429);
expect((await f.send()).status).toBe(429);
expect(upstream).toHaveBeenCalledTimes(1);
await f.relay.close();
const records = await f.records();
expect(records.filter(row => row.type === "quota_exhausted")).toHaveLength(1);
expect(records.find(row => row.type === "outcome")).toMatchObject({ outcome: "rejected", httpStatus: 503 });
expect(records.at(-1)).toMatchObject({ admittedRequests: 1, admittedBytes: 2, incompleteRequests: 1 });
});
it.each(["traces", "logs"] as const)("preserves partial %s rejection without returning upstream diagnostic text", async signal => {
const upstream = vi.fn<typeof fetch>(async () => Response.json({ partialSuccess: {
[signal === "traces" ? "rejectedSpans" : "rejectedLogRecords"]: "2", errorMessage: "private-upstream-diagnostic" } }));
const f = await fixture({ transport: upstream });
const response = await f.send("{}", {}, `/v1/${signal}`);
expect(response.status).toBe(200);
const text = await response.text(); expect(text).not.toContain("private-upstream-diagnostic");
expect(evalOtlpRejected(Buffer.from(text), "application/json", signal)).toBe(2);
const protobuf = evalOtlpResponse(2, "application/x-protobuf", signal);
expect(evalOtlpRejected(protobuf, "application/x-protobuf", signal)).toBe(2);
expect((await f.records()).find(row => row.type === "outcome")).toMatchObject({ outcome: "partial", rejectedRecords: 2 });
});
it("aborts an in-flight export on close and retains its uncertain outcome", async () => {
let started!: () => void, aborted = false;
const active = new Promise<void>(resolve => { started = resolve; });
const upstream = vi.fn<typeof fetch>(async (_url, init) => {
started(); await new Promise<void>((_resolve, reject) => init!.signal!.addEventListener("abort", () => { aborted = true; reject(new Error("fixture_abort")); }, { once: true }));
return new Response(null, { status: 200 });
});
const f = await fixture({ transport: upstream });
const request = f.send().catch(() => undefined); await active;
await f.relay.close(); await request;
expect(aborted).toBe(true);
expect((await f.records()).find(row => row.type === "outcome")).toMatchObject({ outcome: "uncertain", dispatched: true });
await f.relay.close();
expect(upstream).toHaveBeenCalledTimes(1);
});
it("retires the listening endpoint at its deadline without a supervisor close", async () => {
const upstream = vi.fn<typeof fetch>(async () => new Response(null, { status: 200 }));
const f = await fixture({ transport: upstream, deadlineAt: Date.now() + 120 });
await delay(180);
await expect(f.send()).rejects.toThrow();
await f.relay.close();
expect(upstream).not.toHaveBeenCalled();
expect((await f.records()).at(-1)).toMatchObject({ type: "closed", admittedRequests: 0 });
});
it.each(["json", "protobuf"])("meters repeated resource/scope data and full record fields in %s before dispatch", async encoding => {
const upstream = vi.fn<typeof fetch>(async () => Response.json({}));
const f = await fixture({ transport: upstream, limits: { ...EVAL_OTLP_LIMITS, maxExpandedBytes: 40_000 } });
const payload = { resourceSpans: [{ resource: { attributes: [{ key: "shared", value: { stringValue: "r".repeat(3000) } }] },
scopeSpans: [{ scope: { name: "s".repeat(1000), version: "fixture" }, spans: Array.from({ length: 4 }, () => ({
name: "n".repeat(1000), traceId: "AQEBAQEBAQEBAQEBAQEBAQ==", spanId: "AgICAgICAgI=", flags: 1,
startTimeUnixNano: "1234567890123456789", endTimeUnixNano: "1234567890123456790",
events: [{ name: "e".repeat(1000), timeUnixNano: "1234567890123456789" }],
links: [{ traceId: "AwMDAwMDAwMDAwMDAwMDAw==", spanId: "BAQEBAQEBAQ=", flags: 1 }],
})) }] }] };
const type = evalOtlpSchema.lookupType("TracesData");
const body = encoding === "json" ? Buffer.from(JSON.stringify(payload)) : Buffer.from(type.encode(type.fromObject(payload)).finish());
const send = () => fetch(f.relay.baseUrl + "/v1/traces", { method: "POST", body: Buffer.from(body),
headers: { authorization: `Bearer ${f.relay.token}`, "content-type": encoding === "json" ? "application/json" : "application/x-protobuf" } });
expect(body.length).toBeLessThan(20_000);
expect((await send()).status).toBe(200);
expect((await send()).status).toBe(429);
expect(upstream).toHaveBeenCalledTimes(1);
expect(Buffer.from(upstream.mock.calls[0]![1]!.body as Uint8Array)).toEqual(body);
await f.relay.close();
const records = await f.records(), admitted = records.find(row => row.type === "admitted");
expect(admitted.recordCount).toBe(4);
expect(admitted.expandedBytes).toBeGreaterThan(35_000);
expect(records.at(-1)).toMatchObject({ admittedRecords: 4, admittedExpandedBytes: admitted.expandedBytes });
});
it("accepts thousands of small native records while bounding their total count", async () => {
const upstream = vi.fn<typeof fetch>(async () => Response.json({}));
const f = await fixture({ transport: upstream, limits: { ...EVAL_OTLP_LIMITS, maxRecords: 3000 } });
const body = JSON.stringify({ resource_logs: [{ scope_logs: [{ log_records: Array.from({ length: 2533 }, () => ({ body: { stringValue: "event" } })) }] }] });
expect((await f.send(body, {}, "/v1/logs")).status).toBe(200);
expect((await f.send(body, {}, "/v1/logs")).status).toBe(429);
expect(upstream).toHaveBeenCalledTimes(1);
expect((await f.records()).find(row => row.type === "admitted").recordCount).toBe(2533);
});
it("rejects unknown protobuf fields instead of excluding forwarded data from sizing", async () => {
const upstream = vi.fn<typeof fetch>(async () => Response.json({}));
const f = await fixture({ transport: upstream });
const body = message(1, message(2, message(2, message(100, Buffer.from("unknown-content")))));
const response = await fetch(f.relay.baseUrl + "/v1/traces", { method: "POST", body,
headers: { authorization: `Bearer ${f.relay.token}`, "content-type": "application/x-protobuf" } });
expect(response.status).toBe(400);
expect(upstream).not.toHaveBeenCalled();
});