fs: do not emit 'close' twice if emitClose enabled

fs streams have some backwards compat behavior that does not behave well if emitClose: true is passed in options. This fixes this edge case until the backwards compat is removed. PR-URL: #31383 Fixes: #31366 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Feb 17, 2020 · 2c2b3ba · 2c2b3ba
1 parent 843c5c6
commit 2c2b3ba
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/lib/internal/fs/streams.js b/lib/internal/fs/streams.js
@@ -269,7 +269,8 @@ function closeFsStream(stream, cb, err) {
     er = er || err;
     cb(er);
     stream.closed = true;
-    if (!er)
+    const s = stream._writableState || stream._readableState;
+    if (!er && !s.emitClose)
       stream.emit('close');
   });
 

diff --git a/test/parallel/test-file-write-stream4.js b/test/parallel/test-file-write-stream4.js
@@ -0,0 +1,21 @@
+'use strict';
+
+// Test that 'close' emits once and not twice when `emitClose: true` is set.
+// Refs: https://github.com/nodejs/node/issues/31366
+
+const common = require('../common');
+const path = require('path');
+const fs = require('fs');
+
+const tmpdir = require('../common/tmpdir');
+tmpdir.refresh();
+
+const filepath = path.join(tmpdir.path, 'write_pos.txt');
+
+const fileReadStream = fs.createReadStream(process.execPath);
+const fileWriteStream = fs.createWriteStream(filepath, {
+  emitClose: true
+});
+
+fileReadStream.pipe(fileWriteStream);
+fileWriteStream.on('close', common.mustCall());