stream: fix deadlock when pipeing to full sink

When piping a paused Readable to a full Writable we didn't register a drain listener which cause the src to never resume. Refs: #48666 PR-URL: #48691 Backport-PR-URL: #49323 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Sep 12, 2023 · c224e1b · c224e1b
1 parent 9d90409
commit c224e1b
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/lib/internal/streams/readable.js b/lib/internal/streams/readable.js
@@ -814,9 +814,7 @@ Readable.prototype.pipe = function(dest, pipeOpts) {
   // Start the flow if it hasn't been started already.
 
   if (dest.writableNeedDrain === true) {
-    if (state.flowing) {
-      pause();
-    }
+    pause();
   } else if (!state.flowing) {
     debug('pipe resume');
     src.resume();

diff --git a/test/parallel/test-stream-pipe-deadlock.js b/test/parallel/test-stream-pipe-deadlock.js
@@ -0,0 +1,27 @@
+'use strict';
+
+const common = require('../common');
+const { Readable, Writable } = require('stream');
+
+// https://github.com/nodejs/node/issues/48666
+(async () => {
+  // Prepare src that is internally ended, with buffered data pending
+  const src = new Readable({ read() {} });
+  src.push(Buffer.alloc(100));
+  src.push(null);
+  src.pause();
+
+  // Give it time to settle
+  await new Promise((resolve) => setImmediate(resolve));
+
+  const dst = new Writable({
+    highWaterMark: 1000,
+    write(buf, enc, cb) {
+      process.nextTick(cb);
+    }
+  });
+
+  dst.write(Buffer.alloc(1000)); // Fill write buffer
+  dst.on('finish', common.mustCall());
+  src.pipe(dst);
+})().then(common.mustCall());