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>
169 lines
5.5 KiB
TypeScript
169 lines
5.5 KiB
TypeScript
import fs from "node:fs";
|
|
import path from "node:path";
|
|
import {
|
|
MANAGED_SHIM_MARKER,
|
|
readInstallManifest,
|
|
resolveInstallStorePaths,
|
|
type InstallStorePaths,
|
|
} from "../install-store.js";
|
|
import type { CheckResult } from "./index.js";
|
|
import { isSupportedNodeVersion, MINIMUM_NODE_VERSION } from "@paperclipai/shared/node-version";
|
|
|
|
function pathContains(directory: string): boolean {
|
|
const normalized = path.resolve(directory);
|
|
return (process.env.PATH ?? "")
|
|
.split(path.delimiter)
|
|
.filter(Boolean)
|
|
.some((entry) => path.resolve(entry) === normalized);
|
|
}
|
|
|
|
function hasManagedArtifacts(paths: InstallStorePaths): boolean {
|
|
const persistentArtifacts = [
|
|
paths.manifestPath,
|
|
paths.markerPath,
|
|
paths.currentPath,
|
|
paths.shimPath,
|
|
].some((entry) => fs.existsSync(entry));
|
|
if (persistentArtifacts) return true;
|
|
try {
|
|
return fs.readdirSync(paths.installsRoot).length > 0;
|
|
} catch (error) {
|
|
if ((error as NodeJS.ErrnoException).code === "ENOENT") return false;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
export function nodeRuntimeCheck(): CheckResult {
|
|
return isSupportedNodeVersion(process.versions.node)
|
|
? { name: "Node.js runtime", status: "pass", message: `Node.js ${process.versions.node}` }
|
|
: {
|
|
name: "Node.js runtime",
|
|
status: "fail",
|
|
message: `Node.js ${process.versions.node} is unsupported`,
|
|
repairHint: `Install Node.js ${MINIMUM_NODE_VERSION} or newer before installing or running Paperclip`,
|
|
};
|
|
}
|
|
|
|
export function managedInstallChecks(
|
|
paths = resolveInstallStorePaths(),
|
|
): CheckResult[] {
|
|
if (!hasManagedArtifacts(paths)) {
|
|
return [
|
|
{
|
|
name: "Managed install",
|
|
status: "pass",
|
|
message: "Not present (optional for npx, global npm, and source-checkout usage)",
|
|
},
|
|
];
|
|
}
|
|
|
|
let manifest;
|
|
try {
|
|
manifest = readInstallManifest(paths);
|
|
} catch (error) {
|
|
return [
|
|
{
|
|
name: "Managed install manifest",
|
|
status: "fail",
|
|
message: error instanceof Error ? error.message : String(error),
|
|
repairHint: "Re-run `paperclipai install` to rebuild the managed install metadata",
|
|
},
|
|
];
|
|
}
|
|
|
|
if (!manifest) {
|
|
return [
|
|
{
|
|
name: "Managed install manifest",
|
|
status: "fail",
|
|
message: `Managed install artifacts exist but ${paths.manifestPath} is missing`,
|
|
repairHint: "Re-run `paperclipai install`",
|
|
},
|
|
];
|
|
}
|
|
|
|
const results: CheckResult[] = [];
|
|
const payloadPath = path.resolve(manifest.payloadPath);
|
|
const relativePayload = path.relative(paths.installsRoot, payloadPath);
|
|
const payloadInStore = Boolean(relativePayload) && !relativePayload.startsWith("..") && !path.isAbsolute(relativePayload);
|
|
const payloadExists = payloadInStore && fs.existsSync(payloadPath) && fs.statSync(payloadPath).isDirectory();
|
|
let currentMatches = false;
|
|
try {
|
|
currentMatches = fs.lstatSync(paths.currentPath).isSymbolicLink()
|
|
&& fs.realpathSync(paths.currentPath) === fs.realpathSync(payloadPath);
|
|
} catch {
|
|
currentMatches = false;
|
|
}
|
|
|
|
results.push(
|
|
payloadExists && currentMatches
|
|
? {
|
|
name: "Managed install store",
|
|
status: "pass",
|
|
message: `${manifest.source} ${manifest.version} is active`,
|
|
}
|
|
: {
|
|
name: "Managed install store",
|
|
status: "fail",
|
|
message: !payloadExists
|
|
? `Manifest payload is missing or outside the install store: ${manifest.payloadPath}`
|
|
: `Current link does not point to ${manifest.payloadPath}`,
|
|
repairHint: "Re-run `paperclipai install` or roll back to a retained payload",
|
|
},
|
|
);
|
|
|
|
let shimValid = false;
|
|
try {
|
|
shimValid = fs.readFileSync(paths.shimPath, "utf8").includes(MANAGED_SHIM_MARKER);
|
|
} catch {
|
|
shimValid = false;
|
|
}
|
|
results.push(
|
|
shimValid
|
|
? { name: "Managed install shim", status: "pass", message: paths.shimPath }
|
|
: {
|
|
name: "Managed install shim",
|
|
status: "fail",
|
|
message: `Missing or unrecognized shim at ${paths.shimPath}`,
|
|
repairHint: "Re-run `paperclipai install`",
|
|
},
|
|
);
|
|
|
|
const shimDirectory = path.dirname(paths.shimPath);
|
|
results.push(
|
|
pathContains(shimDirectory)
|
|
? { name: "Managed install PATH", status: "pass", message: `${shimDirectory} is on PATH` }
|
|
: {
|
|
name: "Managed install PATH",
|
|
status: "warn",
|
|
message: `${shimDirectory} is not on PATH`,
|
|
repairHint: 'Run `export PATH="$HOME/.local/bin:$PATH"` and add it to your shell startup file',
|
|
},
|
|
);
|
|
|
|
const retained = new Set(
|
|
[manifest, ...manifest.previous].map((record) => path.resolve(record.payloadPath)),
|
|
);
|
|
const orphaned: string[] = [];
|
|
for (const source of ["npm", "git"] as const) {
|
|
const sourceRoot = path.join(paths.installsRoot, source);
|
|
if (!fs.existsSync(sourceRoot)) continue;
|
|
for (const entry of fs.readdirSync(sourceRoot)) {
|
|
const candidate = path.join(sourceRoot, entry);
|
|
if (!entry.startsWith(".") && !retained.has(path.resolve(candidate))) orphaned.push(candidate);
|
|
}
|
|
}
|
|
results.push(
|
|
orphaned.length === 0
|
|
? { name: "Managed install retention", status: "pass", message: "No orphaned payloads" }
|
|
: {
|
|
name: "Managed install retention",
|
|
status: "warn",
|
|
message: `${orphaned.length} orphaned payload${orphaned.length === 1 ? "" : "s"} found`,
|
|
repairHint: "A successful `paperclipai update` prunes unretained payloads",
|
|
},
|
|
);
|
|
|
|
return results;
|
|
}
|