selenium-webdriver 4.0.0-alpha.5 → 4.0.0-beta.1

package/http/index.js

@@ -20,14 +20,13 @@
  * communicates with a remote end using HTTP + JSON.
  */
 
-'use strict';
+'use strict'
 
-const http = require('http');
-const https = require('https');
-const url = require('url');
-
-const httpLib = require('../lib/http');
+const http = require('http')
+const https = require('https')
+const url = require('url')
 
+const httpLib = require('../lib/http')
 
 /**
  * @typedef {{protocol: (?string|undefined),
@@ -38,8 +37,7 @@ const httpLib = require('../lib/http');
  *            path: (?string|undefined),
  *            pathname: (?string|undefined)}}
  */
-var RequestOptions;
-
+var RequestOptions // eslint-disable-line
 
 /**
  * @param {string} aUrl The request URL to parse.
@@ -47,26 +45,25 @@ var RequestOptions;
  * @throws {Error} if the URL does not include a hostname.
  */
 function getRequestOptions(aUrl) {
-  let options = url.parse(aUrl);
+  //eslint-disable-next-line node/no-deprecated-api
+  let options = url.parse(aUrl)
   if (!options.hostname) {
-    throw new Error('Invalid URL: ' + aUrl);
+    throw new Error('Invalid URL: ' + aUrl)
   }
   // Delete the search and has portions as they are not used.
-  options.search = null;
-  options.hash = null;
-  options.path = options.pathname;
-  return options;
+  options.search = null
+  options.hash = null
+  options.path = options.pathname
+  return options
 }
 
-
 /** @const {string} */
-const USER_AGENT = (function() {
-  const version = require('../package.json').version;
+const USER_AGENT = (function () {
+  const version = require('../package.json').version
   const platform =
-      ({'darwin': 'mac', 'win32': 'windows'}[process.platform]) || 'linux';
-  return `selenium/${version} (js ${platform})`;
-})();
-
+    { darwin: 'mac', win32: 'windows' }[process.platform] || 'linux'
+  return `selenium/${version} (js ${platform})`
+})()
 
 /**
  * A basic HTTP client used to send messages to a remote end.
@@ -83,47 +80,48 @@ class HttpClient {
    */
   constructor(serverUrl, opt_agent, opt_proxy) {
     /** @private {http.Agent} */
-    this.agent_ = opt_agent || null;
+    this.agent_ = opt_agent || null
 
     /**
      * Base options for each request.
      * @private {RequestOptions}
      */
-    this.options_ = getRequestOptions(serverUrl);
+    this.options_ = getRequestOptions(serverUrl)
 
     /**
      * @private {?RequestOptions}
      */
-    this.proxyOptions_ = opt_proxy ? getRequestOptions(opt_proxy) : null;
+    this.proxyOptions_ = opt_proxy ? getRequestOptions(opt_proxy) : null
   }
 
   /** @override */
   send(httpRequest) {
-    let data;
+    let data
 
-    let headers = {};
+    let headers = {}
 
     if (httpRequest.headers) {
-      httpRequest.headers.forEach(function(value, name) {
-        headers[name] = value;
-      });
+      httpRequest.headers.forEach(function (value, name) {
+        headers[name] = value
+      })
     }
 
-    headers['User-Agent'] = USER_AGENT;
-    headers['Content-Length'] = 0;
+    headers['User-Agent'] = USER_AGENT
+    headers['Content-Length'] = 0
     if (httpRequest.method == 'POST' || httpRequest.method == 'PUT') {
-      data = JSON.stringify(httpRequest.data);
-      headers['Content-Length'] = Buffer.byteLength(data, 'utf8');
-      headers['Content-Type'] = 'application/json;charset=UTF-8';
+      data = JSON.stringify(httpRequest.data)
+      headers['Content-Length'] = Buffer.byteLength(data, 'utf8')
+      headers['Content-Type'] = 'application/json;charset=UTF-8'
     }
 
-    let path = this.options_.path;
+    let path = this.options_.path
     if (path.endsWith('/') && httpRequest.path.startsWith('/')) {
-      path += httpRequest.path.substring(1);
+      path += httpRequest.path.substring(1)
     } else {
-      path += httpRequest.path;
+      path += httpRequest.path
     }
-    let parsedPath = url.parse(path);
+    //eslint-disable-next-line node/no-deprecated-api
+    let parsedPath = url.parse(path)
 
     let options = {
       agent: this.agent_ || null,
@@ -140,15 +138,14 @@ class HttpClient {
       hash: parsedPath.hash,
 
       headers,
-    };
+    }
 
     return new Promise((fulfill, reject) => {
-      sendRequest(options, fulfill, reject, data, this.proxyOptions_);
-    });
+      sendRequest(options, fulfill, reject, data, this.proxyOptions_)
+    })
   }
 }
 
