allow timeout + retry on selenium sessions timeout

The Nightwatch.startSession http action often times out despite the selenium server
being totally responsive. This PR adds timeout and retry parameters to
the http module, allowing the tests to continue despite a failed session
attempt.

Author: NickStefan

lib/http/request.js

@@ -7,12 +7,14 @@ var format = util.format;
 
 module.exports = (function() {
   var Settings = {
-    selenium_host : 'localhost',
-    selenium_port : 4444,
-    default_path  : '/wd/hub',
-    credentials   : null,
-    use_ssl       : false,
-    proxy         : null
+    selenium_host  : 'localhost',
+    selenium_port  : 4444,
+    default_path   : '/wd/hub',
+    credentials    : null,
+    use_ssl        : false,
+    proxy          : null,
+    timeout        : 60000,
+    retry_attempts : 0
   };
 
   var DO_NOT_LOG_ERRORS = [
@@ -29,11 +31,13 @@ module.exports = (function() {
   util.inherits(HttpRequest, events.EventEmitter);
 
   HttpRequest.prototype.setOptions = function(options) {
-    this.data          = options.data && jsonStringify(options.data) || '';
-    this.contentLength = this.data.length;
-    this.reqOptions    = this.createOptions(options);
-    this.hostname      = formatHostname(this.reqOptions.host, this.reqOptions.port);
-    this.request       = null;
+    this.data           = options.data && jsonStringify(options.data) || '';
+    this.contentLength  = this.data.length;
+    this.reqOptions     = this.createOptions(options);
+    this.hostname       = formatHostname(this.reqOptions.host, this.reqOptions.port);
+    this.request        = null;
+    this.timeout        = Settings.timeout;
+    this.retryAttempts  = Settings.retry_attempts;
 
     return this;
   };
@@ -165,6 +169,16 @@ module.exports = (function() {
       self.emit('error', {}, response);
     });
 
+    this.request.setTimeout(this.timeout, function(){
+      if (self.retryAttempts) {
+        Logger.info('retrying on http timeout');
+        self.retryAttempts = self.retryAttempts - 1;
+        self.send();
+      } else {
+        self.emit('error', {});
+      }
+    });
+
     Logger.info('Request: ' + this.reqOptions.method + ' ' + this.hostname + this.reqOptions.path,
       '\n - data: ', this.data, '\n - headers: ', JSON.stringify(this.reqOptions.headers));
 
@@ -205,6 +219,12 @@ module.exports = (function() {
   HttpRequest.setDefaultPathPrefix = function(path) {
     Settings.default_path = path;
   };
+  HttpRequest.setTimeout = function(timeout) {
+    Settings.timeout = timeout;
+  };
+  HttpRequest.setRetryAttempts = function(retryAttempts) {
+    Settings.retry_attempts = retryAttempts;
+  };
 
   ///////////////////////////////////////////////////////////
   // Helpers

lib/index.js

@@ -113,10 +113,13 @@ Nightwatch.prototype.setOptions = function(options) {
 
   this.api.options.log_screenshot_data = this.options.log_screenshot_data ||
     (typeof this.options.log_screenshot_data == 'undefined');
-  var seleniumPort = this.options.seleniumPort || this.options.selenium_port;
-  var seleniumHost = this.options.seleniumHost || this.options.selenium_host;
-  var useSSL       = this.options.useSsl || this.options.use_ssl;
-  var proxy        = this.options.proxy;
+  var seleniumPort     = this.options.seleniumPort || this.options.selenium_port;
+  var seleniumHost     = this.options.seleniumHost || this.options.selenium_host;
+  var useSSL           = this.options.useSsl || this.options.use_ssl;
+  var proxy            = this.options.proxy;
+  var timeoutOptions   = this.options.request_timeout_options || {};
+  var timeout          = timeoutOptions.timeout;
+  var retryAttempts    = timeoutOptions.retry_attempts;
 
   if (seleniumPort) {
     HttpRequest.setSeleniumPort(seleniumPort);
@@ -130,6 +133,12 @@ Nightwatch.prototype.setOptions = function(options) {
   if (proxy) {
     HttpRequest.setProxy(proxy);
   }
+  if (timeout) {
+    HttpRequest.setTimeout(timeout);
+  }
+  if (retryAttempts) {
+    HttpRequest.setRetryAttempts(retryAttempts);
+  }
 
   if (typeof this.options.default_path_prefix == 'string') {
     HttpRequest.setDefaultPathPrefix(this.options.default_path_prefix);

package.json

@@ -37,11 +37,12 @@
     "jscoverage": "latest",
     "jshint": "~2.4.4",
     "jsonlint": "~1.6.0",
+    "lodash.once": "^4.1.1",
     "mocha": "^2.3.4",
     "mocha-lcov-reporter": "^1.2.0",
     "mock-spawn": "^0.2.1",
     "mockery": "~1.4.0",
-    "nock": "~0.45.0",
+    "nock": "https://github.com/NickStefan/nock/tarball/set-allow-unmock",
     "nodeunit": "latest"
   },
   "bin": {

test/lib/nocks.js

@@ -1,4 +1,5 @@
 var nock = require('nock');
+nock.setAllowUnmocked(true);
 
 module.exports = {
   createSession : function() {

test/src/http/testRequest.js

@@ -4,6 +4,7 @@ var Logger = common.require('util/logger');
 var nock = require('nock');
 var assert = require('assert');
 var mockery = require('mockery');
+var once = require('lodash.once');
 
 module.exports = {
   'test HttpRequest' : {
@@ -31,6 +32,9 @@ module.exports = {
     },
 
     afterEach: function () {
+      HttpRequest.setTimeout(60000) // back to default after these tests
+      HttpRequest.setRetryAttempts(0);
+
       mockery.disable();
     },
 
@@ -204,6 +208,63 @@ module.exports = {
         done();
       }).send();
 
+    },
+
+    testRequestTimeout: function (done) {
+      nock('http://localhost:4444')
+        .get('/wd/hub/123456/element')
+        .socketDelay(10000)
+        .reply(200, {});
+
+      var options = {
+        path: '/:sessionId/element',
+        method: 'GET',
+        sessionId: '123456'
+      };
+
+      HttpRequest.setTimeout(1000);
+
+      var request = new HttpRequest(options);
+
+      request.on('error', function () {
+        assert.ok(true); // should trigger error on timeout
+        done();
+      }).send();
+
+    },
+
+    testRetryAttempts: function (done) {
+      nock('http://localhost:4444')
+        .get('/wd/hub/123456/element')
+        .socketDelay(10000)
+        .reply(200, {})
+        .get('/wd/hub/123456/element')
+        .socketDelay(100)
+        .reply(200, {})
+
+      var options = {
+        path: '/:sessionId/element',
+        method: 'GET',
+        sessionId: '123456'
+      };
+
+      HttpRequest.setTimeout(800);
+      HttpRequest.setRetryAttempts(1);
+
+      var request = new HttpRequest(options);
+      var doneOnce = once(function(){
+        // the nock library is still passing 200 for the first request
+        // rather than truly timing out
+        done(); 
+      });
+
+      request
+      .on('success', function (result) {
+        assert.ok(true); // should succeed
+        doneOnce();
+      }).send();
+
     }
   }
+
 };