feat: node-arguments for passing arguments to child processes node instances

Author: maxeljkin

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 options to be passed to child node processes when running tests
     --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 options to be passed to child node processes when running tests
 
 Note that providing files on the CLI overrides the `files` option.
 

lib/api.js

@@ -311,7 +311,7 @@ class Api extends Emittery {
 	}
 
 	async _computeForkExecArgv() {
-		const execArgv = this.options.testOnlyExecArgv || process.execArgv;
+		const execArgv = this.options.nodeArguments;
 		if (execArgv.length === 0) {
 			return Promise.resolve(execArgv);
 		}

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 options to be passed to child node processes when running tests
 		  --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: conf.nodeArguments
+			},
 			'--': {
 				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');
 
@@ -265,6 +271,7 @@ exports.run = async () => { // eslint-disable-line complexity
 		snapshotDir: conf.snapshotDir ? path.resolve(projectDir, conf.snapshotDir) : null,
 		timeout: conf.timeout,
 		updateSnapshots: conf.updateSnapshots,
+		nodeArguments: normalizeNodeArguments(conf.nodeArguments || []),
 		workerArgv: cli.flags['--']
 	});
 

lib/node-arguments.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const trim = require('lodash/trim');
+
+// Parse formats:
+// --param=--parameter --abc
+//         |_this____|
+// --param=" --arg1 --arg2 param " --abc
+//         |_this part___________|
+function parseCliParameter(str) {
+	str = str[0].startsWith('"') && str.endsWith('"') ? str.slice(1, str.length - 1) : str;
+	return trim(str)
+		.split(' ');
+}
+
+function normalizeNodeArguments(nodeArguments) {
+	const parsed = Array.isArray(nodeArguments) ? nodeArguments : parseCliParameter(nodeArguments);
+
+	const detectedInspect = parsed.find(arg => /^--inspect(-brk)?(=|$)/.test(arg));
+
+	if (detectedInspect && detectedInspect.includes('=')) {
+		throw new Error('The \'nodeArguments\' configuration must not contain inspect with port.');
+	}
+
+	const mainProcessArgs = process.execArgv.filter(arg => !detectedInspect || !/^--inspect(-brk)?(=|$)/.test(arg));
+
+	return parsed.concat(mainProcessArgs);
+}
+
+module.exports = normalizeNodeArguments;

test/api.js

@@ -37,6 +37,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 +1180,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: execArgv});
 		return api._computeForkExecArgv()
 			.then(result => {
 				t.true(result.length === execArgv.length);
@@ -1190,7 +1191,7 @@ function generatePassDebugTests(execArgv) {
 
 function generatePassInspectIntegrationTests(execArgv) {
 	test(`pass ${execArgv.join(' ')} to fork`, t => {
-		const api = apiCreator({testOnlyExecArgv: execArgv});
+		const api = apiCreator({nodeArguments: 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

@@ -94,7 +94,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,31 @@
+'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', '--b', '--c']);
+	t.end();
+});
+
+test('normalizes multiple node arguments from config', t => {
+	t.deepEqual(normalizeNodeArguments(['--arg1', '--b']), ['--arg1', '--b']);
+	t.end();
+});
+
+test('normalizes single node arguments from cli', t => {
+	t.deepEqual(normalizeNodeArguments('--test-flag'), ['--test-flag']);
+	t.end();
+});
+
+test('removes extra inspect', t => {
+	process.execArgv = ['--inspect-brk=123'];
+	t.deepEqual(normalizeNodeArguments('--inspect'), ['--inspect']);
+	t.end();
+});
+
+test('fails on inspect with port', t => {
+	t.throws(() => normalizeNodeArguments('--inspect=9230'), 'The \'nodeArguments\' configuration must not contain inspect with port.');
+	t.end();
+});
+