Allow Node arguments to be configured

docs/05-command-line.md

@@ -21,6 +21,7 @@ $ npx ava --help
     --color                 Force color output
     --no-color              Disable color output
     --reset-cache           Reset AVA's compilation cache and exit
+    --node-arguments        Configure Node.js arguments used to launch worker processes
     --config                JavaScript file for AVA to read its config from, instead of using package.json
                             or ava.config.js files
 

docs/06-configuration.md

@@ -44,7 +44,11 @@ To ignore files, prefix the pattern with an `!` (exclamation mark).
 			"testOptions": {
 				"babelrc": false
 			}
-		}
+		},
+		"nodeArguments": [
+				"--trace-deprecation",
+				"--napi-modules"
+		]
 	}
 }
 ```
@@ -70,6 +74,7 @@ Arguments passed to the CLI will always take precedence over the CLI options con
 - `babel`: test file specific Babel options. See our [Babel recipe](./recipes/babel.md#configuring-babel) for more details
 - `babel.extensions`: extensions of test files that will be precompiled using AVA's Babel presets. Setting this overrides the default `"js"` value, so make sure to include that extension in the list
 - `timeout`: Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our [timeout documentation](./07-test-timeouts.md) for more options.
+- `nodeArguments`: Configure Node.js arguments used to launch worker processes.
 
 Note that providing files on the CLI overrides the `files` option.
 

lib/api.js

@@ -1,4 +1,5 @@
 'use strict';
+
 const path = require('path');
 const fs = require('fs');
 const os = require('os');
@@ -15,6 +16,8 @@ const makeDir = require('make-dir');
 const ms = require('ms');
 const chunkd = require('chunkd');
 const Emittery = require('emittery');
+const minimist = require('minimist');
+const dargs = require('dargs');
 const globs = require('./globs');
 const RunStatus = require('./run-status');
 const fork = require('./fork');
@@ -320,28 +323,28 @@ class Api extends Emittery {
 	}
 
 	async _computeForkExecArgv() {
-		const execArgv = this.options.testOnlyExecArgv || process.execArgv;
-		if (execArgv.length === 0) {
-			return Promise.resolve(execArgv);
-		}
+		const {nodeArguments: configExecArgs} = this.options;
 
-		// --inspect-brk is used in addition to --inspect to break on first line and wait
-		const inspectArgIndex = execArgv.findIndex(arg => /^--inspect(-brk)?($|=)/.test(arg));
-		if (inspectArgIndex === -1) {
-			return Promise.resolve(execArgv);
-		}
+		const mainProcessArgs = minimist(process.execArgv);
 
-		const port = await getPort();
-		const forkExecArgv = execArgv.slice();
-		let flagName = '--inspect';
-		const oldValue = forkExecArgv[inspectArgIndex];
-		if (oldValue.includes('brk')) {
-			flagName += '-brk';
-		}
+		const args = {
+			...mainProcessArgs,
+			...configExecArgs
+		};
 
-		forkExecArgv[inspectArgIndex] = `${flagName}=${port}`;
+		const hasInspect = args.inspect || args['inspect-brk'];
+		if (hasInspect) {
+			if (args.inspect && args['inspect-brk']) {
+				throw new Error('Flags inspect and inspect-brk provided simultaneously');
+			}
+
+			const port = await getPort();
+
+			const flagName = args.inspect ? 'inspect' : 'inspect-brk';
+			args[flagName] = port;
+		}
 
-		return forkExecArgv;
+		return dargs(args);
 	}
 }
 

lib/cli.js

@@ -51,6 +51,7 @@ exports.run = async () => { // eslint-disable-line complexity
 		  --color                 Force color output
 		  --no-color              Disable color output
 		  --reset-cache           Reset AVA's compilation cache and exit
+		  --node-arguments        Configure Node.js arguments used to launch worker processes (For example --node-arguments="--frozen-intrinsics --experimental-modules")
 		  --config                JavaScript file for AVA to read its config from, instead of using package.json
 		                          or ava.config.js files
 
@@ -115,6 +116,10 @@ exports.run = async () => { // eslint-disable-line complexity
 				type: 'boolean',
 				default: false
 			},
+			'node-arguments': {
+				type: 'string',
+				default: ''
+			},
 			'--': {
 				type: 'string'
 			}
@@ -180,6 +185,7 @@ exports.run = async () => { // eslint-disable-line complexity
 	const Watcher = require('./watcher');
 	const babelManager = require('./babel-manager');
 	const normalizeExtensions = require('./extensions');
+	const normalizeNodeArguments = require('./node-arguments');
 	const {normalizeGlobs} = require('./globs');
 	const validateEnvironmentVariables = require('./environment-variables');
 
@@ -214,6 +220,13 @@ exports.run = async () => { // eslint-disable-line complexity
 		exit(error.message);
 	}
 
+	let nodeArguments;
+	try {
+		nodeArguments = normalizeNodeArguments(conf.nodeArguments, cli.flags.nodeArguments);
+	} catch (error) {
+		exit(error.message);
+	}
+
 	// Copy resultant cli.flags into conf for use with Api and elsewhere
 	Object.assign(conf, cli.flags);
 
@@ -265,6 +278,7 @@ exports.run = async () => { // eslint-disable-line complexity
 		snapshotDir: conf.snapshotDir ? path.resolve(projectDir, conf.snapshotDir) : null,
 		timeout: conf.timeout,
 		updateSnapshots: conf.updateSnapshots,
+		nodeArguments,
 		workerArgv: cli.flags['--']
 	});
 

lib/node-arguments.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const minimist = require('minimist');
+const omit = require('lodash/omit');
+
+/**
+ * @param {string[]} confParams
+ * @param {string} cliParams
+ * @return {object}
+ */
+function normalizeNodeArguments(confParams, cliParams) {
+	return omit({
+		...minimist(confParams || []),
+		...minimist(cliParams.split(' '))
+	}, '_');
+}
+
+module.exports = normalizeNodeArguments;

package.json

@@ -80,6 +80,7 @@
 		"concordance": "^4.0.0",
 		"convert-source-map": "^1.6.0",
 		"currently-unhandled": "^0.4.1",
+		"dargs": "^7.0.0",
 		"debug": "^4.1.1",
 		"del": "^5.1.0",
 		"dot-prop": "^5.2.0",
@@ -106,6 +107,7 @@
 		"md5-hex": "^3.0.1",
 		"meow": "^5.0.0",
 		"micromatch": "^4.0.2",
+		"minimist": "^1.2.0",
 		"ms": "^2.1.2",
 		"observable-to-promise": "^1.0.0",
 		"ora": "^4.0.2",

test/api.js

@@ -5,6 +5,7 @@ const assert = require('assert');
 const path = require('path');
 const fs = require('fs');
 const del = require('del');
+const minimist = require('minimist');
 const {test} = require('tap');
 const Api = require('../lib/api');
 const babelManager = require('../lib/babel-manager');
@@ -37,6 +38,7 @@ function apiCreator(options = {}) {
 	options.experiments = {};
 	options.globs = normalizeGlobs(options.files, options.helpers, options.sources, options.extensions.all);
 	options.resolveTestsFrom = options.resolveTestsFrom || options.projectDir;
+	options.nodeArguments = options.nodeArguments || {};
 	const instance = new Api(options);
 	if (!options.precompileHelpers) {
 		instance._precompileHelpers = () => Promise.resolve();
@@ -1179,7 +1181,7 @@ test('using --match with matching tests will only report those passing tests', t
 
 function generatePassDebugTests(execArgv) {
 	test(`pass ${execArgv.join(' ')} to fork`, t => {
-		const api = apiCreator({testOnlyExecArgv: execArgv});
+		const api = apiCreator({nodeArguments: minimist(execArgv)});
 		return api._computeForkExecArgv()
 			.then(result => {
 				t.true(result.length === execArgv.length);
@@ -1190,7 +1192,7 @@ function generatePassDebugTests(execArgv) {
 
 function generatePassInspectIntegrationTests(execArgv) {
 	test(`pass ${execArgv.join(' ')} to fork`, t => {
-		const api = apiCreator({testOnlyExecArgv: execArgv});
+		const api = apiCreator({nodeArguments: minimist(execArgv)});
 		return api.run([path.join(__dirname, 'fixture/inspect-arg.js')])
 			.then(runStatus => {
 				t.is(runStatus.stats.passedTests, 1);

test/fixture/node-arguments.js

@@ -0,0 +1,7 @@
+import test from '../..';
+
+test('exec arguments includes --throw-deprecation and --zero-fill-buffers', t => {
+	t.plan(2);
+	t.truthy(process.execArgv.includes('--throw-deprecation'));
+	t.truthy(process.execArgv.includes('--zero-fill-buffers'));
+});

test/fixture/node-arguments/package.json

@@ -0,0 +1,8 @@
+{
+	"ava": {
+		"nodeArguments": [
+			"--require",
+			"./setup.js"
+		]
+	}
+}

test/fixture/node-arguments/setup.js

@@ -0,0 +1 @@
+global.SETUP_CALLED = true;

test/fixture/node-arguments/test.js

@@ -0,0 +1,7 @@
+import test from '../../..';
+
+test('works', t => {
+	t.plan(2);
+	t.truthy(global.SETUP_CALLED);
+	t.truthy(process.execArgv.includes('--require'));
+});

test/helper/report.js

@@ -95,7 +95,8 @@ const run = (type, reporter, match = []) => {
 		concurrency: 1,
 		updateSnapshots: false,
 		snapshotDir: false,
-		color: true
+		color: true,
+		nodeArguments: {}
 	};
 	let pattern = '*.js';
 

test/integration/node-arguments.js

@@ -0,0 +1,15 @@
+'use strict';
+const {test} = require('tap');
+const {execCli} = require('../helper/cli');
+
+test('passes node arguments to workers', t => {
+	t.plan(1);
+	execCli(['--node-arguments="--throw-deprecation --zero-fill-buffers"', 'node-arguments.js'], err => t.ifError(err));
+});
+
+test('reads node arguments from config', t => {
+	t.plan(1);
+	execCli(['test.js'], {
+		dirname: 'fixture/node-arguments'
+	}, err => t.ifError(err));
+});

test/node-arguments.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const {test} = require('tap');
+const normalizeNodeArguments = require('../lib/node-arguments');
+
+test('normalizes multiple node arguments from cli', t => {
+	t.deepEqual(normalizeNodeArguments([], '--a --b --c'), {a: true, b: true, c: true});
+	t.end();
+});
+
+test('normalizes multiple node arguments from config', t => {
+	t.deepEqual(normalizeNodeArguments(['--arg1', '--b'], ''), {arg1: true, b: true});
+	t.end();
+});
+
+test('normalizes node arguments from config and cli', t => {
+	t.deepEqual(
+		normalizeNodeArguments(['--arg1', '--b=2'], '--arg2 --b=12'),
+		{arg1: true, arg2: true, b: 12}
+	);
+	t.end();
+});
+
+test('normalizes single node arguments from cli', t => {
+	t.deepEqual(normalizeNodeArguments([], '--test-flag'), {'test-flag': true});
+	t.end();
+});