mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 21:05:21 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Local Claude, Codex, Gemini, and custom ACP adapters run through the shared embedded ACPX engine > - That engine wrapped every local agent command in a generated Bash script to inject environment variables and filter child stderr > - Windows cannot directly spawn that Bash wrapper, and npm/pnpm ACP binaries are exposed through `.cmd` shims there > - ACPX 0.12 already supports per-session child environment variables, so the wrapper is unnecessary > - This pull request registers agent commands directly, injects env through ACPX session options, captures child stderr in-process, and adds a real Node ACP spawn smoke on Ubuntu and Windows > - The benefit is one cross-platform spawn path with a reusable smoke test instead of parallel shell-wrapper implementations ## Linked Issues or Issue Description Fixes #9941. Refs #9428 and #9771. **What happened** ACPX-backed local agents failed to start on Windows because Paperclip registered a generated POSIX `.sh` wrapper as the agent command. Windows also needs the `.cmd` npm/pnpm shim when resolving built-in ACP binaries, and symlink creation can fail with `EPERM` for seeded auth/skill files. **Expected behavior** The same ACPX engine path should spawn a real ACP agent on Windows and Linux, forward Paperclip/runtime env without mutating `process.env`, preserve filtered/unfiltered child stderr behavior, and fall back to copies where Windows symlinks are unavailable. **Steps to reproduce** Run a local ACPX adapter on Windows with the prior wrapper path. ACPX attempts to spawn the generated `.sh` file and the agent never initializes. **Deployment mode** Local Paperclip adapters using `packages/adapter-utils/src/acpx-engine/`. ## What Changed - Removed generated Bash agent/env wrappers and registered local commands directly with ACPX. - Passed the resolved child environment through ACPX `sessionOptions.env`, including resume retry paths. - Added a minimal `acpx@0.12.0` package patch exposing child stderr callbacks and allowing documented uppercase env-map keys in persisted session options. - Moved stderr tee/filter behavior in-process: raw stderr remains in the per-run file while benign `nes/close` noise is omitted from live stderr. - Preferred `.cmd` ancestor binaries on Windows and added `EPERM` copy fallbacks for Codex auth seeding and Gemini skill materialization. - Added a real Node ACP echo-agent spawn smoke that can run directly on any supported platform. ## Verification - `pnpm exec vitest run packages/adapter-utils/src/acpx-engine/execute.test.ts packages/adapter-utils/src/acpx-engine/spawn-smoke.test.ts` — 57 passed. - `pnpm --filter @paperclipai/adapter-utils typecheck` — passed. - `node --test scripts/acpx-patch-packaging.test.mjs scripts/release-lib.test.mjs` — 10 passed. - Full canary release dry run under Node 24.18.0 / npm 11.16.0 — passed in an isolated scratch clone. - `git diff --check` — passed during implementation verification. - One-time GitHub Actions proof: [Ubuntu ACPX spawn smoke](https://github.com/paperclipai/paperclip/actions/runs/29924348927/job/88937774579), [Windows ACPX spawn smoke](https://github.com/paperclipai/paperclip/actions/runs/29924348927/job/88937774558), and [Canary Dry Run](https://github.com/paperclipai/paperclip/actions/runs/29924348927/job/88937774497) passed on head `f345ac69f2`; the dedicated smoke jobs are intentionally not retained in the recurring PR workflow. ## Risks - The ACPX stderr callback and env persistence exemption are carried as a pnpm dependency patch until ACPX exposes/fixes those behaviors upstream. - Child stderr is synchronously appended to preserve ordering and failure diagnostics; unusually high-volume agent stderr could briefly block the Node event loop. - The Windows-specific `.cmd` resolution and symlink `EPERM` branches are proven by the standalone smoke test and the linked one-time `windows-latest` run rather than a permanent CI gate. > 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 GPT-5.4 via Codex CLI, medium reasoning, repository/tool execution enabled; context-window size is not exposed in this session. ## 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 searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
117 lines
3.8 KiB
JavaScript
117 lines
3.8 KiB
JavaScript
#!/usr/bin/env node
|
|
/**
|
|
* generate-npm-package-json.mjs
|
|
*
|
|
* Reads the dev package.json (which has workspace:* refs) and produces
|
|
* a publishable package.json in cli/ with:
|
|
* - workspace:* dependencies removed
|
|
* - all external dependencies from workspace packages inlined
|
|
* - proper metadata for npm
|
|
*
|
|
* Reads from cli/package.dev.json if it exists (build already ran),
|
|
* otherwise from cli/package.json.
|
|
*/
|
|
|
|
import { existsSync, readFileSync, writeFileSync } from "node:fs";
|
|
import { resolve, dirname } from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { bundledCliNpmDependencies } from "./cli-bundled-npm-dependencies.mjs";
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = resolve(__dirname, "..");
|
|
|
|
function readPkg(relativePath) {
|
|
return JSON.parse(readFileSync(resolve(repoRoot, relativePath, "package.json"), "utf8"));
|
|
}
|
|
|
|
// Read all workspace packages that are BUNDLED into the CLI.
|
|
// Note: "server" is excluded — it's published separately as a dependency.
|
|
const workspacePaths = [
|
|
"cli",
|
|
"packages/db",
|
|
"packages/shared",
|
|
"packages/adapter-utils",
|
|
"packages/adapters/claude-local",
|
|
"packages/adapters/codex-local",
|
|
"packages/adapters/hermes-gateway",
|
|
"packages/adapters/hermes",
|
|
"packages/adapters/opencode-local",
|
|
"packages/adapters/openclaw-gateway",
|
|
];
|
|
|
|
// Workspace packages that are NOT bundled and must stay as npm dependencies.
|
|
// These get published separately and resolved at runtime.
|
|
const externalWorkspacePackages = new Set([
|
|
"@paperclipai/server",
|
|
]);
|
|
|
|
// Collect all external dependencies from all workspace packages
|
|
const allDeps = {};
|
|
const allOptionalDeps = {};
|
|
|
|
for (const pkgPath of workspacePaths) {
|
|
const pkg = readPkg(pkgPath);
|
|
const deps = pkg.dependencies || {};
|
|
const optDeps = pkg.optionalDependencies || {};
|
|
|
|
for (const [name, version] of Object.entries(deps)) {
|
|
if (name.startsWith("@paperclipai/") && !externalWorkspacePackages.has(name)) continue;
|
|
if (bundledCliNpmDependencies.has(name)) continue;
|
|
// For external workspace packages, read their version directly
|
|
if (externalWorkspacePackages.has(name)) {
|
|
const pkgDirMap = { "@paperclipai/server": "server" };
|
|
const wsPkg = readPkg(pkgDirMap[name]);
|
|
allDeps[name] = wsPkg.version;
|
|
continue;
|
|
}
|
|
// Keep the more specific (pinned) version if conflict
|
|
if (!allDeps[name] || !version.startsWith("^")) {
|
|
allDeps[name] = version;
|
|
}
|
|
}
|
|
|
|
for (const [name, version] of Object.entries(optDeps)) {
|
|
allOptionalDeps[name] = version;
|
|
}
|
|
}
|
|
|
|
// Sort alphabetically
|
|
const sortedDeps = Object.fromEntries(Object.entries(allDeps).sort(([a], [b]) => a.localeCompare(b)));
|
|
const sortedOptDeps = Object.fromEntries(
|
|
Object.entries(allOptionalDeps).sort(([a], [b]) => a.localeCompare(b)),
|
|
);
|
|
|
|
// Read the CLI package metadata — prefer the dev backup if it exists
|
|
const devPkgPath = resolve(repoRoot, "cli/package.dev.json");
|
|
const cliPkg = existsSync(devPkgPath)
|
|
? JSON.parse(readFileSync(devPkgPath, "utf8"))
|
|
: readPkg("cli");
|
|
|
|
// Build the publishable package.json
|
|
const publishPkg = {
|
|
name: cliPkg.name,
|
|
version: cliPkg.version,
|
|
description: cliPkg.description,
|
|
type: cliPkg.type,
|
|
bin: cliPkg.bin,
|
|
keywords: cliPkg.keywords,
|
|
license: cliPkg.license,
|
|
repository: cliPkg.repository,
|
|
homepage: cliPkg.homepage,
|
|
bugs: cliPkg.bugs,
|
|
files: cliPkg.files,
|
|
engines: { node: ">=20" },
|
|
dependencies: sortedDeps,
|
|
};
|
|
|
|
if (Object.keys(sortedOptDeps).length > 0) {
|
|
publishPkg.optionalDependencies = sortedOptDeps;
|
|
}
|
|
|
|
const output = JSON.stringify(publishPkg, null, 2) + "\n";
|
|
const outPath = resolve(repoRoot, "cli/package.json");
|
|
writeFileSync(outPath, output);
|
|
|
|
console.log(` ✓ Generated publishable package.json (${Object.keys(sortedDeps).length} deps)`);
|
|
console.log(` Version: ${cliPkg.version}`);
|