stream: use more accurate end-of-stream writable and readable detection · nodejs/node@369b7c2 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 369b7c2

Browse filesBrowse the repository at this point in the historyBrowse files

Stewart Addison

authored and

BethGriggs

committed

stream: use more accurate end-of-stream writable and readable detection

The value of stream.readable and stream.writable should not be used to detect whether a stream is Writable or Readable. Refs: #29395 PR-URL: #29409 Backport-PR-URL: #31345 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

1 parent 023a802 commit 369b7c2
Copy full SHA for 369b7c2

2 files changed

+65-2Lines changed: 65 additions & 2 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• lib/internal/streams
  • end-of-stream.js
• test/parallel
  • test-stream-finished.js

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎lib/internal/streams/end-of-stream.js‎

Copy file name to clipboardExpand all lines: lib/internal/streams/end-of-stream.js

+16-2Lines changed: 16 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -13,6 +13,18 @@ function isRequest(stream) {
13	13	return stream.setHeader && typeof stream.abort === 'function';
14	14	}
15	15
	16	+ function isReadable(stream) {
	17	+ return typeof stream.readable === 'boolean' ||
	18	+ typeof stream.readableEnded === 'boolean' ||
	19	+ !!stream._readableState;
	20	+ }
	21	+
	22	+ function isWritable(stream) {
	23	+ return typeof stream.writable === 'boolean' ||
	24	+ typeof stream.writableEnded === 'boolean' ||
	25	+ !!stream._writableState;
	26	+ }
	27	+
16	28	function eos(stream, opts, callback) {
17	29	if (arguments.length === 2) {
18	30	callback = opts;
@@ -28,8 +40,10 @@ function eos(stream, opts, callback) {
28	40
29	41	callback = once(callback);
30	42
31		- let readable = opts.readable || (opts.readable !== false && stream.readable);
32		- let writable = opts.writable || (opts.writable !== false && stream.writable);
	43	+ let readable = opts.readable ||
	44	+ (opts.readable !== false && isReadable(stream));
	45	+ let writable = opts.writable ||
	46	+ (opts.writable !== false && isWritable(stream));
33	47
34	48	const onlegacyfinish = () => {
35	49	if (!stream.writable) onfinish();

Collapse file

‎test/parallel/test-stream-finished.js‎

Copy file name to clipboardExpand all lines: test/parallel/test-stream-finished.js

+49Lines changed: 49 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -184,3 +184,52 @@ const { promisify } = require('util');
184	184	finished(streamLike, common.mustCall);
185	185	streamLike.emit('close');
186	186	}
	187	+
	188	+
	189	+ {
	190	+ // Test is readable check through readable
	191	+ const streamLike = new EE();
	192	+ streamLike.readable = false;
	193	+ finished(streamLike, common.mustCall());
	194	+ streamLike.emit('end');
	195	+ }
	196	+
	197	+ {
	198	+ // Test is readable check through readableEnded
	199	+ const streamLike = new EE();
	200	+ streamLike.readableEnded = true;
	201	+ finished(streamLike, common.mustCall());
	202	+ streamLike.emit('end');
	203	+ }
	204	+
	205	+ {
	206	+ // Test is readable check through _readableState
	207	+ const streamLike = new EE();
	208	+ streamLike._readableState = {};
	209	+ finished(streamLike, common.mustCall());
	210	+ streamLike.emit('end');
	211	+ }
	212	+
	213	+ {
	214	+ // Test is writable check through writable
	215	+ const streamLike = new EE();
	216	+ streamLike.writable = false;
	217	+ finished(streamLike, common.mustCall());
	218	+ streamLike.emit('finish');
	219	+ }
	220	+
	221	+ {
	222	+ // Test is writable check through writableEnded
	223	+ const streamLike = new EE();
	224	+ streamLike.writableEnded = true;
	225	+ finished(streamLike, common.mustCall());
	226	+ streamLike.emit('finish');
	227	+ }
	228	+
	229	+ {
	230	+ // Test is writable check through _writableState
	231	+ const streamLike = new EE();
	232	+ streamLike._writableState = {};
	233	+ finished(streamLike, common.mustCall());
	234	+ streamLike.emit('finish');
	235	+ }

0 commit comments

Comments

0 (0)