Skip to content
Permalink
Browse files

stream: make null an invalid chunk to write in object mode

this harmonizes behavior between readable, writable, and transform
streams so that they all handle nulls in object mode the same way by
considering them invalid chunks.

PR-URL: #6170
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
  • Loading branch information...
calvinmetcalf authored and jasnell committed Apr 12, 2016
1 parent ec2822a commit e7c077c610afa371430180fbd447bfef60ebc5ea
Showing with 66 additions and 4 deletions.
  1. +10 −4 lib/_stream_writable.js
  2. +56 −0 test/parallel/test-stream-writable-null.js
@@ -176,13 +176,19 @@ function writeAfterEnd(stream, cb) {
// how many bytes or characters.
function validChunk(stream, state, chunk, cb) {
var valid = true;

if (!(chunk instanceof Buffer) &&
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 !== null &&
chunk !== undefined &&
!state.objectMode) {
var er = new TypeError('Invalid non-string/buffer chunk');
er = new TypeError('Invalid non-string/buffer chunk');
}
if (er) {
stream.emit('error', er);
process.nextTick(cb, er);
valid = false;
@@ -0,0 +1,56 @@
'use strict';
require('../common');
const assert = require('assert');

const stream = require('stream');
const util = require('util');

function MyWritable(options) {
stream.Writable.call(this, options);
}

util.inherits(MyWritable, stream.Writable);

MyWritable.prototype._write = function(chunk, encoding, callback) {
assert.notStrictEqual(chunk, null);
callback();
};

assert.throws(() => {
var m = new MyWritable({objectMode: true});
m.write(null, (err) => assert.ok(err));
}, TypeError, 'May not write null values to stream');
assert.doesNotThrow(() => {
var m = new MyWritable({objectMode: true}).on('error', (e) => {
assert.ok(e);
});
m.write(null, (err) => {
assert.ok(err);
});
});

assert.throws(() => {
var m = new MyWritable();
m.write(false, (err) => assert.ok(err));
}, TypeError, 'Invalid non-string/buffer chunk');
assert.doesNotThrow(() => {
var m = new MyWritable().on('error', (e) => {
assert.ok(e);
});
m.write(false, (err) => {
assert.ok(err);
});
});

assert.doesNotThrow(() => {
var m = new MyWritable({objectMode: true});
m.write(false, (err) => assert.ifError(err));
});
assert.doesNotThrow(() => {
var m = new MyWritable({objectMode: true}).on('error', (e) => {
assert.ifError(e || new Error('should not get here'));
});
m.write(false, (err) => {
assert.ifError(err);
});
});

0 comments on commit e7c077c

Please sign in to comment.
You can’t perform that action at this time.