Merge pull request #46085 from xxxigm/fix/bundled-node-global-npm-path

fix(install): make `npm install -g` packages reachable on PATH
This commit is contained in:
ethernet 2026-06-15 15:47:54 -04:00 committed by GitHub
commit 39f479cba8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 101 additions and 0 deletions

View file

@ -413,6 +413,25 @@ get_command_link_display_dir() {
fi
}
# Point a Hermes-managed Node's `npm install -g` at a directory that is on
# PATH. npm's default global prefix for a bundled Node is the Node dir itself,
# so global package binaries land in $HERMES_HOME/node/bin — which is NOT on
# PATH (only the command link dir is) and is wiped on every Node upgrade.
# Redirecting the prefix to the link dir's parent makes global bins resolve to
# the command link dir (node/npm/npx live there too, already on PATH) and
# survive upgrades. Scoped to the managed Node via its prefix-local global
# npmrc, so the user's other Node installs and their ~/.npmrc are untouched.
# Hermes's own global installs pass an explicit --prefix and are unaffected.
# Idempotent and a no-op when there is no Hermes-managed npm, so calling it on
# every install run repairs pre-existing installs, not just fresh ones.
configure_managed_node_npm_prefix() {
[ -x "$HERMES_HOME/node/bin/npm" ] || return 0
local link_dir
link_dir="$(get_command_link_dir)"
mkdir -p "$HERMES_HOME/node/etc"
printf 'prefix=%s\n' "$(dirname "$link_dir")" > "$HERMES_HOME/node/etc/npmrc"
}
get_hermes_command_path() {
local link_dir
link_dir="$(get_command_link_dir)"
@ -722,6 +741,11 @@ node_satisfies_build() {
check_node() {
log_info "Checking Node.js (for browser tools)..."
# Repair pre-existing Hermes-managed installs where `npm install -g` lands
# off PATH. No-op when there's no managed Node, so this is safe to run on
# every install — including re-runs that skip the Node (re)install below.
configure_managed_node_npm_prefix
if command -v node &> /dev/null && node_satisfies_build "$(node --version)"; then
log_success "Node.js $(node --version) found"
HAS_NODE=true
@ -851,6 +875,8 @@ install_node() {
ln -sf "$HERMES_HOME/node/bin/npm" "$node_link_dir/npm"
ln -sf "$HERMES_HOME/node/bin/npx" "$node_link_dir/npx"
configure_managed_node_npm_prefix
export PATH="$HERMES_HOME/node/bin:$PATH"
local installed_ver

View file

@ -57,6 +57,19 @@ _nb_get_link_dir() {
fi
}
# Redirect a Hermes-managed Node's `npm install -g` to the command link dir
# (already on PATH) instead of the default $HERMES_HOME/node/bin, which is off
# PATH and wiped on every Node upgrade. Scoped to the managed Node via its
# prefix-local global npmrc; the user's other Node installs / ~/.npmrc are
# untouched. Idempotent no-op when there's no managed npm.
_nb_configure_npm_prefix() {
[ -x "$HERMES_HOME/node/bin/npm" ] || return 0
local _link_dir
_link_dir="$(_nb_get_link_dir)"
mkdir -p "$HERMES_HOME/node/etc"
printf 'prefix=%s\n' "$(dirname "$_link_dir")" > "$HERMES_HOME/node/etc/npmrc"
}
_nb_node_major() {
local v
v=$(node --version 2>/dev/null | sed 's/^v//' | cut -d. -f1)
@ -206,6 +219,9 @@ _nb_install_bundled_node() {
ln -sf "$HERMES_HOME/node/bin/node" "$_link_dir/node"
ln -sf "$HERMES_HOME/node/bin/npm" "$_link_dir/npm"
ln -sf "$HERMES_HOME/node/bin/npx" "$_link_dir/npx"
_nb_configure_npm_prefix
export PATH="$HERMES_HOME/node/bin:$PATH"
_nb_have_modern_node || return 1
@ -220,6 +236,10 @@ _nb_install_bundled_node() {
ensure_node() {
HERMES_NODE_AVAILABLE=false
# Repair pre-existing managed installs where `npm install -g` lands off
# PATH. No-op when there's no managed Node, so it's safe to run first.
_nb_configure_npm_prefix
if _nb_have_modern_node; then
_nb_ok "Node $(node --version) found"
HERMES_NODE_AVAILABLE=true

View file

@ -0,0 +1,55 @@
"""Regression tests for the Hermes-managed Node's npm global prefix.
When the installer falls back to a bundled Node under ``$HERMES_HOME/node``,
npm's default global prefix is that Node dir, so ``npm install -g <pkg>``
drops the package binary in ``$HERMES_HOME/node/bin`` which is NOT on PATH
(only the command link dir is) and is wiped on every Node upgrade. Users then
report "I can ``npm i -g`` but the package isn't usable on the command line".
The fix redirects the bundled Node's global prefix to the command link dir's
parent (so global bins land in the already-on-PATH link dir alongside
node/npm/npx), scoped to the bundled Node via its prefix-local global npmrc.
"""
from pathlib import Path
REPO_ROOT = Path(__file__).resolve().parent.parent
INSTALL_SH = REPO_ROOT / "scripts" / "install.sh"
NODE_BOOTSTRAP = REPO_ROOT / "scripts" / "lib" / "node-bootstrap.sh"
def test_install_sh_redirects_bundled_npm_global_prefix_to_link_dir() -> None:
text = INSTALL_SH.read_text()
# The redirect must target the link dir's PARENT so global bins resolve to
# <parent>/bin == the command link dir (node/npm/npx live there and it is
# guaranteed on PATH by the installer's PATH setup).
assert "configure_managed_node_npm_prefix()" in text
assert 'printf \'prefix=%s\\n\' "$(dirname "$link_dir")" > "$HERMES_HOME/node/etc/npmrc"' in text
def test_install_sh_repairs_existing_managed_node_on_rerun() -> None:
"""The redirect must run on every install (not just fresh Node installs),
so re-running the installer repairs pre-existing managed installs whose
Node is already up to date and would otherwise skip install_node."""
text = INSTALL_SH.read_text()
check_node_body = text.split("check_node()", 1)[1].split("\ninstall_node()", 1)[0]
assert "configure_managed_node_npm_prefix" in check_node_body
# No-op guard so it's safe to call when there is no managed Node.
assert '[ -x "$HERMES_HOME/node/bin/npm" ] || return 0' in text
def test_node_bootstrap_redirects_bundled_npm_global_prefix_to_link_dir() -> None:
text = NODE_BOOTSTRAP.read_text()
assert "_nb_configure_npm_prefix()" in text
assert 'printf \'prefix=%s\\n\' "$(dirname "$_link_dir")" > "$HERMES_HOME/node/etc/npmrc"' in text
# Runs at the top of ensure_node so existing managed installs are repaired
# even when a modern Node is already present (early return path).
ensure_node_body = text.split("ensure_node()", 1)[1]
assert "_nb_configure_npm_prefix" in ensure_node_body
assert '[ -x "$HERMES_HOME/node/bin/npm" ] || return 0' in text