Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

stream: remove thenable support #40773

Merged
merged 2 commits into from
Apr 8, 2022
Merged

stream: remove thenable support #40773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d2064b
stream: remove thenable support
ronag Nov 10, 2021
ae07236
Update doc/api/deprecations.md
ronag Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3019,14 +3019,17 @@ it was an aborted or graceful destroy.

<!-- YAML
ronag marked this conversation as resolved.
Show resolved Hide resolved
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/40773
ronag marked this conversation as resolved.
Show resolved Hide resolved
description: End-of-life.
- version:
- v17.2.0
- v16.14.0
pr-url: https://github.com/nodejs/node/pull/40860
description: Documentation-only deprecation.
ronag marked this conversation as resolved.
Show resolved Hide resolved
-->

Type: Documentation-only
Type: End-of-Life

An undocumented feature of Node.js streams was to support thenables in
implementation methods. This is now deprecated, use callbacks instead and avoid
Expand Down
34 changes: 2 additions & 32 deletions lib/internal/streams/destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,20 +106,7 @@ function _destroy(self, err, cb) {
}
}
try {
const result = self._destroy(err || null, onDestroy);
if (result != null) {
const then = result.then;
if (typeof then === 'function') {
then.call(
result,
function() {
process.nextTick(onDestroy, null);
},
function(err) {
process.nextTick(onDestroy, err);
});
}
}
self._destroy(err || null, onDestroy);
} catch (err) {
onDestroy(err);
}
Expand Down Expand Up @@ -285,24 +272,7 @@ function constructNT(stream) {
}

try {
const result = stream._construct(onConstruct);
if (result != null) {
const then = result.then;
if (typeof then === 'function') {
then.call(
result,
function() {
if (!called) {
process.nextTick(onConstruct, null);
}
},
function(err) {
if (!called) {
process.nextTick(onConstruct, err);
}
});
}
}
stream._construct(onConstruct);
} catch (err) {
onConstruct(err);
}
Expand Down
13 changes: 1 addition & 12 deletions lib/internal/streams/readable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,18 +493,7 @@ Readable.prototype.read = function(n) {

// Call internal read method
try {
const result = this._read(state.highWaterMark);
if (result != null) {
const then = result.then;
if (typeof then === 'function') {
then.call(
result,
nop,
function(err) {
errorOrDestroy(this, err);
});
}
}
this._read(state.highWaterMark);
} catch (err) {
errorOrDestroy(this, err);
}
Expand Down
67 changes: 2 additions & 65 deletions lib/internal/streams/transform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,8 @@ function Transform(options) {
}

function final(cb) {
let called = false;
if (typeof this._flush === 'function' && !this.destroyed) {
const result = this._flush((er, data) => {
called = true;
this._flush((er, data) => {
if (er) {
if (cb) {
cb(er);
Expand All @@ -128,33 +126,6 @@ function final(cb) {
cb();
}
});
if (result !== undefined && result !== null) {
try {
const then = result.then;
if (typeof then === 'function') {
then.call(
result,
(data) => {
if (called)
return;
if (data != null)
this.push(data);
this.push(null);
if (cb)
process.nextTick(cb);
},
(err) => {
if (cb) {
process.nextTick(cb, err);
} else {
process.nextTick(() => this.destroy(err));
}
});
}
} catch (err) {
process.nextTick(() => this.destroy(err));
}
}
} else {
this.push(null);
if (cb) {
Expand All @@ -180,9 +151,7 @@ Transform.prototype._write = function(chunk, encoding, callback) {
const wState = this._writableState;
const length = rState.length;

let called = false;
const result = this._transform(chunk, encoding, (err, val) => {
called = true;
this._transform(chunk, encoding, (err, val) => {
if (err) {
callback(err);
return;
Expand All @@ -204,38 +173,6 @@ Transform.prototype._write = function(chunk, encoding, callback) {
this[kCallback] = callback;
}
});
if (result !== undefined && result != null) {
try {
const then = result.then;
if (typeof then === 'function') {
then.call(
result,
(val) => {
if (called)
return;

if (val != null) {
this.push(val);
}

if (
wState.ended ||
length === rState.length ||
rState.length < rState.highWaterMark ||
rState.length === 0) {
process.nextTick(callback);
} else {
this[kCallback] = callback;
}
},
(err) => {
process.nextTick(callback, err);
});
}
} catch (err) {
process.nextTick(callback, err);
}
}
};

Transform.prototype._read = function() {
Expand Down
19 changes: 1 addition & 18 deletions lib/internal/streams/writable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,24 +693,7 @@ function callFinal(stream, state) {
state.pendingcb++;

try {
const result = stream._final(onFinish);
if (result != null) {
const then = result.then;
if (typeof then === 'function') {
then.call(
result,
function() {
if (!called) {
process.nextTick(onFinish, null);
}
},
function(err) {
if (!called) {
process.nextTick(onFinish, err);
}
});
}
}
stream._final(onFinish);
} catch (err) {
onFinish(err);
}
Expand Down
Loading