Allow runners to specify spawn options

src/debug.js

@@ -17,7 +17,8 @@ const runIteration = async function({
   taskPath,
   taskId,
   variationId,
-  commandValue,
+  commandSpawn,
+  commandSpawnOptions,
   commandOpt,
   opts: { cwd },
 }) {
@@ -33,7 +34,8 @@ const runIteration = async function({
   }
 
   await executeChild({
-    commandValue,
+    commandSpawn,
+    commandSpawnOptions,
     input,
     cwd,
     taskId,

src/iterations/get.js

@@ -8,7 +8,7 @@ import { validateIds } from './validate.js'
 export const getCommandIterations = async function({
   taskPath,
   command,
-  command: { commandValue, commandOpt },
+  command: { commandSpawn, commandSpawnOptions, commandOpt },
   duration,
   cwd,
   debug,
@@ -17,7 +17,8 @@ export const getCommandIterations = async function({
   const input = { type: 'load', taskPath, opts: commandOpt }
   const type = debug ? 'loadDebug' : 'run'
   const { iterations } = await executeChild({
-    commandValue,
+    commandSpawn,
+    commandSpawnOptions,
     input,
     duration,
     cwd,
@@ -46,7 +47,8 @@ const normalizeIteration = function(
     commandId,
     commandTitle,
     commandDescription,
-    commandValue,
+    commandSpawn,
+    commandSpawnOptions,
     commandOpt,
   },
   { taskPath, system: { id: systemId, title: systemTitle } },
@@ -65,7 +67,8 @@ const normalizeIteration = function(
     commandId,
     commandTitle,
     commandDescription,
-    commandValue,
+    commandSpawn,
+    commandSpawnOptions,
     commandOpt,
     systemId,
     systemTitle,

src/processes/execute.js

@@ -14,7 +14,8 @@ import { forwardChildError } from './error.js'
 //  - whether `run` or `debug` is used
 //  - whether this is the initial load
 export const executeChild = async function({
-  commandValue: [file, ...args],
+  commandSpawn: [file, ...args],
+  commandSpawnOptions,
   input,
   input: { taskPath },
   duration,
@@ -27,7 +28,12 @@ export const executeChild = async function({
 
   const { stdio, outputFd, errorFds } = FDS[type]
 
-  const spawnOptions = getSpawnOptions({ stdio, cwd, duration })
+  const spawnOptions = getSpawnOptions({
+    stdio,
+    cwd,
+    duration,
+    commandSpawnOptions,
+  })
   const child = execa(file, [...args, inputA], spawnOptions)
 
   // Wait for child process successful exit, failed exit, spawning error,
@@ -61,14 +67,23 @@ export const executeChild = async function({
   return outputA
 }
 
-const getSpawnOptions = function({ stdio, cwd, duration }) {
+// Commands cannot override the spawn options we set with one exception:
+// `preferLocal` since that option can create issues with some runners, such as
+// `node` runner `versions` option.
+const getSpawnOptions = function({
+  stdio,
+  cwd,
+  duration,
+  commandSpawnOptions,
+}) {
   const timeout = getTimeout(duration)
   return {
+    preferLocal: true,
+    ...commandSpawnOptions,
     stdio,
     cwd,
     timeout,
     buffer: false,
     reject: false,
-    preferLocal: true,
   }
 }

src/processes/main.js

@@ -5,6 +5,7 @@ import { getStats } from '../stats/compute.js'
 import { runChildren } from './run.js'
 
 // Start several child processes benchmarking the same task.
+// eslint-disable-next-line max-lines-per-function
 export const runProcesses = async function({
   name,
   columnName,
@@ -17,7 +18,8 @@ export const runProcesses = async function({
   commandId,
   commandTitle,
   commandDescription,
-  commandValue,
+  commandSpawn,
+  commandSpawnOptions,
   commandOpt,
   systemId,
   systemTitle,
@@ -34,7 +36,8 @@ export const runProcesses = async function({
     taskPath,
     taskId,
     variationId,
-    commandValue,
+    commandSpawn,
+    commandSpawnOptions,
     commandOpt,
     duration,
     runEnd,

src/processes/run.js

@@ -20,7 +20,8 @@ export const runChildren = async function({
   taskPath,
   taskId,
   variationId,
-  commandValue,
+  commandSpawn,
+  commandSpawnOptions,
   commandOpt,
   duration,
   runEnd,
@@ -43,7 +44,8 @@ export const runChildren = async function({
   do {
     // eslint-disable-next-line no-await-in-loop
     const { times, count } = await executeChild({
-      commandValue,
+      commandSpawn,
+      commandSpawnOptions,
       input,
       duration,
       cwd,

src/run/command.js

@@ -8,8 +8,17 @@ export const getCommands = function({
   commands,
 }) {
   return Promise.all(
-    commands.map(({ id, title, value, versions }) =>
-      getCommand({ runnerId, runnerTitle, runOpt, id, title, value, versions }),
+    commands.map(({ id, title, spawn, spawnOptions, versions }) =>
+      getCommand({
+        runnerId,
+        runnerTitle,
+        runOpt,
+        id,
+        title,
+        spawn,
+        spawnOptions,
+        versions,
+      }),
     ),
   )
 }
@@ -20,7 +29,8 @@ const getCommand = async function({
   runOpt,
   id,
   title,
-  value,
+  spawn,
+  spawnOptions = {},
   versions,
 }) {
   const commandId = id === undefined ? runnerId : `${runnerId}_${id}`
@@ -36,7 +46,8 @@ const getCommand = async function({
     commandId,
     commandTitle,
     commandDescription,
-    commandValue: value,
+    commandSpawn: spawn,
+    commandSpawnOptions: spawnOptions,
     commandOpt: runOpt,
   }
 }

src/run/runners/cli/main.js

@@ -1,7 +1,7 @@
 const START_PATH = `${__dirname}/start.js`
 
 const commands = function() {
-  return [{ value: ['node', START_PATH], versions: [] }]
+  return [{ spawn: ['node', START_PATH], versions: [] }]
 }
 
 export const cli = {

src/run/runners/node/commands.js

@@ -13,7 +13,7 @@ export const commands = async function(runOpts) {
   if (versions === undefined) {
     return [
       {
-        value: ['node', START_PATH],
+        spawn: ['node', START_PATH],
         versions: [{ value: ['node', '--version'] }],
       },
     ]
@@ -27,7 +27,7 @@ const getNodeCommand = function({ nodePath, version, fullVersion }) {
   return {
     id: version,
     title: version,
-    value: [nodePath, START_PATH],
+    spawn: [nodePath, START_PATH],
     versions,
   }
 }