mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 02:40:39 +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>
121 lines
3.5 KiB
TypeScript
121 lines
3.5 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { printAcpxStreamEvent } from "./format-event.js";
|
|
|
|
function emit(payload: Record<string, unknown>): string {
|
|
return JSON.stringify(payload);
|
|
}
|
|
|
|
interface CapturedOutput {
|
|
log: string[];
|
|
stdout: string[];
|
|
}
|
|
|
|
function captureOutput(): { capture: CapturedOutput; restore: () => void } {
|
|
const log: string[] = [];
|
|
const stdout: string[] = [];
|
|
const logSpy = vi.spyOn(console, "log").mockImplementation((value?: unknown) => {
|
|
log.push(String(value ?? ""));
|
|
});
|
|
const stdoutSpy = vi.spyOn(process.stdout, "write").mockImplementation(((chunk: unknown) => {
|
|
stdout.push(String(chunk ?? ""));
|
|
return true;
|
|
}) as typeof process.stdout.write);
|
|
return {
|
|
capture: { log, stdout },
|
|
restore: () => {
|
|
logSpy.mockRestore();
|
|
stdoutSpy.mockRestore();
|
|
},
|
|
};
|
|
}
|
|
|
|
function strip(value: string): string {
|
|
return value.replace(/\x1b\[[0-9;]*m/g, "");
|
|
}
|
|
|
|
describe("printAcpxStreamEvent", () => {
|
|
let captured: CapturedOutput;
|
|
let restore: () => void;
|
|
|
|
beforeEach(() => {
|
|
const result = captureOutput();
|
|
captured = result.capture;
|
|
restore = result.restore;
|
|
});
|
|
|
|
afterEach(() => {
|
|
restore();
|
|
});
|
|
|
|
it("renders acpx.session as a labeled session header", () => {
|
|
printAcpxStreamEvent(
|
|
emit({
|
|
type: "acpx.session",
|
|
agent: "claude",
|
|
acpSessionId: "acp-1",
|
|
mode: "persistent",
|
|
permissionMode: "approve-all",
|
|
}),
|
|
false,
|
|
);
|
|
expect(captured.log.map(strip)).toEqual(["claude session: acp-1 [persistent / approve-all]"]);
|
|
});
|
|
|
|
it("streams output text_delta to stdout for live progress", () => {
|
|
printAcpxStreamEvent(
|
|
emit({ type: "acpx.text_delta", text: "hello", channel: "output" }),
|
|
false,
|
|
);
|
|
expect(captured.log).toEqual([]);
|
|
expect(captured.stdout.map(strip)).toEqual(["hello"]);
|
|
});
|
|
|
|
it("renders thought text_delta on its own line", () => {
|
|
printAcpxStreamEvent(
|
|
emit({ type: "acpx.text_delta", text: "thinking…", channel: "thought" }),
|
|
false,
|
|
);
|
|
expect(captured.log.map(strip)).toEqual(["thinking…"]);
|
|
});
|
|
|
|
it("renders tool_call with status and id", () => {
|
|
printAcpxStreamEvent(
|
|
emit({
|
|
type: "acpx.tool_call",
|
|
name: "read",
|
|
toolCallId: "tool-1",
|
|
status: "running",
|
|
text: "read README.md",
|
|
}),
|
|
false,
|
|
);
|
|
expect(captured.log.map(strip)).toEqual([
|
|
"tool_call: read [running] (tool-1)",
|
|
"read README.md",
|
|
]);
|
|
});
|
|
|
|
it("renders status events with optional context window", () => {
|
|
printAcpxStreamEvent(
|
|
emit({ type: "acpx.status", tag: "context_window", used: 100, size: 200000 }),
|
|
false,
|
|
);
|
|
expect(captured.log.map(strip)).toEqual(["status: context_window (100/200000 ctx)"]);
|
|
});
|
|
|
|
it("renders acpx.result and acpx.error", () => {
|
|
printAcpxStreamEvent(emit({ type: "acpx.result", summary: "completed", stopReason: "end_turn" }), false);
|
|
printAcpxStreamEvent(emit({ type: "acpx.error", message: "auth required" }), false);
|
|
expect(captured.log.map(strip)).toEqual(["result: completed", "error: auth required"]);
|
|
});
|
|
|
|
it("falls back to plain output for non-JSON lines", () => {
|
|
printAcpxStreamEvent("not json", false);
|
|
expect(captured.log).toEqual(["not json"]);
|
|
});
|
|
|
|
it("still emits unknown / non-JSON lines when debug is enabled", () => {
|
|
printAcpxStreamEvent("not json", true);
|
|
expect(strip(captured.log[0])).toBe("not json");
|
|
});
|
|
});
|