node/lib/internal/streams/destroy.js
Robert Nagy 4fa1744e11 stream: add comment about undocumented API
PR-URL: https://github.com/nodejs/node/pull/29805
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-10-03 13:57:30 -07:00

137 lines
2.8 KiB
JavaScript

'use strict';
function needError(stream, err) {
if (!err) {
return false;
}
const r = stream._readableState;
const w = stream._writableState;
if ((w && w.errorEmitted) || (r && r.errorEmitted)) {
return false;
}
if (w) {
w.errorEmitted = true;
}
if (r) {
r.errorEmitted = true;
}
return true;
}
// Undocumented cb() API, needed for core, not for public API.
// The cb() will be invoked synchronously if _destroy is synchronous.
function destroy(err, cb) {
const r = this._readableState;
const w = this._writableState;
if (w && err) {
w.errored = true;
}
if ((w && w.destroyed) || (r && r.destroyed)) {
if (cb) {
cb(err);
} else if (needError(this, err)) {
process.nextTick(emitErrorNT, this, err);
}
return this;
}
// We set destroyed to true before firing error callbacks in order
// to make it re-entrance safe in case destroy() is called within callbacks
if (w) {
w.destroyed = true;
}
if (r) {
r.destroyed = true;
}
this._destroy(err || null, (err) => {
const emitClose = (w && w.emitClose) || (r && r.emitClose);
if (cb) {
// Invoke callback before scheduling emitClose so that callback
// can schedule before.
cb(err);
if (emitClose) {
process.nextTick(emitCloseNT, this);
}
} else if (needError(this, err)) {
process.nextTick(emitClose ? emitErrorCloseNT : emitErrorNT, this, err);
} else if (emitClose) {
process.nextTick(emitCloseNT, this);
}
});
return this;
}
function emitErrorCloseNT(self, err) {
self.emit('error', err);
self.emit('close');
}
function emitCloseNT(self) {
self.emit('close');
}
function emitErrorNT(self, err) {
self.emit('error', err);
}
function undestroy() {
const r = this._readableState;
const w = this._writableState;
if (r) {
r.destroyed = false;
r.reading = false;
r.ended = false;
r.endEmitted = false;
r.errorEmitted = false;
}
if (w) {
w.destroyed = false;
w.errored = false;
w.ended = false;
w.ending = false;
w.finalCalled = false;
w.prefinished = false;
w.finished = false;
w.errorEmitted = false;
}
}
function errorOrDestroy(stream, err) {
// We have tests that rely on errors being emitted
// in the same tick, so changing this is semver major.
// For now when you opt-in to autoDestroy we allow
// the error to be emitted nextTick. In a future
// semver major update we should change the default to this.
const r = stream._readableState;
const w = stream._writableState;
if (w & err) {
w.errored = true;
}
if ((r && r.autoDestroy) || (w && w.autoDestroy))
stream.destroy(err);
else if (needError(stream, err))
stream.emit('error', err);
}
module.exports = {
destroy,
undestroy,
errorOrDestroy
};