mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 10:00:38 +09:00
## Thinking Path > - Paperclip orchestrates AI-agent companies through a control plane that can start, supervise, and recover agent runs. > - Local adapters are the bridge between Paperclip issues and concrete agent runtimes such as Claude, Codex, and other ACP-compatible tools. > - The roadmap calls out broader “bring your own agent” and claw-style agent support, and ACPX gives Paperclip one path to normalize multiple ACP agents behind a single adapter. > - The branch needed to become one reviewable PR against current `paperclipai/paperclip:master`, without carrying stale base conflicts or generated lockfile churn. > - This pull request adds an experimental built-in `acpx_local` adapter, integrates it through the server/CLI/UI adapter surfaces, and adds regression coverage for runtime execution, skill sync, stream parsing, diagnostics, and log redaction. > - The benefit is that Paperclip can run Claude/Codex/custom ACP agents through ACPX while keeping operator configuration, skills, logging, and transcript rendering inside the existing adapter model. ## What Changed - Added `@paperclipai/adapter-acpx-local` with server execution, config schema, ACPX session handling, CLI formatting, UI config helpers, and stdout parsing. - Registered `acpx_local` across CLI, server, shared constants, UI adapter metadata, adapter capabilities, and agent creation/editing surfaces. - Added ACPX runtime execution support with persistent sessions, local-agent JWT environment handling, skill snapshots, runtime skill materialization, and isolation/security regressions. - Added ACPX adapter diagnostics and marked the adapter experimental in the UI. - Added command/env secret redaction for resolved command metadata in adapter-utils, server event storage, and the Agent Detail invocation UI. - Added Storybook coverage for ACPX config, transcript rendering, and skill states, plus PR screenshots under `docs/pr-screenshots/pap-2944/`. - Rebased the branch onto current `public-gh/master`; `pnpm-lock.yaml` is intentionally not included and there are no migration/schema changes. ## Verification - `pnpm exec vitest run packages/adapters/acpx-local/src/server/execute.test.ts packages/adapters/acpx-local/src/server/test.test.ts packages/adapters/acpx-local/src/cli/format-event.test.ts packages/adapters/acpx-local/src/ui/parse-stdout.test.ts packages/adapter-utils/src/server-utils.test.ts server/src/__tests__/redaction.test.ts server/src/__tests__/acpx-local-execute.test.ts server/src/__tests__/acpx-local-skill-sync.test.ts server/src/__tests__/acpx-local-adapter-environment.test.ts server/src/__tests__/adapter-routes.test.ts server/src/__tests__/agent-skills-routes.test.ts ui/src/adapters/metadata.test.ts` — 12 files, 87 tests passed. - `pnpm --filter @paperclipai/adapter-acpx-local typecheck` — passed. - `pnpm --filter @paperclipai/server typecheck` — passed. - `pnpm --filter @paperclipai/ui typecheck` — passed. - Confirmed PR diff does not include `pnpm-lock.yaml`, database schema files, or migrations. Screenshots:    ## Risks - Medium risk: this introduces a new built-in adapter package and touches runtime execution, adapter registration, agent config, skills, and transcript rendering. - ACPX and ACP agent behavior can vary by installed tool versions; the adapter is marked experimental to set operator expectations. - `pnpm-lock.yaml` is excluded per repository PR policy, so dependency lock refresh must be handled by the repo’s automation or maintainers. - No database migration risk: no schema or migration files changed. > 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 — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex coding agent based on GPT-5, with repository tool use, shell execution, git operations, and local verification. Exact hosted context window was not exposed in this environment. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
187 lines
6.5 KiB
TypeScript
187 lines
6.5 KiB
TypeScript
export interface SessionCompactionPolicy {
|
|
enabled: boolean;
|
|
maxSessionRuns: number;
|
|
maxRawInputTokens: number;
|
|
maxSessionAgeHours: number;
|
|
}
|
|
|
|
export type NativeContextManagement = "confirmed" | "likely" | "unknown" | "none";
|
|
|
|
export interface AdapterSessionManagement {
|
|
supportsSessionResume: boolean;
|
|
nativeContextManagement: NativeContextManagement;
|
|
defaultSessionCompaction: SessionCompactionPolicy;
|
|
}
|
|
|
|
export interface ResolvedSessionCompactionPolicy {
|
|
policy: SessionCompactionPolicy;
|
|
adapterSessionManagement: AdapterSessionManagement | null;
|
|
explicitOverride: Partial<SessionCompactionPolicy>;
|
|
source: "adapter_default" | "agent_override" | "legacy_fallback";
|
|
}
|
|
|
|
const DEFAULT_SESSION_COMPACTION_POLICY: SessionCompactionPolicy = {
|
|
enabled: true,
|
|
maxSessionRuns: 200,
|
|
maxRawInputTokens: 2_000_000,
|
|
maxSessionAgeHours: 72,
|
|
};
|
|
|
|
// Adapters with native context management still participate in session resume,
|
|
// but Paperclip should not rotate them using threshold-based compaction.
|
|
const ADAPTER_MANAGED_SESSION_POLICY: SessionCompactionPolicy = {
|
|
enabled: true,
|
|
maxSessionRuns: 0,
|
|
maxRawInputTokens: 0,
|
|
maxSessionAgeHours: 0,
|
|
};
|
|
|
|
export const LEGACY_SESSIONED_ADAPTER_TYPES = new Set([
|
|
"acpx_local",
|
|
"claude_local",
|
|
"codex_local",
|
|
"cursor",
|
|
"gemini_local",
|
|
"hermes_local",
|
|
"opencode_local",
|
|
"pi_local",
|
|
]);
|
|
|
|
export const ADAPTER_SESSION_MANAGEMENT: Record<string, AdapterSessionManagement> = {
|
|
acpx_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "confirmed",
|
|
defaultSessionCompaction: ADAPTER_MANAGED_SESSION_POLICY,
|
|
},
|
|
claude_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "confirmed",
|
|
defaultSessionCompaction: ADAPTER_MANAGED_SESSION_POLICY,
|
|
},
|
|
codex_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "confirmed",
|
|
defaultSessionCompaction: ADAPTER_MANAGED_SESSION_POLICY,
|
|
},
|
|
cursor: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "unknown",
|
|
defaultSessionCompaction: DEFAULT_SESSION_COMPACTION_POLICY,
|
|
},
|
|
gemini_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "unknown",
|
|
defaultSessionCompaction: DEFAULT_SESSION_COMPACTION_POLICY,
|
|
},
|
|
opencode_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "unknown",
|
|
defaultSessionCompaction: DEFAULT_SESSION_COMPACTION_POLICY,
|
|
},
|
|
pi_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "unknown",
|
|
defaultSessionCompaction: DEFAULT_SESSION_COMPACTION_POLICY,
|
|
},
|
|
hermes_local: {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "confirmed",
|
|
defaultSessionCompaction: ADAPTER_MANAGED_SESSION_POLICY,
|
|
},
|
|
};
|
|
|
|
function isRecord(value: unknown): value is Record<string, unknown> {
|
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
}
|
|
|
|
function readBoolean(value: unknown): boolean | undefined {
|
|
if (typeof value === "boolean") return value;
|
|
if (typeof value === "number") {
|
|
if (value === 1) return true;
|
|
if (value === 0) return false;
|
|
return undefined;
|
|
}
|
|
if (typeof value !== "string") return undefined;
|
|
const normalized = value.trim().toLowerCase();
|
|
if (normalized === "true" || normalized === "1" || normalized === "yes" || normalized === "on") {
|
|
return true;
|
|
}
|
|
if (normalized === "false" || normalized === "0" || normalized === "no" || normalized === "off") {
|
|
return false;
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
function readNumber(value: unknown): number | undefined {
|
|
if (typeof value === "number" && Number.isFinite(value)) {
|
|
return Math.max(0, Math.floor(value));
|
|
}
|
|
if (typeof value !== "string") return undefined;
|
|
const parsed = Number(value.trim());
|
|
return Number.isFinite(parsed) ? Math.max(0, Math.floor(parsed)) : undefined;
|
|
}
|
|
|
|
export function getAdapterSessionManagement(adapterType: string | null | undefined): AdapterSessionManagement | null {
|
|
if (!adapterType) return null;
|
|
return ADAPTER_SESSION_MANAGEMENT[adapterType] ?? null;
|
|
}
|
|
|
|
export function readSessionCompactionOverride(runtimeConfig: unknown): Partial<SessionCompactionPolicy> {
|
|
const runtime = isRecord(runtimeConfig) ? runtimeConfig : {};
|
|
const heartbeat = isRecord(runtime.heartbeat) ? runtime.heartbeat : {};
|
|
const compaction = isRecord(
|
|
heartbeat.sessionCompaction ?? heartbeat.sessionRotation ?? runtime.sessionCompaction,
|
|
)
|
|
? (heartbeat.sessionCompaction ?? heartbeat.sessionRotation ?? runtime.sessionCompaction) as Record<string, unknown>
|
|
: {};
|
|
|
|
const explicit: Partial<SessionCompactionPolicy> = {};
|
|
const enabled = readBoolean(compaction.enabled);
|
|
const maxSessionRuns = readNumber(compaction.maxSessionRuns);
|
|
const maxRawInputTokens = readNumber(compaction.maxRawInputTokens);
|
|
const maxSessionAgeHours = readNumber(compaction.maxSessionAgeHours);
|
|
|
|
if (enabled !== undefined) explicit.enabled = enabled;
|
|
if (maxSessionRuns !== undefined) explicit.maxSessionRuns = maxSessionRuns;
|
|
if (maxRawInputTokens !== undefined) explicit.maxRawInputTokens = maxRawInputTokens;
|
|
if (maxSessionAgeHours !== undefined) explicit.maxSessionAgeHours = maxSessionAgeHours;
|
|
|
|
return explicit;
|
|
}
|
|
|
|
export function resolveSessionCompactionPolicy(
|
|
adapterType: string | null | undefined,
|
|
runtimeConfig: unknown,
|
|
): ResolvedSessionCompactionPolicy {
|
|
const adapterSessionManagement = getAdapterSessionManagement(adapterType);
|
|
const explicitOverride = readSessionCompactionOverride(runtimeConfig);
|
|
const hasExplicitOverride = Object.keys(explicitOverride).length > 0;
|
|
const fallbackEnabled = Boolean(adapterType && LEGACY_SESSIONED_ADAPTER_TYPES.has(adapterType));
|
|
const basePolicy = adapterSessionManagement?.defaultSessionCompaction ?? {
|
|
...DEFAULT_SESSION_COMPACTION_POLICY,
|
|
enabled: fallbackEnabled,
|
|
};
|
|
|
|
return {
|
|
policy: {
|
|
enabled: explicitOverride.enabled ?? basePolicy.enabled,
|
|
maxSessionRuns: explicitOverride.maxSessionRuns ?? basePolicy.maxSessionRuns,
|
|
maxRawInputTokens: explicitOverride.maxRawInputTokens ?? basePolicy.maxRawInputTokens,
|
|
maxSessionAgeHours: explicitOverride.maxSessionAgeHours ?? basePolicy.maxSessionAgeHours,
|
|
},
|
|
adapterSessionManagement,
|
|
explicitOverride,
|
|
source: hasExplicitOverride
|
|
? "agent_override"
|
|
: adapterSessionManagement
|
|
? "adapter_default"
|
|
: "legacy_fallback",
|
|
};
|
|
}
|
|
|
|
export function hasSessionCompactionThresholds(policy: Pick<
|
|
SessionCompactionPolicy,
|
|
"maxSessionRuns" | "maxRawInputTokens" | "maxSessionAgeHours"
|
|
>) {
|
|
return policy.maxSessionRuns > 0 || policy.maxRawInputTokens > 0 || policy.maxSessionAgeHours > 0;
|
|
}
|