@gjsify/cli 0.26.1 → 0.27.1

package/lib/utils/install-backend-native.js

@@ -11,6 +11,43 @@
 // when its required version is incompatible with what's already at
 // the root. Mirrors npm v3+ behavior.
 //
+// PLATFORM FILTERING (os/cpu/libc) — the tree is RESOLVED for every platform
+// and INSTALLED for one. A node whose declaration excludes the host is marked
+// `inert` (npm's word — arborist build-ideal-tree.js's `node.inert = true`)
+// which skips its download + extract, but it stays in `gjsify-lock.json` with
+// its `os`/`cpu`/`libc` recorded. That split is deliberate and is the whole
+// reason lockfiles are shareable: a lockfile containing only what ONE host can
+// install is not a lockfile, it is a machine snapshot — commit it and every
+// colleague on another OS gets a tree missing its binaries with no drift
+// reported. So the DECLARATIONS are locked and the VERDICT is recomputed per
+// host at install time (see applyPlatformFilter).
+//
+// TWO INVARIANTS MAKE THAT CLAIM TRUE, and both are structural rather than
+// documented, because the first draft of this feature broke both while reading
+// as if it did not:
+//
+//   1. THE RESOLVE IS TARGET-BLIND. `resolveDeps` is not given the platform
+//      target at all — it cannot be, so it cannot record a target-dependent
+//      declaration. The draft passed the target in to decide when to escalate to
+//      a full packument for `libc`, gated on `target.os === 'linux'`; a lockfile
+//      authored on macOS therefore carried NO `libc` for anything, and a Linux
+//      colleague running `--immutable` off that file got no libc filtering at
+//      all — precisely the direction this header promises is portable. The
+//      resolve now reads the FULL document for every package (see resolveDeps),
+//      which is also what arborist does for every dependency it resolves
+//      (`#fetchManifest` sets `fullMetadata: true`).
+//   2. `optional` IS DERIVED, NEVER TRUSTED. It is recomputed as a FIXPOINT over
+//      the placed graph on BOTH paths (computeOptionalFlags), before it is
+//      persisted and before the platform verdict reads it. The draft promoted a
+//      node out of the optional set at the reuse site, one shot, which made the
+//      answer depend on BFS edge order: a genuinely required transitive dep
+//      reached first through an optional edge stayed flagged optional, was
+//      persisted that way, and was then silently skipped on every machine
+//      instead of raising EBADPLATFORM. npm computes the same flags as a
+//      fixpoint for the same reason (refs/npm-cli/workspaces/arborist/lib/
+//      calc-dep-flags.js: "If a node is changed, we add to the queue and
+//      continue until no more changes").
+//
 // Out of scope (still deferred): peerDependencies validation,
 // lifecycle scripts, git/file specs.
 import * as fs from 'node:fs';
@@ -24,7 +61,9 @@ import { acquireInstallLock } from './install-lock.js';
 import { getCachedTarball, getForeignCachedTarball, putCachedTarball, } from './install-tarball-cache.js';
 import { getCachedPackument, putCachedPackument } from './install-packument-cache.js';
 import { assertNativeBackendNodeVersion } from './node-version.js';
-import { buildCmdShim, parseShebang } from './bin-shim.js';
+import { buildCmdShim, buildLauncherShims, buildNativeEnvPreamble, buildShLauncher, isGjsBundlePath, parseShebang, pickBinMap, } from './bin-shim.js';
+import { detectNativePackages } from './detect-native-packages.js';
+import { badPlatformError, checkPlatform, declaresPlatform, describePlatformTarget, readPlatformForce, resolveHostPlatform, } from './platform-check.js';
 // 16-wide download pool. Matched to the shared Soup.Session's lifted
 // `max-conns-per-host` (see @gjsify/fetch `getSharedSession`) — a higher pool
 // here only translates into real concurrency because that cap was raised from
@@ -32,7 +71,21 @@ import { buildCmdShim, parseShebang } from './bin-shim.js';
 // 16) use the same order of magnitude. Override with GJSIFY_INSTALL_CONCURRENCY.
 const DEFAULT_CONCURRENCY = Number(process.env.GJSIFY_INSTALL_CONCURRENCY ?? '16') || 16;
 const LOCKFILE_NAME = 'gjsify-lock.json';
