mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-28 12:04:41 +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
95 lines
4.3 KiB
Markdown
95 lines
4.3 KiB
Markdown
# Capability Mock ControlPlanePort
|
|
|
|
`CapabilityMockControlPlaneAdapter` is a deterministic, serializable, in-memory
|
|
model of Paperclip's control-plane **semantics** — not its transport. It imports
|
|
no server route, service, database, or provider binding, and it holds no
|
|
credential.
|
|
|
|
Sources: `src/mock-core/capability-mock-control-plane-adapter.ts`,
|
|
`src/mock-core/capability-control-plane-types.ts`. Shared contract:
|
|
`src/conformance/control-plane-port.ts`.
|
|
|
|
## Entity domains
|
|
|
|
The adapter models ten renderable entity domains, which are exactly the domains
|
|
the [scenario explorer](capability-scenario-explorer.md) diffs:
|
|
|
|
`tasks`, `comments`, `documents`, `interactions`, `approvals`, `artifacts`
|
|
(artifacts and work products), `blockers`, `workspace` (workspace services),
|
|
`budget`, and `run`.
|
|
|
|
The fixture state also carries supporting records — company, actors, wakes,
|
|
audit, decisions, idempotency, faults, counters, and a fixture clock — that back
|
|
behavior but are not diff domains.
|
|
|
|
## Operations
|
|
|
|
- **Lifecycle:** `start()` / `stop()` only change local object state.
|
|
- **Runs:** `openRun()` / `openFixtureRun()` return a run context with atomic
|
|
checkout; `context(runId)` reads it back.
|
|
- **Events:** `appendEvent()` accepts both canonical PRP events and native run
|
|
events with deduplication, replay-conflict detection, and contiguous-sequence
|
|
tracking; `replayEvents()` replays from an exclusive cursor.
|
|
- **Commands:** `applyCommand(envelope)` executes a semantic command with
|
|
idempotency and an optimistic `expectedRevision`.
|
|
- **Sessions:** `loadSessionCheckpoint()` / `checkpointSession()`.
|
|
- **Terminal:** `completeRun()` reconciles a terminal disposition — `done`,
|
|
`blocked`, `needs_review`, or `yielded` — and fans out blocker wakes.
|
|
- **Introspection:** `snapshot()`, `decisionRecords()`, `serialize()`, and
|
|
static `restore()`.
|
|
|
|
The eighteen semantic command kinds (`report_progress`, `write_document`,
|
|
`request_human_input`, `resolve_human_input`, `register_deliverable`,
|
|
`set_dependencies`, `create_task`, `request_approval`, `decide_approval`,
|
|
`comment_on_approval`, `control_workspace_service`, `record_budget_usage`,
|
|
`finish_task`, `block_task`, `request_review`, `release_task`, `schedule_wake`)
|
|
are the mock side of the [semantic tool catalog](capability-semantic-tools.md).
|
|
|
|
## Determinism
|
|
|
|
- **Fixture clock.** Every timestamp derives from `clock.epochMs + tick*1000`
|
|
and the tick increments on each read. The default epoch is
|
|
`2026-08-09T00:00:00Z`. There is no RNG anywhere.
|
|
- **Deterministic IDs.** Every generated ID is `fixture-<kind>-<nnnn>` from a
|
|
monotonic per-kind counter.
|
|
- **Immutability.** Inputs and outputs are `structuredClone`d and every returned
|
|
value is deep-frozen. Canonical JSON with sorted keys backs every dedupe and
|
|
replay comparison.
|
|
- **Serializable.** `serialize()` / `restore()` round-trip under the schema tag
|
|
`paperclip.capability.mock-state.v1`.
|
|
- **Scripted faults.** A fault rule injects a bounded number of
|
|
`retryable_error` or `lost_ack` effects; a lost-ack command commits once and
|
|
returns its stored result on retry.
|
|
|
|
## Boundary
|
|
|
|
The adapter is a pure state machine: no network, no database, no provider SDK,
|
|
no credentials. Secrets appearing in wake payloads are redacted against
|
|
`/authorization|credential|api.?key|secret|token/i`; the adapter test seeds
|
|
`apiKey` and `Bearer` values and asserts they never surface. See
|
|
[authorization and exposure](capability-authorization-and-exposure.md).
|
|
|
|
## Shared conformance
|
|
|
|
The adapter satisfies the same `runControlPlanePortConformance` contract used by
|
|
earlier phases: it rejects open-binding violations, recovers from source gaps,
|
|
treats duplicates idempotently, and rejects event-id, sequence, replay-binding,
|
|
and result mutations (failing closed with `native_event_replay_conflict`).
|
|
|
|
## Running the tests
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner exec vitest run \
|
|
src/conformance/control-plane-port.test.ts \
|
|
src/mock-core/capability-mock-control-plane-adapter.test.ts
|
|
```
|
|
|
|
Nine tests, no npm alias of their own — they also run inside
|
|
`pnpm --filter @paperclipai/paperclip-runner test`.
|
|
|
|
## Related
|
|
|
|
- [Semantic tool catalog](capability-semantic-tools.md)
|
|
- [Authorization and exposure](capability-authorization-and-exposure.md)
|
|
- [Future binding boundary](capability-future-binding-boundary.md)
|