* fix(#2544): stage the CommonJS marker in GSD-owned dirs, not the config root installSharedHooksBundle wrote `{"type":"commonjs"}` over <configRoot>/package.json unconditionally — no existence check, no merge, no backup — on every install and every /gsd-update re-install. On the 11 affected runtimes that file is often user-owned; on OpenCode and Kilo it is the documented place to declare local-plugin npm dependencies, so a user's name/type/dependencies/scripts were destroyed on each run. The uninstall path already read the file and unlinked it only on an exact content match. That asymmetry was the defect: the discipline existed in the codebase, it just was not applied on the write side. Move the marker into the directories GSD creates and fills with its own .js files — hooks/ (all shared-hooks runtimes, incl. Kimi's own root) and the nativePlugin dir (plugins/ for OpenCode+Kilo, extensions/ for pi) — and stop writing the config root entirely. New src/commonjs-marker.cts owns the marker string plus one ownership predicate (absent / gsd-owned / foreign, fail-closed on an unreadable file) shared by ensureCommonJsMarker and removeCommonJsMarker, so install and uninstall cannot drift apart again. Nothing else depended on the config-root marker: package identity is baked at build time (#378/#498) and version resolution prefers gsd-core/VERSION and already tolerates a missing root package.json (#1383) — Codex has installed without one all along. A package.json in plugins/ or extensions/ is inert to plugin discovery, which globs *.{ts,js} only (see installer-migration 006). Uninstall retires the pre-fix config-root marker, so upgrading users are cleaned up on removal, and still never touches a file it did not write. * fix(#2544): point the changeset fragment at the filed PR The fragment's `pr:` field is only knowable after `gh pr create` returns. * fix(#2544): register commonjs-marker.cjs in the tsc-generated ESLint ignore set bin/lib/commonjs-marker.cjs is tsc output (src/commonjs-marker.cts is the linted source), so it belongs in the ADR-457 ignore list like its siblings. Clears the lint-tests no-var failure and the repo-invariants "linted xor ignored" migration-state test. * fix(#2544): pin the kimi CommonJS marker to hooks/, not the ~/.kimi root The UPGRADE 1 test still asserted the pre-#2544 marker location (~/.kimi/package.json). The marker now lives inside ~/.kimi/hooks — the directory GSD itself creates — matching the updated golden-install-parity and install-tree fixtures. Also asserts the root marker is NOT written. * fix(#2544): make the CommonJS marker write path non-fatal Review round 2, Major 3 + Minor 1 + the stagedHooks nit. ensureCommonJsMarker rethrew any non-EEXIST write error and neither call site caught it, so EACCES on a read-only hooks/, EROFS, or ENOSPC aborted the whole install with a raw stack trace. Every other marker interaction in the module is best-effort — removeCommonJsMarker swallows unlink failures, classifyMarker swallows read failures — and this was the write path, i.e. the one most likely to fail on a locked-down config dir. It now returns a new 'failed' outcome and both call sites warn and continue. Sibling found while sweeping for the same defect class: fs.mkdirSync sat OUTSIDE the try block, so an unwritable parent threw past the guard entirely. Creating the directory is the same environmental hazard as writing into it, so it moved inside. Also in this file: - The hooks marker is now gated on `stagedHooks && hooksOk`, not stagedHooks alone. stagedHooks is computed from the SOURCE listing before the copy loop, so it stays true when the copies land but verifyInstalled() then fails — marking a hooks/ GSD did not successfully populate claims an ownership the install did not earn. - The uninstall rmdir of the native plugin dir is gated on GSD having actually removed something from it. Hoisting it out of the adapter-exists guard (so the marker-only case could prune) had silently widened it into deleting a user-created but empty plugins/ or extensions/ dir — the same "don't touch territory GSD didn't fill" principle this issue is about, inverted. - Kimi's pre-#2544 marker at its native hook root (~/.kimi) is retired at the same call site that writes its replacement. That path is outside kimi's configDir, so installer-migration 007 structurally cannot reach it. * fix(#2544): retire the stale config-root marker via installer-migration 007 Review round 2, Major 1 — the PR's headline claim was false for existing installs. Upgraders kept BOTH markers: the new one under hooks/ and the stale {"type":"commonjs"} at the config root, so their config root stayed pinned to CommonJS and their dependency manifest stayed gone until they uninstalled. The migration is unusual in one way, and it is the part worth reviewing: the config-root marker was never recorded in gsd-file-manifest.json (writeManifest records hooks/, agents/, commands/, scripts/ and the native plugin, never a root package.json), so classifyArtifact answers 'unknown' for it and the planner's own guard downgrades a remove-managed on an 'unknown' classification to preserve-user. 007 therefore supplies the "purpose-built detector for an old GSD-owned shape" that docs/installer-migrations.md#remove-managed sanctions — exact content match, the same predicate removeCommonJsMarker has always used — and declares the resulting classification on the action. A package.json with any other content is left untouched, and there is deliberately no backup-and-remove branch: a non-matching file here is not a patched GSD artifact, it is somebody else's file. Scope is all runtimes. The `runtimes` field is OMITTED rather than `[]`: validateStringArray requires the field to be non-empty WHEN PRESENT, while the runtime filter treats an empty array as "all" — so `runtimes: []` throws at plan time and the migration never runs. The metadata test pins this. Kimi is a deliberate carve-out, named in the migration's own header: its marker lived at ~/.kimi, outside kimi's configDir, and migration relPaths are structurally confined to configDir. It is retired by the installer instead. Registration: shipped-migrations table, .gitignore for the emitted .cjs, the EXPECTED_CHECKSUMS baseline, and the ESLint ignore set. That last one is not copied from migration 006 by rote — 006 needs no entry because it imports nothing, while 007 imports node builtins, so tsc emits its __importDefault helper and the `var` in it trips no-var. This is the same lint gate that made round 1 red. * test(#2544): fault-injection and multi-runtime marker coverage Review round 2, Major 2 + Minors 4 and 5. Major 2 — CONTRIBUTING.md:514-531 is mandatory for install/uninstall flows and the suite had no fs monkeypatching at all. Every branch now covered is one whose doc comment claims it as the module's safety posture: - classifyMarker non-ENOENT lstat error -> 'foreign' (the fail-closed rule), with an ENOENT control alongside it so the test discriminates rather than just asserting one side - classifyMarker readFileSync throw -> 'foreign' (present-but-unreadable never downgrades to the permissive answer) — the fixture's bytes are exactly GSD's marker, so the test fails if the code ever answers on content it could not read - a DIRECTORY at the marker path (CONTRIBUTING:521; the symlink case was already covered with a real symlink, the directory case needs no injection at all) - the ensureCommonJsMarker TOCTOU EEXIST branch — the entire reason for flag:'wx' - the new 'failed' outcome, for both writeFileSync (EACCES/EROFS/ENOSPC) and the mkdirSync that used to sit outside the guard - removeCommonJsMarker unlink throw -> false These save and restore fs methods in `finally` rather than using chmod 0o000, which does not fault under root and would pass vacuously in root Docker and CI. Minor 4 — uninstall was driven for opencode only. pi's extensions/ and both kimi locations now have behavioral coverage, install and uninstall, each paired with a user-authored-file case proving GSD leaves it alone. Minor 5 — the stagedHooks gate had no assertion behind its stated reason. A pre-existing, GSD-untouched hooks/ directory is now driven through a runtime that declares skipSharedHooksInstall and asserted to stay marker-free, with its user content intact. Also regression-tests the uninstall rmdir gate from the previous commit: an empty plugin dir GSD removed nothing from must survive. * docs(#2544): correct stale marker prose, register the module, document the trade-off Review round 2, Minors 2, 3 and 6. Minor 2 — six files asserted the installed ROOT ships the synthetic marker. None was load-bearing (all three walk-up consumers are VERSION-first with try/catch and the marker never carried a `version`), but ADR-457:52 is the rationale for keeping a generated module, so a future reader would mis-derive the constraint from it. Each site is corrected to what is now true: the installed tree carries no package.json with a .name at all, because the only ones GSD stages are {"type":"commonjs"} markers and they now live in GSD's own directories. Two of the six needed more than a location swap. hooks/gsd-check-update-worker.js and the platform-gate test both described `require('../package.json').name` resolving to undefined; post-#2544 that require does not resolve at all, so the history is kept accurate and the present-tense claim corrected rather than just moved. And src/runtime-artifact-conversion.cts described the no-root-package.json case as Codex-only — it is now every runtime, which strengthens that comment's own argument for lazy resolution. The generated .cjs sibling needs no edit: it is gitignored build output, not a tracked file. Minor 3 — src/commonjs-marker.cts had no CONTEXT.md entry, unlike every peer module, and CONTEXT.md is the #2 co-change partner of bin/install.js. Added, including the fail-closed posture and the never-throws contract. Minor 6 — the plugins//extensions/ marker shadows the config root for all .js siblings, so an OpenCode/Kilo user's ESM plugin/*.js stays broken. That is exactly what #2544's Fix section prescribed and it is disclosed in the PR body, but the PR body is not documentation. It now lives in the OpenCode section of docs/how-to/install-on-your-runtime.md, stated as a real constraint rather than a pure improvement, with the .ts mitigation and a fallback for ESM plugins. * test(#2544): attribute the CommonJS marker in the emitted-provenance rules The differential emitted-attribution gate (#2723, landed on `next` after this branch was cut) went red on the macOS shards once this PR rebased onto it. Two distinct causes, both real gaps rather than noise: 1. `plugins/package.json` and `extensions/package.json` matched NO rule — the `native-plugin` rule covers `*.{js,cjs,mjs}` only, so the marker read as an unattributed emitted family. 2. `hooks/package.json` fell through to `hooks-built`, which attributes an emitted `hooks/<X>` to a repo source `hooks/<X>`. There is no `hooks/package.json` in the repo, so it resolved to a nonexistent path. Cause 2 is exactly the failure already documented three lines above it for Copilot's `gsd-session.json` — "a code literal, not a built script" — so the fix follows that precedent rather than inventing one: `package.json` is excluded from `hooks-built` the same way, and a dedicated `commonjs-marker` rule attributes the family across all four roots it can appear in (both hooks roots plus `plugins`/`extensions`) to the sources that actually emit it. Deliberately a RULE, not an entry in tests/emitted-drift-ack.json. An ack is for a one-off ripple and goes stale by design — the gate fails a stale ack precisely so it cannot pre-clear the next change on that path. These markers are a permanent part of the emitted tree from #2544 onward, so they need standing attribution. Verified by reproducing the CI failure locally with GSD_EMITTED_BASE: 3 provenance errors + 12 unattributed paths before, 35/35 green after. * fix(#2544): route the #2717 hooks-surface marker helpers through commonjs-marker #2717 landed a second copy of ensureCommonJsMarker/removeCommonJsMarkerIfGsdOwned in src/runtime-hooks-surface.cts for the runtimes that stage .js hooks via dedicated paths (cursor/windsurf/codex). That copy had drifted from this PR's module on the two properties that matter: - ownership probe: `fs.existsSync` FOLLOWS symlinks and reports false for a DANGLING one, so a dangling package.json symlink classified as absent and the write went straight through it. Demonstrated: against the pre-fix copy, ensureCommonJsMarker() on a hooks/ dir holding a dangling package.json symlink returns true and creates {"type":"commonjs"} OUTSIDE that directory. - create: a plain writeFileSync leaves the classify->write window open, where commonjs-marker creates with flag:'wx' (O_EXCL). Both helpers now delegate to src/commonjs-marker.cts, which is what this PR's own docstring already claimed was the single place these rules are enforced. Exported signatures are unchanged (still boolean), so bin/install.js and the #2717 tests are unaffected. The new subtest is the only coverage that fails if the duplicate is ever reintroduced — the two implementations agree on every non-adversarial input, so the existing suites pass against both. * test(#2544): pin the stagedHooks gate on zcode, not windsurf The Minor-5 coverage picked windsurf because hostBehaviors.skipSharedHooksInstall kept it out of the shared hooks bundle, so GSD staged nothing into hooks/ and the marker was correctly absent. #2717 changed that premise: cursor/windsurf/codex now stage their .js hooks via dedicated paths and get the marker beside those scripts. Measured on this tree, windsurf stages 2 .js hooks and receives a marker — so the assertion was pinning behaviour that is now wrong, not the gate it was written for. ZCode is the durable choice: per #1821 it has hooksSurface:'none' AND no plugin surface to spawn hooks, so GSD stages no .js there by either route (measured: 0 staged, no marker). The property under test is unchanged — a user-created hooks/ directory GSD never fills stays marker-free. * test(#2544): use the shared cleanup helper in the migration test Addresses the review's Major 1. The suppression's stated reason — "no helpers import available" — was not correct: tests/helpers.cjs exports cleanup, and the other test file added in this same PR imports it (tests/commonjs-marker.test.cjs). The local reimplementation dropped two protections that are live on this repo's windows-latest lane: the CWD guard (Windows cannot remove a directory that is the current working directory) and the 20 x 250ms retry budget that absorbs the deferred-scan handle Windows Defender holds on newly-written files. Local function and suppression both removed; local/no-raw-rmsync-in-tests now passes without one. * test(#2544): expect hooks/package.json for the #2717 runtimes The fresh-install contract table predates #2717, which stages cursor/windsurf/ codex .js hooks via dedicated paths and writes the CommonJS marker beside them. All three therefore now receive hooks/package.json legitimately. Measured on this tree: codex stages 3 .js hooks, cursor 6, windsurf 2 — each with the marker; cline/copilot/trae/zcode stage none and get none, so their contracts are unchanged. * fix(#2544): gate the #2717 marker writes on having staged something The three dedicated marker writers #2717 added ran unconditionally. Each one mkdirs hooks/ up front and stages its scripts conditionally on the source existing, so with an absent or empty hook source they created a directory, filled it with nothing, and marked it as GSD's anyway. That is the same write-into-someone-else's-territory this issue is about, and installSharedHooksBundle already guards the identical case with `stagedHooks`. The dedicated paths now carry the matching gate: - cursor / windsurf: `installedScripts.size > 0` - codex: a new `codexStagedHooks` flag. The enclosing guard only proves that hooks/dist EXISTS; it says nothing about whether any CODEX_HOOKS_TO_COPY entry landed. Covered for cursor and windsurf by driving each writer against a src tree whose hooks/ dir is empty. The codex leg is defensive and deliberately uncovered: its trigger state needs a package tree where hooks/dist exists but holds none of the allowlist, which is not constructible from a real checkout. * test(#2544): scope the commonjs-marker sources per root The rule declared one flat source list for every marker root, so `extensions/package.json` was attributed to runtime-hooks-surface.cts (which never writes there) and `.kimi/hooks/package.json` to install-engine.cts. That is not merely untidy. emitted-diff.cjs accepts the FIRST satisfied source, so a flat list containing bin/install.js let any change anywhere in that 13k-line file authorise marker drift for every root — the blanket escape hatch this file's own agents-verbatim comment refuses for exactly the same reason. Sources are now derived per root from ctx.rel. Note the rule ctx is `{ rel, runtime }` and carries no `root`, so keying on ctx.root would have sent every path down one branch silently. * test(#2544): state precisely what the zcode assertion pins The comment claimed the test pinned installSharedHooksBundle's `stagedHooks` gate. It does not, and neither did the windsurf version it replaced: zcode declares skipSharedHooksInstall, so the outer guard skips that helper entirely and the gate is never evaluated. The test passes on the runtime exclusion. What it does pin — the outcome a pre-existing, GSD-untouched hooks/ stays marker-free — is still worth having, and is what the review asked for. The two `staging zero hook scripts` tests are the ones that pin a real staged-nothing gate. Comment corrected rather than left implying coverage that is not there. --------- Co-authored-by: Tom Boucher <trekkie@nomorestars.com>
This commit is contained in:
0xdhx
142
src/commonjs-marker.cts
Normal file
142
src/commonjs-marker.cts
Normal file
@@ -0,0 +1,142 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* CommonJS module-type marker — single source of truth (#2544).
|
||||
*
|
||||
* GSD stages its own hook scripts and native plugin adapters as `.js` files.
|
||||
* Node resolves a `.js` file's module type by walking up for the nearest
|
||||
* `package.json`, so an ambient `"type": "module"` above the install location
|
||||
* makes every one of those scripts fail with `require is not defined`. GSD
|
||||
* pins them to CommonJS by writing a minimal `{"type":"commonjs"}` marker.
|
||||
*
|
||||
* Two rules govern that marker, and this module exists so both are enforced in
|
||||
* exactly one place:
|
||||
*
|
||||
* 1. **Write only where GSD owns the contents.** The marker belongs in the
|
||||
* directories GSD fills with its own `.js` files (`hooks/`, and the
|
||||
* `nativePlugin.dir` for the runtimes that declare one) — never at the
|
||||
* runtime's shared config root, which on OpenCode and Kilo is documented,
|
||||
* user-writable territory for declaring local-plugin npm dependencies.
|
||||
*
|
||||
* 2. **Never overwrite a file GSD did not write.** Before #2544 the install
|
||||
* path wrote the marker unconditionally while the uninstall path already
|
||||
* compared content before unlinking. That asymmetry is the defect: the
|
||||
* discipline existed in the codebase, it was simply not applied on the
|
||||
* write side. `classifyMarker` is now the shared predicate behind both
|
||||
* `ensureCommonJsMarker` and `removeCommonJsMarker`, so install and
|
||||
* uninstall cannot drift apart again.
|
||||
*
|
||||
* Ownership is decided by exact content match against the marker GSD itself
|
||||
* writes — the same test the uninstall path has always used.
|
||||
*/
|
||||
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
|
||||
/** The exact marker content GSD writes (and the only content it will remove). */
|
||||
export const COMMONJS_MARKER = '{"type":"commonjs"}';
|
||||
|
||||
/** File bytes written to disk — the marker plus a trailing newline. */
|
||||
export const COMMONJS_MARKER_CONTENT = `${COMMONJS_MARKER}\n`;
|
||||
|
||||
/**
|
||||
* `absent` — no package.json here; GSD may create one.
|
||||
* `gsd-owned` — content is exactly GSD's marker; GSD may rewrite or remove it.
|
||||
* `foreign` — anything else, including a present-but-unreadable file. GSD
|
||||
* must leave it strictly alone.
|
||||
*/
|
||||
export type MarkerOwnership = 'absent' | 'gsd-owned' | 'foreign';
|
||||
|
||||
/**
|
||||
* Outcome of an `ensureCommonJsMarker` call, for caller-side reporting.
|
||||
*
|
||||
* `failed` is the best-effort outcome: the marker could not be written for an
|
||||
* environmental reason (`EACCES` on a read-only `hooks/`, `EROFS`, `ENOSPC`).
|
||||
* It is reported, never thrown — see `ensureCommonJsMarker`.
|
||||
*/
|
||||
export type MarkerWriteOutcome = 'written' | 'unchanged' | 'preserved-foreign' | 'failed';
|
||||
|
||||
/** The marker path for a directory. */
|
||||
export function markerPathFor(dir: string): string {
|
||||
return path.join(dir, 'package.json');
|
||||
}
|
||||
|
||||
/**
|
||||
* Classify the package.json in `dir` by ownership.
|
||||
*
|
||||
* Fails CLOSED: a file that exists but cannot be read is reported `foreign`,
|
||||
* never `absent`. Reporting it absent would license the overwrite this module
|
||||
* exists to prevent. (Same posture as the unreadable-config branch in
|
||||
* capability-command-router.cjs: present-but-unreadable never downgrades to
|
||||
* the permissive answer.)
|
||||
*/
|
||||
export function classifyMarker(dir: string): MarkerOwnership {
|
||||
const markerPath = markerPathFor(dir);
|
||||
let stat: import('node:fs').Stats;
|
||||
try {
|
||||
// lstat, not existsSync: existsSync follows symlinks and reports `false`
|
||||
// for a DANGLING one, which would classify the path `absent` and let the
|
||||
// write below follow the link and land outside the directory GSD owns.
|
||||
stat = fs.lstatSync(markerPath);
|
||||
} catch (err) {
|
||||
if ((err as NodeJS.ErrnoException).code === 'ENOENT') return 'absent';
|
||||
return 'foreign';
|
||||
}
|
||||
// Anything that is not a regular file (symlink, directory, socket) is not
|
||||
// something GSD wrote, so it is never ours to overwrite or remove.
|
||||
if (!stat.isFile()) return 'foreign';
|
||||
try {
|
||||
const content = fs.readFileSync(markerPath, 'utf8');
|
||||
return content.trim() === COMMONJS_MARKER ? 'gsd-owned' : 'foreign';
|
||||
} catch {
|
||||
return 'foreign';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Write the CommonJS marker into `dir`, unless a file GSD does not own is
|
||||
* already there.
|
||||
*
|
||||
* Creates `dir` when needed. Returns what happened so the caller can report
|
||||
* it; a `preserved-foreign` result is not an error — it is the guard working.
|
||||
*
|
||||
* NEVER THROWS. Every other marker interaction in this module is best-effort —
|
||||
* `removeCommonJsMarker` swallows unlink failures, `classifyMarker` swallows
|
||||
* read failures — and the write path is the one most likely to fail on a
|
||||
* locked-down config dir (`EACCES` on a read-only `hooks/`, `EROFS`, `ENOSPC`).
|
||||
* Letting it throw made an unwritable marker abort the entire install with a
|
||||
* raw stack trace, which is a strictly worse outcome than hooks that resolve as
|
||||
* ESM: the caller can warn and continue, and does. Both the `mkdir` and the
|
||||
* write are inside the guard — creating the directory is the same environmental
|
||||
* hazard as writing into it.
|
||||
*/
|
||||
export function ensureCommonJsMarker(dir: string): MarkerWriteOutcome {
|
||||
const ownership = classifyMarker(dir);
|
||||
if (ownership === 'foreign') return 'preserved-foreign';
|
||||
if (ownership === 'gsd-owned') return 'unchanged';
|
||||
try {
|
||||
fs.mkdirSync(dir, { recursive: true });
|
||||
// Exclusive create closes the gap between classifying and writing: if
|
||||
// anything at all appeared at the path in between — including a symlink —
|
||||
// this fails with EEXIST instead of following or overwriting it.
|
||||
fs.writeFileSync(markerPathFor(dir), COMMONJS_MARKER_CONTENT, { flag: 'wx' });
|
||||
return 'written';
|
||||
} catch (err) {
|
||||
if ((err as NodeJS.ErrnoException).code === 'EEXIST') return 'preserved-foreign';
|
||||
return 'failed';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the CommonJS marker from `dir` — only when the content is exactly
|
||||
* the marker GSD writes. Returns true when a file was removed.
|
||||
*/
|
||||
export function removeCommonJsMarker(dir: string): boolean {
|
||||
if (classifyMarker(dir) !== 'gsd-owned') return false;
|
||||
try {
|
||||
fs.unlinkSync(markerPathFor(dir));
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -30,6 +30,7 @@ import installProfiles = require('./install-profiles.cjs');
|
||||
import installerMigrations = require('./installer-migrations.cjs');
|
||||
import { posixNormalize } from './shell-command-projection.cjs';
|
||||
import { isPathConfined } from './external-descriptor-trust.cjs';
|
||||
import { ensureCommonJsMarker } from './commonjs-marker.cjs';
|
||||
|
||||
const { processAttribution } = runtimeArtifactConversion;
|
||||
// resolveRuntimeArtifactLayout: accessed via module ref (not destructured) so
|
||||
@@ -1121,6 +1122,33 @@ function _installNativePluginIfDeclared(
|
||||
);
|
||||
fs.mkdirSync(path.dirname(destPath), { recursive: true });
|
||||
fs.copyFileSync(pluginSrc, destPath);
|
||||
// #2544: the staged adapter is a `.js` file, so Node decides its module
|
||||
// type by walking up for the nearest package.json. It used to find the
|
||||
// marker the installer wrote at the config root — the write that
|
||||
// clobbered user-authored files. Pin it from the plugin's own directory
|
||||
// instead, leaving the config root alone. The marker cannot disturb
|
||||
// plugin discovery: OpenCode auto-discovers `plugins/*.{ts,js}` and pi's
|
||||
// isExtensionFile() accepts only `.ts`/`.js` (see installer-migration
|
||||
// 006), so a package.json here is never treated as a plugin. Never
|
||||
// written over a package.json GSD does not own — but when one is already
|
||||
// there, say so: the adapter is CommonJS and will not load under a
|
||||
// foreign `"type": "module"`, and a silent no-op would leave every guard
|
||||
// the adapter spawns dead with no diagnostic (the #2305 failure shape).
|
||||
const markerOutcome = ensureCommonJsMarker(path.dirname(destPath));
|
||||
if (markerOutcome === 'preserved-foreign') {
|
||||
console.warn(
|
||||
` ⚠ ${np.dir}/package.json is not GSD's CommonJS marker — left untouched. `
|
||||
+ `If it declares "type": "module", ${np.file} will not load.`,
|
||||
);
|
||||
} else if (markerOutcome === 'failed') {
|
||||
// Best-effort, never fatal: an unwritable plugin dir must not abort the
|
||||
// install. Same warn-and-continue posture as the foreign-marker branch —
|
||||
// the adapter is staged either way, it just may not resolve as CommonJS.
|
||||
console.warn(
|
||||
` ⚠ Could not write ${np.dir}/package.json (CommonJS marker) — install continued. `
|
||||
+ `If the config root declares "type": "module", ${np.file} will not load.`,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,196 @@
|
||||
/**
|
||||
* Installer migration: retire the config-root `{"type":"commonjs"}` marker that
|
||||
* pre-#2544 installs wrote over `<configRoot>/package.json`.
|
||||
*
|
||||
* What old artifact is being retired?
|
||||
* `package.json` at the runtime config root. Before #2544,
|
||||
* `installSharedHooksBundle(destRootDir)` wrote `{"type":"commonjs"}` there
|
||||
* unconditionally on every install and every re-install, to pin GSD's staged
|
||||
* `.js` hook scripts to CommonJS via Node's ancestor walk. #2544 moved that
|
||||
* marker into the directories GSD actually fills (`hooks/`, and the
|
||||
* `nativePlugin.dir` for runtimes declaring one) and stopped writing the
|
||||
* config root at all. Without this migration an upgrader keeps BOTH markers:
|
||||
* the new one under `hooks/` and the stale one at the root, so the config
|
||||
* root stays pinned to CommonJS and the PR's own claim — that GSD no longer
|
||||
* writes the shared config root — is false for every install made since the
|
||||
* marker was introduced, until the user uninstalls.
|
||||
*
|
||||
* How do we prove it is GSD-owned?
|
||||
* By exact content match, NOT by the manifest. The config-root marker was
|
||||
* never recorded in `gsd-file-manifest.json` — `writeManifest()` records
|
||||
* `hooks/`, `agents/`, `commands/`, `scripts/`, and the native plugin, and
|
||||
* has never had a `manifest.files['package.json']` entry — so
|
||||
* `classifyArtifact('package.json')` answers `unknown` and the planner's
|
||||
* own guard would downgrade a `remove-managed` to `preserve-user`.
|
||||
* This migration therefore supplies the "purpose-built detector for an old
|
||||
* GSD-owned shape" that `docs/installer-migrations.md#remove-managed`
|
||||
* sanctions, and declares the resulting classification on the action: the
|
||||
* file is removed only when its bytes are exactly the marker GSD writes
|
||||
* (`{"type":"commonjs"}`, trailing whitespace tolerated). That is the same
|
||||
* predicate `removeCommonJsMarker` has always used on the uninstall side, so
|
||||
* install, uninstall, and migration cannot drift apart.
|
||||
*
|
||||
* What happens if the user modified it?
|
||||
* Then it is not the marker, and this migration does not touch it. Any
|
||||
* `package.json` carrying a `name`, `dependencies`, `scripts`, or any key
|
||||
* beyond the single `type` — i.e. every file the #2544 defect destroyed —
|
||||
* fails the exact-content test and is left exactly as found. There is
|
||||
* deliberately no `backup-and-remove` branch: a modified file here is not a
|
||||
* patched GSD artifact, it is somebody else's file.
|
||||
*
|
||||
* What happens if it is missing?
|
||||
* No actions. Fresh post-#2544 installs never wrote it, already-migrated
|
||||
* installs no longer have it, and the executor additionally journals a
|
||||
* `missing` outcome if it disappears between plan and apply. Idempotent.
|
||||
*
|
||||
* What runtime and scope does it affect?
|
||||
* Every runtime whose config root received the marker — i.e. every runtime
|
||||
* not excluded from `installSharedHooksBundle(targetDir)` by
|
||||
* `hostBehaviors.skipSharedHooksInstall` and not Codex: antigravity,
|
||||
* augment, claude, claude-local, codebuddy, hermes, qwen, kilo, opencode,
|
||||
* and pi. The `runtimes` field is OMITTED — the framework's "all runtimes" —
|
||||
* rather than carrying that hand-list: a runtime that never received the
|
||||
* marker simply has no file to match, so enumerating them would add a second
|
||||
* place for the set to drift out of date without changing behavior. Note it
|
||||
* must be omitted and not `[]`; see the field's own comment below.
|
||||
*
|
||||
* ONE DELIBERATE CARVE-OUT — kimi. Kimi's marker was written to its native
|
||||
* hook root (`~/.kimi`, `resolveKimiHooksTomlDir`), which is NOT under
|
||||
* kimi's `configDir` (its generic Agent-Skills root). Migration relPaths are
|
||||
* structurally confined to `configDir` (`validateSafeRelPath` /
|
||||
* `ensureInsideConfig`), so this framework cannot address that path at all.
|
||||
* Kimi's stale root marker is retired by the installer instead, at the same
|
||||
* call site that writes its replacement — see the `kimi-hooks-toml` branch
|
||||
* in `bin/install.js`. Named here so the gap is not mistaken for an
|
||||
* oversight.
|
||||
*
|
||||
* Is the action safe in non-interactive install?
|
||||
* Yes. `remove-managed` is non-interactive and journaled, the executor takes
|
||||
* a rollback snapshot before unlinking, and no branch of this migration can
|
||||
* emit `prompt-user`. A file that is not byte-identical to GSD's marker
|
||||
* produces no action at all.
|
||||
*
|
||||
* See docs/installer-migrations.md#shipped-migrations and #action-types.
|
||||
*/
|
||||
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import crypto from 'node:crypto';
|
||||
|
||||
type ArtifactClassification = string;
|
||||
|
||||
interface ClassifiedArtifact {
|
||||
classification: ArtifactClassification;
|
||||
[key: string]: unknown;
|
||||
}
|
||||
|
||||
type ActionType = 'remove-managed';
|
||||
|
||||
interface MigrationAction {
|
||||
type: ActionType;
|
||||
relPath: string;
|
||||
reason: string;
|
||||
ownershipEvidence: string;
|
||||
classification: string;
|
||||
originalHash: string;
|
||||
currentHash: string;
|
||||
}
|
||||
|
||||
interface MigrationPlanContext {
|
||||
configDir: string;
|
||||
classifyArtifact(relPath: string): ClassifiedArtifact;
|
||||
}
|
||||
|
||||
interface InstallerMigration {
|
||||
id: string;
|
||||
title: string;
|
||||
description: string;
|
||||
introducedIn: string;
|
||||
/**
|
||||
* OMITTED, not `[]`, to mean "every runtime". The authoring validator treats
|
||||
* the field as optional but requires it to be NON-EMPTY when present
|
||||
* (`validateStringArray`), while the runtime filter treats an empty array the
|
||||
* same as an absent one. Only the validator actually runs on the record, so
|
||||
* `runtimes: []` throws at plan time and the migration never executes.
|
||||
*/
|
||||
runtimes?: string[];
|
||||
scopes: string[];
|
||||
destructive: boolean;
|
||||
plan: (ctx: MigrationPlanContext) => MigrationAction[];
|
||||
}
|
||||
|
||||
/** The config-root path the pre-#2544 installer wrote, relative to configDir. */
|
||||
const STALE_ROOT_MARKER = 'package.json';
|
||||
|
||||
/**
|
||||
* The exact marker content GSD wrote. Duplicated as a literal rather than
|
||||
* imported from `src/commonjs-marker.cts` on purpose: a migration record is a
|
||||
* frozen historical statement about what a PAST version installed, and it must
|
||||
* keep matching those bytes even if the live module's constant is ever changed.
|
||||
* Importing would silently re-point this detector at a future value.
|
||||
*/
|
||||
const LEGACY_MARKER_CONTENT = '{"type":"commonjs"}';
|
||||
|
||||
const OWNERSHIP_EVIDENCE =
|
||||
'file content is byte-identical to the {"type":"commonjs"} marker pre-#2544 installs '
|
||||
+ 'wrote at the config root (installSharedHooksBundle); same exact-content predicate '
|
||||
+ 'removeCommonJsMarker uses on uninstall. Never manifest-recorded, so this is the '
|
||||
+ 'purpose-built detector permitted by docs/installer-migrations.md#remove-managed';
|
||||
|
||||
const REASON =
|
||||
'superseded by the hooks/ and plugin-dir markers (#2544); leaving it pins the shared '
|
||||
+ 'config root to CommonJS and keeps GSD occupying a file it no longer writes';
|
||||
|
||||
const migration: InstallerMigration = {
|
||||
id: '2026-07-28-retire-config-root-commonjs-marker',
|
||||
title: 'Retire the pre-#2544 config-root CommonJS marker',
|
||||
description:
|
||||
'Remove <configRoot>/package.json when it is exactly the {"type":"commonjs"} marker '
|
||||
+ 'pre-#2544 installs wrote there, now superseded by markers scoped to the directories '
|
||||
+ 'GSD owns. A package.json with any other content is left untouched.',
|
||||
introducedIn: '1.8.0',
|
||||
scopes: ['global', 'local'],
|
||||
destructive: true,
|
||||
plan: (ctx: MigrationPlanContext): MigrationAction[] => {
|
||||
const markerPath = path.join(ctx.configDir, STALE_ROOT_MARKER);
|
||||
|
||||
let stat: import('node:fs').Stats;
|
||||
try {
|
||||
// lstat, not existsSync: existsSync follows symlinks and reports false for
|
||||
// a dangling one. A symlink here is not something GSD wrote, and removing
|
||||
// it is never ours to do — mirrors classifyMarker's fail-closed posture.
|
||||
stat = fs.lstatSync(markerPath);
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
if (!stat.isFile()) return [];
|
||||
|
||||
let content: string;
|
||||
try {
|
||||
content = fs.readFileSync(markerPath, 'utf8');
|
||||
} catch {
|
||||
// Present but unreadable never downgrades to the permissive answer.
|
||||
return [];
|
||||
}
|
||||
if (content.trim() !== LEGACY_MARKER_CONTENT) return [];
|
||||
|
||||
const hash = crypto.createHash('sha256').update(content).digest('hex');
|
||||
return [
|
||||
{
|
||||
type: 'remove-managed',
|
||||
relPath: STALE_ROOT_MARKER,
|
||||
reason: REASON,
|
||||
ownershipEvidence: OWNERSHIP_EVIDENCE,
|
||||
// Declared, not derived: classifyArtifact answers 'unknown' for this
|
||||
// never-manifested path, and the planner downgrades a remove-managed on
|
||||
// an 'unknown' classification to preserve-user. The exact-content match
|
||||
// above IS the ownership proof, so the classification is stated here.
|
||||
classification: 'managed-pristine',
|
||||
originalHash: hash,
|
||||
currentHash: hash,
|
||||
},
|
||||
];
|
||||
},
|
||||
};
|
||||
|
||||
export = migration;
|
||||
@@ -30,11 +30,14 @@ import { posixNormalize } from './shell-command-projection.cjs';
|
||||
// `require('../../../package.json')`. That require ran at module load on every
|
||||
// gsd-tools invocation (this module sits in the gsd-tools loader chain) and
|
||||
// threw `Cannot find module '../../../package.json'` on runtimes whose root has
|
||||
// no package.json — notably Codex, where the installer omits the synthetic root
|
||||
// package.json — taking the entire CLI down before it did anything. And even
|
||||
// where it resolved (Claude's synthetic `{"type":"commonjs"}`), there is no
|
||||
// `version` field, so the single consumer below already emitted
|
||||
// `version: undefined`. Resolve lazily and defensively instead:
|
||||
// no package.json — originally just Codex, where the installer never wrote the
|
||||
// synthetic root package.json; since #2544 that is true of EVERY runtime, as
|
||||
// GSD's markers moved into `hooks/` and the native plugin dir and the config
|
||||
// root is no longer written at all — taking the entire CLI down before it did
|
||||
// anything. And even where it used to resolve (the synthetic
|
||||
// `{"type":"commonjs"}`), there is no `version` field, so the single consumer
|
||||
// below already emitted `version: undefined`. Resolve lazily and defensively
|
||||
// instead:
|
||||
// 1. Installed trees carry <root>/gsd-core/VERSION (written by the installer);
|
||||
// this module lives at <root>/gsd-core/bin/lib, so VERSION is two dirs up.
|
||||
// 2. The source / npm-package tree has no gsd-core/VERSION but carries a real
|
||||
|
||||
@@ -27,6 +27,13 @@
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import os from 'node:os';
|
||||
// #2544: the single source of truth for the CommonJS module-type marker. The
|
||||
// two helpers below are thin boolean-returning shims over these — see the
|
||||
// marker section for why this file no longer carries its own copy.
|
||||
import {
|
||||
ensureCommonJsMarker as ensureCommonJsMarkerOwned,
|
||||
removeCommonJsMarker as removeCommonJsMarkerOwned,
|
||||
} from './commonjs-marker.cjs';
|
||||
import {
|
||||
CURSOR_HOOK_EVENTS,
|
||||
CURSOR_EVENT_SCRIPT_MAP,
|
||||
@@ -217,61 +224,53 @@ function atomicWriteFileSync(target: string, data: string, options: fs.WriteFile
|
||||
//
|
||||
// The marker content is byte-identical to installSharedHooksBundle's
|
||||
// (bin/install.js installSharedHooksBundle): {"type":"commonjs"}\n.
|
||||
//
|
||||
// #2544: the two helpers below no longer carry their own copy of the write and
|
||||
// remove rules — they DELEGATE to src/commonjs-marker.cts, which #2544 makes the
|
||||
// single place both rules are enforced. Keeping a second copy here was not
|
||||
// merely redundant; the copies had drifted apart on exactly the two properties
|
||||
// that matter:
|
||||
//
|
||||
// - ownership probe: `fs.existsSync` FOLLOWS symlinks and reports `false` for
|
||||
// a DANGLING one, so a dangling `package.json` symlink classified as absent
|
||||
// and the write below followed the link outside the directory GSD owns.
|
||||
// `classifyMarker` uses `lstat` + `isFile()`, so a symlink or a directory at
|
||||
// the marker path is classified `foreign` and left strictly alone.
|
||||
// - create: a plain `writeFileSync` leaves the classify->write window open.
|
||||
// `ensureCommonJsMarker` creates with `flag: 'wx'` (O_EXCL), so anything
|
||||
// that appears at the path in between fails with EEXIST instead of being
|
||||
// followed or overwritten.
|
||||
//
|
||||
// The exported signatures are unchanged (both still return a boolean), so every
|
||||
// caller and the #2717 tests are unaffected.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** The exact marker content GSD writes, matching installSharedHooksBundle. */
|
||||
const COMMONJS_MARKER_CONTENT = '{"type":"commonjs"}\n';
|
||||
|
||||
/**
|
||||
* Ensure a `package.json` forcing CommonJS mode exists in `dir` (the directory
|
||||
* holding GSD-staged `.js` hook scripts). Idempotent: a no-op if the marker is
|
||||
* already present with GSD's content. Overwrites only when the file is absent
|
||||
* or already carries GSD's exact marker — it never clobbers a distinct
|
||||
* user-authored package.json (it leaves such a file in place; the user owns it).
|
||||
* already present with GSD's content. Never clobbers a distinct user-authored
|
||||
* package.json (it leaves such a file in place; the user owns it).
|
||||
*
|
||||
* @param dir - absolute path to the directory holding the staged .js hooks
|
||||
* @returns `true` if the marker is present after the call (written or already there)
|
||||
* @returns `true` if GSD's marker is present after the call (written or already there)
|
||||
*/
|
||||
function ensureCommonJsMarker(dir: string): boolean {
|
||||
const markerPath = path.join(dir, 'package.json');
|
||||
try {
|
||||
if (fs.existsSync(markerPath)) {
|
||||
const existing = fs.readFileSync(markerPath, 'utf8');
|
||||
// Already GSD's marker (tolerant of trailing-whitespace variants) — done.
|
||||
if (existing.trim() === '{"type":"commonjs"}') return true;
|
||||
// A distinct package.json the user owns — do NOT clobber. The hook will
|
||||
// load as whatever type the user declared; that is the user's choice.
|
||||
return false;
|
||||
}
|
||||
fs.writeFileSync(markerPath, COMMONJS_MARKER_CONTENT);
|
||||
return true;
|
||||
} catch {
|
||||
// Best-effort: a marker write failure must not fail the whole install.
|
||||
return false;
|
||||
}
|
||||
// 'written' | 'unchanged' -> the marker is ours and present.
|
||||
// 'preserved-foreign' -> a file GSD does not own is there; left untouched.
|
||||
// 'failed' -> environmental (EACCES/EROFS/ENOSPC); best-effort.
|
||||
const outcome = ensureCommonJsMarkerOwned(dir);
|
||||
return outcome === 'written' || outcome === 'unchanged';
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the CommonJS marker from `dir` on uninstall — but ONLY if it carries
|
||||
* GSD's exact marker content. A user-authored package.json is never deleted.
|
||||
* Mirrors the kimi uninstall guard in bin/install.js.
|
||||
*
|
||||
* @param dir - absolute path to the directory that held the staged .js hooks
|
||||
* @returns `true` if a GSD-owned marker was removed
|
||||
*/
|
||||
function removeCommonJsMarkerIfGsdOwned(dir: string): boolean {
|
||||
const markerPath = path.join(dir, 'package.json');
|
||||
try {
|
||||
if (!fs.existsSync(markerPath)) return false;
|
||||
const content = fs.readFileSync(markerPath, 'utf8').trim();
|
||||
if (content === '{"type":"commonjs"}') {
|
||||
fs.unlinkSync(markerPath);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
return removeCommonJsMarkerOwned(dir);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -1271,7 +1270,15 @@ function writeCursorHooksJson(targetDir: string, src: string, opts?: WriteCursor
|
||||
// installSharedHooksBundle (the only other writer of this marker); without
|
||||
// it, a ~/.cursor/package.json declaring {"type":"module"} makes Node load
|
||||
// these require()-using scripts as ESM and every Cursor hook fails silently.
|
||||
ensureCommonJsMarker(hooksDir);
|
||||
//
|
||||
// #2544: gated on having actually staged a script, mirroring
|
||||
// installSharedHooksBundle's `stagedHooks` gate. hooks/ is shared space, and
|
||||
// this function mkdirs it unconditionally — so an ungated write drops a GSD
|
||||
// marker into a directory GSD created but did not fill, which is the same
|
||||
// write-into-someone-else's-territory this issue is about.
|
||||
if (installedScripts.size > 0) {
|
||||
ensureCommonJsMarker(hooksDir);
|
||||
}
|
||||
|
||||
const hookOpts: BuildHookCommandOpts = { runtime: 'cursor', platform: opts.platform || process.platform };
|
||||
const commands: Record<string, string | null> = {};
|
||||
@@ -1484,7 +1491,12 @@ function writeWindsurfHooksJson(targetDir: string, src: string, opts?: WriteWind
|
||||
// installSharedHooksBundle (the only other writer of this marker); without
|
||||
// it, a config-root package.json declaring {"type":"module"} makes Node load
|
||||
// these require()-using scripts as ESM and the Windsurf hooks fail silently.
|
||||
ensureCommonJsMarker(hooksDir);
|
||||
//
|
||||
// #2544: gated on having actually staged a script — see the identical gate in
|
||||
// the Cursor writer above and `stagedHooks` in installSharedHooksBundle.
|
||||
if (installedScripts.size > 0) {
|
||||
ensureCommonJsMarker(hooksDir);
|
||||
}
|
||||
|
||||
const hookOpts: BuildHookCommandOpts = { runtime: 'windsurf', platform: opts.platform || process.platform };
|
||||
const commands: Record<string, string | null> = {};
|
||||
|
||||
Reference in New Issue
Block a user