Skip to content

Commit

Permalink
child_process: rename _validateStdtio to getValidStdio
Browse files Browse the repository at this point in the history
The name indicated only validation while it did much more and it
returned a different value to the callee function. The underscore
was also not necessary as the function is internal one way or the
other.

PR-URL: #26809
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
BridgeAR committed Mar 27, 2019
1 parent 9e8c9be commit 28e2c37
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions lib/child_process.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const {
const { validateString, isInt32 } = require('internal/validators');
const child_process = require('internal/child_process');
const {
_validateStdio,
getValidStdio,
setupChannel,
ChildProcess
} = child_process;
Expand Down Expand Up @@ -577,7 +577,7 @@ function spawnSync(file, args, options) {
// Validate and translate the kill signal, if present.
options.killSignal = sanitizeKillSignal(options.killSignal);

options.stdio = _validateStdio(options.stdio || 'pipe', true).stdio;
options.stdio = getValidStdio(options.stdio || 'pipe', true).stdio;

if (options.input) {
var stdin = options.stdio[0] = { ...options.stdio[0] };
Expand Down
6 changes: 3 additions & 3 deletions lib/internal/child_process.js
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ ChildProcess.prototype.spawn = function(options) {
// If no `stdio` option was given - use default
var stdio = options.stdio || 'pipe';

stdio = _validateStdio(stdio, false);
stdio = getValidStdio(stdio, false);

ipc = stdio.ipc;
ipcFd = stdio.ipcFd;
Expand Down Expand Up @@ -873,7 +873,7 @@ function isInternal(message) {

function nop() { }

function _validateStdio(stdio, sync) {
function getValidStdio(stdio, sync) {
var ipc;
var ipcFd;

Expand Down Expand Up @@ -1028,6 +1028,6 @@ function spawnSync(opts) {
module.exports = {
ChildProcess,
setupChannel,
_validateStdio,
getValidStdio,
spawnSync
};
12 changes: 6 additions & 6 deletions test/parallel/test-child-process-validate-stdio.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@

const common = require('../common');
const assert = require('assert');
const _validateStdio = require('internal/child_process')._validateStdio;
const getValidStdio = require('internal/child_process').getValidStdio;

const expectedError =
common.expectsError({ code: 'ERR_INVALID_OPT_VALUE', type: TypeError }, 2);

// Should throw if string and not ignore, pipe, or inherit
assert.throws(() => _validateStdio('foo'), expectedError);
assert.throws(() => getValidStdio('foo'), expectedError);

// Should throw if not a string or array
assert.throws(() => _validateStdio(600), expectedError);
assert.throws(() => getValidStdio(600), expectedError);

// Should populate stdio with undefined if len < 3
{
const stdio1 = [];
const result = _validateStdio(stdio1, false);
const result = getValidStdio(stdio1, false);
assert.strictEqual(stdio1.length, 3);
assert.strictEqual(result.hasOwnProperty('stdio'), true);
assert.strictEqual(result.hasOwnProperty('ipc'), true);
Expand All @@ -26,14 +26,14 @@ assert.throws(() => _validateStdio(600), expectedError);

// Should throw if stdio has ipc and sync is true
const stdio2 = ['ipc', 'ipc', 'ipc'];
common.expectsError(() => _validateStdio(stdio2, true),
common.expectsError(() => getValidStdio(stdio2, true),
{ code: 'ERR_IPC_SYNC_FORK', type: Error }
);


if (common.isMainThread) {
const stdio3 = [process.stdin, process.stdout, process.stderr];
const result = _validateStdio(stdio3, false);
const result = getValidStdio(stdio3, false);
assert.deepStrictEqual(result, {
stdio: [
{ type: 'fd', fd: 0 },
Expand Down

0 comments on commit 28e2c37

Please sign in to comment.