node-arguments simplify processing

Author: Maksim Elkin

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 {nodeArguments: execArgv} = this.options;
-		if (execArgv.length === 0) {
-			return 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 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).join(' ');
 	}
 }
 

lib/cli.js

@@ -118,7 +118,7 @@ exports.run = async () => { // eslint-disable-line complexity
 			},
 			'node-arguments': {
 				type: 'string',
-				default: conf.nodeArguments
+				default: ''
 			},
 			'--': {
 				type: 'string'
@@ -220,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);
 
@@ -271,7 +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: normalizeNodeArguments(conf.nodeArguments || []),
+		nodeArguments,
 		workerArgv: cli.flags['--']
 	});
 

lib/node-arguments.js

@@ -1,30 +1,18 @@
 '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);
+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-lock.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",

package.json

@@ -4,28 +4,24 @@ 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.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', '--b']);
+	t.deepEqual(normalizeNodeArguments(['--arg1', '--b'], ''), {arg1: true, b: true});
 	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']);
+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('fails on inspect with port', t => {
-	t.throws(() => normalizeNodeArguments('--inspect=9230'), 'The \'nodeArguments\' configuration must not contain inspect with port.');
+test('normalizes single node arguments from cli', t => {
+	t.deepEqual(normalizeNodeArguments([], '--test-flag'), {'test-flag': true});
 	t.end();
 });
-