stream: don't emit finish after close

Writable stream could emit 'finish' after 'close'. PR-URL: #32933 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Apr 28, 2020 · 3c07b17 · 3c07b17 · ronag · Apr 28, 2020
1 parent fad188f
commit 3c07b17
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 3 deletions.
diff --git a/lib/_stream_writable.js b/lib/_stream_writable.js
@@ -175,6 +175,10 @@ function WritableState(options, stream, isDuplex) {
 
   // Indicates whether the stream has finished destroying.
   this.closed = false;
+
+  // True if close has been emitted or would have been emitted
+  // depending on emitClose.
+  this.closeEmitted = false;
 }
 
 function resetBuffer(state) {
@@ -639,7 +643,8 @@ function finishMaybe(stream, state, sync) {
 
 function finish(stream, state) {
   state.pendingcb--;
-  if (state.errorEmitted)
+  // TODO (ronag): Unify with needFinish.
+  if (state.errorEmitted || state.closeEmitted)
     return;
 
   state.finished = true;

diff --git a/lib/internal/streams/destroy.js b/lib/internal/streams/destroy.js
@@ -73,6 +73,10 @@ function emitCloseNT(self) {
   const r = self._readableState;
   const w = self._writableState;
 
+  if (w) {
+    w.closeEmitted = true;
+  }
+
   if ((w && w.emitClose) || (r && r.emitClose)) {
     self.emit('close');
   }
@@ -111,15 +115,16 @@ function undestroy() {
   }
 
   if (w) {
-    w.closed = false;
     w.destroyed = false;
+    w.closed = false;
+    w.closeEmitted = false;
     w.errored = false;
+    w.errorEmitted = false;
     w.ended = false;
     w.ending = false;
     w.finalCalled = false;
     w.prefinished = false;
     w.finished = false;
-    w.errorEmitted = false;
   }
 }
 

diff --git a/test/parallel/test-stream-writable-finish-destroyed.js b/test/parallel/test-stream-writable-finish-destroyed.js
@@ -0,0 +1,33 @@
+'use strict';
+
+const common = require('../common');
+const { Writable } = require('stream');
+
+{
+  const w = new Writable({
+    write: common.mustCall((chunk, encoding, cb) => {
+      w.on('close', common.mustCall(() => {
+        cb();
+      }));
+    })
+  });
+
+  w.on('finish', common.mustNotCall());
+  w.end('asd');
+  w.destroy();
+}
+
+{
+  const w = new Writable({
+    write: common.mustCall((chunk, encoding, cb) => {
+      w.on('close', common.mustCall(() => {
+        cb();
+        w.end();
+      }));
+    })
+  });
+
+  w.on('finish', common.mustNotCall());
+  w.write('asd');
+  w.destroy();
+}