-const LOCKFILE_VERSION = 2;
+/**
+ * v3 adds the per-entry platform declaration (`os`/`cpu`/`libc`) plus
+ * `optional`, which together let a foreign-platform package be recorded without
+ * being installed. v2 lockfiles are still READ (see {@link readLockfile}).
+ */
+const LOCKFILE_VERSION = 3;
+/**
+ * Lockfile versions this CLI can read. A v2 lockfile is a valid pin set that
+ * simply predates the platform fields; rejecting it (the old
+ * `!== LOCKFILE_VERSION → null` behaviour) would discard the whole file and let
+ * the following fresh resolve bump every `^`-range to the newest in-range
+ * version — the exact silent churn lockfile preservation exists to prevent, on
+ * every user's first install after upgrading the CLI.
+ */
+const READABLE_LOCKFILE_VERSIONS = new Set([2, LOCKFILE_VERSION]);
 export async function installPackagesNative(opts) {
     // Fail clearly on an unsupported Node major BEFORE touching the ABI-locked
     // native deps — otherwise they SIGSEGV mid-extract with no actionable message.
@@ -63,7 +116,23 @@ async function installPackagesNativeLocked(opts, npmrc, log) {
     const progress = opts.progress;
     const lockfilePath = path.join(opts.prefix, LOCKFILE_NAME);
     const existingLock = readLockfile(lockfilePath);
+    // The triple this install materialises FOR. Normally the running host;
+    // `--os/--cpu/--libc` (npm's config keys `os`/`cpu`/`libc`, read from the
+    // environment by resolveHostPlatform) override it, which is what makes the
+    // darwin/win32/musl selection testable — and reviewable — from one machine.
+    const target = resolveHostPlatform();
+    const force = readPlatformForce(process.env);
+    log('install: platform target %s%s', describePlatformTarget(target), force ? ' (--force: checks bypassed)' : '');
     let nodes;
+    /** Did a resolve actually run? Only then is there something new to persist. */
+    let resolved = false;
+    /**
+     * Edges whose resolve FAILED and was tolerated because the edge looked
+     * optional at the time it was visited. Checked against the final (fixpoint)
+     * optionality below — see {@link assertRequiredEdgesResolved}. Empty on the
+     * lockfile paths, which resolve nothing.
+     */
+    let skippedEdges = new Set();
     if (opts.frozen) {
         // --immutable / --frozen: lockfile is the authoritative source.
         // Reject if the file is missing, version-mismatched, or its
@@ -82,12 +151,22 @@ async function installPackagesNativeLocked(opts, npmrc, log) {
         log('install: --immutable, using lockfile (%d package(s))', Object.keys(existingLock.packages).length);
         nodes = lockfileToNodes(existingLock);
     }
-    else if (!opts.refreshLockfile && existingLock && lockfileMatchesRequest(existingLock, opts.specs)) {
+    else if (!opts.refreshLockfile &&
+        existingLock &&
+        existingLock.lockfileVersion === LOCKFILE_VERSION &&
+        lockfileMatchesRequest(existingLock, opts.specs)) {
         log('install: using lockfile (%d package(s))', Object.keys(existingLock.packages).length);
         nodes = lockfileToNodes(existingLock);
     }
     else {
         // A resolve has to run (new/changed/removed dep, or no lockfile yet).
+        //
+        // A pre-v3 lockfile lands here too, even when it matches the request:
+        // its entries carry no platform declarations, so consuming it verbatim
+        // would keep installing the foreign-platform tree forever with nothing
+        // on disk to recompute the verdict from. One resolve — version-
+        // preserving, per the seeding below, so nothing bumps — upgrades it.
+        //
         // Unless --refresh-lockfile was passed, seed it with the versions
         // already pinned in the existing lockfile so unchanged deps keep their
         // resolved version and only the genuinely new/changed deps move — the
@@ -96,11 +175,29 @@ async function installPackagesNativeLocked(opts, npmrc, log) {
         // (and silently bumping transitive deps) on a one-package add.
         const preferred = !opts.refreshLockfile && existingLock ? buildPreferredVersions(existingLock) : undefined;
         log('install: resolving %d top-level spec(s) → %s%s', opts.specs.length, opts.prefix, preferred ? ` (preserving ${preferred.size} locked name(s))` : '');
-        nodes = await resolveDeps(opts.specs, npmrc, log, opts.overrides, opts.skipDeps, opts.signal, progress, preferred, opts.workspaceNames, opts.specOrigins);
-        if (opts.lockfile) {
-            writeLockfile(lockfilePath, opts.specs, nodes);
-            log('install: wrote %s (%d entries)', LOCKFILE_NAME, nodes.length);
-        }
+        // NOTE the absent argument: `target` is deliberately NOT passed. The
+        // resolve must produce the same tree and the same recorded declarations
+        // on every machine (header note, invariant 1), and the cheapest way to
+        // keep that true is to give it nothing target-shaped to read.
+        const resolveResult = await resolveDeps(opts.specs, npmrc, log, opts.overrides, opts.skipDeps, opts.signal, progress, preferred, opts.workspaceNames, opts.specOrigins, opts.optionalSpecs);
+        nodes = resolveResult.nodes;
+        skippedEdges = resolveResult.skippedEdges;
+        resolved = true;
+    }
+    // `optional` is DERIVED here, on BOTH paths, for the same reason
+    // `applyPlatformFilter` is: the answer must not depend on which path the tree
+    // arrived by, and a flag read back from a file is an INPUT nothing checked.
+    // Runs BEFORE writeLockfile (so the persisted flag is the final one) and
+    // before the platform verdict (which reads it to decide fatal vs. inert), and
+    // before the workspace filter below (which removes nodes and would truncate
+    // the walk).
+    computeOptionalFlags(nodes, requiredTopLevelNames(opts.specs, opts.optionalSpecs), log);
+    assertRequiredEdgesResolved(nodes, skippedEdges);
+    if (resolved && opts.lockfile) {
+        // The FULL resolved set, inert nodes included — see the header note:
+        // the lockfile is the portable artifact, the platform verdict is not.
+        writeLockfile(lockfilePath, opts.specs, nodes);
+        log('install: wrote %s (%d entries)', LOCKFILE_NAME, nodes.length);
     }
     // A package whose name is one of the monorepo's own workspaces is provided
     // by a workspace symlink (wired by `workspaceInstall`), NOT by a registry
@@ -119,10 +216,14 @@ async function installPackagesNativeLocked(opts, npmrc, log) {
             log('install: %d workspace-provided package(s) symlinked, not fetched', dropped);
         }
     }
-    log('install: downloading %d tarball(s)', nodes.length);
-    await downloadAndExtractAll(nodes, opts.prefix, npmrc, log, opts.signal, progress);
-    await linkBins(nodes, opts.prefix, log);
-    warnMissingNativeBuilds(nodes, opts.prefix, log);
+    // os/cpu/libc: throws for an incompatible REQUIRED dep, marks incompatible
+    // OPTIONAL ones inert. Runs on BOTH paths (fresh resolve and lockfile) —
+    // that is what makes one committed lockfile install a per-host subset.
+    const installable = applyPlatformFilter(nodes, target, force, log);
+    log('install: downloading %d tarball(s)', installable.length);
+    await downloadAndExtractAll(installable, opts.prefix, npmrc, log, opts.signal, progress);
+    await linkBins(installable, opts.prefix, log);
+    warnMissingNativeBuilds(installable, opts.prefix, log);
     log('install: done');
     // Surface the top-level requested packages so callers can update
     // package.json with the resolved version (mirrors `npm install --save`
@@ -134,6 +235,65 @@ function errMsg(err) {
         return err.message;
     return String(err);
 }
+/**
+ * Split a resolved tree into what THIS target can install, marking the rest
+ * inert. Mirrors arborist's post-resolve platform pass
+ * (`refs/npm-cli/workspaces/arborist/lib/arborist/build-ideal-tree.js`, the
+ * `checkPlatform` loop around line 210) rather than filtering during the walk,
+ * for two reasons: the verdict must be identical whether the tree came from a
+ * fresh resolve or from `gjsify-lock.json`, and a node's optionality is only
+ * final once every edge that could reach it has been visited.
+ *
+ * The two outcomes are npm's, including the asymmetry around `force`:
+ *   - REQUIRED + incompatible → EBADPLATFORM. A required dependency the host
+ *     cannot run is a broken install, not a smaller one; failing loudly with
+ *     `pkgid`/`current`/`required` is the only honest answer. `--force`
+ *     suppresses it (the user is asserting something about their own machine).
+ *   - OPTIONAL + incompatible → inert: not downloaded, not extracted, still in
+ *     the lockfile. `--force` does NOT lift this — npm says so in as many words
+ *     ("We ignore the --force and --engine-strict flags") and it is right:
+ *     forcing an optional binary that cannot load buys a download and nothing
+ *     else.
+ *
+ * The skip line goes through the debug logger with npm's `current`/`required`
+ * payload, so `--verbose` recovers exactly WHY a package is absent. Silence
+ * here is what made the original defect invisible in the other direction: 3.67
+ * GB arrived with no line saying it should not have.
+ */
+export function applyPlatformFilter(nodes, target, force, log) {
+    const installable = [];
+    let skipped = 0;
+    for (const node of nodes) {
+        const declaration = node.platform;
+        if (!declaration || !declaresPlatform(declaration)) {
+            installable.push(node);
+            continue;
+        }
+        const verdict = checkPlatform(declaration, target);
+        if (verdict.ok) {
+            installable.push(node);
+            continue;
+        }
+        const pkgid = `${node.name}@${node.version}`;
+        if (!node.optional) {
+            if (force) {
+                log('platform-forced: %s (required, incompatible, installed anyway via --force)', pkgid);
+                installable.push(node);
+                continue;
+            }
+            throw badPlatformError(pkgid, verdict);
+        }
+        node.inert = true;
+        skipped++;
+        log('platform-skip: %s (%s) current=%s required=%s', pkgid, node.installPath, JSON.stringify(verdict.current), JSON.stringify(verdict.required));
+    }
+    if (skipped > 0) {
+        // Verbose-only, like every other per-install summary here — and like npm,
+        // which reports inert optional packages only through its final count.
+        log('install: %d optional package(s) inert — not installable on %s', skipped, describePlatformTarget(target));
+    }
+    return installable;
+}
 /**
  * Warn about a native package that installed WITHOUT a usable binary.
  *
@@ -239,6 +399,16 @@ function parseSpecName(spec) {
  * specs are seeded with a synthetic `null` requester so they hoist to
  * the root. Each placement returns a `ResolvedNode` whose `installPath`
  * captures where it lives in the tree.
+ *
+ * TAKES NO PLATFORM TARGET, and that is a load-bearing absence (header note,
+ * invariant 1): the tree it produces and the `os`/`cpu`/`libc` it records must be
+ * identical on every machine, so the platform verdict is a separate post-pass
+ * (`applyPlatformFilter`) that this function cannot influence. An earlier draft
+ * did take one — to decide when to escalate to a full packument for `libc`,
+ * gated on `target.os === 'linux'` — and a macOS-authored lockfile ended up with
+ * no `libc` recorded anywhere, i.e. unusable for filtering on the Linux hosts it
+ * was committed for. Do not reintroduce the parameter: the resolve now reads the
+ * full document unconditionally, which needs no target and no heuristic.
  */
 async function resolveDeps(specs, npmrc, log, overrides, skipDeps, signal, progress, 
 /**
@@ -261,7 +431,15 @@ workspaceNames,
  * names) — see `InstallOptions.specOrigins`. Used only to attribute the
  * version-conflict warning.
  */
-specOrigins) {
+specOrigins, 
+/**
+ * Names of top-level specs declared as `optionalDependencies` — see
+ * {@link NativeInstallOptions.optionalSpecs}. Such an edge is seeded
+ * `required: false`, so a resolve failure is skipped rather than fatal. It
+ * also seeds the optional-flag walk, but the FINAL flag comes from
+ * {@link computeOptionalFlags}, not from this walk.
+ */
+optionalSpecs) {
     progress?.beginPhase('resolve', specs.length);
     const applyOverride = (name, range) => {
         if (!overrides)
@@ -279,7 +457,32 @@ specOrigins) {
         const cached = packumentCache.get(name);
         if (cached)
             return cached;
-        const fresh = fetchPackumentWithDiskCache(name, npmrc, log, signal);
+        // FULL document (`accept: application/json`), not the abbreviated
+        // "corgi" install document — the same choice arborist makes for every
+        // dependency it resolves (`#fetchManifest` sets `fullMetadata: true`,
+        // refs/npm-cli/workspaces/arborist/lib/arborist/build-ideal-tree.js).
+        //
+        // WHY, and why no cheaper trigger exists: the registry omits `libc` from
+        // the abbreviated body (measured — `@rollup/rollup-linux-x64-musl` returns
+        // `{os,cpu}` under the corgi accept header and `{os,cpu,libc}` under
+        // `application/json`), so the abbreviated body can never PROVE that a
+        // version has no libc restriction. Every "escalate only where it can
+        // matter" rule therefore has a hole, and the first draft's rule — escalate
+        // when the corgi entry declares `os` or `cpu` — had exactly the hole that
+        // matters here: the nine `@gjsify/*` bridges declare `libc: ["glibc"]`
+        // with NO `os`/`cpu`, so on Alpine the installer would have handed a
+        // glibc-only prebuild to a musl host and failed at `dlopen` instead of at
+        // install time.
+        //
+        // Cost, measured over 15 representative deps of this workspace (transfer
+        // bytes, largest packages dominating): the full document is 1.26× the
+        // abbreviated one. Corgi-plus-escalate-everything would be 2.26× and
+        // twice the requests; corgi-plus-escalate-the-declaring-~12% (the draft)
+        // was ~1.15× and 1.12× the requests, i.e. this change costs ~10% more
+        // metadata bytes and ~11% FEWER round-trips than the shape it replaces.
+        // That is the whole trade: one authoritative document per package instead
+        // of two documents and a heuristic that cannot be made sound.
+        const fresh = fetchPackumentWithDiskCache(name, npmrc, log, signal, 'full');
         packumentCache.set(name, fresh);
         return fresh;
     };
@@ -287,6 +490,8 @@ specOrigins) {
     const byPath = new Map();
     /** Root placements indexed by name for the hoist-vs-nest decision. */
     const root = new Map();
+    /** See {@link ResolveResult.skippedEdges}. Keyed by {@link edgeKey}. */
+    const skippedEdges = new Set();
     // Top-level range bookkeeping for the version-conflict warning:
     // `name → (applied range → requester labels)`. Only TOP-LEVEL specs
     // participate: conflicting transitive edges are resolved correctly by
@@ -315,7 +520,7 @@ specOrigins) {
             from: null,
             name: s.name,
             range,
-            required: true,
+            required: !optionalSpecs?.has(s.name),
         };
     });
     // Wave-based BFS. Each iteration drains the current queue level, prefetches
@@ -363,6 +568,15 @@ specOrigins) {
             const visible = findVisible(edge.from, edge.name, byPath);
             if (visible && satisfiesRange(visible.version, edge.range)) {
                 // Compatible placement reachable; reuse, no new install.
+                //
+                // NOTHING IS PROMOTED HERE. A `visible.optional = false` on a
+                // required edge is the obvious move and it is wrong: the node's own
+                // dep edges were already queued with the STALE flag, so its
+                // children stayed optional and the one-shot promotion produced an
+                // order-dependent answer (the reviewed defect). Optionality is
+                // recomputed as a fixpoint over the finished graph instead —
+                // {@link computeOptionalFlags}, which is order-independent by
+                // construction and is the only writer of the final flag.
                 continue;
             }
             // No compatible existing placement. Resolve a version — preferring a
@@ -374,8 +588,12 @@ specOrigins) {
                 const preferred = preferredVersionFor(preferredVersions?.get(edge.name), edge.range);
                 version = pickVersion(packument, edge.range, preferred);
                 if (!version) {
-                    if (!edge.required)
-                        continue;
+                    // Throw even for an optional edge and let the catch below
+                    // decide: ONE place that knows what a tolerated failure costs
+                    // (a log line and a `skippedEdges` entry). The `if
+                    // (!edge.required) continue` this replaces was a second,
+                    // silent copy of that decision — it skipped with no log line
+                    // at all and left nothing for the post-pass to re-judge.
                     throw new Error(`No version of ${edge.name} satisfies ${edge.range}`);
                 }
                 const v = packument.versions[version];
@@ -398,6 +616,15 @@ specOrigins) {
                     dependencies: v.dependencies ?? {},
                     optionalDependencies: v.optionalDependencies ?? {},
                     bin: v.bin,
+                    // Complete as published — `fetchPkg` reads the FULL document,
+                    // so all three fields come from one authoritative body and no
+                    // second fetch or per-package heuristic is involved.
+                    platform: platformDeclarationOf(v),
+                    // Forward guess only; `computeOptionalFlags` overwrites it.
+                    // It is still worth setting: the child edges queued below read
+                    // it, which is what keeps a failure under a plainly-optional
+                    // subtree non-fatal at the point of failure.
+                    optional: !edge.required,
                 };
                 byPath.set(installPath, node);
                 if (installPath === `node_modules/${edge.name}`) {
@@ -418,8 +645,18 @@ specOrigins) {
                         queue.push({
                             from: installPath,
                             name: depName,
+                            // A dependency of an OPTIONAL node inherits its
+                            // optionality — npm's `optionalSet`. Load-bearing for
+                            // the platform check, not a nicety: we resolve
+                            // foreign-platform optional packages on purpose (the
+                            // lockfile must stay portable), so their own required
+                            // deps get visited too. `fsevents` (darwin-only) is
+                            // the live shape — treating its subtree as required
+                            // would raise EBADPLATFORM for a package nothing on
+                            // this host will ever load, i.e. fail every Linux
+                            // install over a darwin-only optional dep.
                             range: applyOverride(depName, depRange),
-                            required: true,
+                            required: !node.optional,
                         });
                     }
                     for (const [depName, depRange] of Object.entries(node.optionalDependencies)) {
@@ -436,7 +673,14 @@ specOrigins) {
                 // Optional deps that fail to resolve are skipped — yarn/npm
                 // behavior. Required deps re-throw.
                 if (!edge.required) {
-                    log('resolve: optional dep %s@%s skipped (%s)', edge.name, edge.range, e.message);
+                    // RECORDED, not merely logged: `edge.required` is the walk's
+                    // forward guess, and a later required edge can still make this
+                    // node mandatory. `assertRequiredEdgesResolved` re-judges every
+                    // entry against the fixpoint flags, so a genuinely required
+                    // dependency cannot end up missing from the tree just because
+                    // BFS order happened to reach it through an optional edge first.
+                    skippedEdges.add(edgeKey(edge.from, edge.name));
+                    log('resolve: optional dep %s@%s skipped (%s)', edge.name, edge.range, errMsg(e));
                     continue;
                 }
                 throw e;
@@ -445,7 +689,237 @@ specOrigins) {
     }
     progress?.endPhase('resolve');
     emitTopLevelConflictWarnings(topLevelRanges, root);
-    return Array.from(byPath.values());
+    // NO declaration post-pass here, deliberately. `fetchPkg` already read the
+    // FULL document for every package, so each node's `platform` is complete as
+    // published and there is nothing left to escalate. The draft DID have a
+    // second `libc`-only fetch at exactly this line, and it took the platform
+    // target to decide when to fire — the one argument this function must never
+    // have (header note, invariant 1). Reintroducing the pass means
+    // reintroducing the parameter, which is how a macOS-authored lockfile ended
+    // up with no `libc` recorded for anyone.
+    //
+    // `optional` is likewise NOT finalised here: the flags on these nodes are
+    // still the walk's forward guess. `computeOptionalFlags` overwrites them at
+    // the call site, on this path and on the lockfile path alike.
+    return { nodes: Array.from(byPath.values()), skippedEdges };
+}
+/**
+ * The platform declaration a packument version carries, or undefined when it
+ * declares none (the common case — keeping it undefined keeps the node and the
+ * lockfile entry minimal). Pure read, no I/O.
+ */
+function platformDeclarationOf(version) {
+    const declaration = { os: version.os, cpu: version.cpu, libc: version.libc };
+    return declaresPlatform(declaration) ? declaration : undefined;
+}
+/**
+ * Identity of one dependency EDGE: the requester's `installPath` (empty string
+ * for the project root) plus the dependency name.
+ *
+ * The PAIR is the identity, never the name alone. The same unresolvable name can
+ * be legitimately absent below an optional subtree and a hard error below a
+ * required one — only the requester says which, so a `skippedEdges` keyed by
+ * name would collapse the two cases and answer whichever it saw last.
+ *
+ * `\n` is the separator because no npm package name and no install path can
+ * contain one (npm rejects control characters in names, and every path here is
+ * built out of names), so the key round-trips through {@link parseEdgeKey}
+ * unambiguously. Deliberately NOT `\u0000`, the other obvious choice: the GJS
+ * bundle minifier rewrites that escape into a raw NUL byte and GJS then refuses
+ * to parse the bundle at all ("template literal not terminated"). A separator
+ * that only fails once this file is bundled for the runtime it ships on is not
+ * worth the theoretical tidiness.
+ */
+function edgeKey(from, name) {
+    return `${from ?? ''}\n${name}`;
+}
+/** Inverse of {@link edgeKey}; `from` is null for a top-level (project) edge. */
+function parseEdgeKey(key) {
+    const sep = key.indexOf('\n');
+    const from = key.slice(0, sep);
+    return { from: from === '' ? null : from, name: key.slice(sep + 1) };
+}
+/**
+ * Seed set for {@link computeOptionalFlags}: the NAMES of the top-level specs
+ * the project did not declare optional. Everything else in the tree has to EARN
+ * its required status by being reachable from one of these.
+ *
+ * The parse is load-bearing. `specs` are flat `"<name>@<range>"` strings while
+ * `optionalSpecs` holds bare NAMES (the range differs per requester — see
+ * {@link NativeInstallOptions.optionalSpecs}), so testing a spec string against
+ * the set is a lookup that can never hit: every top-level optionalDependency
+ * would be seeded as REQUIRED, and the `optionalDependencies: { fsevents }`
+ * shape would fail every Linux install with EBADPLATFORM instead of thinning.
+ * An earlier version of this walk compared the two directly and did exactly
+ * that; the `(c) an incompatible OPTIONAL top-level dep is skipped, not fatal`
+ * case in `tests/e2e/install-platform-filter` is where it is pinned.
+ */
+function requiredTopLevelNames(specs, optionalSpecs) {
+    const names = new Set();
+    for (const spec of specs) {
+        const name = parseSpecName(spec);
+        if (optionalSpecs?.has(name))
+            continue;
+        names.add(name);
+    }
+    return names;
+}
+/**
+ * Recompute every node's `optional` flag as a FIXPOINT over the placed graph.
+ * The only writer of the final flag; whatever the nodes arrive carrying is an
+ * input nothing checked (a BFS forward guess on the resolve path, a value read
+ * back out of a file on the lockfile path) and is overwritten unconditionally.
+ *
+ * DEFINITION: a node is REQUIRED iff it is reachable from `requiredNames`
+ * through `dependencies` edges alone; every other node is optional. Optionality
+ * is therefore INHERITED — a plain dependency OF an optional package is still
+ * optional — which is what npm's `optionalSet` computes.
+ *
+ * WHY A FIXPOINT AND NOT A ONE-SHOT PROMOTION AT THE REUSE SITE (the reviewed
+ * defect): the walk queues a node's own dep edges at the moment it is placed,
+ * carrying the optionality it had THEN. Promoting the node later leaves its
+ * children behind, so the answer depends on which edge BFS happened to traverse
+ * first — a genuinely required transitive dep reached first through an optional
+ * edge stayed flagged optional, was persisted that way, and was then silently
+ * skipped by the platform filter on every machine instead of raising
+ * EBADPLATFORM. A monotone worklist over the FINISHED graph cannot have that
+ * property: "required" only ever spreads, so the result is independent of visit
+ * order. npm reaches for the same shape and says so —
+ * refs/npm-cli/workspaces/arborist/lib/calc-dep-flags.js: "If a node is changed,
+ * we add to the queue and continue until no more changes."
+ *
+ * PATH-INDEPENDENCE IS THE OTHER REQUIREMENT, and it is why the walk reads
+ * `dependencies` ONLY. A lockfile entry records `dependencies` and nothing else
+ * (an `optionalDependencies` map is not persisted), so consulting
+ * `node.optionalDependencies` here would make the fresh-resolve path and the
+ * lockfile path compute different flags for the same tree — precisely the split
+ * this pass exists to close. The cost is one npm quirk we do not reproduce: a
+ * publisher listing the same name in BOTH blocks means "optional" to npm, and
+ * comes out required here. That shape is vanishingly rare in practice (the
+ * platform-binary packages this feature is about — rollup, lightningcss,
+ * esbuild, fsevents — all list their optional deps in one block only), and
+ * erring toward REQUIRED errs toward the loud failure, not the silent one.
+ *
+ * Runs before `writeLockfile` so the persisted flag is the final one, and before
+ * `applyPlatformFilter` so the fatal-vs-inert decision reads it rather than the
+ * guess.
+ */
+function computeOptionalFlags(nodes, requiredNames, log) {
+    const byPath = new Map();
+    for (const node of nodes)
+        byPath.set(node.installPath, node);
+    /** `installPath`s proven reachable through required edges alone. */
+    const required = new Set();
+    /** Nodes newly proven required and not yet expanded. */
+    const worklist = [];
+    const enter = (node) => {
+        if (required.has(node.installPath))
+            return;
+        required.add(node.installPath);
+        worklist.push(node.installPath);
+    };
+    // Top-level specs always hoist (`decidePlacement` returns the root slot for
+    // a null requester), so the seed lookup is exact. A name with no placement
+    // is a workspace member satisfied by its symlink — nothing to flag.
+    for (const name of requiredNames) {
+        const seed = byPath.get(`node_modules/${name}`);
+        if (seed)
+            enter(seed);
+    }
+    while (worklist.length > 0) {
+        const installPath = worklist.pop();
+        if (installPath === undefined)
+            break;
+        const node = byPath.get(installPath);
+        if (!node)
+            continue;
+        for (const depName of Object.keys(node.dependencies)) {
+            // Resolve the edge the way the REQUESTER will at runtime — through
+            // the ancestor `node_modules` chain — so a nested copy is credited
+            // to the requester that nested it and the hoisted one is not
+            // accidentally kept alive by a dependent that cannot even see it.
+            const resolvedTo = findVisible(installPath, depName, byPath);
+            if (resolvedTo)
+                enter(resolvedTo);
+        }
+    }
+    // Count the disagreements, don't just apply them. A nonzero `corrected` is
+    // the signal that the incoming flags (the walk's guess, or a lockfile
+    // written by an older CLI) were wrong for this tree — the class of bug this
+    // pass exists for, otherwise invisible because the corrected result looks
+    // exactly like a correct one.
+    let corrected = 0;
+    for (const node of nodes) {
+        const optional = !required.has(node.installPath);
+        if ((node.optional ?? false) !== optional)
+            corrected++;
+        node.optional = optional;
+    }
+    log('install: optionality fixpoint — %d of %d node(s) reachable only via optional edges%s', nodes.length - required.size, nodes.length, corrected > 0 ? `; corrected ${corrected} incoming flag(s)` : '');
+}
+/**
+ * Re-judge every failure the resolve swallowed against the FIXPOINT flags, and
+ * throw if one of them turned out to be required after all.
+ *
+ * `resolveDeps` tolerates a failed edge on the strength of `edge.required`,
+ * which is a forward guess made while the graph was still incomplete. This is
+ * the second half of that bargain: without it, a genuinely required dependency
+ * disappears from the tree for no better reason than BFS reaching it through an
+ * optional edge first — an install that "succeeded" and produced a tree that
+ * cannot run, with the explanation confined to a `--verbose` line nobody read.
+ *
+ * Same shape as npm's `#pruneFailedOptional()` ("if (!node.optional) throw
+ * node.errors[0]"), including its position AFTER the flag pass. The difference
+ * is what we hold: npm placed a real (broken) Node and still has the original
+ * error, we recorded only the edge — so the message has to name the edge and
+ * point at the verbose line that carries the cause.
+ *
+ * Three tolerated cases, and each is a property of the EDGE, not of the tree:
+ * a root edge the project itself declared optional, an edge under a subtree the
+ * fixpoint says is optional-only, and a required node's own
+ * `optionalDependencies` entry.
+ */
+function assertRequiredEdgesResolved(nodes, skippedEdges) {
+    if (skippedEdges.size === 0)
+        return;
+    const byPath = new Map();
+    for (const node of nodes)
+        byPath.set(node.installPath, node);
+    for (const key of skippedEdges) {
+        const { from, name } = parseEdgeKey(key);
+        // Top-level edge: tolerated only because the project's own manifest put
+        // the spec in `optionalDependencies` (that is the ONLY way
+        // `requiredTopLevelNames` leaves it out of the seed set). The manifest
+        // is the whole truth for a root edge — no later edge can revise it.
+        if (from === null)
+            continue;
+        const requester = byPath.get(from);
+        // Requester never made it into the tree. Nothing depends on this edge
+        // any more, so nothing is missing.
+        if (!requester)
+            continue;
+        // The whole subtree is reachable only through optional edges — npm's
+        // `optionalSet`, skipped in silence.
+        if (requester.optional)
+            continue;
+        // A REQUIRED package's own optionalDependency stays optional whatever
+        // the package's flag says: optionality lives on the edge, not on its
+        // endpoints. This branch is what keeps a darwin-only `fsevents` under a
+        // required `chokidar` from failing every Linux install.
+        //
+        // Safe on both paths because `skippedEdges` is only ever non-empty on
+        // the fresh-resolve path, where `optionalDependencies` is populated; the
+        // lockfile paths resolve nothing and reach here with an empty set.
+        if (name in requester.optionalDependencies)
+            continue;
+        throw new Error(`install: required dependency ${name} of ${requester.name}@${requester.version} ` +
+            `(${requester.installPath}) could not be resolved.\n` +
+            `The failure was tolerated during the walk because ${requester.name} looked optional at that ` +
+            `point, but the final dependency graph makes it required — so ${name} is required too and the ` +
+            `tree would be incomplete.\n` +
+            `Re-run with --verbose and look for the "resolve: optional dep ${name}@… skipped (…)" line for ` +
+            `the underlying cause.`);
+    }
 }
 /**
  * Loud, single-line-per-package warning for top-level version-range
@@ -505,31 +979,39 @@ function emitTopLevelConflictWarnings(topLevelRanges, root) {
  * keyed by the registry the name resolves to, so scope-registry overrides never
  * cross-contaminate. Falls back to a plain fetch when there's no cached entry
  * or the registry doesn't send an ETag (the 304 fast-path simply never fires).
+ *
+ * `shape` selects WHICH document: `'corgi'` (abbreviated — every resolve) or
+ * `'full'` (the escalation that carries `libc`). It is threaded all the way
+ * through — request `accept`, cache read AND cache write — because the two are
+ * different bodies with independently-versioned ETags for one URL. Mixing them
+ * anywhere in that chain produces a `libc`-less body that looks like a hit.
  */
