mirror of
https://github.com/nodejs/node.git
synced 2025-05-02 22:16:31 +00:00
380929ec0c
This change removes `common.noop` from the Node.js internal testing
common module.
Over the last few weeks, I've grown to dislike the `common.noop`
abstraction.
First, new (and experienced) contributors are unaware of it and so it
results in a large number of low-value nits on PRs. It also increases
the number of things newcomers and infrequent contributors have to be
aware of to be effective on the project.
Second, it is confusing. Is it a singleton/property or a getter? Which
should be expected? This can lead to subtle and hard-to-find bugs. (To
my knowledge, none have landed on master. But I also think it's only a
matter of time.)
Third, the abstraction is low-value in my opinion. What does it really
get us? A case could me made that it is without value at all.
Lastly, and this is minor, but the abstraction is wordier than not using
the abstraction. `common.noop` doesn't save anything over `() => {}`.
So, I propose removing it.
PR-URL: https://github.com/nodejs/node/pull/12822
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Refael Ackermann <refack@gmail.com>
97 lines
2.6 KiB
JavaScript
97 lines
2.6 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const Readable = require('stream').Readable;
|
|
|
|
const readable = new Readable({
|
|
read: () => {}
|
|
});
|
|
|
|
// Initialized to false.
|
|
assert.strictEqual(readable._readableState.needReadable, false);
|
|
|
|
readable.on('readable', common.mustCall(() => {
|
|
// When the readable event fires, needReadable is reset.
|
|
assert.strictEqual(readable._readableState.needReadable, false);
|
|
readable.read();
|
|
}));
|
|
|
|
// If a readable listener is attached, then a readable event is needed.
|
|
assert.strictEqual(readable._readableState.needReadable, true);
|
|
|
|
readable.push('foo');
|
|
readable.push(null);
|
|
|
|
readable.on('end', common.mustCall(() => {
|
|
// No need to emit readable anymore when the stream ends.
|
|
assert.strictEqual(readable._readableState.needReadable, false);
|
|
}));
|
|
|
|
const asyncReadable = new Readable({
|
|
read: () => {}
|
|
});
|
|
|
|
asyncReadable.on('readable', common.mustCall(() => {
|
|
if (asyncReadable.read() !== null) {
|
|
// After each read(), the buffer is empty.
|
|
// If the stream doesn't end now,
|
|
// then we need to notify the reader on future changes.
|
|
assert.strictEqual(asyncReadable._readableState.needReadable, true);
|
|
}
|
|
}, 3));
|
|
|
|
process.nextTick(common.mustCall(() => {
|
|
asyncReadable.push('foooo');
|
|
}));
|
|
process.nextTick(common.mustCall(() => {
|
|
asyncReadable.push('bar');
|
|
}));
|
|
process.nextTick(common.mustCall(() => {
|
|
asyncReadable.push(null);
|
|
}));
|
|
|
|
const flowing = new Readable({
|
|
read: () => {}
|
|
});
|
|
|
|
// Notice this must be above the on('data') call.
|
|
flowing.push('foooo');
|
|
flowing.push('bar');
|
|
flowing.push('quo');
|
|
process.nextTick(common.mustCall(() => {
|
|
flowing.push(null);
|
|
}));
|
|
|
|
// When the buffer already has enough data, and the stream is
|
|
// in flowing mode, there is no need for the readable event.
|
|
flowing.on('data', common.mustCall(function(data) {
|
|
assert.strictEqual(flowing._readableState.needReadable, false);
|
|
}, 3));
|
|
|
|
const slowProducer = new Readable({
|
|
read: () => {}
|
|
});
|
|
|
|
slowProducer.on('readable', common.mustCall(() => {
|
|
if (slowProducer.read(8) === null) {
|
|
// The buffer doesn't have enough data, and the stream is not need,
|
|
// we need to notify the reader when data arrives.
|
|
assert.strictEqual(slowProducer._readableState.needReadable, true);
|
|
} else {
|
|
assert.strictEqual(slowProducer._readableState.needReadable, false);
|
|
}
|
|
}, 4));
|
|
|
|
process.nextTick(common.mustCall(() => {
|
|
slowProducer.push('foo');
|
|
}));
|
|
process.nextTick(common.mustCall(() => {
|
|
slowProducer.push('foo');
|
|
}));
|
|
process.nextTick(common.mustCall(() => {
|
|
slowProducer.push('foo');
|
|
}));
|
|
process.nextTick(common.mustCall(() => {
|
|
slowProducer.push(null);
|
|
}));
|