chore: gracefulExit is given to pool.end

mysqljs · HQidea · Aug 27, 2017 · Sep 9, 2017 · Sep 9, 2017 · Sep 24, 2017
commit f39bce5a6b955e38026548d134d4fc32462eb377
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,3 @@
 coverage/
 node_modules/
 npm-debug.log
-.DS_Store
diff --git a/Readme.md b/Readme.md
@@ -392,7 +392,6 @@ constructor. In addition to those options pools accept a few extras:
 * `queueLimit`: The maximum number of connection requests the pool will queue
   before returning an error from `getConnection`. If set to `0`, there is no
   limit to the number of queued connection requests. (Default: `0`)
-* `gracefulExit`: Determines whether to end gracefully. If `true`, every `pool.getConnection` or `pool.query` called before `pool.end` will success. If `false`, only commands / queries already in progress will complete, others will throw an error.
 
 ## Pool events
 
@@ -452,25 +451,37 @@ trying to gracefully shutdown a server. To end all the connections in the
 pool, use the `end` method on the pool:
 
 ```js
-pool.end(function (err) {
+pool.end(false, function (err) {
   // all connections in the pool have ended
 });
 ```
 
-The `end` method takes an _optional_ callback that you can use to know once
-all the connections have ended.
+The `end` method takes two _optional_ arguemnts:
+
+* `gracefulExit`: Determines whether to end gracefully. If `true`, every
+`pool.getConnection` or `pool.query` called before `pool.end` will complete.
+If `false`, only commands / queries already in progress will complete,
+others will fail. (Default: `false`)
+
+* `callback`: Will be called once all the connections have ended.
 
 **Once `pool.end()` has been called, `pool.getConnection` and other operations
 can no longer be performed**
 
-If `gracefulExit` is set to `true`, the connections end _gracefully_, so all
- -pending queries will still complete and the time to end the pool will vary.
+### Under the hood
+
+If `gracefulExit` is set to `true`, after calling `pool.end` the poll will
+enter into the `pendingClose` state, all former or queued queries will still
+complete. But the pool will no longer accept new queries.
 
-The default `gracefulExit` is `false`, the following behavior will take effect.
+This works by not queueing the `QUIT` packet on all the connections until there
+is no connection in the aquiring state and no queued queries. All established
+connections will still queue queries which were added before calling `pool.end`.
 
-This works by calling `connection.end()` on every active connection in the
-pool, which queues a `QUIT` packet on the connection. And sets a flag to
-prevent `pool.getConnection` from continuing to create any new connections.
+If `gracefulExit` is set to `false`, `pool.end` works by calling `connection.end()`
+on every active connection in the pool, which queues a `QUIT` packet on the
+connection. And sets a flag to prevent `pool.getConnection` from continuing to
+create any new connections.
 
 Since this queues a `QUIT` packet on each connection, all commands / queries
 already in progress will complete, just like calling `connection.end()`. If

diff --git a/lib/Pool.js b/lib/Pool.js
@@ -17,10 +17,10 @@ function Pool(options) {
   this._freeConnections      = [];
   this._connectionQueue      = [];
   this._closed               = false;
-  this._pendingClosing       = false;
+  this._pendingClose         = false;
 }
 
-Pool.prototype.getConnection = function (cb, queued) {
+Pool.prototype.getConnection = function (cb, _queued) {
 
   if (this._closed) {
     var err = new Error('Pool is closed.');
@@ -34,13 +34,13 @@ Pool.prototype.getConnection = function (cb, queued) {
   var connection;
   var pool = this;
    <
8000
span class='blob-code-inner blob-code-marker ' data-code-marker=" ">
-  if (this._freeConnections.length > 0 && (!this._pendingClosing || queued)) {
+  if (this._freeConnections.length > 0 && (!this._pendingClose || _queued)) {
     connection = this._freeConnections.shift();
     this.acquireConnection(connection, cb);
     return;
   }
 
-  if (this._pendingClosing) {
+  if (this._pendingClose) {
     var err = new Error('Pool is closed.');
     err.code = 'POOL_CLOSED';
     process.nextTick(function () {
@@ -152,8 +152,8 @@ Pool.prototype.releaseConnection = function releaseConnection(connection) {
       this.emit('release', connection);
     }
 
-    if (this._pendingClosing) {
-      this.end(this._endCallback);
+    if (this._pendingClose) {
+      this.end(true, this._endCallback);
     }
   }
 
@@ -172,7 +172,11 @@ Pool.prototype.releaseConnection = function releaseConnection(connection) {
   }
 };
 
-Pool.prototype.end = function (cb) {
+Pool.prototype.end = function (gracefulExit, cb) {
+  if (typeof gracefulExit === 'function') {
+    cb = gracefulExit;
+    gracefulExit = false;
+  }
   if (typeof cb !== 'function') {
     cb = function (err) {
       if (err) throw err;
@@ -194,7 +198,7 @@ Pool.prototype.end = function (cb) {
     readyToEnd = true;
   }
 
-  if (!this.config.gracefulExit || readyToEnd) {
+  if (!gracefulExit || readyToEnd) {
     this._closed = true;
 
     while (this._allConnections.length !== 0) {

diff --git a/lib/PoolConfig.js b/lib/PoolConfig.js
@@ -20,9 +20,6 @@ function PoolConfig(options) {
   this.queueLimit         = (options.queueLimit === undefined)
     ? 0
     : Number(options.queueLimit);
-  this.gracefulExit       = (options.gracefulExit === undefined)
-    ? false
-    : Boolean(options.gracefulExit);
 }
 
 PoolConfig.prototype.newConnectionConfig = function newConnectionConfig() {

diff --git a/test/unit/pool/test-graceful-exit-ping.js b/test/unit/pool/test-graceful-exit-ping.js
@@ -4,8 +4,7 @@ var pool   = common.createPool({
   connectionLimit    : 1,
   port               : common.fakeServerPort,
   queueLimit         : 5,
-  waitForConnections : true,
-  gracefulExit       : true
+  waitForConnections : true
 });
 
 var server = common.createFakeServer();
@@ -22,7 +21,7 @@ server.listen(common.fakeServerPort, function (err) {
       conn.release();
     });
 
-    pool.end(function (err) {
+    pool.end(true, function (err) {
       assert.ifError(err);
       server.destroy();
     });

diff --git a/test/unit/pool/test-graceful-exit-queued.js b/test/unit/pool/test-graceful-exit-queued.js
@@ -4,8 +4,7 @@ var pool   = common.createPool({
   connectionLimit    : 1,
   port               : common.fakeServerPort,
   queueLimit         : 5,
-  waitForConnections : true,
-  gracefulExit       : true
+  waitForConnections : true
 });
 
 var server = common.createFakeServer();
@@ -16,7 +15,7 @@ server.listen(common.fakeServerPort, function (err) {
   pool.getConnection(function (err, conn) {
     assert.ifError(err);
 
-    pool.end(function (err) {
+    pool.end(true, function (err) {
       assert.ifError(err);
       server.destroy();
     });