Add proxy support to the NodeJS webdriver.http.Client so that it can

connect to a Selenium server through a proxy.

Signed-off-by: Jason Leyba <[email protected]>

Author: Elias Faxö

Diff for: javascript/node/selenium-webdriver/CHANGES.md

@@ -1,5 +1,7 @@
 ## v2.46.0-dev
 
+* Added support for using a proxy server for WebDriver commands.
+    See `Builder#usingWebDriverProxy()` for more info.
 * Removed deprecated functions:
     * Capabilities#toJSON()
     * UnhandledAlertError#getAlert()

Diff for: javascript/node/selenium-webdriver/builder.js

@@ -95,6 +95,9 @@ var Builder = function() {
   /** @private {string} */
   this.url_ = '';
 
+  /** @private {?string} */
+  this.proxy_ = null;
+
   /** @private {!webdriver.Capabilities} */
   this.capabilities_ = new Capabilities();
 
@@ -156,6 +159,29 @@ Builder.prototype.getServerUrl = function() {
 };
 
 
+/**
+ * Sets the URL of the proxy to use for the WebDriver's HTTP connections.
+ * If this method is never called, the Builder will create a connection without
+ * a proxy.
+ *
+ * @param {string} proxy The URL of a proxy to use.
+ * @return {!Builder} A self reference.
+ */
+Builder.prototype.usingWebDriverProxy = function(proxy) {
+  this.proxy_ = proxy;
+  return this;
+};
+
+
+/**
+ * @return {string} The URL of the proxy server to use for the WebDriver's HTTP
+ *    connections.
+ */
+Builder.prototype.getWebDriverProxy = function() {
+  return this.proxy_;
+};
+
+
 /**
  * Sets the desired capabilities when requesting a new session. This will
  * overwrite any previously set capabilities.
@@ -415,7 +441,7 @@ Builder.prototype.build = function() {
   }
 
   if (url) {
-    var executor = executors.createExecutor(url);
+    var executor = executors.createExecutor(url, this.proxy_);
     return WebDriver.createSession(executor, capabilities, this.flow_);
   }
 

Diff for: javascript/node/selenium-webdriver/executors.js

@@ -54,11 +54,13 @@ exports.DeferredExecutor = DeferredExecutor;
  * Creates a command executor that uses WebDriver's JSON wire protocol.
  * @param {(string|!webdriver.promise.Promise.<string>)} url The server's URL,
  *     or a promise that will resolve to that URL.
+ * @param {string=} opt_proxy (optional) The URL of the HTTP proxy for the
+ *     client to use.
  * @returns {!webdriver.CommandExecutor} The new command executor.
  */
-exports.createExecutor = function(url) {
+exports.createExecutor = function(url, opt_proxy) {
   return new DeferredExecutor(promise.when(url, function(url) {
-    var client = new HttpClient(url);
+    var client = new HttpClient(url, null, opt_proxy);
     return new HttpExecutor(client);
   }));
 };

Diff for: javascript/node/selenium-webdriver/http/index.js

@@ -33,10 +33,12 @@ var base = require('../_base'),
  * @param {string} serverUrl URL for the WebDriver server to send commands to.
  * @param {http.Agent=} opt_agent The agent to use for each request.
  *     Defaults to {@code http.globalAgent}.
+ * @param {string=} opt_proxy The proxy to use for the connection to the server.
+ *     Default is to use no proxy.
  * @constructor
  * @implements {webdriver.http.Client}
  */
-var HttpClient = function(serverUrl, opt_agent) {
+var HttpClient = function(serverUrl, opt_agent, opt_proxy) {
   var parsedUrl = url.parse(serverUrl);
   if (!parsedUrl.hostname) {
     throw new Error('Invalid server URL: ' + serverUrl);
@@ -45,6 +47,9 @@ var HttpClient = function(serverUrl, opt_agent) {
   /** @private {http.Agent} */
   this.agent_ = opt_agent;
 
+  /** @private {string} */
+  this.proxy_ = opt_proxy;
+
   /**
    * Base options for each request.
    * @private {!Object}
@@ -81,10 +86,12 @@ HttpClient.prototype.send = function(httpRequest, callback) {
     path: path,
     headers: httpRequest.headers
   };
+
   if (this.agent_) {
     options.agent = this.agent_;
   }
-  sendRequest(options, callback, data);
+
+  sendRequest(options, callback, data, this.proxy_);
 };
 
 
@@ -94,8 +101,25 @@ HttpClient.prototype.send = function(httpRequest, callback) {
  * @param {function(Error, !webdriver.http.Response=)} callback The function to
  *     invoke with the server's response.
  * @param {string=} opt_data The data to send with the request.
+ * @param {string=} opt_proxy The proxy server to use for the request.
  */
-var sendRequest = function(options, callback, opt_data) {
+var sendRequest = function(options, callback, opt_data, opt_proxy) {
+  var host = options.host;
+  var port = options.port;
+
+  if (opt_proxy) {
+    var proxy = url.parse(opt_proxy);
+
+    options.headers['Host'] = options.host;
+    options.host = proxy.hostname;
+    options.port = proxy.port;
+
+    if (proxy.auth) {
+      options.headers['Proxy-Authorization'] =
+          'Basic ' + new Buffer(proxy.auth).toString('base64');
+    }
+  }
+
   var request = http.request(options, function(response) {
     if (response.statusCode == 302 || response.statusCode == 303) {
       try {
@@ -109,8 +133,8 @@ var sendRequest = function(options, callback, opt_data) {
       }
 
       if (!location.hostname) {
-        location.hostname = options.host;
-        location.port = options.port;
+        location.hostname = host;
+        location.port = port;
       }
 
       request.abort();
@@ -122,7 +146,7 @@ var sendRequest = function(options, callback, opt_data) {
         headers: {
           'Accept': 'application/json; charset=utf-8'
         }
-      }, callback);
+      }, callback, undefined, opt_proxy);
       return;
     }
 
@@ -138,7 +162,7 @@ var sendRequest = function(options, callback, opt_data) {
   request.on('error', function(e) {
     if (e.code === 'ECONNRESET') {
       setTimeout(function() {
-        sendRequest(options, callback, opt_data);
+        sendRequest(options, callback, opt_data, opt_proxy);
       }, 15);
     } else {
       var message = e.message;

Diff for: javascript/node/selenium-webdriver/test/http/http_test.js

@@ -25,6 +25,8 @@ var promise = require('../..').promise;
 var test = require('../../lib/test');
 
 describe('HttpClient', function() {
+  this.timeout(4*1000);
+
   var server = new Server(function(req, res) {
     if (req.method == 'GET' && req.url == '/echo') {
       res.writeHead(200, req.headers);
@@ -42,6 +44,14 @@ describe('HttpClient', function() {
       res.writeHead(303, {});
       res.end();
 
+    } else if (req.method == 'GET' && req.url == '/proxy') {
+      res.writeHead(200, req.headers);
+      res.end();
+
+    } else if (req.method == 'GET' && req.url == '/proxy/redirect') {
+      res.writeHead(303, {'Location': '/proxy'});
+      res.end();
+
     } else {
       res.writeHead(404, {});
       res.end();
@@ -90,10 +100,33 @@ describe('HttpClient', function() {
   test.it('handles malformed redirect responses', function() {
     var request = new HttpRequest('GET', '/badredirect');
     var client = new HttpClient(server.url());
-    return promise.checkedNodeCall(client.send.bind(client, request)).
-        thenCatch(function(err) {
+    return promise.checkedNodeCall(client.send.bind(client, request))
+        .thenCatch(function(err) {
           assert.ok(/Failed to parse "Location"/.test(err.message),
               'Not the expected error: ' + err.message);
         });
   });
+
+  test.it('proxies requests through the webdriver proxy', function() {
+    var request = new HttpRequest('GET', '/proxy');
+    var client = new HttpClient(
+        'http://another.server.com', undefined, server.url());
+    return promise.checkedNodeCall(client.send.bind(client, request))
+        .then(function(response) {
+           assert.equal(200, response.status);
+           assert.equal('another.server.com', response.headers['host']);
+        });
+  });
+
+  test.it(
+      'proxies requests through the webdriver proxy on redirect', function() {
+    var request = new HttpRequest('GET', '/proxy/redirect');
+    var client = new HttpClient(
+        'http://another.server.com', undefined, server.url());
+    return promise.checkedNodeCall(client.send.bind(client, request))
+        .then(function(response) {
+          assert.equal(200, response.status);
+          assert.equal('another.server.com', response.headers['host']);
+        });
+  });
 });