mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 09:41:04 +01:00
Dotta
560e7e48b5
## 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
103 lines
3.1 KiB
Markdown
103 lines
3.1 KiB
Markdown
# Conformance: Run the Standalone Tracer
|
|
|
|
## What this phase is
|
|
|
|
Conformance is the smallest standalone runner path. It uses a mock control plane and does not start Paperclip.
|
|
|
|
## What this phase proves
|
|
|
|
This phase proves that the package has an independent Rust boundary. It also proves that Rust and TypeScript accept the same fixture.
|
|
|
|
You will install the package tools. You will compile the Rust and TypeScript code. You will run the tests and checks.
|
|
|
|
You will start the Rust mock core. The tracer validates one fixture and prints a deterministic result. The process then stops.
|
|
|
|
## Prerequisites
|
|
|
|
- repository checkout on the assigned runner branch;
|
|
- Node.js 20 or newer;
|
|
- pnpm 9 or newer;
|
|
- stable Rust with `cargo` on `PATH`;
|
|
- commands run from the repository root.
|
|
|
|
## 1. Install the package tools
|
|
|
|
```sh
|
|
pnpm install --filter @paperclipai/paperclip-runner --lockfile=false --offline --ignore-scripts --dev
|
|
```
|
|
|
|
`--lockfile=false` follows this repository's policy that automation owns the
|
|
root lockfile. `--offline` proves Conformance needs no newly downloaded package.
|
|
`--dev` makes the package tooling explicit even when the calling shell has
|
|
`NODE_ENV=production`.
|
|
|
|
## 2. Build the standalone package
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner build
|
|
```
|
|
|
|
Expected result: TypeScript writes package-local `dist/` files and Cargo builds
|
|
the `paperclip-runner-core` crate under `runner/target/`.
|
|
|
|
## 3. Run the behavior and boundary tests
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner test
|
|
pnpm --filter @paperclipai/paperclip-runner check:forbidden-imports
|
|
```
|
|
|
|
The tests cover fixture validation, complete Rust and TypeScript mock-core paths,
|
|
stable output, and negative TypeScript/Cargo core-dependency fixtures. The
|
|
standalone boundary check must print `Standalone boundary check passed.`
|
|
|
|
## 4. Validate the documentation
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner docs:validate
|
|
```
|
|
|
|
Expected result: documentation-link validation passes. The historical OKF and
|
|
recorded-evidence bundle is intentionally deferred from this release.
|
|
|
|
## 5. Run the tracer
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner trace:conformance
|
|
```
|
|
|
|
Expected final line:
|
|
|
|
```json
|
|
{"schemaVersion":"paperclip.runner.conformance.output.v1","runIdentity":{"runId":"run_conformance_0001","sessionId":"session_conformance_0001"},"result":{"status":"succeeded","summary":"Standalone Conformance fixture accepted."}}
|
|
```
|
|
|
|
The command exits successfully after the mock core stops. No service remains
|
|
|
|
The default tracer is Rust. Prove that the TypeScript reference produces the
|
|
same bytes with:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner check:conformance-parity
|
|
```
|
|
|
|
Expected result: `Rust and TypeScript Conformance tracer output matches the shared
|
|
golden fixture.`
|
|
|
|
## 6. Inspect the conformance fixture
|
|
|
|
```sh
|
|
sed -n '1,240p' packages/paperclip-runner/protocol/fixtures/conformance-minimal-run.json
|
|
```
|
|
|
|
## One-command rerun
|
|
|
|
After installation, the same checks can be repeated with:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner verify
|
|
```
|
|
|
|
Continue with the [cumulative end-to-end tutorial](end-to-end.md), which points
|
|
to this tutorial as the current complete path.
|