-
 /**
  * Sends a single HTTP request.
  * @param {!Object} options The request options.
@@ -160,114 +157,131 @@ class HttpClient {
  * @param {number=} opt_retries The current number of retries.
  */
 function sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries) {
-  var hostname = options.hostname;
-  var port = options.port;
+  var hostname = options.hostname
+  var port = options.port
 
   if (opt_proxy) {
-    let proxy = /** @type {RequestOptions} */(opt_proxy);
+    let proxy = /** @type {RequestOptions} */ (opt_proxy)
 
     // RFC 2616, section 5.1.2:
     // The absoluteURI form is REQUIRED when the request is being made to a
     // proxy.
-    let absoluteUri = url.format(options);
+    let absoluteUri = url.format(options)
 
     // RFC 2616, section 14.23:
     // An HTTP/1.1 proxy MUST ensure that any request message it forwards does
     // contain an appropriate Host header field that identifies the service
     // being requested by the proxy.
-    let targetHost = options.hostname;
+    let targetHost = options.hostname
     if (options.port) {
-      targetHost += ':' + options.port;
+      targetHost += ':' + options.port
     }
 
     // Update the request options with our proxy info.
-    options.headers['Host'] = targetHost;
-    options.path = absoluteUri;
-    options.host = proxy.host;
-    options.hostname = proxy.hostname;
-    options.port = proxy.port;
+    options.headers['Host'] = targetHost
+    options.path = absoluteUri
+    options.host = proxy.host
+    options.hostname = proxy.hostname
+    options.port = proxy.port
+
+    // Update the protocol to avoid EPROTO errors when the webdriver proxy
+    // uses a different protocol from the remote selenium server.
+    options.protocol = opt_proxy.protocol
 
     if (proxy.auth) {
       options.headers['Proxy-Authorization'] =
-          'Basic ' + new Buffer(proxy.auth).toString('base64');
+        'Basic ' + Buffer.from(proxy.auth).toString('base64')
     }
   }
 
-  let requestFn = options.protocol === 'https:' ? https.request : http.request;
+  let requestFn = options.protocol === 'https:' ? https.request : http.request
   var request = requestFn(options, function onResponse(response) {
     if (response.statusCode == 302 || response.statusCode == 303) {
       try {
-        var location = url.parse(response.headers['location']);
+        // eslint-disable-next-line node/no-deprecated-api
+        var location = url.parse(response.headers['location'])
       } catch (ex) {
-        onError(Error(
+        onError(
+          Error(
             'Failed to parse "Location" header for server redirect: ' +
-            ex.message + '\nResponse was: \n' +
-            new httpLib.Response(response.statusCode, response.headers, '')));
-        return;
+              ex.message +
+              '\nResponse was: \n' +
+              new httpLib.Response(response.statusCode, response.headers, '')
+          )
+        )
+        return
       }
 
       if (!location.hostname) {
-        location.hostname = hostname;
-        location.port = port;
+        location.hostname = hostname
+        location.port = port
+        location.auth = options.auth
       }
 
-      request.abort();
-      sendRequest({
-        method: 'GET',
-        protocol: location.protocol || options.protocol,
-        hostname: location.hostname,
-        port: location.port,
-        path: location.path,
-        pathname: location.pathname,
-        search: location.search,
-        hash: location.hash,
-        headers: {
-          'Accept': 'application/json; charset=utf-8',
-          'User-Agent': USER_AGENT,
-        }
-      }, onOk, onError, undefined, opt_proxy);
-      return;
+      request.abort()
+      sendRequest(
+        {
+          method: 'GET',
+          protocol: location.protocol || options.protocol,
+          hostname: location.hostname,
+          port: location.port,
+          path: location.path,
+          auth: location.auth,
+          pathname: location.pathname,
+          search: location.search,
+          hash: location.hash,
+          headers: {
+            Accept: 'application/json; charset=utf-8',
+            'User-Agent': USER_AGENT,
+          },
+        },
+        onOk,
+        onError,
+        undefined,
+        opt_proxy
+      )
+      return
     }
 
-    var body = [];
-    response.on('data', body.push.bind(body));
-    response.on('end', function() {
+    var body = []
+    response.on('data', body.push.bind(body))
+    response.on('end', function () {
       var resp = new httpLib.Response(
-          /** @type {number} */(response.statusCode),
-          /** @type {!Object<string>} */(response.headers),
-          Buffer.concat(body).toString('utf8').replace(/\0/g, ''));
-      onOk(resp);
-    });
-  });
-
-  request.on('error', function(e) {
+        /** @type {number} */ (response.statusCode),
+        /** @type {!Object<string>} */ (response.headers),
+        Buffer.concat(body).toString('utf8').replace(/\0/g, '')
+      )
+      onOk(resp)
+    })
+  })
+
+  request.on('error', function (e) {
     if (typeof opt_retries === 'undefined') {
-      opt_retries = 0;
+      opt_retries = 0
     }
 
     if (shouldRetryRequest(opt_retries, e)) {
-      opt_retries += 1;
-      setTimeout(function() {
-        sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries);
-      }, 15);
+      opt_retries += 1
+      setTimeout(function () {
+        sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries)
+      }, 15)
     } else {
-      var message = e.message;
+      var message = e.message
       if (e.code) {
-        message = e.code + ' ' + message;
+        message = e.code + ' ' + message
       }
-      onError(new Error(message));
+      onError(new Error(message))
     }
