node/test/parallel/test-stream-writable-finished.js
Robert Nagy ea87809bb6 stream: fix _final and 'prefinish' timing
This PR fixes a few different things:

The timing of 'prefinish' depends on whether or not
_final is defined. In on case the event is emitted
synchronously with end() and otherwise asynchronously.

_final is currently unecessarily called asynchronously
which forces implementors to use 'prefinish' as a hack
to emulate synchronous behaviour. Furthermore, this hack
is subtly broken due to the above issue.

Refs: https://github.com/nodejs/node/issues/31401
Refs: https://github.com/nodejs/node/pull/32763#discussion_r407041983

PR-URL: https://github.com/nodejs/node/pull/32780
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-04-22 09:40:03 +02:00

100 lines
1.7 KiB
JavaScript

'use strict';
const common = require('../common');
const { Writable } = require('stream');
const assert = require('assert');
// basic
{
// Find it on Writable.prototype
assert(Writable.prototype.hasOwnProperty('writableFinished'));
}
// event
{
const writable = new Writable();
writable._write = (chunk, encoding, cb) => {
// The state finished should start in false.
assert.strictEqual(writable.writableFinished, false);
cb();
};
writable.on('finish', common.mustCall(() => {
assert.strictEqual(writable.writableFinished, true);
}));
writable.end('testing finished state', common.mustCall(() => {
assert.strictEqual(writable.writableFinished, true);
}));
}
{
// Emit finish asynchronously.
const w = new Writable({
write(chunk, encoding, cb) {
cb();
}
});
w.end();
w.on('finish', common.mustCall());
}
{
// Emit prefinish synchronously.
const w = new Writable({
write(chunk, encoding, cb) {
cb();
}
});
let sync = true;
w.on('prefinish', common.mustCall(() => {
assert.strictEqual(sync, true);
}));
w.end();
sync = false;
}
{
// Emit prefinish synchronously w/ final.
const w = new Writable({
write(chunk, encoding, cb) {
cb();
},
final(cb) {
cb();
}
});
let sync = true;
w.on('prefinish', common.mustCall(() => {
assert.strictEqual(sync, true);
}));
w.end();
sync = false;
}
{
// Call _final synchronously.
let sync = true;
const w = new Writable({
write(chunk, encoding, cb) {
cb();
},
final: common.mustCall((cb) => {
assert.strictEqual(sync, true);
cb();
})
});
w.end();
sync = false;
}