stream: do cleanup when iterator is destroyed

PR-URL: nodejs#42320 Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Nitzan Uziely <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]>
NOUIY · Mar 16, 2022 · 6d3920d · 6d3920d
1 parent 6a51306
commit 6d3920d
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/lib/internal/streams/readable.js b/lib/internal/streams/readable.js
@@ -1122,7 +1122,7 @@ async function* createAsyncIterator(stream, options) {
   stream.on('readable', next);
 
   let error;
-  eos(stream, { writable: false }, (err) => {
+  const cleanup = eos(stream, { writable: false }, (err) => {
     error = err ? aggregateTwoErrors(error, err) : null;
     callback();
     callback = nop;
@@ -1150,6 +1150,9 @@ async function* createAsyncIterator(stream, options) {
       (error === undefined || stream._readableState.autoDestroy)
     ) {
       destroyImpl.destroyer(stream, null);
+    } else {
+      stream.off('readable', next);
+      cleanup();
     }
   }
 }

diff --git a/test/parallel/test-stream-readable-async-iterators.js b/test/parallel/test-stream-readable-async-iterators.js
@@ -789,6 +789,20 @@ async function tests() {
       }
     );
   }
+
+  // Check for dangling listeners
+  (async function() {
+    const readable = createReadable();
+    const opts = { destroyOnReturn: false };
+    while (readable.readable) {
+      // eslint-disable-next-line no-unused-vars
+      for await (const chunk of readable.iterator(opts)) {
+        break;
+      }
+    }
+
+    assert.deepStrictEqual(readable.eventNames(), []);
+  })().then(common.mustCall());
 }
 
 {