-async function fetchPackumentWithDiskCache(name, npmrc, log, signal) {
+async function fetchPackumentWithDiskCache(name, npmrc, log, signal, shape = 'corgi') {
     const registry = registryFor(name, npmrc);
-    const disk = getCachedPackument(registry, name);
+    const fullMetadata = shape === 'full';
+    const disk = getCachedPackument(registry, name, shape);
     const onRetry = ({ attempt, error, delayMs }) => {
-        log('packument %s: retry %d after %dms (%s)', name, attempt, delayMs, errMsg(error));
+        log('packument %s (%s): retry %d after %dms (%s)', name, shape, attempt, delayMs, errMsg(error));
     };
     const result = await fetchPackumentConditional(name, {
         npmrc,
         signal,
         ifNoneMatch: disk?.etag,
+        fullMetadata,
         onRetry,
     });
     if (result.status === 'not-modified' && disk) {
-        log('packument-cache-hit: %s (304, etag %s)', name, disk.etag);
+        log('packument-cache-hit: %s (%s, 304, etag %s)', name, shape, disk.etag);
         return disk.packument;
     }
     if (result.status === 'fresh' && result.packument) {
         if (result.etag)
-            putCachedPackument(registry, name, result.etag, result.packument);
+            putCachedPackument(registry, name, result.etag, result.packument, shape);
         return result.packument;
     }
     // 304 with no cached body to satisfy it (a stale `If-None-Match` raced a
     // cache eviction). Re-fetch unconditionally so we always return a body.
-    return fetchPackument(name, { npmrc, signal, onRetry });
+    return fetchPackument(name, { npmrc, signal, fullMetadata, onRetry });
 }
 async function prefetchPackuments(names, fetchPkg, signal) {
     if (names.length === 0)
@@ -630,7 +1112,12 @@ function readLockfile(lockfilePath) {
         return null;
     try {
         const parsed = JSON.parse(fs.readFileSync(lockfilePath, 'utf-8'));
-        if (parsed.lockfileVersion !== LOCKFILE_VERSION)
+        // Accept every readable version, not just the current one — see
+        // READABLE_LOCKFILE_VERSIONS for why returning null on a v2 file is
+        // worse than reading it. The caller decides what it may be used FOR:
+        // a v2 file seeds version preservation but never short-circuits the
+        // resolve, because it carries no platform declarations.
+        if (!READABLE_LOCKFILE_VERSIONS.has(parsed.lockfileVersion))
             return null;
         if (!parsed.packages || typeof parsed.packages !== 'object')
             return null;
@@ -651,6 +1138,14 @@ function writeLockfile(lockfilePath, specs, nodes) {
             integrity: node.integrity,
             dependencies: Object.keys(node.dependencies).length > 0 ? node.dependencies : undefined,
             bin: node.bin,
+            // The DECLARATION, never the verdict: `inert` is per-host and
+            // deliberately absent from the file (a lockfile that recorded which
+            // packages the author's machine skipped would install a different
+            // tree for everyone else — the failure this design exists to avoid).
+            os: node.platform?.os,
+            cpu: node.platform?.cpu,
+            libc: node.platform?.libc,
+            optional: node.optional ? true : undefined,
         };
     }
     const lockfile = {
@@ -702,18 +1197,29 @@ function preferredVersionFor(locked, range) {
     return best;
 }
 function lockfileToNodes(lockfile) {
-    return Object.entries(lockfile.packages).map(([installPath, entry]) => ({
-        // Recover the package name from the path: the last segment is
-        // either `<name>` (unscoped) or `@scope/<name>` (scoped).
-        name: nameFromInstallPath(installPath),
-        version: entry.version,
-        tarballUrl: entry.resolved,
-        integrity: entry.integrity,
-        installPath,
-        dependencies: entry.dependencies ?? {},
-        optionalDependencies: {},
-        bin: entry.bin,
-    }));
+    return Object.entries(lockfile.packages).map(([installPath, entry]) => {
+        const platform = { os: entry.os, cpu: entry.cpu, libc: entry.libc };
+        return {
+            // Recover the package name from the path: the last segment is
+            // either `<name>` (unscoped) or `@scope/<name>` (scoped).
+            name: nameFromInstallPath(installPath),
+            version: entry.version,
+            tarballUrl: entry.resolved,
+            integrity: entry.integrity,
+            installPath,
+            dependencies: entry.dependencies ?? {},
+            optionalDependencies: {},
+            bin: entry.bin,
+            // Rebuilt from the recorded declaration so `applyPlatformFilter`
+            // reaches the SAME verdict on this path as on the fresh-resolve
+            // path — for THIS host, which is generally not the host that wrote
+            // the file. A v2 entry has none of these fields, so nothing is
+            // filtered; that install behaves exactly as it did before the
+            // feature (see READABLE_LOCKFILE_VERSIONS).
+            platform: declaresPlatform(platform) ? platform : undefined,
+            optional: entry.optional === true,
+        };
+    });
 }
 function nameFromInstallPath(installPath) {
     // Last `node_modules/` boundary, then the rest is the package name
@@ -1153,9 +1659,39 @@ function readShebang(file) {
  * the same set from the same templates. See `./bin-shim.ts`.
  */
 export function writeBinEntry(opts) {
-    const { binDir, binName, targetAbs } = opts;
+    const { binDir, binName, targetAbs, gjs } = opts;
     const platform = opts.platform ?? process.platform;
     const linkPath = path.join(binDir, binName);
+    if (gjs) {
+        const isBundle = isGjsBundlePath(targetAbs);
+        // Replace the whole sibling set: a previous install may have written a
+        // plain symlink (or npm's three-file shim) under this very name.
+        for (const stale of [linkPath, `${linkPath}.cmd`, `${linkPath}.ps1`])
+            rmWithRetry(stale);
+        fs.writeFileSync(linkPath, buildShLauncher(targetAbs, { envPreamble: gjs.envPreamble, isGjsBundle: isBundle }));
+        try {
+            fs.chmodSync(linkPath, 0o755);
+        }
+        catch {
+            /* inert on Windows; harmless under WSL/MSYS */
+        }
+        if (platform === 'win32' && isBundle) {
+            // No dedicated DLL-search variable on Windows: LoadLibrary searches
+            // PATH, and GLib's search-path separator is `;` there too — so both
+            // variables take the same `;`-joined value.
+            const joined = gjs.prebuildDirs.join(';');
+            const prependEnv = gjs.prebuildDirs.length > 0 ? { GI_TYPELIB_PATH: joined, PATH: joined } : {};
+            const shims = buildLauncherShims({
+                interpreter: 'gjs',
+                interpreterArgs: ['-m'],
+                target: targetAbs,
+                prependEnv,
+            });
+            fs.writeFileSync(`${linkPath}.cmd`, shims.cmd);
+            fs.writeFileSync(`${linkPath}.ps1`, shims.ps1);
+        }
+        return;
+    }
     if (platform === 'win32') {
         const relPosix = path.relative(binDir, targetAbs).split('\\').join('/');
         const { sh, cmd, ps1 } = buildCmdShim(relPosix, readShebang(targetAbs));
@@ -1193,17 +1729,34 @@ async function linkBins(nodes, prefix, log) {
     // backend depends on it (gjsify's own use cases all hit root bins).
     const binDir = path.join(prefix, 'node_modules', '.bin');
     let created = 0;
+    // Computed on first use only: the scan walks the whole prefix, and most
+    // installs contain no package declaring `gjsify.bin` at all.
+    let gjsEnv;
+    const gjsEnvForPrefix = () => {
+        if (gjsEnv === undefined) {
+            const prebuildDirs = detectNativePackages(prefix).map((p) => p.prebuildsDir);
+            gjsEnv = { envPreamble: buildNativeEnvPreamble(prefix, prebuildDirs), prebuildDirs };
+        }
+        return gjsEnv;
+    };
     for (const node of nodes) {
-        if (!node.bin)
-            continue;
         if (depth(node.installPath) !== 1)
             continue;
-        const map = normalizeBin(node.name, node.bin);
-        if (map.size === 0)
+        const pkgDir = path.join(prefix, node.installPath);
+        // The INSTALLED manifest is the source of truth here, not the packument
+        // the resolver carried: `gjsify.bin` is a gjsify-specific field npm's
+        // abbreviated packument does not include, so a packument-only read can
+        // never see it. Falls back to the resolved npm `bin` when the extracted
+        // manifest is unreadable, which keeps the previous behaviour intact.
+        const manifest = readInstalledManifest(pkgDir) ?? (node.bin === undefined ? null : { bin: node.bin });
+        if (manifest === null)
+            continue;
+        const picked = pickBinMap(node.name, manifest);
+        if (picked === null || picked.map.size === 0)
             continue;
         fs.mkdirSync(binDir, { recursive: true });
-        for (const [binName, binTarget] of map) {
-            const targetAbs = path.join(prefix, node.installPath, binTarget);
+        for (const [binName, binTarget] of picked.map) {
+            const targetAbs = path.join(pkgDir, binTarget);
             if (!fs.existsSync(targetAbs))
                 continue;
             try {
@@ -1212,13 +1765,35 @@ async function linkBins(nodes, prefix, log) {
             catch {
                 /* best effort */
             }
-            writeBinEntry({ binDir, binName, targetAbs });
+            writeBinEntry({
+                binDir,
+                binName,
+                targetAbs,
+                gjs: picked.isGjsBin ? gjsEnvForPrefix() : undefined,
+            });
             created++;
         }
     }
     if (created > 0)
         log('bin: linked %d entry(ies) under .bin/', created);
 }
+/**
+ * Read an extracted package's `package.json`.
+ *
+ * Returns `null` rather than throwing: a node can legitimately have no manifest
+ * on disk yet (an optional dependency skipped for this platform), and bin
+ * linking is not the place to fail an otherwise-complete install. The caller
+ * falls back to the resolved npm `bin`.
+ */
+function readInstalledManifest(pkgDir) {
+    try {
+        const raw = fs.readFileSync(path.join(pkgDir, 'package.json'), 'utf-8');
+        return JSON.parse(raw);
+    }
+    catch {
+        return null;
+    }
+}
 /**
  * `fs.rmSync(..., { force: true })` with the Windows retry npm/rimraf apply.
  *
@@ -1232,18 +1807,6 @@ async function linkBins(nodes, prefix, log) {
 function rmWithRetry(target) {
     fs.rmSync(target, { recursive: true, force: true, maxRetries: 10, retryDelay: 100 });
 }
-function normalizeBin(pkgName, bin) {
-    const out = new Map();
-    if (typeof bin === 'string') {
-        // String form is shorthand for `{ <last-segment-of-pkgName>: <bin> }`.
-        const baseName = pkgName.startsWith('@') ? pkgName.slice(pkgName.indexOf('/') + 1) : pkgName;
-        out.set(baseName, bin);
-        return out;
-    }
-    for (const [k, v] of Object.entries(bin))
-        out.set(k, v);
-    return out;
-}
 async function loadNpmrc(opts) {
     const home = os.homedir();
     let parsed = {