mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-02 10:16:20 +08: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>
86 lines
3.8 KiB
JavaScript
86 lines
3.8 KiB
JavaScript
import fs from "node:fs";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
|
|
const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
|
const expectedEngine = ">=24.11.0";
|
|
const expectedTypes = "^24.0.0";
|
|
const failures = [];
|
|
const skippedDirectories = new Set([".git", ".paperclip", "coverage", "data", "dist", "node_modules"]);
|
|
|
|
function relative(filePath) {
|
|
return path.relative(repoRoot, filePath) || ".";
|
|
}
|
|
|
|
function walk(directory, visit) {
|
|
for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
|
|
if (entry.isDirectory() && skippedDirectories.has(entry.name)) continue;
|
|
const entryPath = path.join(directory, entry.name);
|
|
if (entry.isDirectory()) walk(entryPath, visit);
|
|
else if (entry.isFile()) visit(entryPath);
|
|
}
|
|
}
|
|
|
|
walk(repoRoot, (filePath) => {
|
|
if (path.basename(filePath) !== "package.json") return;
|
|
const manifest = JSON.parse(fs.readFileSync(filePath, "utf8"));
|
|
for (const section of ["dependencies", "devDependencies", "optionalDependencies", "peerDependencies"]) {
|
|
const specifier = manifest[section]?.["@types/node"];
|
|
if (specifier && specifier !== expectedTypes) {
|
|
failures.push(`${relative(filePath)}: ${section}.@types/node must be ${expectedTypes}, found ${specifier}`);
|
|
}
|
|
}
|
|
if (manifest.engines?.node !== expectedEngine) {
|
|
failures.push(`${relative(filePath)}: engines.node must be ${expectedEngine}, found ${manifest.engines?.node ?? "missing"}`);
|
|
}
|
|
});
|
|
|
|
const workflowRoot = path.join(repoRoot, ".github", "workflows");
|
|
walk(workflowRoot, (filePath) => {
|
|
if (!/\.ya?ml$/.test(filePath)) return;
|
|
const source = fs.readFileSync(filePath, "utf8");
|
|
for (const match of source.matchAll(/node-version:\s*["']?([^\s"'#]+)/g)) {
|
|
if (match[1] !== "24") failures.push(`${relative(filePath)}: node-version must be 24, found ${match[1]}`);
|
|
}
|
|
});
|
|
|
|
walk(repoRoot, (filePath) => {
|
|
if (!path.basename(filePath).startsWith("Dockerfile")) return;
|
|
const source = fs.readFileSync(filePath, "utf8");
|
|
for (const match of source.matchAll(/^\s*FROM\s+node:([^\s]+)/gm)) {
|
|
if (!match[1].startsWith("24-")) failures.push(`${relative(filePath)}: Node base image must use the Node 24 major, found node:${match[1]}`);
|
|
}
|
|
for (const match of source.matchAll(/^\s*ARG\s+NODE_(?:MAJOR|VERSION)=([^\s]+)/gm)) {
|
|
if (match[1] !== "24") failures.push(`${relative(filePath)}: Node build argument must be 24, found ${match[1]}`);
|
|
}
|
|
});
|
|
|
|
const requiredSourceFragments = [
|
|
[".nvmrc", "24"],
|
|
["packages/shared/src/node-version.ts", 'MINIMUM_NODE_VERSION = "24.11.0"'],
|
|
["scripts/install.sh", "MIN_NODE_VERSION=\"${MIN_NODE_MAJOR}.${MIN_NODE_MINOR}.${MIN_NODE_PATCH}\""],
|
|
["scripts/install.sh", "MIN_NODE_MAJOR=24"],
|
|
["scripts/install.sh", "MIN_NODE_MINOR=11"],
|
|
["scripts/install.sh", "DEFAULT_NODE_MAJOR=24"],
|
|
["docker/agent-runtime/Dockerfile.base", "ARG NODE_VERSION=24"],
|
|
["packages/adapter-utils/src/sandbox-install-command.ts", "NODE_VERSION=\"v24.11.0\""],
|
|
["packages/plugins/sandbox-providers/exe-dev/src/plugin.ts", "nodesource.com/setup_24.x"],
|
|
["packages/plugins/sandbox-providers/modal/src/manifest.ts", 'default: "node:24"'],
|
|
["cli/esbuild.config.mjs", 'target: "node24"'],
|
|
["packages/plugins/sdk/src/bundlers.ts", 'target: "node24"'],
|
|
["scripts/generate-npm-package-json.mjs", `engines: { node: "${expectedEngine}" }`],
|
|
];
|
|
|
|
for (const [filePath, fragment] of requiredSourceFragments) {
|
|
const source = fs.readFileSync(path.join(repoRoot, filePath), "utf8");
|
|
if (!source.includes(fragment)) failures.push(`${filePath}: missing Node 24 policy fragment ${JSON.stringify(fragment)}`);
|
|
}
|
|
|
|
if (failures.length > 0) {
|
|
console.error("Node version policy check failed:");
|
|
for (const failure of failures) console.error(`- ${failure}`);
|
|
process.exit(1);
|
|
}
|
|
|
|
console.log("Node version policy check passed (Node >=24.11.0, @types/node 24.x).");
|