forked from farhoodlabs/paperclip
4272c1604d
## 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>
242 lines
7.0 KiB
TypeScript
242 lines
7.0 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { sessionCodec as claudeSessionCodec } from "@paperclipai/adapter-claude-local/server";
|
|
import { sessionCodec as codexSessionCodec, isCodexUnknownSessionError } from "@paperclipai/adapter-codex-local/server";
|
|
import {
|
|
sessionCodec as cursorSessionCodec,
|
|
isCursorUnknownSessionError,
|
|
} from "@paperclipai/adapter-cursor-local/server";
|
|
import {
|
|
sessionCodec as geminiSessionCodec,
|
|
isGeminiUnknownSessionError,
|
|
} from "@paperclipai/adapter-gemini-local/server";
|
|
import {
|
|
sessionCodec as opencodeSessionCodec,
|
|
isOpenCodeUnknownSessionError,
|
|
} from "@paperclipai/adapter-opencode-local/server";
|
|
import { sessionCodec as acpxSessionCodec } from "@paperclipai/adapter-acpx-local/server";
|
|
|
|
describe("adapter session codecs", () => {
|
|
it("normalizes claude session params with cwd", () => {
|
|
const parsed = claudeSessionCodec.deserialize({
|
|
session_id: "claude-session-1",
|
|
folder: "/tmp/workspace",
|
|
prompt_bundle_key: "bundle-1",
|
|
});
|
|
expect(parsed).toEqual({
|
|
sessionId: "claude-session-1",
|
|
cwd: "/tmp/workspace",
|
|
promptBundleKey: "bundle-1",
|
|
});
|
|
|
|
const serialized = claudeSessionCodec.serialize(parsed);
|
|
expect(serialized).toEqual({
|
|
sessionId: "claude-session-1",
|
|
cwd: "/tmp/workspace",
|
|
promptBundleKey: "bundle-1",
|
|
});
|
|
expect(claudeSessionCodec.getDisplayId?.(serialized ?? null)).toBe("claude-session-1");
|
|
});
|
|
|
|
it("normalizes codex session params with cwd", () => {
|
|
const parsed = codexSessionCodec.deserialize({
|
|
sessionId: "codex-session-1",
|
|
cwd: "/tmp/codex",
|
|
});
|
|
expect(parsed).toEqual({
|
|
sessionId: "codex-session-1",
|
|
cwd: "/tmp/codex",
|
|
});
|
|
|
|
const serialized = codexSessionCodec.serialize(parsed);
|
|
expect(serialized).toEqual({
|
|
sessionId: "codex-session-1",
|
|
cwd: "/tmp/codex",
|
|
});
|
|
expect(codexSessionCodec.getDisplayId?.(serialized ?? null)).toBe("codex-session-1");
|
|
});
|
|
|
|
it("normalizes opencode session params with cwd", () => {
|
|
const parsed = opencodeSessionCodec.deserialize({
|
|
sessionID: "opencode-session-1",
|
|
cwd: "/tmp/opencode",
|
|
});
|
|
expect(parsed).toEqual({
|
|
sessionId: "opencode-session-1",
|
|
cwd: "/tmp/opencode",
|
|
});
|
|
|
|
const serialized = opencodeSessionCodec.serialize(parsed);
|
|
expect(serialized).toEqual({
|
|
sessionId: "opencode-session-1",
|
|
cwd: "/tmp/opencode",
|
|
});
|
|
expect(opencodeSessionCodec.getDisplayId?.(serialized ?? null)).toBe("opencode-session-1");
|
|
});
|
|
|
|
it("normalizes cursor session params with cwd", () => {
|
|
const parsed = cursorSessionCodec.deserialize({
|
|
session_id: "cursor-session-1",
|
|
cwd: "/tmp/cursor",
|
|
});
|
|
expect(parsed).toEqual({
|
|
sessionId: "cursor-session-1",
|
|
cwd: "/tmp/cursor",
|
|
});
|
|
|
|
const serialized = cursorSessionCodec.serialize(parsed);
|
|
expect(serialized).toEqual({
|
|
sessionId: "cursor-session-1",
|
|
cwd: "/tmp/cursor",
|
|
});
|
|
expect(cursorSessionCodec.getDisplayId?.(serialized ?? null)).toBe("cursor-session-1");
|
|
});
|
|
|
|
it("normalizes gemini session params with cwd", () => {
|
|
const parsed = geminiSessionCodec.deserialize({
|
|
session_id: "gemini-session-1",
|
|
cwd: "/tmp/gemini",
|
|
});
|
|
expect(parsed).toEqual({
|
|
sessionId: "gemini-session-1",
|
|
cwd: "/tmp/gemini",
|
|
});
|
|
|
|
const serialized = geminiSessionCodec.serialize(parsed);
|
|
expect(serialized).toEqual({
|
|
sessionId: "gemini-session-1",
|
|
cwd: "/tmp/gemini",
|
|
});
|
|
expect(geminiSessionCodec.getDisplayId?.(serialized ?? null)).toBe("gemini-session-1");
|
|
});
|
|
|
|
it("preserves acpx session params required for compatibility checks", () => {
|
|
const parsed = acpxSessionCodec.deserialize({
|
|
sessionKey: "paperclip:company:agent:task:fingerprint",
|
|
runtimeSessionName: "runtime-session-1",
|
|
acpxRecordId: "record-1",
|
|
acpSessionId: "acp-session-1",
|
|
agentSessionId: "agent-session-1",
|
|
agent: "claude",
|
|
cwd: "/tmp/acpx",
|
|
mode: "persistent",
|
|
stateDir: "/tmp/acpx-state",
|
|
configFingerprint: "fingerprint",
|
|
workspaceId: "workspace-1",
|
|
repoUrl: "https://example.com/repo.git",
|
|
repoRef: "main",
|
|
remoteExecution: {
|
|
environmentId: "environment-1",
|
|
leaseId: "lease-1",
|
|
},
|
|
});
|
|
|
|
expect(parsed).toMatchObject({
|
|
sessionKey: "paperclip:company:agent:task:fingerprint",
|
|
runtimeSessionName: "runtime-session-1",
|
|
acpxRecordId: "record-1",
|
|
acpSessionId: "acp-session-1",
|
|
agentSessionId: "agent-session-1",
|
|
agent: "claude",
|
|
cwd: "/tmp/acpx",
|
|
mode: "persistent",
|
|
stateDir: "/tmp/acpx-state",
|
|
configFingerprint: "fingerprint",
|
|
workspaceId: "workspace-1",
|
|
repoUrl: "https://example.com/repo.git",
|
|
repoRef: "main",
|
|
remoteExecution: {
|
|
environmentId: "environment-1",
|
|
leaseId: "lease-1",
|
|
},
|
|
});
|
|
expect(acpxSessionCodec.serialize(parsed)).toEqual(parsed);
|
|
expect(acpxSessionCodec.getDisplayId?.(parsed)).toBe("runtime-session-1");
|
|
});
|
|
});
|
|
|
|
describe("codex resume recovery detection", () => {
|
|
it("detects unknown session errors from codex output", () => {
|
|
expect(
|
|
isCodexUnknownSessionError(
|
|
'{"type":"error","message":"Unknown session id abc"}',
|
|
"",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isCodexUnknownSessionError(
|
|
"",
|
|
"thread 123 not found",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isCodexUnknownSessionError(
|
|
'{"type":"result","ok":true}',
|
|
"",
|
|
),
|
|
).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("opencode resume recovery detection", () => {
|
|
it("detects unknown session errors from opencode output", () => {
|
|
expect(
|
|
isOpenCodeUnknownSessionError(
|
|
"",
|
|
"NotFoundError: Resource not found: /Users/test/.local/share/opencode/storage/session/proj/ses_missing.json",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isOpenCodeUnknownSessionError(
|
|
"{\"type\":\"step_finish\",\"part\":{\"reason\":\"stop\"}}",
|
|
"",
|
|
),
|
|
).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("cursor resume recovery detection", () => {
|
|
it("detects unknown session errors from cursor output", () => {
|
|
expect(
|
|
isCursorUnknownSessionError(
|
|
"",
|
|
"Error: unknown session id abc",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isCursorUnknownSessionError(
|
|
"",
|
|
"chat abc not found",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isCursorUnknownSessionError(
|
|
"{\"type\":\"result\",\"subtype\":\"success\"}",
|
|
"",
|
|
),
|
|
).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("gemini resume recovery detection", () => {
|
|
it("detects unknown session errors from gemini output", () => {
|
|
expect(
|
|
isGeminiUnknownSessionError(
|
|
"",
|
|
"unknown session id abc",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isGeminiUnknownSessionError(
|
|
"",
|
|
"checkpoint latest not found",
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
isGeminiUnknownSessionError(
|
|
"{\"type\":\"result\",\"subtype\":\"success\"}",
|
|
"",
|
|
),
|
|
).toBe(false);
|
|
});
|
|
});
|