Skip to content
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.

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

fix(exec): consistent error message for maxBuffer #919

Merged
merged 2 commits into from Dec 3, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 34 additions & 4 deletions src/exec-child.js
Expand Up @@ -16,19 +16,49 @@ var pipe = params.pipe;
var stdoutFile = params.stdoutFile;
var stderrFile = params.stderrFile;

function isMaxBufferError(err) {
var maxBufferErrorPattern = /^.*\bmaxBuffer\b.*exceeded.*$/;
if (err instanceof Error && err.message &&
err.message.match(maxBufferErrorPattern)) {
// < v10
// Error: stdout maxBuffer exceeded
return true;
} else if (err instanceof RangeError && err.message &&
err.message.match(maxBufferErrorPattern)) {
// >= v10
// RangeError [ERR_CHILD_PROCESS_STDIO_MAXBUFFER]: stdout maxBuffer length
// exceeded
// TODO(nfischer): remove when we add v10 CI (Github issue #856).
/* istanbul ignore next */
return true;
}
return false;
}

var stdoutStream = fs.createWriteStream(stdoutFile);
var stderrStream = fs.createWriteStream(stderrFile);

function appendError(message, code) {
stderrStream.write(message);
process.exitCode = code;
}

var c = childProcess.exec(cmd, execOptions, function (err) {
if (!err) {
process.exitCode = 0;
} else if (isMaxBufferError(err)) {
appendError('maxBuffer exceeded', 1);
} else if (err.code === undefined && err.message) {
/* istanbul ignore next */
appendError(err.message, 1);
} else if (err.code === undefined) {
process.exitCode = 1;
/* istanbul ignore next */
appendError('Unknown issue', 1);
} else {
process.exitCode = err.code;
}
});

var stdoutStream = fs.createWriteStream(stdoutFile);
var stderrStream = fs.createWriteStream(stderrFile);

c.stdout.pipe(stdoutStream);
c.stderr.pipe(stderrStream);
c.stdout.pipe(process.stdout);
Expand Down
6 changes: 5 additions & 1 deletion test/exec.js
Expand Up @@ -133,8 +133,12 @@ test('set maxBuffer (very small)', t => {
t.falsy(shell.error());
t.is(result.code, 0);
t.is(result.stdout, '1234567890' + os.EOL);
shell.exec('echo 1234567890', { maxBuffer: 6 });
const result2 = shell.exec('echo 1234567890', { maxBuffer: 6 });
t.truthy(shell.error());
t.is(result2.code, 1);
t.is(result2.stdout, '1234567890' + os.EOL);
const maxBufferErrorPattern = /.*\bmaxBuffer\b.*\bexceeded\b.*/;
t.regex(result2.stderr, maxBufferErrorPattern);
});

test('set timeout option', t => {
Expand Down