Skip to content

child_process: simplify spawn argument parsing #27854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cjihrig merged 1 commit into from
May 27, 2019
Merged

child_process: simplify spawn argument parsing #27854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
child_process: simplify spawn argument parsing 
This commit simplifies the object returned by
normalizeSpawnArguments(). This does impact monkey patching,
as illustrated by the changes in tests.

PR-URL: #27854
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
@cjihrig
cjihrig committed May 27, 2019
commit 4f9cd2770a5f04b4e83157c71a3a9f1bf5b42d84
66 changes: 24 additions & 42 deletions lib/child_process.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,16 +460,14 @@ function normalizeSpawnArguments(file, args, options) {
}

// Validate windowsVerbatimArguments, if present.
if (options.windowsVerbatimArguments != null &&
typeof options.windowsVerbatimArguments !== 'boolean') {
let { windowsVerbatimArguments } = options;
if (windowsVerbatimArguments != null &&
typeof windowsVerbatimArguments !== 'boolean') {
throw new ERR_INVALID_ARG_TYPE('options.windowsVerbatimArguments',
'boolean',
options.windowsVerbatimArguments);
windowsVerbatimArguments);
}

// Make a shallow copy so we don't clobber the user's options object.
options = { ...options };

if (options.shell) {
const command = [file].concat(args).join(' ');
// Set the shell, switches, and commands.
Expand All @@ -481,7 +479,7 @@ function normalizeSpawnArguments(file, args, options) {
// '/d /s /c' is used only for cmd.exe.
if (/^(?:.*\\)?cmd(?:\.exe)?$/i.test(file)) {
args = ['/d', '/s', '/c', `"${command}"`];
options.windowsVerbatimArguments = true;
windowsVerbatimArguments = true;
} else {
args = ['-c', command];
}
Expand Down Expand Up @@ -521,58 +519,42 @@ function normalizeSpawnArguments(file, args, options) {
}

return {
file: file,
args: args,
options: options,
envPairs: envPairs
// Make a shallow copy so we don't clobber the user's options object.
...options,
args,
detached: !!options.detached,
envPairs,
file,
windowsHide: !!options.windowsHide,
windowsVerbatimArguments: !!windowsVerbatimArguments
};
}


var spawn = exports.spawn = function spawn(file, args, options) {
const opts = normalizeSpawnArguments(file, args, options);
const child = new ChildProcess();

options = opts.options;
debug('spawn', opts.args, options);

child.spawn({
file: opts.file,
args: opts.args,
cwd: options.cwd,
windowsHide: !!options.windowsHide,
windowsVerbatimArguments: !!options.windowsVerbatimArguments,
detached: !!options.detached,
envPairs: opts.envPairs,
stdio: options.stdio,
uid: options.uid,
gid: options.gid
});
options = normalizeSpawnArguments(file, args, options);
debug('spawn', options);
child.spawn(options);

return child;
};

function spawnSync(file, args, options) {
const opts = normalizeSpawnArguments(file, args, options);

const defaults = {
options = {
maxBuffer: MAX_BUFFER,
...opts.options
...normalizeSpawnArguments(file, args, options)
};
options = opts.options = defaults;

debug('spawnSync', opts.args, options);
debug('spawnSync', options);

// Validate the timeout, if present.
validateTimeout(options.timeout);

// Validate maxBuffer, if present.
validateMaxBuffer(options.maxBuffer);

options.file = opts.file;
options.args = opts.args;
options.envPairs = opts.envPairs;

// Validate and translate the kill signal, if present.
options.killSignal = sanitizeKillSignal(options.killSignal);

Expand Down Expand Up @@ -603,7 +585,7 @@ function spawnSync(file, args, options) {
}
}

return child_process.spawnSync(opts);
return child_process.spawnSync(options);
}
exports.spawnSync = spawnSync;

Expand All @@ -628,15 +610,15 @@ function checkExecSyncError(ret, args, cmd) {


function execFileSync(command, args, options) {
const opts = normalizeSpawnArguments(command, args, options);
const inheritStderr = !opts.options.stdio;
options = normalizeSpawnArguments(command, args, options);

const ret = spawnSync(opts.file, opts.args.slice(1), opts.options);
const inheritStderr = !options.stdio;
const ret = spawnSync(options.file, options.args.slice(1), options);

if (inheritStderr && ret.stderr)
process.stderr.write(ret.stderr);

const err = checkExecSyncError(ret, opts.args, undefined);
const err = checkExecSyncError(ret, options.args, undefined);

if (err)
throw err;
Expand Down
9 changes: 4 additions & 5 deletions lib/internal/child_process.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1022,8 +1022,7 @@ function maybeClose(subprocess) {
}
}

function spawnSync(opts) {
const options = opts.options;
function spawnSync(options) {
const result = spawn_sync.spawn(options);

if (result.output && options.encoding && options.encoding !== 'buffer') {
Expand All @@ -1038,9 +1037,9 @@ function spawnSync(opts) {
result.stderr = result.output && result.output[2];

if (result.error) {
result.error = errnoException(result.error, 'spawnSync ' + opts.file);
result.error.path = opts.file;
result.error.spawnargs = opts.args.slice(1);
result.error = errnoException(result.error, 'spawnSync ' + options.file);
result.error.path = options.file;
result.error.spawnargs = options.args.slice(1);
}

return result;
Expand Down
6 changes: 3 additions & 3 deletions test/parallel/test-child-process-spawnsync-kill-signal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ if (process.argv[2] === 'child') {
// Verify that the default kill signal is SIGTERM.
{
const child = spawn(undefined, (opts) => {
assert.strictEqual(opts.options.killSignal, undefined);
assert.strictEqual(opts.killSignal, undefined);
});

assert.strictEqual(child.signal, 'SIGTERM');
Expand All @@ -45,7 +45,7 @@ if (process.argv[2] === 'child') {
// Verify that a string signal name is handled properly.
{
const child = spawn('SIGKILL', (opts) => {
assert.strictEqual(opts.options.killSignal, SIGKILL);
assert.strictEqual(opts.killSignal, SIGKILL);
});

assert.strictEqual(child.signal, 'SIGKILL');
Expand All @@ -56,7 +56,7 @@ if (process.argv[2] === 'child') {
assert.strictEqual(typeof SIGKILL, 'number');

const child = spawn(SIGKILL, (opts) => {
assert.strictEqual(opts.options.killSignal, SIGKILL);
assert.strictEqual(opts.killSignal, SIGKILL);
});

assert.strictEqual(child.signal, 'SIGKILL');
Expand Down
12 changes: 6 additions & 6 deletions test/parallel/test-child-process-spawnsync-shell.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ assert.strictEqual(env.stdout.toString().trim(), 'buzz');
assert.strictEqual(opts.file, shellOutput);
assert.deepStrictEqual(opts.args,
[shellOutput, ...shellFlags, outputCmd]);
assert.strictEqual(opts.options.shell, shell);
assert.strictEqual(opts.options.file, opts.file);
assert.deepStrictEqual(opts.options.args, opts.args);
assert.strictEqual(opts.options.windowsHide, undefined);
assert.strictEqual(opts.options.windowsVerbatimArguments,
windowsVerbatim);
assert.strictEqual(opts.shell, shell);
assert.strictEqual(opts.file, opts.file);
assert.deepStrictEqual(opts.args, opts.args);
assert.strictEqual(opts.windowsHide, false);
Copy link
Copy Markdown
Member

@himself65 himself65 May 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should opts.windowsHide only exist on Windows system?

Copy link
Copy Markdown
Contributor Author

@cjihrig cjihrig May 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's only meaningful on Windows, but it's been set on every spawn() call since it was introduced, so I think it's fine.

assert.strictEqual(opts.windowsVerbatimArguments,
!!windowsVerbatim);
});
cp.spawnSync(cmd, { shell });
internalCp.spawnSync = oldSpawnSync;
Expand Down
2 changes: 1 addition & 1 deletion test/parallel/test-child-process-windows-hide.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ internalCp.ChildProcess.prototype.spawn = common.mustCall(function(options) {
}, 2);

internalCp.spawnSync = common.mustCall(function(options) {
assert.strictEqual(options.options.windowsHide, true);
assert.strictEqual(options.windowsHide, true);
return originalSpawnSync.apply(this, arguments);
});

Expand Down