Skip to content

Commit

Permalink
stream: avoid additional validation for Buffers
Browse files Browse the repository at this point in the history
These changes result in ~50% improvement in the included benchmark.

PR-URL: #10580
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
mscdex authored and MylesBorins committed Mar 28, 2017
1 parent 0cc39e0 commit 0e9bd94
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 20 deletions.
23 changes: 23 additions & 0 deletions benchmark/streams/writable-manywrites.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
'use strict';

const common = require('../common');
const Writable = require('stream').Writable;

const bench = common.createBenchmark(main, {
n: [2e6]
});

function main(conf) {
const n = +conf.n;
const b = Buffer.allocUnsafe(1024);
const s = new Writable();
s._write = function(chunk, encoding, cb) {
cb();
};

bench.start();
for (var k = 0; k < n; ++k) {
s.write(b);
}
bench.end(n);
}
37 changes: 17 additions & 20 deletions lib/_stream_writable.js
Original file line number Diff line number Diff line change
Expand Up @@ -196,23 +196,18 @@ function writeAfterEnd(stream, cb) {
process.nextTick(cb, er);
}

// If we get something that is not a buffer, string, null, or undefined,
// and we're not in objectMode, then that's an error.
// Otherwise stream chunks are all considered to be of length=1, and the
// watermarks determine how many objects to keep in the buffer, rather than
// how many bytes or characters.
// Checks that a user-supplied chunk is valid, especially for the particular
// mode the stream is in. Currently this means that `null` is never accepted
// and undefined/non-string values are only allowed in object mode.
function validChunk(stream, state, chunk, cb) {
var valid = true;
var er = false;
// Always throw error if a null is written
// if we are not in object mode then throw
// if it is not a buffer, string, or undefined.

if (chunk === null) {
er = new TypeError('May not write null values to stream');
} else if (!(chunk instanceof Buffer) &&
typeof chunk !== 'string' &&
chunk !== undefined &&
!state.objectMode) {
} else if (typeof chunk !== 'string' &&
chunk !== undefined &&
!state.objectMode) {
er = new TypeError('Invalid non-string/buffer chunk');
}
if (er) {
Expand All @@ -226,13 +221,14 @@ function validChunk(stream, state, chunk, cb) {
Writable.prototype.write = function(chunk, encoding, cb) {
var state = this._writableState;
var ret = false;
var isBuf = (chunk instanceof Buffer);

if (typeof encoding === 'function') {
cb = encoding;
encoding = null;
}

if (chunk instanceof Buffer)
if (isBuf)
encoding = 'buffer';
else if (!encoding)
encoding = state.defaultEncoding;
Expand All @@ -242,9 +238,9 @@ Writable.prototype.write = function(chunk, encoding, cb) {

if (state.ended)
writeAfterEnd(this, cb);
else if (validChunk(this, state, chunk, cb)) {
else if (isBuf || validChunk(this, state, chunk, cb)) {
state.pendingcb++;
ret = writeOrBuffer(this, state, chunk, encoding, cb);
ret = writeOrBuffer(this, state, isBuf, chunk, encoding, cb);
}

return ret;
Expand Down Expand Up @@ -293,11 +289,12 @@ function decodeChunk(state, chunk, encoding) {
// if we're already writing something, then just put this
// in the queue, and wait our turn. Otherwise, call _write
// If we return false, then we need a drain event, so set that flag.
function writeOrBuffer(stream, state, chunk, encoding, cb) {
chunk = decodeChunk(state, chunk, encoding);

if (chunk instanceof Buffer)
encoding = 'buffer';
function writeOrBuffer(stream, state, isBuf, chunk, encoding, cb) {
if (!isBuf) {
chunk = decodeChunk(state, chunk, encoding);
if (chunk instanceof Buffer)
encoding = 'buffer';
}
var len = state.objectMode ? 1 : chunk.length;

state.length += len;
Expand Down

0 comments on commit 0e9bd94

Please sign in to comment.