Restore node PATH override as a backup

Although NODE_OPTIONS should be sufficient more most cases, if
users set their own and ignore the env var (e.g. in an npm script,
which imo is reasonably common) then it won't be used. Keeping
the path override has little or no downside, and provides a
backup that lets us catch most of those cases too.

The one place that won't work is Yarn usage with NODE_OPTIONS,
which effectively ignores both env vars entirely. Don't do that.

Author: pimterry

overrides/js/prepend-node.js

@@ -1,5 +1,8 @@
 /**
- * --require'd by node before loading any other modules.
+ * --require'd by node before loading any other modules. The --require
+ * option is injected both using NODE_OPTIONS and with a node wrapper in
+ * PATH to handle various potential cases (node dedupes --require anyway).
+ *
  * This file sets up a global agent for the http & https modules,
  * plus tweaks various other HTTP clients that need nudges, so they
  * all correctly pick up the proxy from the environment.

overrides/path/node

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -e
+
+# Exclude ourselves from PATH, find the real node, then reset PATH
+PATH="${PATH//`dirname "$0"`:/}"
+real_node=`command -v node`
+PATH="`dirname "$0"`:$PATH"
+
+PREPEND_PATH=`dirname "$0"`/../js/prepend-node.js
+
+# Call node with the given arguments, prefixed with our extra logic
+if command -v winpty >/dev/null 2>&1; then
+    winpty "$real_node" -r "$PREPEND_PATH" "$@"
+else
+    "$real_node" -r "$PREPEND_PATH" "$@"
+fi

overrides/path/node.bat

@@ -0,0 +1,20 @@
+@echo off
+SETLOCAL
+
+REM Exclude ourselves from PATH within this script, to avoid recursing
+set ORIGINALPATH=%PATH%
+REM Get the current file's folder
+set THIS_PATH=%~dp0
+REM Strip the trailing slash from the folder
+set WRAPPER_FOLDER=%THIS_PATH:~0,-1%
+REM Remove that folder from PATH
+call set PATH=%%PATH:%WRAPPER_FOLDER%;=%%
+
+REM Get the real node path, store it in %REAL_NODE%
+FOR /F "tokens=*" %%g IN ('where node') do (SET REAL_NODE=%%g)
+
+REM Reset PATH, so its visible to node & subprocesses
+set PATH=%ORIGINALPATH%
+
+REM Start Node for real, with an extra arg to inject our logic
+"%REAL_NODE%" -r "%WRAPPER_FOLDER%\..\js\prepend-node.js" %*

src/interceptors/terminal/terminal-env-overrides.ts

@@ -9,7 +9,14 @@ const PATH_VAR_SEPARATOR = process.platform === 'win32' ? ';' : ':';
 export const OVERRIDES_DIR = path.join(APP_ROOT, 'overrides');
 const OVERRIDE_RUBYGEMS_PATH = path.join(OVERRIDES_DIR, 'gems');
 const OVERRIDE_PYTHONPATH = path.join(OVERRIDES_DIR, 'pythonpath');
+
 const OVERRIDE_JS_SCRIPT = path.join(OVERRIDES_DIR, 'js', 'prepend-node.js');
+const NODE_OPTION = `--require ${
+    // Avoid quoting except when necessary, because node 8 doesn't support quotes here
+    OVERRIDE_JS_SCRIPT.includes(' ')
+    ? `"${OVERRIDE_JS_SCRIPT}"`
+    : OVERRIDE_JS_SCRIPT
+}`;
 
 export const OVERRIDE_BIN_PATH = path.join(OVERRIDES_DIR, 'path');
 
@@ -72,14 +79,11 @@ export function getTerminalEnvVars(
                 ? `${OVERRIDE_PYTHONPATH}:${currentEnv.PYTHONPATH}`
             : OVERRIDE_PYTHONPATH,
 
-        // We use $NODE_OPTIONS to prepend our script into node. Notably this also
-        // clears it, which is important, as _our_ NODE_OPTIONS aren't meant for
+        // We use $NODE_OPTIONS to prepend our script into node. Notably this drops existing
+        // env values, when using our env, because _our_ NODE_OPTIONS aren't meant for
         // subprocesses. Otherwise e.g. --max-http-header-size breaks old Node/Electron.
-        'NODE_OPTIONS': `--require ${
-            // Avoid quoting except when necessary, because node 8 doesn't support quotes here
-            OVERRIDE_JS_SCRIPT.includes(' ')
-            ? `"${OVERRIDE_JS_SCRIPT}"`
-            : OVERRIDE_JS_SCRIPT
-        }`
+        'NODE_OPTIONS': currentEnv === 'runtime-inherit'
+            ? `$NODE_OPTIONS ${NODE_OPTION}`
+            : NODE_OPTION
     };
 }