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>
130 lines
4.3 KiB
TypeScript
130 lines
4.3 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { testEnvironment } from "@paperclipai/adapter-acpx-local/server";
|
|
import type { AdapterEnvironmentCheck } from "@paperclipai/adapter-utils";
|
|
|
|
function credentialChecks(checks: AdapterEnvironmentCheck[]): AdapterEnvironmentCheck[] {
|
|
return checks.filter((check) => check.code.startsWith("acpx_claude_") || check.code.startsWith("acpx_codex_"));
|
|
}
|
|
|
|
describe("acpx_local environment credential diagnostics", () => {
|
|
beforeEach(() => {
|
|
vi.stubEnv("ANTHROPIC_API_KEY", "");
|
|
vi.stubEnv("ANTHROPIC_BEDROCK_BASE_URL", "");
|
|
vi.stubEnv("CLAUDE_CODE_USE_BEDROCK", "");
|
|
vi.stubEnv("CLAUDE_CONFIG_DIR", "");
|
|
vi.stubEnv("OPENAI_API_KEY", "");
|
|
vi.stubEnv("CODEX_HOME", "");
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.unstubAllEnvs();
|
|
});
|
|
|
|
it("emits an info-level Claude credential hint when ANTHROPIC_API_KEY is present", async () => {
|
|
const result = await testEnvironment({
|
|
companyId: "company-1",
|
|
adapterType: "acpx_local",
|
|
config: {
|
|
agent: "claude",
|
|
env: {
|
|
ANTHROPIC_API_KEY: "sk-ant-test",
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(result.checks).toContainEqual(expect.objectContaining({
|
|
code: "acpx_claude_anthropic_api_key_detected",
|
|
level: "info",
|
|
}));
|
|
expect(result.checks.some((check) => check.code.startsWith("acpx_codex_"))).toBe(false);
|
|
});
|
|
|
|
it("emits an info-level Claude missing credential hint without changing diagnostic health", async () => {
|
|
const root = path.join(os.tmpdir(), `paperclip-acpx-claude-noauth-${Date.now()}-${Math.random().toString(16).slice(2)}`);
|
|
const claudeConfigDir = path.join(root, ".claude");
|
|
|
|
try {
|
|
await fs.mkdir(claudeConfigDir, { recursive: true });
|
|
|
|
const result = await testEnvironment({
|
|
companyId: "company-1",
|
|
adapterType: "acpx_local",
|
|
config: {
|
|
agent: "claude",
|
|
env: {
|
|
CLAUDE_CONFIG_DIR: claudeConfigDir,
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(result.checks).toContainEqual(expect.objectContaining({
|
|
code: "acpx_claude_credentials_missing",
|
|
level: "info",
|
|
}));
|
|
expect(credentialChecks(result.checks).every((check) => check.level === "info")).toBe(true);
|
|
} finally {
|
|
await fs.rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it("emits an info-level Codex credential hint when native auth is present", async () => {
|
|
const root = path.join(os.tmpdir(), `paperclip-acpx-codex-auth-${Date.now()}-${Math.random().toString(16).slice(2)}`);
|
|
const codexHome = path.join(root, ".codex");
|
|
|
|
try {
|
|
await fs.mkdir(codexHome, { recursive: true });
|
|
await fs.writeFile(path.join(codexHome, "auth.json"), JSON.stringify({ accessToken: "token" }), "utf8");
|
|
|
|
const result = await testEnvironment({
|
|
companyId: "company-1",
|
|
adapterType: "acpx_local",
|
|
config: {
|
|
agent: "codex",
|
|
env: {
|
|
CODEX_HOME: codexHome,
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(result.checks).toContainEqual(expect.objectContaining({
|
|
code: "acpx_codex_native_auth_detected",
|
|
level: "info",
|
|
}));
|
|
expect(result.checks.some((check) => check.code.startsWith("acpx_claude_"))).toBe(false);
|
|
} finally {
|
|
await fs.rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it("emits an info-level Codex missing credential hint without changing diagnostic health", async () => {
|
|
const root = path.join(os.tmpdir(), `paperclip-acpx-codex-noauth-${Date.now()}-${Math.random().toString(16).slice(2)}`);
|
|
const codexHome = path.join(root, ".codex");
|
|
|
|
try {
|
|
await fs.mkdir(codexHome, { recursive: true });
|
|
|
|
const result = await testEnvironment({
|
|
companyId: "company-1",
|
|
adapterType: "acpx_local",
|
|
config: {
|
|
agent: "codex",
|
|
env: {
|
|
CODEX_HOME: codexHome,
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(result.checks).toContainEqual(expect.objectContaining({
|
|
code: "acpx_codex_credentials_missing",
|
|
level: "info",
|
|
}));
|
|
expect(credentialChecks(result.checks).every((check) => check.level === "info")).toBe(true);
|
|
} finally {
|
|
await fs.rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|