-  });
+  })
 
   if (opt_data) {
-    request.write(opt_data);
+    request.write(opt_data)
   }
 
-  request.end();
+  request.end()
 }
 
-
-const MAX_RETRIES = 3;
+const MAX_RETRIES = 3
 
 /**
  * A retry is sometimes needed on Windows where we may quickly run out of
@@ -279,7 +293,7 @@ const MAX_RETRIES = 3;
  * @return {boolean}
  */
 function shouldRetryRequest(retries, err) {
-  return retries < MAX_RETRIES && isRetryableNetworkError(err);
+  return retries < MAX_RETRIES && isRetryableNetworkError(err)
 }
 
 /**
@@ -288,21 +302,23 @@ function shouldRetryRequest(retries, err) {
  */
 function isRetryableNetworkError(err) {
   if (err && err.code) {
-    return err.code === 'ECONNABORTED' ||
-          err.code === 'ECONNRESET' ||
-          err.code === 'ECONNREFUSED' ||
-          err.code === 'EADDRINUSE' ||
-          err.code === 'EPIPE';
+    return (
+      err.code === 'ECONNABORTED' ||
+      err.code === 'ECONNRESET' ||
+      err.code === 'ECONNREFUSED' ||
+      err.code === 'EADDRINUSE' ||
+      err.code === 'EPIPE' ||
+      err.code === 'ETIMEDOUT'
+    )
   }
 
-  return false;
+  return false
 }
 
-
 // PUBLIC API
 
-exports.Agent = http.Agent;
-exports.Executor = httpLib.Executor;
-exports.HttpClient = HttpClient;
-exports.Request = httpLib.Request;
-exports.Response = httpLib.Response;
+exports.Agent = http.Agent
+exports.Executor = httpLib.Executor
+exports.HttpClient = HttpClient
+exports.Request = httpLib.Request
+exports.Response = httpLib.Response

package/http/util.js

@@ -19,16 +19,14 @@
  * @fileoverview Various HTTP utilities.
  */
 
-'use strict';
+'use strict'
 
 const Executor = require('./index').Executor,
-    HttpClient = require('./index').HttpClient,
-    HttpRequest = require('./index').Request,
-    Command = require('../lib/command').Command,
-    CommandName = require('../lib/command').Name,
-    error = require('../lib/error');
-
-
+  HttpClient = require('./index').HttpClient,
+  HttpRequest = require('./index').Request,
+  Command = require('../lib/command').Command,
+  CommandName = require('../lib/command').Name,
+  error = require('../lib/error')
 
 /**
  * Queries a WebDriver server for its current status.
@@ -37,30 +35,25 @@ const Executor = require('./index').Executor,
  *     a hash of the server status.
  */
 function getStatus(url) {
-  var client = new HttpClient(url);
-  var executor = new Executor(client);
-  var command = new Command(CommandName.GET_SERVER_STATUS);
-  return executor.execute(command);
+  const client = new HttpClient(url)
+  const executor = new Executor(client)
+  const command = new Command(CommandName.GET_SERVER_STATUS)
+  return executor.execute(command)
 }
 
