Merge pull request #726 from dougwilson/feature/connect-timeout

Add option for connect timeout

Author: sidorares

Changes.md

@@ -6,6 +6,8 @@ you spot any mistakes.
 
 ## HEAD
 
+* Add `connectTimeout` option to specify a timeout for establishing a connection #726
+
 ## v2.0.1
 
 * internal parser speed improvement #702

Readme.md

@@ -140,6 +140,8 @@ When establishing a connection, you can set the following options:
 * `database`: Name of the database to use for this connection (Optional).
 * `charset`: The charset for the connection. (Default: `'UTF8_GENERAL_CI'`. Value needs to be all in upper case letters!)
 * `timezone`: The timezone used to store local dates. (Default: `'local'`)
+* `connectTimeout`: The milliseconds before a timeout occurs during the initial connection
+  to the MySQL server. (Default: no timeout)
 * `stringifyObjects`: Stringify objects instead of converting to values. See
 issue [#501](https://github.com/felixge/node-mysql/issues/501). (Default: `'false'`)
 * `insecureAuth`: Allow connecting to MySQL instances that ask for the old

lib/Connection.js

@@ -76,6 +76,15 @@ Connection.prototype.connect = function(cb) {
     this._protocol.on('unhandledError', this._handleProtocolError.bind(this));
     this._protocol.on('drain', this._handleProtocolDrain.bind(this));
     this._protocol.on('end', this._handleProtocolEnd.bind(this));
+
+    if (this.config.connectTimeout) {
+      var handleConnectTimeout = this._handleConnectTimeout.bind(this);
+
+      this._socket.setTimeout(this.config.connectTimeout, handleConnectTimeout);
+      this._socket.once('connect', function() {
+        this.setTimeout(0, handleConnectTimeout);
+      });
+    }
   }
 
   this._protocol.handshake(cb);
@@ -191,6 +200,20 @@ Connection.prototype.format = function(sql, values) {
   return SqlString.format(sql, values, this.config.stringifyObjects, this.config.timezone);
 };
 
+Connection.prototype._handleConnectTimeout = function() {
+  if (this._socket) {
+    this._socket.setTimeout(0);
+    this._socket.destroy();
+  }
+
+  var err = new Error('connect ETIMEDOUT');
+  err.errorno = 'ETIMEDOUT';
+  err.code = 'ETIMEDOUT';
+  err.syscall = 'connect';
+
+  this._handleNetworkError(err);
+};
+
 Connection.prototype._handleNetworkError = function(err) {
   this._protocol.handleNetworkError(err);
 };

lib/ConnectionConfig.js

@@ -15,6 +15,7 @@ function ConnectionConfig(options) {
   this.user               = options.user || undefined;
   this.password           = options.password || undefined;
   this.database           = options.database;
+  this.connectTimeout     = options.connectTimeout || undefined;
   this.insecureAuth       = options.insecureAuth || false;
   this.supportBigNumbers  = options.supportBigNumbers || false;
   this.bigNumberStrings   = options.bigNumberStrings || false;

test/integration/connection/test-connect-timeout-only.js

@@ -0,0 +1,22 @@
+var common     = require('../../common');
+var connection = common.createConnection({connectTimeout: 1000});
+var assert     = require('assert');
+
+connection.connect();
+
+var connectErr;
+var rows = undefined;
+var fields = undefined;
+connection.query('SELECT SLEEP(3)', function(err, _rows, _fields) {
+  connectErr = err;
+  rows = _rows;
+  fields = _fields;
+});
+
+connection.end();
+
+process.on('exit', function() {
+  assert.ifError(connectErr);
+  assert.deepEqual(rows, [{'SLEEP(3)': 0}]);
+  assert.equal(fields[0].name, 'SLEEP(3)');
+});

test/integration/connection/test-connect-timeout.js

@@ -0,0 +1,20 @@
+var common     = require('../../common');
+var connection = common.createConnection({host: '1.1.1.1', port: common.fakeServerPort, connectTimeout: 500});
+var assert     = require('assert');
+
+var testTimeout = setTimeout(function() {
+  connection.destroy();
+}, 5000);
+
+var connectErr;
+connection.connect(function(err) {
+  connectErr = err;
+  clearTimeout(testTimeout);
+});
+
+process.on('exit', function() {
+  assert.ok(connectErr);
+  assert.equal(connectErr.code, 'ETIMEDOUT');
+  assert.equal(connectErr.syscall, 'connect');
+  assert.equal(connectErr.fatal, true);
+});