Fix listener leak in stream.pipe()
authorMikeal Rogers <mikeal.rogers@gmail.com>
Mon, 28 Mar 2011 18:19:44 +0000 (11:19 -0700)
committerRyan Dahl <ry@tinyclouds.org>
Mon, 28 Mar 2011 18:19:44 +0000 (11:19 -0700)
lib/stream.js
test/simple/test-stream-pipe-cleanup.js [new file with mode: 0644]

index 94368d6..d31a9fe 100644 (file)
@@ -58,13 +58,6 @@ Stream.prototype.pipe = function(dest, options) {
     source.on('end', onend);
   }
 
-  dest.on('close', function() {
-    source.removeListener('data', ondata);
-    dest.removeListener('drain', ondrain);
-    source.removeListener('end', onend);
-  });
-
-
   /*
    * Questionable:
    */
@@ -80,14 +73,39 @@ Stream.prototype.pipe = function(dest, options) {
       source.emit('resume');
     };
   }
-
-  dest.on('pause', function() {
+  
+  var onpause = function() {
     source.pause();
-  });
+  }
 
-  dest.on('resume', function() {
+  dest.on('pause', onpause);
+  
+  var onresume = function() {
     if (source.readable) source.resume();
-  });
+  };
+  
+  dest.on('resume', onresume);
+  
+  var cleanup = function () {
+    source.removeListener('data', ondata);
+    dest.removeListener('drain', ondrain);
+    source.removeListener('end', onend);
+    
+    dest.removeListener('pause', onpause);
+    dest.removeListener('resume', onresume);
+    
+    source.removeListener('end', cleanup);
+    source.removeListener('close', cleanup);
+    
+    dest.removeListener('end', cleanup);
+    dest.removeListener('close', cleanup);
+  }
+  
+  source.on('end', cleanup);
+  source.on('close', cleanup);
+
+  dest.on('end', cleanup);
+  dest.on('close', cleanup);
 
   dest.emit('pipe', source);
 };
diff --git a/test/simple/test-stream-pipe-cleanup.js b/test/simple/test-stream-pipe-cleanup.js
new file mode 100644 (file)
index 0000000..fce4ac8
--- /dev/null
@@ -0,0 +1,82 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+// This test asserts that Stream.prototype.pipe does not leave listeners
+// hanging on the source or dest.
+
+var stream = require('stream');
+var assert = require('assert');
+var util = require('util');
+
+function Writable () {
+  this.writable = true;
+  stream.Stream.call(this);
+}
+util.inherits(Writable, stream.Stream);
+Writable.prototype.end = function () {}
+
+function Readable () {
+  this.readable = true;
+  stream.Stream.call(this);
+}
+util.inherits(Readable, stream.Stream);
+
+var i = 0;
+var limit = 100;
+
+var w = new Writable();
+
+console.error = function (text) {
+  throw new Error(text);
+}
+
+var r;
+
+for (i = 0; i < limit; i++) {
+  r = new Readable()
+  r.pipe(w)
+  r.emit('end')
+}
+assert.equal(0, r.listeners('end').length);
+
+for (i = 0; i < limit; i++) {
+  r = new Readable()
+  r.pipe(w)
+  r.emit('close')
+}
+assert.equal(0, r.listeners('close').length);
+
+r = new Readable();
+
+for (i = 0; i < limit; i++) {
+  w = new Writable();
+  r.pipe(w);
+  w.emit('end');
+}
+assert.equal(0, w.listeners('end').length);
+
+for (i = 0; i < limit; i++) {
+  w = new Writable();
+  r.pipe(w);
+  w.emit('close');
+}
+assert.equal(0, w.listeners('close').length);
+