-
 class CancellationError {}
 
-
 // PUBLIC API
 
-
 /**
  * Queries a WebDriver server for its current status.
  * @param {string} url Base URL of the server to query.
  * @return {!Promise<!Object>} A promise that resolves with
  *     a hash of the server status.
  */
-exports.getStatus = getStatus;
-
-
-exports.CancellationError = CancellationError;
+exports.getStatus = getStatus
 
+exports.CancellationError = CancellationError
 
 /**
  * Waits for a WebDriver server to be healthy and accepting requests.
@@ -72,50 +65,49 @@ exports.CancellationError = CancellationError;
  * @return {!Promise} A promise that will resolve when the server is ready, or
  *     if the wait is cancelled.
  */
-exports.waitForServer = function(url, timeout, opt_cancelToken) {
+exports.waitForServer = function (url, timeout, opt_cancelToken) {
   return new Promise((onResolve, onReject) => {
-    let start = Date.now();
+    let start = Date.now()
 
-    let done = false;
+    let done = false
     let resolve = (status) => {
-      done = true;
-      onResolve(status);
-    };
+      done = true
+      onResolve(status)
+    }
     let reject = (err) => {
-      done = true;
-      onReject(err);
-    };
+      done = true
+      onReject(err)
+    }
 
     if (opt_cancelToken) {
-      opt_cancelToken.then(_ => reject(new CancellationError));
+      opt_cancelToken.then((_) => reject(new CancellationError()))
     }
 
-    checkServerStatus();
+    checkServerStatus()
     function checkServerStatus() {
-      return getStatus(url).then(status => resolve(status), onError);
+      return getStatus(url).then((status) => resolve(status), onError)
     }
 
     function onError(e) {
       // Some servers don't support the status command. If they are able to
       // response with an error, then can consider the server ready.
       if (e instanceof error.UnsupportedOperationError) {
-        resolve({});
-        return;
+        resolve({})
+        return
       }
 
       if (Date.now() - start > timeout) {
-        reject(Error('Timed out waiting for the WebDriver server at ' + url));
+        reject(Error('Timed out waiting for the WebDriver server at ' + url))
       } else {
-        setTimeout(function() {
+        setTimeout(function () {
           if (!done) {
-            checkServerStatus();
+            checkServerStatus()
           }
-        }, 50);
+        }, 50)
       }
     }
-  });
-};
-
+  })
+}
 
 /**
  * Polls a URL with GET requests until it returns a 2xx response or the
@@ -128,53 +120,53 @@ exports.waitForServer = function(url, timeout, opt_cancelToken) {
  * @return {!Promise} A promise that will resolve when a 2xx is received from
  *     the given URL, or if the wait is cancelled.
  */
-exports.waitForUrl = function(url, timeout, opt_cancelToken) {
+exports.waitForUrl = function (url, timeout, opt_cancelToken) {
   return new Promise((onResolve, onReject) => {
-    let client = new HttpClient(url);
-    let request = new HttpRequest('GET', '');
-    let start = Date.now();
+    let client = new HttpClient(url)
+    let request = new HttpRequest('GET', '')
+    let start = Date.now()
 
-    let done = false;
+    let done = false
     let resolve = () => {
-      done = true;
-      onResolve();
-    };
+      done = true
+      onResolve()
+    }
     let reject = (err) => {
-      done = true;
-      onReject(err);
-    };
+      done = true
+      onReject(err)
+    }
 
     if (opt_cancelToken) {
-      opt_cancelToken.then(_ => reject(new CancellationError));
+      opt_cancelToken.then((_) => reject(new CancellationError()))
     }
 
-    testUrl();
+    testUrl()
 
     function testUrl() {
-      client.send(request).then(onResponse, onError);
+      client.send(request).then(onResponse, onError)
     }
 
     function onError() {
       if (Date.now() - start > timeout) {
-        reject(Error('Timed out waiting for the URL to return 2xx: ' + url));
+        reject(Error('Timed out waiting for the URL to return 2xx: ' + url))
       } else {
-        setTimeout(function() {
+        setTimeout(function () {
           if (!done) {
-            testUrl();
+            testUrl()
           }
-        }, 50);
+        }, 50)
       }
     }
 
     function onResponse(response) {
       if (done) {
-        return;
+        return
       }
       if (response.status > 199 && response.status < 300) {
-        resolve();
-        return;
+        resolve()
+        return
       }
-      onError();
+      onError()
     }
-  });
-};
+  })
+}