mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 10:50: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>
160 lines
4.6 KiB
TypeScript
160 lines
4.6 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { parseAcpxStdoutLine } from "./parse-stdout.js";
|
|
|
|
const TS = "2026-04-30T00:00:00.000Z";
|
|
|
|
function emit(payload: Record<string, unknown>): string {
|
|
return JSON.stringify(payload);
|
|
}
|
|
|
|
describe("parseAcpxStdoutLine", () => {
|
|
it("renders an init entry from acpx.session", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({
|
|
type: "acpx.session",
|
|
agent: "claude",
|
|
acpSessionId: "acp-1",
|
|
runtimeSessionName: "runtime-1",
|
|
mode: "persistent",
|
|
permissionMode: "approve-all",
|
|
}),
|
|
TS,
|
|
);
|
|
expect(entries).toEqual([
|
|
{
|
|
kind: "init",
|
|
ts: TS,
|
|
model: "claude (persistent / approve-all)",
|
|
sessionId: "acp-1",
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("routes output text_delta to the assistant transcript", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({ type: "acpx.text_delta", text: "hello", channel: "output", tag: "agent_message_chunk" }),
|
|
TS,
|
|
);
|
|
expect(entries).toEqual([
|
|
{ kind: "assistant", ts: TS, text: "hello", delta: true },
|
|
]);
|
|
});
|
|
|
|
it("routes thought text_delta to the thinking transcript", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({ type: "acpx.text_delta", text: "thinking…", channel: "thought" }),
|
|
TS,
|
|
);
|
|
expect(entries).toEqual([
|
|
{ kind: "thinking", ts: TS, text: "thinking…", delta: true },
|
|
]);
|
|
});
|
|
|
|
it("falls back to stream when channel is missing", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({ type: "acpx.text_delta", text: "thinking…", stream: "thought" }),
|
|
TS,
|
|
);
|
|
expect(entries[0]).toMatchObject({ kind: "thinking" });
|
|
});
|
|
|
|
it("renders status events as system text with optional ctx usage", () => {
|
|
expect(
|
|
parseAcpxStdoutLine(
|
|
emit({ type: "acpx.status", text: "thinking", tag: "agent_thought_chunk" }),
|
|
TS,
|
|
),
|
|
).toEqual([{ kind: "system", ts: TS, text: "thinking" }]);
|
|
|
|
expect(
|
|
parseAcpxStdoutLine(
|
|
emit({ type: "acpx.status", tag: "context_window", used: 12000, size: 200000 }),
|
|
TS,
|
|
),
|
|
).toEqual([{ kind: "system", ts: TS, text: "context_window (12000/200000 ctx)" }]);
|
|
});
|
|
|
|
it("emits a tool_call entry that preserves toolCallId, status, and input", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({
|
|
type: "acpx.tool_call",
|
|
name: "read",
|
|
toolCallId: "tool-1",
|
|
status: "running",
|
|
text: "read README.md",
|
|
}),
|
|
TS,
|
|
);
|
|
expect(entries).toEqual([
|
|
{
|
|
kind: "tool_call",
|
|
ts: TS,
|
|
name: "read",
|
|
toolUseId: "tool-1",
|
|
input: { text: "read README.md", status: "running" },
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("emits a paired tool_result entry when a tool_call reports terminal status", () => {
|
|
const completed = parseAcpxStdoutLine(
|
|
emit({
|
|
type: "acpx.tool_call",
|
|
name: "read",
|
|
toolCallId: "tool-1",
|
|
status: "completed",
|
|
text: "ok",
|
|
}),
|
|
TS,
|
|
);
|
|
expect(completed[1]).toEqual({
|
|
kind: "tool_result",
|
|
ts: TS,
|
|
toolUseId: "tool-1",
|
|
toolName: "read",
|
|
content: "ok",
|
|
isError: false,
|
|
});
|
|
|
|
const failed = parseAcpxStdoutLine(
|
|
emit({
|
|
type: "acpx.tool_call",
|
|
name: "edit",
|
|
toolCallId: "tool-2",
|
|
status: "failed",
|
|
text: "permission denied",
|
|
}),
|
|
TS,
|
|
);
|
|
expect(failed[1]).toMatchObject({ kind: "tool_result", isError: true, content: "permission denied" });
|
|
});
|
|
|
|
it("renders acpx.result with summary fallback to stopReason", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({ type: "acpx.result", summary: "completed", stopReason: "end_turn" }),
|
|
TS,
|
|
);
|
|
expect(entries[0]).toMatchObject({ kind: "result", text: "completed", subtype: "end_turn", isError: false });
|
|
});
|
|
|
|
it("treats acpx.error as a stderr entry", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({ type: "acpx.error", message: "auth required", code: "ACP_AUTH" }),
|
|
TS,
|
|
);
|
|
expect(entries).toEqual([{ kind: "stderr", ts: TS, text: "auth required" }]);
|
|
});
|
|
|
|
it("renders unknown acpx.* events as system entries", () => {
|
|
const entries = parseAcpxStdoutLine(
|
|
emit({ type: "acpx.misc", message: "unhandled" }),
|
|
TS,
|
|
);
|
|
expect(entries).toEqual([{ kind: "system", ts: TS, text: "unhandled" }]);
|
|
});
|
|
|
|
it("falls back to a stdout entry for non-JSON lines", () => {
|
|
const entries = parseAcpxStdoutLine("not json", TS);
|
|
expect(entries).toEqual([{ kind: "stdout", ts: TS, text: "not json" }]);
|
|
});
|
|
});
|