feat: use nodeGyp option (#230)

This allows for a `nodeGyp` option to be passed in to define where the
node-gyp bin is to run.

It also allows for the environment variable `npm_config_node_gyp` to
already be set, and not override it if it is.


This is an extension of #222

Closes: npm/cli#2839

Co-author: @legobeat

---------

Co-authored-by: legobt <[email protected]>

Author: wraithgar

lib/make-spawn-args.js

@@ -1,21 +1,34 @@
 /* eslint camelcase: "off" */
 const setPATH = require('./set-path.js')
 const { resolve } = require('path')
-const npm_config_node_gyp = require.resolve('node-gyp/bin/node-gyp.js')
+
+let npm_config_node_gyp
 
 const makeSpawnArgs = options => {
   const {
+    args,
+    binPaths,
+    cmd,
+    env,
     event,
+    nodeGyp,
     path,
     scriptShell = true,
-    binPaths,
-    env,
     stdio,
-    cmd,
-    args,
     stdioString,
   } = options
 
+  if (nodeGyp) {
+    // npm already pulled this from env and passes it in to options
+    npm_config_node_gyp = nodeGyp
+  } else if (env.npm_config_node_gyp) {
+    // legacy mode for standalone user
+    npm_config_node_gyp = env.npm_config_node_gyp
+  } else {
+    // default
+    npm_config_node_gyp = require.resolve('node-gyp/bin/node-gyp.js')
+  }
+
   const spawnEnv = setPATH(path, binPaths, {
     // we need to at least save the PATH environment var
     ...process.env,

lib/run-script-pkg.js

@@ -7,18 +7,19 @@ const isServerPackage = require('./is-server-package.js')
 
 const runScriptPkg = async options => {
   const {
-    event,
-    path,
-    scriptShell,
+    args = [],
     binPaths = false,
     env = {},
-    stdio = 'pipe',
+    event,
+    nodeGyp,
+    path,
     pkg,
-    args = [],
-    stdioString,
+    scriptShell,
     // how long to wait for a process.kill signal
     // only exposed here so that we can make the test go a bit faster.
     signalTimeout = 500,
+    stdio = 'pipe',
+    stdioString,
   } = options
 
   const { scripts = {}, gypfile } = pkg
@@ -63,14 +64,15 @@ const runScriptPkg = async options => {
   }
 
   const [spawnShell, spawnArgs, spawnOpts] = makeSpawnArgs({
+    args,
+    binPaths,
+    cmd,
+    env: { ...env, ...packageEnvs(pkg) },
     event,
+    nodeGyp,
     path,
     scriptShell,
-    binPaths,
-    env: { ...env, ...packageEnvs(pkg) },
     stdio,
-    cmd,
-    args,
     stdioString,
   })
 

test/make-spawn-args.js

@@ -62,20 +62,39 @@ t.test('spawn args', async t => {
       /.*/,
       a => a.includes('echo test'),
       e => {
-        return e.env.test_fixture === 'a string'
+        return e.env.test_fixture === 'a string' &&
+          e.env.npm_config_node_gyp === '/test/path.js'
       }
     )
     await t.resolves(() => runScript({
       pkg,
       path: testdir,
       env: {
+        npm_config_node_gyp: '/test/path.js',
         test_fixture: 'a string',
       },
       event: 'test',
     }))
     t.ok(spawk.done())
   })
 
+  await t.test('provided options.nodeGyp', async t => {
+    spawk.spawn(
+      /.*/,
+      a => a.includes('echo test'),
+      e => {
+        return e.env.npm_config_node_gyp === '/test/path.js'
+      }
+    )
+    await t.resolves(() => runScript({
+      pkg,
+      path: testdir,
+      nodeGyp: '/test/path.js',
+      event: 'test',
+    }))
+    t.ok(spawk.done())
+  })
+
   await t.test('provided args', async t => {
     spawk.spawn(
       /.*/,