Jannik/PaperClipAI
1
0 Fork 0
mirror of https://github.com/paperclipai/paperclip.git synced 2026-10-06 10:48:12 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
0ea6b10967d43abec23062aa5ef0cb55dfed973d
PaperClipAI/packages/paperclip-runner/docs/tutorials/replay.md
T
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

3.8 KiB
Raw Blame History

Replay: Validate and Replay a PRP Fixture

What this phase is

Replay is a static replay path for a Paperclip Runner Protocol fixture. It uses the same reducer in the CLI and browser.

What this phase proves

This phase proves that Rust and TypeScript accept the same protocol data. It also proves that duplicate events do not change the result.

The tutorial validates one fixture. It reduces the events in the CLI. It then shows the same snapshot in the browser.

Prerequisites

  • Node.js 20 or newer
  • pnpm 9 or newer
  • a stable Rust toolchain with cargo
  • a Chromium-compatible browser

Start from a clean repository checkout and run every command from the repository root. Install only this workspace without writing the root lockfile:

pnpm install --filter @paperclipai/paperclip-runner --lockfile=false --ignore-scripts --dev
pnpm --filter @paperclipai/paperclip-runner exec playwright install chromium

On a minimal Linux host, Playwright may also request system browser libraries:

pnpm --filter @paperclipai/paperclip-runner exec playwright install-deps chromium

1. Check the contract and golden corpus

pnpm --filter @paperclipai/paperclip-runner typecheck
pnpm --filter @paperclipai/paperclip-runner check:replay-goldens
pnpm --filter @paperclipai/paperclip-runner check:replay-parity
pnpm --filter @paperclipai/paperclip-runner check:forbidden-imports

Expected: generated schema sources are current, TypeScript and Rust accept the same fixtures, all parity summaries match, and the standalone boundary passes.

2. Replay the happy path in the CLI

pnpm --filter @paperclipai/paperclip-runner replay:fixture

Expected JSON facts:

  • ok is true;
  • snapshot.integrity is complete;
  • snapshot.timeline contains 9 entries;
  • snapshot.terminal.runTerminalState is succeeded.

Pass a different fixture path to inspect another case:

pnpm --filter @paperclipai/paperclip-runner replay:fixture packages/paperclip-runner/protocol/fixtures/replay/source-gap.json

Expected: snapshot.integrity is gap_detected and the missing source sequence is 3.

An unsupported required version exits non-zero and returns a structured error:

pnpm --filter @paperclipai/paperclip-runner replay:fixture packages/paperclip-runner/protocol/fixtures/replay/unsupported-required-version.json

3. Open the standalone replay page

Start the package-local Vite server:

pnpm --filter @paperclipai/paperclip-runner browser:dev --host 127.0.0.1 --port 4179

Open http://127.0.0.1:4179, then:

  1. Select Happy path and confirm the terminal badge reads succeeded.
  2. Edit the fixture summary in the JSON textarea and select Validate & replay.
  3. Select Duplicate event and confirm one duplicate is ignored.
  4. Select Source sequence gap and confirm the missing sequence diagnostic.
  5. Select Unsupported required version and confirm replay is rejected.
  6. Expand Inspect snapshot JSON and compare it with the CLI output.

Stop Vite with Ctrl+C.

4. Run the browser regression path

pnpm --filter @paperclipai/paperclip-runner check:browser-tokens
pnpm --filter @paperclipai/paperclip-runner test:browser

Expected: the Playwright tests pass and temporary screenshots are written under the ignored packages/paperclip-runner/test-results/ directory. The regression suite does not rewrite committed evidence images.

What this proves

  • JSON Schema is the executable source for validation and TypeScript types.
  • The CLI and browser call the same validator and reducer.
  • Duplicate delivery is idempotent and sequence gaps remain visible.
  • Unknown optional fields do not change the v1 projection.
  • No Paperclip server, UI, CLI, adapter, or production database module starts or imports into the standalone path.

Local runner is outside this tutorial and must not start before the Replay human checkpoint.

Reference in new issue View Git Blame Copy Permalink