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>
312 lines
12 KiB
TypeScript
312 lines
12 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import { vi } from "vitest";
|
|
import type { ServerAdapterModule } from "../adapters/index.js";
|
|
|
|
const mockAdapterPluginStore = vi.hoisted(() => ({
|
|
listAdapterPlugins: vi.fn(),
|
|
addAdapterPlugin: vi.fn(),
|
|
removeAdapterPlugin: vi.fn(),
|
|
getAdapterPluginByType: vi.fn(),
|
|
getAdapterPluginsDir: vi.fn(),
|
|
getDisabledAdapterTypes: vi.fn(),
|
|
setAdapterDisabled: vi.fn(),
|
|
}));
|
|
|
|
const mockPluginLoader = vi.hoisted(() => ({
|
|
buildExternalAdapters: vi.fn(),
|
|
loadExternalAdapterPackage: vi.fn(),
|
|
getUiParserSource: vi.fn(),
|
|
getOrExtractUiParserSource: vi.fn(),
|
|
reloadExternalAdapter: vi.fn(),
|
|
}));
|
|
|
|
const overridingConfigSchemaAdapter: ServerAdapterModule = {
|
|
type: "claude_local",
|
|
execute: async () => ({ exitCode: 0, signal: null, timedOut: false }),
|
|
testEnvironment: async () => ({
|
|
adapterType: "claude_local",
|
|
status: "pass",
|
|
checks: [],
|
|
testedAt: new Date(0).toISOString(),
|
|
}),
|
|
getConfigSchema: async () => ({
|
|
version: 1,
|
|
fields: [
|
|
{
|
|
key: "mode",
|
|
type: "text",
|
|
label: "Mode",
|
|
},
|
|
],
|
|
}),
|
|
};
|
|
|
|
let registerServerAdapter: typeof import("../adapters/registry.js").registerServerAdapter;
|
|
let unregisterServerAdapter: typeof import("../adapters/registry.js").unregisterServerAdapter;
|
|
let findServerAdapter: typeof import("../adapters/registry.js").findServerAdapter;
|
|
let setOverridePaused: typeof import("../adapters/registry.js").setOverridePaused;
|
|
let adapterRoutes: typeof import("../routes/adapters.js").adapterRoutes;
|
|
let errorHandler: typeof import("../middleware/index.js").errorHandler;
|
|
|
|
function registerModuleMocks() {
|
|
vi.doMock("node:child_process", async () => vi.importActual("node:child_process"));
|
|
vi.doMock("../adapters/plugin-loader.js", () => mockPluginLoader);
|
|
vi.doMock("../services/adapter-plugin-store.js", () => mockAdapterPluginStore);
|
|
vi.doMock("../routes/adapters.js", async () => vi.importActual("../routes/adapters.js"));
|
|
vi.doMock("../routes/authz.js", async () => vi.importActual("../routes/authz.js"));
|
|
vi.doMock("../middleware/index.js", async () => vi.importActual("../middleware/index.js"));
|
|
}
|
|
|
|
function createApp(actorOverrides: Partial<Express.Request["actor"]> = {}) {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = {
|
|
type: "board",
|
|
userId: "local-board",
|
|
companyIds: [],
|
|
source: "local_implicit",
|
|
isInstanceAdmin: false,
|
|
...actorOverrides,
|
|
};
|
|
next();
|
|
});
|
|
app.use("/api", adapterRoutes());
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("adapter routes", () => {
|
|
beforeEach(async () => {
|
|
vi.resetModules();
|
|
vi.doUnmock("node:child_process");
|
|
vi.doUnmock("../adapters/registry.js");
|
|
vi.doUnmock("../adapters/plugin-loader.js");
|
|
vi.doUnmock("../services/adapter-plugin-store.js");
|
|
vi.doUnmock("../routes/adapters.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
registerModuleMocks();
|
|
mockAdapterPluginStore.listAdapterPlugins.mockReturnValue([]);
|
|
mockAdapterPluginStore.addAdapterPlugin.mockResolvedValue(undefined);
|
|
mockAdapterPluginStore.removeAdapterPlugin.mockReturnValue(false);
|
|
mockAdapterPluginStore.getAdapterPluginByType.mockReturnValue(undefined);
|
|
mockAdapterPluginStore.getAdapterPluginsDir.mockReturnValue("/tmp/paperclip-adapter-routes-test");
|
|
mockAdapterPluginStore.getDisabledAdapterTypes.mockReturnValue([]);
|
|
mockAdapterPluginStore.setAdapterDisabled.mockReturnValue(false);
|
|
mockPluginLoader.buildExternalAdapters.mockResolvedValue([]);
|
|
mockPluginLoader.loadExternalAdapterPackage.mockResolvedValue(null);
|
|
mockPluginLoader.getUiParserSource.mockResolvedValue(null);
|
|
mockPluginLoader.getOrExtractUiParserSource.mockResolvedValue(null);
|
|
mockPluginLoader.reloadExternalAdapter.mockResolvedValue(null);
|
|
const [registry, routes, middleware] = await Promise.all([
|
|
vi.importActual<typeof import("../adapters/registry.js")>("../adapters/registry.js"),
|
|
import("../routes/adapters.js"),
|
|
import("../middleware/index.js"),
|
|
]);
|
|
registerServerAdapter = registry.registerServerAdapter;
|
|
unregisterServerAdapter = registry.unregisterServerAdapter;
|
|
findServerAdapter = registry.findServerAdapter;
|
|
setOverridePaused = registry.setOverridePaused;
|
|
adapterRoutes = routes.adapterRoutes;
|
|
errorHandler = middleware.errorHandler;
|
|
setOverridePaused("claude_local", false);
|
|
unregisterServerAdapter("claude_local");
|
|
registerServerAdapter(overridingConfigSchemaAdapter);
|
|
});
|
|
|
|
afterEach(() => {
|
|
setOverridePaused("claude_local", false);
|
|
unregisterServerAdapter("claude_local");
|
|
});
|
|
|
|
it("GET /api/adapters includes capabilities object for each adapter", async () => {
|
|
const app = createApp();
|
|
|
|
const res = await request(app).get("/api/adapters");
|
|
expect(res.status).toBe(200);
|
|
const adapters = Array.isArray(res.body) ? res.body : JSON.parse(res.text);
|
|
expect(Array.isArray(adapters)).toBe(true);
|
|
expect(adapters.length).toBeGreaterThan(0);
|
|
|
|
// Every adapter should have a capabilities object
|
|
for (const adapter of adapters) {
|
|
expect(adapter.capabilities).toBeDefined();
|
|
expect(typeof adapter.capabilities.supportsInstructionsBundle).toBe("boolean");
|
|
expect(typeof adapter.capabilities.supportsSkills).toBe("boolean");
|
|
expect(typeof adapter.capabilities.supportsLocalAgentJwt).toBe("boolean");
|
|
expect(typeof adapter.capabilities.requiresMaterializedRuntimeSkills).toBe("boolean");
|
|
}
|
|
});
|
|
|
|
it("GET /api/adapters returns correct capabilities for built-in adapters", async () => {
|
|
const app = createApp();
|
|
|
|
const res = await request(app).get("/api/adapters");
|
|
expect(res.status).toBe(200);
|
|
|
|
// codex_local has instructions bundle + skills + jwt, no materialized skills
|
|
// (claude_local is overridden by beforeEach, so check codex_local instead)
|
|
const codexLocal = res.body.find((a: any) => a.type === "codex_local");
|
|
expect(codexLocal).toBeDefined();
|
|
expect(codexLocal.capabilities).toMatchObject({
|
|
supportsInstructionsBundle: true,
|
|
supportsSkills: true,
|
|
supportsLocalAgentJwt: true,
|
|
requiresMaterializedRuntimeSkills: false,
|
|
});
|
|
|
|
// process adapter should have no local capabilities
|
|
const processAdapter = res.body.find((a: any) => a.type === "process");
|
|
expect(processAdapter).toBeDefined();
|
|
expect(processAdapter.capabilities).toMatchObject({
|
|
supportsInstructionsBundle: false,
|
|
supportsSkills: false,
|
|
supportsLocalAgentJwt: false,
|
|
requiresMaterializedRuntimeSkills: false,
|
|
});
|
|
|
|
// cursor adapter should require materialized runtime skills
|
|
const cursorAdapter = res.body.find((a: any) => a.type === "cursor");
|
|
expect(cursorAdapter).toBeDefined();
|
|
expect(cursorAdapter.capabilities.requiresMaterializedRuntimeSkills).toBe(true);
|
|
expect(cursorAdapter.capabilities.supportsInstructionsBundle).toBe(true);
|
|
|
|
// hermes_local currently supports skills + local JWT, but not the managed
|
|
// instructions bundle flow because the bundled adapter does not consume
|
|
// instructionsFilePath at runtime.
|
|
const hermesAdapter = res.body.find((a: any) => a.type === "hermes_local");
|
|
expect(hermesAdapter).toBeDefined();
|
|
expect(hermesAdapter.capabilities).toMatchObject({
|
|
supportsInstructionsBundle: false,
|
|
supportsSkills: true,
|
|
supportsLocalAgentJwt: true,
|
|
requiresMaterializedRuntimeSkills: false,
|
|
});
|
|
});
|
|
|
|
it("GET /api/adapters derives supportsSkills from listSkills/syncSkills presence", async () => {
|
|
const app = createApp();
|
|
|
|
const res = await request(app).get("/api/adapters");
|
|
expect(res.status).toBe(200);
|
|
|
|
// http adapter has no listSkills/syncSkills
|
|
const httpAdapter = res.body.find((a: any) => a.type === "http");
|
|
expect(httpAdapter).toBeDefined();
|
|
expect(httpAdapter.capabilities.supportsSkills).toBe(false);
|
|
|
|
// codex_local has listSkills/syncSkills
|
|
const codexLocal = res.body.find((a: any) => a.type === "codex_local");
|
|
expect(codexLocal).toBeDefined();
|
|
expect(codexLocal.capabilities.supportsSkills).toBe(true);
|
|
|
|
// acpx_local exposes runtime-aware skill snapshots for Claude/Codex/custom ACP agents
|
|
const acpxLocal = res.body.find((a: any) => a.type === "acpx_local");
|
|
expect(acpxLocal).toBeDefined();
|
|
expect(acpxLocal.capabilities.supportsSkills).toBe(true);
|
|
});
|
|
|
|
it("uses the active adapter when resolving config schema for a paused builtin override", async () => {
|
|
const app = createApp();
|
|
|
|
const active = await request(app).get("/api/adapters/claude_local/config-schema");
|
|
expect(active.status, JSON.stringify(active.body)).toBe(200);
|
|
expect(active.body).toMatchObject({
|
|
fields: [{ key: "mode" }],
|
|
});
|
|
|
|
const paused = await request(app)
|
|
.patch("/api/adapters/claude_local/override")
|
|
.send({ paused: true });
|
|
expect(paused.status, JSON.stringify(paused.body)).toBe(200);
|
|
|
|
const builtin = await request(app).get("/api/adapters/claude_local/config-schema");
|
|
expect([200, 404], JSON.stringify(builtin.body)).toContain(builtin.status);
|
|
expect(builtin.body).not.toMatchObject({
|
|
fields: [{ key: "mode" }],
|
|
});
|
|
});
|
|
|
|
it("serves the built-in acpx_local config schema", async () => {
|
|
const app = createApp();
|
|
|
|
const res = await request(app).get("/api/adapters/acpx_local/config-schema");
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(200);
|
|
expect(res.body.fields).toEqual(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
key: "agent",
|
|
default: "claude",
|
|
options: expect.arrayContaining([
|
|
expect.objectContaining({ value: "claude" }),
|
|
expect.objectContaining({ value: "codex" }),
|
|
expect.objectContaining({ value: "custom" }),
|
|
]),
|
|
}),
|
|
expect.objectContaining({
|
|
key: "permissionMode",
|
|
default: "approve-all",
|
|
}),
|
|
]),
|
|
);
|
|
});
|
|
|
|
it("rejects signed-in users without org access", async () => {
|
|
const app = createApp({
|
|
userId: "outsider-1",
|
|
source: "session",
|
|
companyIds: [],
|
|
memberships: [],
|
|
isInstanceAdmin: false,
|
|
});
|
|
|
|
const res = await request(app).get("/api/adapters/claude_local/config-schema");
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
});
|
|
|
|
it("POST /api/adapters/install preserves module-provided sessionManagement (hot-install parity with init-time IIFE)", async () => {
|
|
const HOT_INSTALL_TYPE = "hot_install_session_test";
|
|
const declaredSessionManagement = {
|
|
supportsSessionResume: true,
|
|
nativeContextManagement: "confirmed" as const,
|
|
defaultSessionCompaction: {
|
|
enabled: true,
|
|
maxSessionRuns: 10,
|
|
maxRawInputTokens: 100_000,
|
|
maxSessionAgeHours: 24,
|
|
},
|
|
};
|
|
const externalModule: ServerAdapterModule = {
|
|
type: HOT_INSTALL_TYPE,
|
|
execute: async () => ({ exitCode: 0, signal: null, timedOut: false }),
|
|
testEnvironment: async () => ({
|
|
adapterType: HOT_INSTALL_TYPE,
|
|
status: "pass",
|
|
checks: [],
|
|
testedAt: new Date(0).toISOString(),
|
|
}),
|
|
sessionManagement: declaredSessionManagement,
|
|
};
|
|
mockPluginLoader.loadExternalAdapterPackage.mockResolvedValue(externalModule);
|
|
|
|
const app = createApp({ isInstanceAdmin: true });
|
|
const res = await request(app)
|
|
.post("/api/adapters/install")
|
|
.send({ packageName: "/tmp/fake-hot-install-adapter", isLocalPath: true });
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(201);
|
|
expect(res.body.type).toBe(HOT_INSTALL_TYPE);
|
|
|
|
const registered = findServerAdapter(HOT_INSTALL_TYPE);
|
|
expect(registered).not.toBeNull();
|
|
expect(registered?.sessionManagement).toEqual(declaredSessionManagement);
|
|
|
|
unregisterServerAdapter(HOT_INSTALL_TYPE);
|
|
});
|
|
});
|