Merge pull request #396 from sidorares/connection-timeout

added connect timeout event and tests

Author: sushantdhiman

lib/connection.js

@@ -1,6 +1,7 @@
-var net = require('net');
+var Net = require('net');
 var util = require('util');
-var tls = require('tls');
+var Tls = require('tls');
+var Timers = require('timers');
 var EventEmitter = require('events').EventEmitter;
 var Queue = require('double-ended-queue');
 
@@ -30,9 +31,9 @@ function Connection (opts)
 
   if (!opts.config.stream) {
     if (opts.config.socketPath) {
-      this.stream = net.connect(opts.config.socketPath);
+      this.stream = Net.connect(opts.config.socketPath);
     } else {
-      this.stream = net.connect(opts.config.port, opts.config.host);
+      this.stream = Net.connect(opts.config.port, opts.config.host);
     }
   } else {
     // if stream is a function, treat it as "stream agent / factory"
@@ -74,19 +75,22 @@ function Connection (opts)
   this.threadId = null;
   this._handshakePacket = null;
   this._fatalError = null;
-
+  this._protocolError = null;
   this._outOfOrderPackets = [];
 
-  this.stream.once('error', function (err) {
-    connection._handleNetworkError(err);
-  });
+  this.stream.once('error', connection._handleNetworkError.bind(this));
 
   // see https://gist.github.com/khoomeister/4985691#use-that-instead-of-bind
   this.packetParser = new PacketParser(function (p) { connection.handlePacket(p); });
+
   this.stream.on('data', function (data) {
+    if (connection.connectTimeout) {
+      Timers.clearTimeout(connection.connectTimeout);
+      connection.connectTimeout = null;
+    }
     connection.packetParser.execute(data);
   });
-  this._protocolError = null;
+
   this.stream.on('end', function () {
     // we need to set this flag everywhere where we want connection to close
     if (connection._closing) {
@@ -119,6 +123,11 @@ function Connection (opts)
   // most common example: "Too many connections" error ( packet is sent immediately on connection attempt, we don't know server encoding yet)
   // will be overwrittedn with actial encoding value as soon as server handshake packet is received
   this.serverEncoding = 'utf8';
+
+  if (this.config.connectTimeout) {
+    var timeoutHandler = this._handleTimeoutError.bind(this);
+    this.connectTimeout = Timers.setTimeout(timeoutHandler, this.config.connectTimeout);
+  }
 }
 util.inherits(Connection, EventEmitter);
 
@@ -139,6 +148,21 @@ Connection.prototype._handleNetworkError = function (err) {
   connection._fatalError = err;
 };
 
+Connection.prototype._handleTimeoutError = function () {
+  if (this.stream) {
+    Timers.clearTimeout(this.connectTimeout);
+    this.connectTimeout = null;
+    this.stream.destroy();
+  }
+
+  var err = new Error('connect ETIMEDOUT');
+  err.errorno = 'ETIMEDOUT';
+  err.code = 'ETIMEDOUT';
+  err.syscall = 'connect';
+
+  this._handleNetworkError(err);
+};
+
 // notify all commands in the queue and bubble error as connection "error"
 // called on stream error or unexpected termination
 Connection.prototype._notifyError = function (err) {
@@ -191,15 +215,15 @@ Connection.prototype.writePacket = function (packet) {
   this.write(packet.buffer);
 };
 
-if (tls.TLSSocket) {
+if (Tls.TLSSocket) {
   // 0.11+ environment
   Connection.prototype.startTLS = function _startTLS (onSecure) {
     if (this.config.debug) {
       console.log('Upgrading connection to TLS');
     }
     var connection = this;
     var stream = this.stream;
-    var secureContext = tls.createSecureContext({
+    var secureContext = Tls.createSecureContext({
       ca         : this.config.ssl.ca,
       cert       : this.config.ssl.cert,
       ciphers    : this.config.ssl.ciphers,
@@ -209,7 +233,7 @@ if (tls.TLSSocket) {
 
     var rejectUnauthorized = this.config.ssl.rejectUnauthorized;
     var secureEstablished = false;
-    var secureSocket = new tls.TLSSocket(connection.stream, {
+    var secureSocket = new Tls.TLSSocket(connection.stream, {
       rejectUnauthorized : rejectUnauthorized,
       requestCert        : true,
       secureContext      : secureContext,
@@ -244,7 +268,6 @@ if (tls.TLSSocket) {
       console.log('Upgrading connection to TLS');
     }
     var connection = this;
-    var tls = require('tls');
     var crypto = require('crypto');
     var config = this.config;
     var stream = this.stream;
@@ -256,7 +279,7 @@ if (tls.TLSSocket) {
       ca         : config.ssl.ca,
       ciphers    : config.ssl.ciphers
     });
-    var securePair = tls.createSecurePair(credentials, false, true, rejectUnauthorized);
+    var securePair = Tls.createSecurePair(credentials, false, true, rejectUnauthorized);
 
     if (stream.ondata) {
       stream.ondata = null;
@@ -278,7 +301,7 @@ if (tls.TLSSocket) {
 
 Connection.prototype.pipe = function () {
   var connection = this;
-  if (this.stream instanceof net.Stream) {
+  if (this.stream instanceof Net.Stream) {
     this.stream.ondata = function (data, start, end) {
       connection.packetParser.execute(data, start, end);
     };

test/common.js

@@ -59,7 +59,7 @@ module.exports.createConnection = function (args, callback) {
   }
 
   var params = {
-    host: config.host,
+    host: args.host || config.host,
     rowsAsArray: args.rowsAsArray,
     user: (args && args.user) || config.user,
     password: (args && args.password) || config.password,

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

@@ -0,0 +1,19 @@
+var common = require('../../common');
+var connection = common.createConnection({
+  host: 'www.google.com'
+});
+var assert = require('assert');
+
+var errorCount = 0;
+var error = null;
+
+
+connection.on('error', function (err) {
+  errorCount++;
+  error = err;
+});
+
+process.on('exit', function () {
+  assert.equal(errorCount, 1);
+  assert.equal(error.code, 'ETIMEDOUT');
+});