Add callback to client#end

brianc · brianc · commit dea0120873cf · 2016-08-11T10:07:42.000-05:00
A long standing bug was the pure JS client didn't accept or call a callback on `client.end`.  This is inconsistent with both the documentation &amp; general node patterns.

This fixes the issue &amp; adds a test.  The issue did not exist in the native version of the client.
diff --git a/lib/client.js b/lib/client.js
@@ -336,8 +336,11 @@ Client.prototype.query = function(config, values, callback) {
   return query;
 };
 
-Client.prototype.end = function() {
+Client.prototype.end = function(cb) {
   this.connection.end();
+  if (cb) {
+    this.connection.once('end', cb);
+  }
 };
 
 Client.md5 = function(string) {
diff --git a/lib/connection.js b/lib/connection.js
@@ -122,6 +122,9 @@ Connection.prototype.attachListeners = function(stream) {
       packet = self._reader.read();
     }
   });
+  stream.on('end', function() {
+    self.emit('end');
+  });
 };
 
 Connection.prototype.requestSsl = function() {
diff --git a/test/integration/client/end-callback-tests.js b/test/integration/client/end-callback-tests.js
@@ -0,0 +1,6 @@
+var helper = require('./test-helper')
+
+var client = helper.client(assert.success(function() {
+  client.end(assert.success(function() {
+  }))
+}))
diff --git a/test/integration/test-helper.js b/test/integration/test-helper.js
@@ -7,9 +7,9 @@ if(helper.args.native) {
 }
 
 //creates a client from cli parameters
-helper.client = function() {
+helper.client = function(cb) {
   var client = new Client(helper.config);
-  client.connect();
+  client.connect(cb);
   return client;
 };
 

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,9 @@ Connection.prototype.attachListeners = function(stream) {`
`122`	`122`	`packet = self._reader.read();`
`123`	`123`	`}`
`124`	`124`	`});`
	`125`	`+ stream.on('end', function() {`
	`126`	`+ self.emit('end');`
	`127`	`+ });`
`125`	`128`	`};`
`126`	`129`
`127`	`130`	`Connection.prototype.requestSsl = function() {`