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>
95 lines
3.7 KiB
TypeScript
95 lines
3.7 KiB
TypeScript
// Re-export everything from the shared adapter-utils/server-utils package.
|
|
// This file is kept as a convenience shim so existing in-tree
|
|
// imports (process/, http/, heartbeat.ts) don't need rewriting.
|
|
import type { ChildProcess } from "node:child_process";
|
|
import { logger } from "../middleware/logger.js";
|
|
import * as serverUtils from "@paperclipai/adapter-utils/server-utils";
|
|
export type { RunProcessResult } from "@paperclipai/adapter-utils/server-utils";
|
|
|
|
type BuildInvocationEnvForLogsOptions = {
|
|
runtimeEnv?: NodeJS.ProcessEnv | Record<string, string>;
|
|
includeRuntimeKeys?: string[];
|
|
resolvedCommand?: string | null;
|
|
resolvedCommandEnvKey?: string;
|
|
};
|
|
|
|
export const runningProcesses: Map<string, { child: ChildProcess; graceSec: number; processGroupId: number | null }> =
|
|
serverUtils.runningProcesses;
|
|
export const MAX_CAPTURE_BYTES = serverUtils.MAX_CAPTURE_BYTES;
|
|
export const MAX_EXCERPT_BYTES = serverUtils.MAX_EXCERPT_BYTES;
|
|
export const parseObject = serverUtils.parseObject;
|
|
export const asString = serverUtils.asString;
|
|
export const asNumber = serverUtils.asNumber;
|
|
export const asBoolean = serverUtils.asBoolean;
|
|
export const asStringArray = serverUtils.asStringArray;
|
|
export const parseJson = serverUtils.parseJson;
|
|
export const appendWithCap = serverUtils.appendWithCap;
|
|
export const appendWithByteCap = serverUtils.appendWithByteCap;
|
|
export const resolvePathValue = serverUtils.resolvePathValue;
|
|
export const renderTemplate = serverUtils.renderTemplate;
|
|
export const redactEnvForLogs = serverUtils.redactEnvForLogs;
|
|
export const buildPaperclipEnv = serverUtils.buildPaperclipEnv;
|
|
export const defaultPathForPlatform = serverUtils.defaultPathForPlatform;
|
|
export const ensurePathInEnv = serverUtils.ensurePathInEnv;
|
|
export const ensureAbsoluteDirectory = serverUtils.ensureAbsoluteDirectory;
|
|
export const ensureCommandResolvable = serverUtils.ensureCommandResolvable;
|
|
export const resolveCommandForLogs = serverUtils.resolveCommandForLogs;
|
|
|
|
export function buildInvocationEnvForLogs(
|
|
env: Record<string, string>,
|
|
options: BuildInvocationEnvForLogsOptions = {},
|
|
): Record<string, string> {
|
|
const maybeBuildInvocationEnvForLogs = (
|
|
serverUtils as typeof serverUtils & {
|
|
buildInvocationEnvForLogs?: (
|
|
env: Record<string, string>,
|
|
options?: BuildInvocationEnvForLogsOptions,
|
|
) => Record<string, string>;
|
|
}
|
|
).buildInvocationEnvForLogs;
|
|
|
|
if (typeof maybeBuildInvocationEnvForLogs === "function") {
|
|
return maybeBuildInvocationEnvForLogs(env, options);
|
|
}
|
|
|
|
const merged: Record<string, string> = { ...env };
|
|
const runtimeEnv = options.runtimeEnv ?? {};
|
|
|
|
for (const key of options.includeRuntimeKeys ?? []) {
|
|
if (key in merged) continue;
|
|
const value = runtimeEnv[key];
|
|
if (typeof value !== "string" || value.length === 0) continue;
|
|
merged[key] = value;
|
|
}
|
|
|
|
const resolvedCommand = options.resolvedCommand?.trim();
|
|
if (resolvedCommand) {
|
|
merged[options.resolvedCommandEnvKey ?? "PAPERCLIP_RESOLVED_COMMAND"] =
|
|
serverUtils.redactCommandTextForLogs(resolvedCommand);
|
|
}
|
|
|
|
return redactEnvForLogs(merged);
|
|
}
|
|
|
|
// Re-export runChildProcess with the server's pino logger wired in.
|
|
import type { RunProcessResult } from "@paperclipai/adapter-utils/server-utils";
|
|
const _runChildProcess = serverUtils.runChildProcess;
|
|
|
|
export async function runChildProcess(
|
|
runId: string,
|
|
command: string,
|
|
args: string[],
|
|
opts: {
|
|
cwd: string;
|
|
env: Record<string, string>;
|
|
timeoutSec: number;
|
|
graceSec: number;
|
|
onLog: (stream: "stdout" | "stderr", chunk: string) => Promise<void>;
|
|
},
|
|
): Promise<RunProcessResult> {
|
|
return _runChildProcess(runId, command, args, {
|
|
...opts,
|
|
onLogError: (err, id, msg) => logger.warn({ err, runId: id }, msg),
|
|
});
|
|
}
|