Files
PaperClipAI/packages/shared/src/validators/provider-trace.ts
T
DottaandDev Agent 25cf079ec5 feat(runner): add Codex-native application integration (#12591)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - The runner package is useful only when the application can start,
observe, and recover a native Codex run safely.
> - Existing direct adapters must keep their current execution and
finalization paths.
> - The application boundary therefore needs additive persistence,
authorization, coordination, and recovery behind an explicit
experimental adapter.
> - This pull request adds that Codex-only boundary without activating
generalized providers, remote environments, or the later task/SDK
surfaces.

## Linked Issues or Issue Description

**Subsystem affected**

Shared contracts, database persistence, adapter utilities, server
native-runtime services, and the experimental Paperclip Runner adapter.

**Problem or motivation**

The already-landed runner package has a qualified Codex path, but the
application needs durable native-run state, guarded runtime selection,
authenticated coordination, tool security, finalization, and recovery
before the experimental adapter can be exercised safely.

**Proposed solution**

Add a Codex-only `paperclip_runner` application path behind the existing
default-off native-runner setting. Bind native state and coordination to
company/run identity, preserve persisted-run recovery, and leave every
direct adapter on its existing legacy execution path.

**Alternatives considered**

The earlier stack boundary introduced a generalized executor and
remote-environment lifecycle here. That made this PR depend on
implementations in higher PRs and changed reusable sandbox behavior
globally. Those pieces are now deferred together to #12592.

**Roadmap alignment**

ROADMAP.md does not list a conflicting native-runner integration
project. This change adds the application boundary for the existing
Runner architecture.

## What Changed

- Added native run/result/finalization/provider-trace persistence,
shared validators, and idempotent migration/replay coverage.
- Added guarded Codex-only runtime selection, authenticated PRP
coordination, recovery, finalization, and interaction services.
- Added run/company-bound tool-gateway authorization, credential
redaction, SSRF protections, and replay-safe behavior.
- Added the explicit `paperclip_runner` adapter behind the default-off
rollout setting.
- Preserved legacy answered-question wake projection and direct-adapter
execution/finalization paths.
- Hardened cancellation so only owned in-memory child processes are
signaled; persisted recycled PIDs/process groups are never trusted.
- Retained the narrow Claude ACPX isolated-context security follow-up
discovered after #12590.
- Deferred the generalized executor, provider ingress, remote lifecycle,
SDK/lab/eval work, release-process changes, and lockfile.

## Verification

- Changed-file delta against `master`: 133 files.
- GitHub Actions is the authoritative verification environment for this
PR.
- Full CI, security, and Greptile review will run on this lowest
unmerged stack PR.
- Local tests/build/typecheck were not run because this checkout is
resource constrained.
- Static diff/reference checks pass, and `pnpm-lock.yaml` is unchanged.

## Risks

- This touches central heartbeat and agent-route code, so legacy
compatibility is the primary risk.
- Runtime selection remains Codex-only and explicit; direct Codex,
Claude, OpenCode, process, HTTP, and plugin adapters remain on their
existing paths.
- Fresh native starts fail closed while the rollout flag is off;
persisted native records remain readable and recoverable.
- Cancellation, company/run binding, tool calls, status decisions, and
completion writes are guarded or replay-safe.

> For core feature work, check [ROADMAP.md](ROADMAP.md) first and
discuss it in #dev before opening the PR. Feature PRs that overlap with
planned core work may need to be redirected.

## Model Used

OpenAI Codex, GPT-5.6, with repository tools, code execution, and
parallel agent review.

## 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 linked existing issues or described the issue in-PR
following the relevant issue template
- [x] I have not referenced internal or 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 — GitHub Actions is
authoritative for this resource-constrained checkout
- [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 and security gates are green
- [ ] Greptile is 5/5 with no open actionable findings
- [x] I will address all Greptile and reviewer comments before merge

## Stack

- Position: 3 of 5 overall; lowest of 3 currently unmerged
- Base: `master`
- Previous:
[#12590](https://github.com/paperclipai/paperclip/pull/12590), qualified
Claude ACPX runtime — merged
- Next: [#12592](https://github.com/paperclipai/paperclip/pull/12592),
generalized Codex executor, task experience, and developer SDKs

---------

Co-authored-by: Dev Agent <dev@paperclip.ing>
2026-08-31 14:38:38 -05:00

118 lines
3.2 KiB
TypeScript

import { z } from "zod";
export const providerTraceDirectionSchema = z.enum([
"client_to_provider",
"provider_to_client",
"provider_stderr",
]);
export const providerTraceDispositionSchema = z.enum([
"mapped",
"generic",
"ignored",
"rejected",
"operator_only",
]);
export const providerTraceFieldMappingSchema = z
.object({
inputPath: z.string().min(1).optional(),
outputPath: z.string().min(1).optional(),
action: z.enum([
"copied",
"renamed",
"normalized",
"derived",
"dropped",
"redacted",
]),
reason: z.string().optional(),
})
.strict();
export const providerTraceStatusSchema = z.enum([
"capturing",
"complete",
"incomplete",
"truncated",
"deleted",
"expired",
]);
const sha256DigestSchema = z.string().regex(/^sha256:[a-f0-9]{64}$/i);
const dateValueSchema = z.union([z.string().datetime(), z.date()]);
export const providerTraceFrameSchema = z
.object({
kind: z.literal("frame").optional(),
schema: z.literal("paperclip.provider_trace_frame.v1"),
debugChannel: z.string().min(1),
debugSequence: z.number().int().positive(),
frameId: z.number().int().positive(),
timestamp: z.string().min(1),
direction: providerTraceDirectionSchema,
transport: z.string().min(1),
provider: z.string().min(1),
byteLength: z.number().int().nonnegative(),
digest: sha256DigestSchema,
rawBase64: z.string(),
})
.strict();
export const providerTraceInterpretationSchema = z
.object({
kind: z.literal("interpretation").optional(),
schema: z.literal("paperclip.provider_trace_interpretation.v1"),
debugChannel: z.string().min(1),
debugSequence: z.number().int().positive(),
frameId: z.number().int().positive(),
stage: z.string().min(1),
ruleId: z.string().min(1),
disposition: providerTraceDispositionSchema,
emittedEventIds: z.array(z.string()),
droppedFields: z.array(z.string()),
fieldMappings: z.array(providerTraceFieldMappingSchema).optional(),
reason: z.string(),
})
.strict();
export const providerTraceMetadataSchema = z
.object({
schema: z.literal("paperclip.provider_trace_metadata.v1"),
id: z.string().min(1),
runId: z.string().min(1),
companyId: z.string().min(1),
status: providerTraceStatusSchema,
provider: z.string().min(1),
frameCount: z.number().int().nonnegative(),
byteCount: z.number().int().nonnegative(),
digest: sha256DigestSchema.nullable(),
reason: z.string().nullable(),
requestedBy: z.string().min(1),
createdAt: dateValueSchema,
expiresAt: dateValueSchema,
deletedAt: dateValueSchema.nullable(),
})
.strict();
export const runPresentationSourceSchema = z.enum([
"existing_issue_comment",
"final_agent_message",
"semantic_result_summary",
"adapter_final_response",
"none",
]);
export const runPresentationDecisionSchema = z
.object({
schema: z.literal("paperclip.run_presentation_decision.v1"),
resolverVersion: z.string().min(1),
chosenSource: runPresentationSourceSchema,
sourceEventId: z.string().nullable(),
commentAction: z.enum(["reuse", "create", "none"]),
commentId: z.string().nullable(),
activityDisposition: z.literal("collapse"),
reasonCodes: z.array(z.string()),
})
.strict();