Files
Dotta 560e7e48b5 feat(runner): add SDK and developer tooling (#12608)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - The runner package already provides the production protocol and
execution spine.
> - Contributors still need stable SDK surfaces, deterministic test
tools, and local inspection tools.
> - Those surfaces share generated contracts and must change as one
package boundary.
> - This pull request adds the package-local SDK, labs, examples, and
drift checks.
> - The benefit is a reviewable developer platform that does not change
application execution selection.

## Linked Issues or Issue Description

**Subsystem affected**

`packages/paperclip-runner` — runner SDK, conformance tools, and
developer tooling.

**Problem or motivation**

The production runner spine is present, but package consumers cannot
build deterministic integrations, inspect sessions, or verify
provider-neutral behavior through supported surfaces.

**Proposed solution**

Add browser, React, standalone, live-session, scenario, conformance, and
evaluation surfaces. Add generated contract inventories and
package-local verification scripts. Keep production application routing
unchanged.

**Alternatives considered**

We considered splitting each generated catalog, SDK surface, and demo
into separate pull requests. Those changes share exports, fixtures, and
drift gates. Splitting them would create intermediate package states
that do not build.

**Roadmap alignment**

No overlapping item appears in `ROADMAP.md`. This work extends the
runner package that is already on `master`.

## What Changed

- Add browser, React, standalone, live-session, and issue-thread SDK
surfaces.
- Add deterministic mock control-plane, scenario, conformance, replay,
and evaluation tools.
- Add bounded Codex, OpenCode, and ACPX development transports and
fixtures.
- Keep deferred managed-provider execution fail-closed. Persisted
compatibility data remains readable.
- Add generated capability inventories with their source files and drift
checks.
- Add examples, package documentation, browser checks, and
clean-consumer checks.
- Preserve the reviewed protocol bounds, replay compatibility aliases,
process environment isolation, and semantic redaction limits.
- Update the ACPX package patch that the existing workspace patch
registry already tracks.
- Do not change `pnpm-lock.yaml`, repository workflows, server runtime
selection, or the application UI.

## Verification

GitHub Actions is the verification authority for this pull request. The
repository CI, package TypeScript and Rust checks, package tests,
generated-output drift checks, browser checks, security scans, and
Greptile review must pass on the exact head.

Local test suites were not run because this series uses parallel GitHub
Actions for verification.

## Risks

This is a large greenfield package change. The main risks are public
export drift, generated-output drift, and optional React consumer
compatibility. Package boundary checks, clean-consumer checks, and
browser tests cover those risks. Production adapter selection and server
execution are outside this pull request.

## Stack

1. **This PR:** runner SDK and developer tooling.
2. [Codex production server
integration](https://github.com/paperclipai/paperclip/pull/12616).
3. [Provider-neutral task-thread
UI](https://github.com/paperclipai/paperclip/pull/12617).

## Model Used

OpenAI Codex, GPT-5, high-reasoning mode, 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 described the issue in-PR following the feature request
template
- [x] I have not referenced internal/instance-local Paperclip issues or
links
- [x] My branch name describes the change and contains no internal
Paperclip ticket id
- [ ] 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 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
2026-08-31 21:33:11 -05:00

643 lines
21 KiB
TypeScript

import { useMemo, useRef, useState } from "react";
import type { PrpEvent, PrpRequest } from "../../../src/protocol/replay-contract";
import type { SessionSnapshot } from "../../../src/reducer/session-reducer";
import type {
LocalRunnerRunMetadata,
LocalRunnerRunTrace,
LocalRunnerScenario,
} from "../../../src/contracts/local-runner";
import {
applyLocalRunnerLiveEvent,
createLocalRunnerLiveSnapshot,
localRunnerSnapshotsMatch,
replayLocalRunnerEvents,
} from "../../../src/tracer/local-runner-live";
import { replayReplayFixtureText } from "../../../src/tracer/replay";
import { Badge } from "./components/ui/badge";
import { Button } from "./components/ui/button";
import {
Card,
CardContent,
CardDescription,
CardHeader,
CardTitle,
} from "./components/ui/card";
import { Textarea } from "./components/ui/textarea";
import { LiveConsole } from "./live/LiveConsole";
const fixtureFiles = import.meta.glob(
"../../../protocol/fixtures/replay/*.json",
{ eager: true, query: "?raw", import: "default" },
) as Record<string, string>;
const fixtureOrder = [
"happy-path",
"failed-run",
"interrupted-run",
"duplicate-event",
"source-gap",
"unknown-optional-fields",
"unsupported-required-version",
];
const liveScenarios: Array<{ key: LocalRunnerScenario; label: string }> = [
{ key: "happy-path", label: "Happy path" },
{ key: "permission-input", label: "Permission and input" },
{ key: "interrupted", label: "Interruption" },
{ key: "error", label: "Scripted error" },
{ key: "duplicate-terminal", label: "Duplicate terminal guard" },
];
type BrowserMode = "console" | "live" | "replay";
type LiveStatus = "idle" | "starting" | "running" | "terminal" | "error";
const modeCopy: Record<
BrowserMode,
{ eyebrow: string; title: string; description: string }
> = {
console: {
eyebrow: "Paperclip Runner Protocol · Live console",
title: "Live Codex protocol console",
description:
"Chat with a live session, steer it, stop it, answer its requests, and inspect the canonical protocol behind every surface.",
},
live: {
eyebrow: "Paperclip Runner Protocol · Local runner",
title: "Live runner diagnostics",
description:
"Run the local harness, stream validated events, and compare the live and replayed state.",
},
replay: {
eyebrow: "Paperclip Runner Protocol · Replay",
title: "Static protocol replay",
description:
"Validate a protocol fixture, replay its events, and inspect the resulting session state.",
},
};
interface BrowserFixture {
key: string;
label: string;
source: string;
}
type LocalRunnerStreamRecord =
| { kind: "event"; event: unknown }
| { kind: "diagnostic"; message: string }
| { kind: "trace"; trace: LocalRunnerRunTrace }
| { kind: "error"; message: string };
const browserFixtures = Object.entries(fixtureFiles)
.map(([path, source]): BrowserFixture => {
const key = path.split("/").at(-1)?.replace(/\.json$/, "") ?? path;
const parsed = JSON.parse(source) as { name?: string };
return { key, label: parsed.name ?? key, source };
})
.sort((left, right) => fixtureOrder.indexOf(left.key) - fixtureOrder.indexOf(right.key));
function terminalTone(snapshot: SessionSnapshot) {
if (snapshot.integrity === "gap_detected") {
return "warning" as const;
}
if (snapshot.terminal?.runTerminalState === "succeeded") {
return "success" as const;
}
if (snapshot.terminal?.runTerminalState === "failed") {
return "danger" as const;
}
return "neutral" as const;
}
function humanizeProtocolLabel(value: string): string {
const words = value.replaceAll(/[_-]/g, " ");
return words.length === 0 ? words : `${words[0]?.toUpperCase()}${words.slice(1)}`;
}
function liveStatusTone(status: LiveStatus, snapshot: SessionSnapshot | null) {
if (status === "error") {
return "danger" as const;
}
if (status !== "terminal") {
return "neutral" as const;
}
if (snapshot?.terminal?.runTerminalState === "succeeded") {
return "success" as const;
}
if (snapshot?.terminal?.runTerminalState === "failed") {
return "danger" as const;
}
return "neutral" as const;
}
function SnapshotSummary({
snapshot,
label = "Session snapshot",
}: {
snapshot: SessionSnapshot;
label?: string;
}) {
return (
<>
<div className="snapshot-heading">
<div>
<p className="eyebrow">{label}</p>
<h2>{snapshot.fixtureName}</h2>
</div>
<Badge tone={terminalTone(snapshot)} data-testid="terminal-badge">
{humanizeProtocolLabel(
snapshot.integrity === "gap_detected"
? "Gap detected"
: (snapshot.terminal?.runTerminalState ?? snapshot.runPhase),
)}
</Badge>
</div>
<dl className="snapshot-grid">
<div>
<dt>Run</dt>
<dd>{snapshot.identity.runId}</dd>
</div>
<div>
<dt>Session</dt>
<dd>{snapshot.identity.normalizedSessionId}</dd>
</div>
<div>
<dt>Turn</dt>
<dd>{snapshot.terminal?.turnTerminalState ?? snapshot.turnState}</dd>
</div>
<div>
<dt>Events</dt>
<dd>{snapshot.timeline.length}</dd>
</div>
</dl>
{snapshot.proposedResult ? (
<div className="result-summary" data-testid="result-summary">
<span>
Reported {humanizeProtocolLabel(snapshot.proposedResult.reportedWorkDisposition)}
</span>
<p>{snapshot.proposedResult.summary}</p>
</div>
) : null}
{snapshot.gaps.length > 0 ? (
<div className="diagnostic" role="status">
Missing source sequence {snapshot.gaps.flatMap((gap) => gap.missing).join(", ")}.
Replay remains inspectable but is not complete.
</div>
) : null}
<div className="timeline-heading">
<h3>Ordered timeline</h3>
<span>{snapshot.duplicateEventIds.length} duplicate events ignored</span>
</div>
<ol className="timeline" data-testid="timeline">
{snapshot.timeline.map((event) => (
<li key={event.sourceEventId}>
<span className="sequence" aria-hidden="true">
{event.sourceSeq}
</span>
<div>
<div className="timeline-title">
<code>{event.eventType}</code>
<time dateTime={event.emittedAt}>{event.emittedAt.slice(11, 23)}</time>
</div>
<p>{event.summary}</p>
</div>
</li>
))}
</ol>
<details className="snapshot-json">
<summary>Inspect snapshot JSON</summary>
<pre>{JSON.stringify(snapshot, null, 2)}</pre>
</details>
</>
);
}
function pendingRuntimeRequest(events: readonly PrpEvent[]): PrpRequest | null {
const resolved = new Set(
events
.filter((event) => event.eventType === "runtime_request.resolved")
.map((event) => (event.payload as Record<string, unknown>).requestId)
.filter((value): value is string => typeof value === "string"),
);
for (const event of events.toReversed()) {
if (event.eventType !== "runtime_request.created") {
continue;
}
const request = (event.payload as Record<string, unknown>).request;
if (
typeof request === "object" &&
request !== null &&
"requestId" in request &&
typeof request.requestId === "string" &&
!resolved.has(request.requestId)
) {
return request as PrpRequest;
}
}
return null;
}
function LiveRunner() {
const [scenario, setScenario] = useState<LocalRunnerScenario>("happy-path");
const [status, setStatus] = useState<LiveStatus>("idle");
const [runId, setRunId] = useState<string | null>(null);
const [snapshot, setSnapshot] = useState<SessionSnapshot | null>(null);
const [events, setEvents] = useState<PrpEvent[]>([]);
const [error, setError] = useState<string | null>(null);
const [diagnostic, setDiagnostic] = useState<string | null>(null);
const [input, setInput] = useState("local-runner-live-trace");
const [trace, setTrace] = useState<LocalRunnerRunTrace | null>(null);
const [parity, setParity] = useState<boolean | null>(null);
const snapshotRef = useRef<SessionSnapshot | null>(null);
const eventsRef = useRef<PrpEvent[]>([]);
const request = useMemo(() => pendingRuntimeRequest(events), [events]);
async function startRun() {
setStatus("starting");
setError(null);
setDiagnostic(null);
setTrace(null);
setParity(null);
setRunId(null);
setEvents([]);
eventsRef.current = [];
setSnapshot(null);
snapshotRef.current = null;
try {
const startResponse = await fetch("/api/localRunner/runs", {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({ scenario }),
});
const started = (await startResponse.json()) as {
id?: string;
metadata?: LocalRunnerRunMetadata;
error?: string;
};
if (!startResponse.ok || started.id === undefined || started.metadata === undefined) {
throw new Error(started.error ?? "The local runner did not start.");
}
setRunId(started.id);
const initial = createLocalRunnerLiveSnapshot(started.metadata);
setSnapshot(initial);
snapshotRef.current = initial;
setStatus("running");
const streamResponse = await fetch(`/api/localRunner/runs/${started.id}/events`);
if (!streamResponse.ok || streamResponse.body === null) {
throw new Error("The live event stream did not open.");
}
const reader = streamResponse.body.getReader();
const decoder = new TextDecoder();
let buffered = "";
while (true) {
const part = await reader.read();
buffered += decoder.decode(part.value, { stream: !part.done });
const lines = buffered.split("\n");
buffered = lines.pop() ?? "";
for (const line of lines) {
if (line.trim().length > 0) {
handleRecord(JSON.parse(line) as LocalRunnerStreamRecord, started.metadata);
}
}
if (part.done) {
if (buffered.trim().length > 0) {
handleRecord(JSON.parse(buffered) as LocalRunnerStreamRecord, started.metadata);
}
break;
}
}
} catch (cause) {
setStatus("error");
setError(cause instanceof Error ? cause.message : String(cause));
}
}
function handleRecord(record: LocalRunnerStreamRecord, metadata: LocalRunnerRunMetadata) {
if (record.kind === "event") {
const current = snapshotRef.current;
if (current === null) {
return;
}
const applied = applyLocalRunnerLiveEvent(current, record.event);
if (!applied.ok) {
setStatus("error");
setError(applied.issues.join("; "));
return;
}
snapshotRef.current = applied.snapshot;
setSnapshot(applied.snapshot);
eventsRef.current = [...eventsRef.current, applied.event];
setEvents(eventsRef.current);
return;
}
if (record.kind === "diagnostic") {
setDiagnostic(record.message);
return;
}
if (record.kind === "error") {
setStatus("error");
setError(record.message);
return;
}
setTrace(record.trace);
const replay = replayLocalRunnerEvents(metadata, record.trace.events);
setParity(
snapshotRef.current === null
? false
: localRunnerSnapshotsMatch(snapshotRef.current, replay),
);
setStatus("terminal");
}
async function postAction(action: "interrupt" | "resolve", body?: unknown) {
if (runId === null) {
return;
}
const response = await fetch(`/api/localRunner/runs/${runId}/${action}`, {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify(body ?? {}),
});
if (!response.ok) {
const failure = (await response.json()) as { error?: string };
setError(failure.error ?? `The ${action} command failed.`);
setStatus("error");
}
}
return (
<div className="workspace-grid live-workspace">
<Card aria-labelledby="live-controls-title">
<CardHeader>
<CardTitle id="live-controls-title">Local runner controls</CardTitle>
<CardDescription>
Start one Rust runner and one scripted fake harness. No network or model is used.
</CardDescription>
</CardHeader>
<CardContent className="editor-content">
<label htmlFor="live-scenario">Scenario</label>
<select
id="live-scenario"
value={scenario}
disabled={status === "starting" || status === "running"}
onChange={(event) => setScenario(event.target.value as LocalRunnerScenario)}
>
{liveScenarios.map((candidate) => (
<option key={candidate.key} value={candidate.key}>
{candidate.label}
</option>
))}
</select>
<div className="scenario-actions">
<Button
type="button"
disabled={status === "starting" || status === "running"}
onClick={() => void startRun()}
>
{status === "starting" ? "Starting…" : "Start local run"}
</Button>
<Button
type="button"
disabled={status !== "running" || snapshot?.turnState !== "running"}
onClick={() => void postAction("interrupt")}
>
Interrupt turn
</Button>
</div>
<div className="live-status" aria-live="polite">
<span>Runner status</span>
<Badge
tone={liveStatusTone(status, snapshot)}
data-testid="live-status"
>
{humanizeProtocolLabel(status)}
</Badge>
</div>
{request?.requestKind === "runtime" ? (
<div className="request-card" data-testid="runtime-request">
<div>
<p className="eyebrow">{request.type} request</p>
<p>{request.prompt}</p>
</div>
{request.type === "permission" ? (
<Button
type="button"
onClick={() =>
void postAction("resolve", {
requestId: request.requestId,
response: { decision: "allow" },
})
}
>
Allow
</Button>
) : (
<>
<label htmlFor="runtime-input">Response</label>
<input
id="runtime-input"
value={input}
onChange={(event) => setInput(event.target.value)}
/>
<Button
type="button"
disabled={input.trim().length === 0}
onClick={() =>
void postAction("resolve", {
requestId: request.requestId,
response: { text: input },
})
}
>
Send input
</Button>
</>
)}
</div>
) : null}
{trace?.harnessProcessExit ? (
<dl className="process-facts" data-testid="process-facts">
<div>
<dt>Harness process exit</dt>
<dd>{trace.harnessProcessExit.exitCode ?? "signal"}</dd>
</div>
<div>
<dt>Semantic result</dt>
<dd>{trace.result?.reportedWorkDisposition ?? "missing"}</dd>
</div>
</dl>
) : null}
{parity !== null ? (
<div className="parity-line" data-testid="parity-result">
<span>Live and replay reducer output</span>
<Badge tone={parity ? "success" : "danger"}>
{parity ? "Match" : "Mismatch"}
</Badge>
</div>
) : null}
{diagnostic ? <p className="diagnostic">{diagnostic}</p> : null}
{error ? <p className="validation-errors" role="alert">{error}</p> : null}
</CardContent>
</Card>
<section className="replay-panel" aria-live="polite">
{snapshot ? (
<SnapshotSummary snapshot={snapshot} label="Validated live snapshot" />
) : (
<div className="empty-live-state">
<p className="eyebrow">Validated live snapshot</p>
<h2>Start a local run</h2>
<p>Each incoming event will pass the Replay validator before the reducer applies it.</p>
</div>
)}
</section>
</div>
);
}
function StaticReplay() {
const defaultFixture = browserFixtures[0];
if (defaultFixture === undefined) {
throw new Error("No Replay fixtures were bundled");
}
const [selectedFixture, setSelectedFixture] = useState(defaultFixture.key);
const [source, setSource] = useState(defaultFixture.source);
const [replay, setReplay] = useState(() => replayReplayFixtureText(defaultFixture.source));
const selected = useMemo(
() => browserFixtures.find((fixture) => fixture.key === selectedFixture),
[selectedFixture],
);
function chooseFixture(key: string) {
const fixture = browserFixtures.find((candidate) => candidate.key === key);
if (fixture === undefined) {
return;
}
setSelectedFixture(key);
setSource(fixture.source);
setReplay(replayReplayFixtureText(fixture.source));
}
return (
<div className="workspace-grid">
<Card aria-labelledby="fixture-editor-title">
<CardHeader>
<CardTitle id="fixture-editor-title">Fixture input</CardTitle>
<CardDescription>
Choose a conformance case or edit the JSON, then validate and replay it.
</CardDescription>
</CardHeader>
<CardContent className="editor-content">
<label htmlFor="fixture-select">Fixture</label>
<select
id="fixture-select"
value={selectedFixture}
onChange={(event) => chooseFixture(event.target.value)}
>
{browserFixtures.map((fixture) => (
<option key={fixture.key} value={fixture.key}>
{fixture.label}
</option>
))}
</select>
<label htmlFor="fixture-source">PRP JSON</label>
<Textarea
id="fixture-source"
spellCheck={false}
value={source}
onChange={(event) => setSource(event.target.value)}
/>
<div className="editor-actions">
<span>{selected?.label ?? "Edited fixture"}</span>
<Button type="button" onClick={() => setReplay(replayReplayFixtureText(source))}>
Validate &amp; replay
</Button>
</div>
</CardContent>
</Card>
<section className="replay-panel" aria-live="polite">
{replay.ok ? (
<SnapshotSummary snapshot={replay.snapshot} label="Static replay snapshot" />
) : (
<div className="validation-errors" role="alert">
<Badge tone="danger">Validation failed</Badge>
<h2>Fixture cannot be replayed</h2>
<ul>
{replay.issues.map((issue, index) => (
<li key={`${issue.path}-${index}`}>
<code>{issue.path}</code> — {issue.message}
</li>
))}
</ul>
</div>
)}
</section>
</div>
);
}
export function App() {
// Replay-3 surfaces keep their landing mode: their screenshots are frozen
// QA evidence and their specs open on the Local runner runner.
const [mode, setMode] = useState<BrowserMode>("live");
const header = modeCopy[mode];
return (
<main className="app-shell">
<header className="page-header">
<div>
<p className="eyebrow">{header.eyebrow}</p>
<h1>{header.title}</h1>
<p>{header.description}</p>
</div>
<Badge tone="neutral">Standalone · no Paperclip core</Badge>
</header>
<nav className="mode-switch" aria-label="Runner devtool mode">
<Button
type="button"
aria-pressed={mode === "console"}
onClick={() => setMode("console")}
>
Live console
</Button>
<Button
type="button"
aria-pressed={mode === "live"}
onClick={() => setMode("live")}
>
Live runner
</Button>
<Button
type="button"
aria-pressed={mode === "replay"}
onClick={() => setMode("replay")}
>
Static replay
</Button>
</nav>
{mode === "console" ? (
<LiveConsole />
) : mode === "live" ? (
<LiveRunner />
) : (
<StaticReplay />
)}
</main>
);
}