mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Paperclip runs across the CLI, server, adapters, plugins, CI, and container images. > - These surfaces declared different Node.js versions from 20 through 24. > - A newer `@types/node` major can expose APIs that the supported runtime does not provide. > - Node.js 20 is no longer a suitable project baseline, and Node.js 24 is the current LTS line. > - This pull request sets Node.js 24.11.0 as one repository-wide baseline, adds a drift check, and gives users actionable startup guidance when their runtime is too old. > - The benefit is one clear runtime contract for development, release, installation, and published packages. ## Linked Issues or Issue Description Refs #2734 Refs #11727 Refs #739 ## What Changed - Require Node.js 24.11.0 or newer in all 42 package manifests and runtime checks. - Use Node.js 24 in GitHub Actions, Docker images, smoke images, sandbox setup, portable installs, and esbuild targets. - Align every direct `@types/node` declaration on `^24.0.0`. - Prevent Dependabot from opening major `@types/node` upgrades without a matching runtime decision. - Add `.nvmrc` and a CI policy check for Node version drift. - Update ACP version gates, tests, and user documentation for the new minimum. - Print a non-blocking warning on CLI and server startup when Node is unsupported, with remediation through a version manager or the documented downloaded `install.sh` workflow. - Deduplicate that warning when `paperclipai run` boots the CLI and server in the same process. ## Verification - `node scripts/check-node-version-policy.mjs` - `node --check scripts/check-node-version-policy.mjs` - `node --check cli/esbuild.config.mjs` - `node --check scripts/generate-npm-package-json.mjs` - `bash -n scripts/install.sh scripts/test-install-sh-docker.sh scripts/e2e-install-lifecycle.sh` - Parsed all 42 package manifests and confirmed `engines.node` is `>=24.11.0`. - `git diff --check` - `vitest run packages/adapter-utils/src/sandbox-install-command.test.ts` passed with 3 tests. - `vitest run cli/src/node-version.test.ts` passed with 4 tests. - Directly exercised the shared warning helper for unsupported-version messaging and same-process deduplication. - The focused exe.dev suite could not resolve the locally unbuilt plugin SDK from this isolated worktree. A full offline workspace install was also blocked because the package-manager signature verifier requires registry access. The full suite was not run locally; draft CI performs a clean install and evaluates the wider impact. ## Risks - This is a breaking runtime change for users, plugins, and deployments that still use Node.js 20 or 22. - Published workspace packages will now produce an engine warning or failure in strict package managers on older Node.js releases. - Node.js 24 can reveal dependency, native module, Playwright, or agent CLI compatibility issues in CI. - The bootstrap installer now installs Node.js 24 when the current runtime is older than 24.11.0. - The portable sandbox fallback is pinned to Node.js 24.11.0 and depends on that upstream tarball remaining available. - Unsupported runtimes continue booting after a warning, so a later incompatibility can still fail at its point of use. - The CLI and server share the warning policy through the published `@paperclipai/shared` package; packaging checks must keep that subpath export available. - This PR does not commit `pnpm-lock.yaml` because repository policy assigns lockfile generation to CI. > 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 based on GPT-5. The exact deployment ID and context window are not exposed in this session. Reasoning, repository tools, shell execution, and GitHub tools were enabled. ## 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 - [x] All Paperclip CI gates are green - [x] 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>
162 lines
3.6 KiB
TypeScript
162 lines
3.6 KiB
TypeScript
/**
|
|
* Bundling presets for Paperclip plugins.
|
|
*
|
|
* These helpers return plain config objects so plugin authors can use them
|
|
* with esbuild or rollup without re-implementing host contract defaults.
|
|
*/
|
|
|
|
export interface PluginBundlerPresetInput {
|
|
pluginRoot?: string;
|
|
manifestEntry?: string;
|
|
workerEntry?: string;
|
|
uiEntry?: string;
|
|
outdir?: string;
|
|
sourcemap?: boolean;
|
|
minify?: boolean;
|
|
}
|
|
|
|
export interface EsbuildLikeOptions {
|
|
entryPoints: string[];
|
|
outdir: string;
|
|
bundle: boolean;
|
|
format: "esm";
|
|
platform: "node" | "browser";
|
|
target: string;
|
|
sourcemap?: boolean;
|
|
minify?: boolean;
|
|
external?: string[];
|
|
}
|
|
|
|
export interface RollupLikeConfig {
|
|
input: string;
|
|
output: {
|
|
dir: string;
|
|
format: "es";
|
|
sourcemap?: boolean;
|
|
entryFileNames?: string;
|
|
};
|
|
external?: string[];
|
|
plugins?: unknown[];
|
|
}
|
|
|
|
export interface PluginBundlerPresets {
|
|
esbuild: {
|
|
worker: EsbuildLikeOptions;
|
|
ui?: EsbuildLikeOptions;
|
|
manifest: EsbuildLikeOptions;
|
|
};
|
|
rollup: {
|
|
worker: RollupLikeConfig;
|
|
ui?: RollupLikeConfig;
|
|
manifest: RollupLikeConfig;
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Build esbuild/rollup baseline configs for plugin worker, manifest, and UI bundles.
|
|
*
|
|
* The presets intentionally externalize host/runtime deps (`react`, SDK packages)
|
|
* to match the Paperclip plugin loader contract.
|
|
*/
|
|
export function createPluginBundlerPresets(input: PluginBundlerPresetInput = {}): PluginBundlerPresets {
|
|
const uiExternal = [
|
|
"@paperclipai/plugin-sdk/ui",
|
|
"@paperclipai/plugin-sdk/ui/hooks",
|
|
"react",
|
|
"react-dom",
|
|
"react/jsx-runtime",
|
|
];
|
|
|
|
const outdir = input.outdir ?? "dist";
|
|
const workerEntry = input.workerEntry ?? "src/worker.ts";
|
|
const manifestEntry = input.manifestEntry ?? "src/manifest.ts";
|
|
const uiEntry = input.uiEntry;
|
|
const sourcemap = input.sourcemap ?? true;
|
|
const minify = input.minify ?? false;
|
|
|
|
const esbuildWorker: EsbuildLikeOptions = {
|
|
entryPoints: [workerEntry],
|
|
outdir,
|
|
bundle: true,
|
|
format: "esm",
|
|
platform: "node",
|
|
target: "node24",
|
|
sourcemap,
|
|
minify,
|
|
external: ["react", "react-dom"],
|
|
};
|
|
|
|
const esbuildManifest: EsbuildLikeOptions = {
|
|
entryPoints: [manifestEntry],
|
|
outdir,
|
|
bundle: true,
|
|
format: "esm",
|
|
platform: "node",
|
|
target: "node24",
|
|
sourcemap,
|
|
external: ["@paperclipai/plugin-sdk"],
|
|
};
|
|
|
|
const esbuildUi = uiEntry
|
|
? {
|
|
entryPoints: [uiEntry],
|
|
outdir: `${outdir}/ui`,
|
|
bundle: true,
|
|
format: "esm" as const,
|
|
platform: "browser" as const,
|
|
target: "es2022",
|
|
sourcemap,
|
|
minify,
|
|
external: uiExternal,
|
|
}
|
|
: undefined;
|
|
|
|
const rollupWorker: RollupLikeConfig = {
|
|
input: workerEntry,
|
|
output: {
|
|
dir: outdir,
|
|
format: "es",
|
|
sourcemap,
|
|
entryFileNames: "worker.js",
|
|
},
|
|
external: ["react", "react-dom"],
|
|
};
|
|
|
|
const rollupManifest: RollupLikeConfig = {
|
|
input: manifestEntry,
|
|
output: {
|
|
dir: outdir,
|
|
format: "es",
|
|
sourcemap,
|
|
entryFileNames: "manifest.js",
|
|
},
|
|
external: ["@paperclipai/plugin-sdk"],
|
|
};
|
|
|
|
const rollupUi = uiEntry
|
|
? {
|
|
input: uiEntry,
|
|
output: {
|
|
dir: `${outdir}/ui`,
|
|
format: "es" as const,
|
|
sourcemap,
|
|
entryFileNames: "index.js",
|
|
},
|
|
external: uiExternal,
|
|
}
|
|
: undefined;
|
|
|
|
return {
|
|
esbuild: {
|
|
worker: esbuildWorker,
|
|
manifest: esbuildManifest,
|
|
...(esbuildUi ? { ui: esbuildUi } : {}),
|
|
},
|
|
rollup: {
|
|
worker: rollupWorker,
|
|
manifest: rollupManifest,
|
|
...(rollupUi ? { ui: rollupUi } : {}),
|
|
},
|
|
};
|
|
}
|