selenium-webdriver 3.3.0 → 4.0.0-alpha.1

package/net/index.js

@@ -17,11 +17,11 @@
 
 'use strict';
 
-var os = require('os');
+const os = require('os');
 
 
 function getLoInterface() {
-  var name;
+  let name;
   if (process.platform === 'darwin') {
     name = 'lo0';
   } else if (process.platform === 'linux') {
@@ -34,32 +34,28 @@ function getLoInterface() {
 /**
  * Queries the system network interfaces for an IP address.
  * @param {boolean} loopback Whether to find a loopback address.
- * @param {string=} opt_family The IP family (IPv4 or IPv6). Defaults to IPv4.
- * @return {string} The located IP address or undefined.
+ * @param {string} family The IP family (IPv4 or IPv6). Defaults to IPv4.
+ * @return {(string|undefined)} The located IP address or undefined.
  */
-function getAddress(loopback, opt_family) {
-  var family = opt_family || 'IPv4';
-  var addresses = [];
-
-  var interfaces;
+function getAddress(loopback, family) {
+  let interfaces;
   if (loopback) {
-    var lo = getLoInterface();
+    let lo = getLoInterface();
     interfaces = lo ? [lo] : null;
   }
   interfaces = interfaces || os.networkInterfaces();
-  for (var key in interfaces) {
+  for (let key in interfaces) {
     if (!interfaces.hasOwnProperty(key)) {
       continue;
     }
 
-    interfaces[key].forEach(function(ipAddress) {
-      if (ipAddress.family === family &&
-          ipAddress.internal === loopback) {
-        addresses.push(ipAddress.address);
+    for (let ipAddress of interfaces[key]) {
+      if (ipAddress.family === family && ipAddress.internal === loopback) {
+        return ipAddress.address;
       }
-    });
+    }
   }
-  return addresses[0];
+  return undefined;
 }
 
 
@@ -68,21 +64,21 @@ function getAddress(loopback, opt_family) {
 
 /**
  * Retrieves the external IP address for this host.
- * @param {string=} opt_family The IP family to retrieve. Defaults to "IPv4".
- * @return {string} The IP address or undefined if not available.
+ * @param {string=} family The IP family to retrieve. Defaults to "IPv4".
+ * @return {(string|undefined)} The IP address or undefined if not available.
  */
-exports.getAddress = function(opt_family) {
-  return getAddress(false, opt_family);
+exports.getAddress = function(family = 'IPv4') {
+  return getAddress(false, family);
 };
 
 
 /**
  * Retrieves a loopback address for this machine.
- * @param {string=} opt_family The IP family to retrieve. Defaults to "IPv4".
- * @return {string} The IP address or undefined if not available.
+ * @param {string=} family The IP family to retrieve. Defaults to "IPv4".
+ * @return {(string|undefined)} The IP address or undefined if not available.
  */
-exports.getLoopbackAddress = function(opt_family) {
-  return getAddress(true, opt_family);
+exports.getLoopbackAddress = function(family = 'IPv4') {
+  return getAddress(true, family);
 };
 
 

package/net/portprober.js

@@ -17,9 +17,9 @@
 
 'use strict';
 
-var exec = require('child_process').exec,
-    fs = require('fs'),
-    net = require('net');
+const fs = require('fs');
+const net = require('net');
+const {exec} = require('child_process');
 
 
 /**
@@ -34,9 +34,9 @@ const DEFAULT_IANA_RANGE = {min: 49152, max: 65535};
 /**
  * The epheremal port range for the current system. Lazily computed on first
  * access.
- * @type {Promise.<{min: number, max: number}>}
+ * @type {Promise<{min: number, max: number}>}
  */
-var systemRange = null;
+let systemRange = null;
 
 
 /**
@@ -49,11 +49,10 @@ function findSystemPortRange() {
   if (systemRange) {
     return systemRange;
   }
-  var range = process.platform === 'win32' ?
-      findWindowsPortRange() : findUnixPortRange();
-  return systemRange = range.catch(function() {
-    return DEFAULT_IANA_RANGE;
-  });
+  let range =
+      process.platform === 'win32'
+          ? findWindowsPortRange() : findUnixPortRange();
+  return systemRange = range.catch(() => DEFAULT_IANA_RANGE);
 }
 
 
@@ -81,7 +80,7 @@ function execute(cmd) {
  * @return {!Promise<{min: number, max: number}>} A promise that will resolve
  *     with the ephemeral port range on the current system.
  */
-function findUnixPortRange() {
+async function findUnixPortRange() {
   var cmd;
   if (process.platform === 'sunos') {
     cmd =
@@ -94,12 +93,17 @@ function findUnixPortRange() {
         ' | sed -e "s/.*:\\s*//"';
   }
 
-  return execute(cmd).then(function(stdout) {
-    if (!stdout || !stdout.length) return DEFAULT_IANA_RANGE;
-    var range = stdout.trim().split(/\s+/).map(Number);
-    if (range.some(isNaN)) return DEFAULT_IANA_RANGE;
-    return {min: range[0], max: range[1]};
-  });
+  let stdout = await execute(cmd);
+  if (!stdout || !stdout.length) {
+    return DEFAULT_IANA_RANGE;
+  };
+
+  let range = stdout.trim().split(/\s+/).map(Number);
+  if (range.some(isNaN)) {
+    return DEFAULT_IANA_RANGE;
+  };
+
+  return {min: range[0], max: range[1]};
 }
 
 
@@ -108,35 +112,29 @@ function findUnixPortRange() {
  * @return {!Promise<{min: number, max: number}>} A promise that will resolve
  *     with the ephemeral port range on the current system.
  */
-function findWindowsPortRange() {
+async function findWindowsPortRange() {
   // First, check if we're running on XP.  If this initial command fails,
   // we just fallback on the default IANA range.
-  return execute('cmd.exe /c ver').then(function(stdout) {
-    if (/Windows XP/.test(stdout)) {
-      // TODO: Try to read these values from the registry.
-      return {min: 1025, max: 5000};
-    } else {
-      return execute('netsh int ipv4 show dynamicport tcp').
-          then(function(stdout) {
-            /* > netsh int ipv4 show dynamicport tcp
-              Protocol tcp Dynamic Port Range
-              ---------------------------------
-              Start Port : 49152
-              Number of Ports : 16384
-             */
-            var range = stdout.split(/\n/).filter(function(line) {
-              return /.*:\s*\d+/.test(line);
-            }).map(function(line) {
-              return Number(line.split(/:\s*/)[1]);
-            });
-
-            return {
-              min: range[0],
-              max: range[0] + range[1]
-            };
-          });
-    }
-  });
+  let stdout = await execute('cmd.exe /c ver');
+  if (/Windows XP/.test(stdout)) {
+    // TODO: Try to read these values from the registry.
+    return {min: 1025, max: 5000};
+  } else {
+    stdout = await execute('netsh int ipv4 show dynamicport tcp');
+    /* > netsh int ipv4 show dynamicport tcp
+      Protocol tcp Dynamic Port Range
+      ---------------------------------
+      Start Port : 49152
+      Number of Ports : 16384
+     */
+    let range = stdout.split(/\n/)
+        .filter((line) => /.*:\s*\d+/.test(line))
+        .map((line) => Number(line.split(/:\s*/)[1]));
+    return {
+      min: range[0],
+      max: range[0] + range[1]
+    };
+  }
 }
 
 
@@ -171,30 +169,15 @@ function isFree(port, opt_host) {
  * @return {!Promise<number>} A promise that will resolve to a free port. If a
  *     port cannot be found, the promise will be rejected.
  */
-function findFreePort(opt_host) {
-  return findSystemPortRange().then(function(range) {
-    var attempts = 0;
-    return new Promise((resolve, reject) => {
-      findPort();
-
-      function findPort() {
-        attempts += 1;
-        if (attempts > 10) {
-          reject(Error('Unable to find a free port'));
-        }
-
-        var port = Math.floor(
-            Math.random() * (range.max - range.min) + range.min);
-        isFree(port, opt_host).then(function(isFree) {
-          if (isFree) {
-            resolve(port);
-          } else {
-            findPort();
-          }
-        });
-      }
-    });
-  });
+async function findFreePort(opt_host) {
+  let range = await findSystemPortRange();
+  for (let i = 0; i < 100; i++) {
+    let port = Math.floor(Math.random() * (range.max - range.min) + range.min);
+    if (await isFree(port, opt_host)) {
+      return port;
+    }
+  }
+  throw Error('Unable to find a free port');
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "3.3.0",
+  "version": "4.0.0-alpha.1",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -20,16 +20,17 @@
     "url": "https://github.com/SeleniumHQ/selenium.git"
   },
   "engines": {
-    "node": ">= 6.9.0"
+    "node": ">= 8.9.0"
   },
   "dependencies": {
-    "adm-zip": "^0.4.7",
+    "jszip": "^3.1.3",
     "rimraf": "^2.5.4",
     "tmp": "0.0.30",
     "xml2js": "^0.4.17"
   },
   "devDependencies": {
     "express": "^4.14.0",
+    "jasmine": "^2.8.0",
     "mocha": "^3.1.2",
     "multer": "^1.2.0",
     "promises-aplus-tests": "^2.1.2",
@@ -37,6 +38,7 @@
     "sinon": "^1.17.6"
   },
   "scripts": {
-    "test": "mocha -t 600000 --recursive test"
+    "test": "mocha -t 600000 --recursive test",
+    "test-jasmine": "jasmine JASMINE_CONFIG_PATH=jasmine.json"
   }
 }

package/remote/index.js

@@ -17,7 +17,6 @@
 
 'use strict';
 
-const AdmZip = require('adm-zip');
 const fs = require('fs');
 const path = require('path');
 const url = require('url');
@@ -26,9 +25,9 @@ const util = require('util');
 const httpUtil = require('../http/util');
 const io = require('../io');
 const exec = require('../io/exec');
+const {Zip} = require('../io/zip');
 const cmd = require('../lib/command');
 const input = require('../lib/input');
-const promise = require('../lib/promise');
 const webdriver = require('../lib/webdriver');
 const net = require('../net');
 const portprober = require('../net/portprober');
@@ -253,7 +252,7 @@ class DriverService {
 
             httpUtil.waitForServer(serverUrl, timeout, cancelToken)
                 .then(_ => fulfill(serverUrl), err => {
-                  if (err instanceof promise.CancellationError) {
+                  if (err instanceof httpUtil.CancellationError) {
                     fulfill(serverUrl);
                   } else {
                     reject(err);
@@ -278,19 +277,10 @@ class DriverService {
     if (!this.address_ || !this.command_) {
       return Promise.resolve(); // Not currently running.
     }
-    return this.command_.then(function(command) {
-      command.kill('SIGTERM');
-    });
-  }
-
-  /**
-   * Schedules a task in the current control flow to stop the server if it is
-   * currently running.
-   * @return {!promise.Thenable} A promise that will be resolved when
-   *     the server has been stopped.
-   */
-  stop() {
-    return promise.controlFlow().execute(this.kill.bind(this));
+    let cmd = this.command_;
+    this.address_ = null;
+    this.command_ = null;
+    return cmd.then(c => c.kill('SIGTERM'));
   }
 }
 
@@ -528,11 +518,9 @@ class SeleniumServer extends DriverService {
  *
  * @typedef {{
  *   loopback: (boolean|undefined),
- *   port: (number|!promise.Promise<number>),
- *   args: !(Array<string>|promise.Promise<!Array<string>>),
- *   jvmArgs: (!Array<string>|
- *             !promise.Promise<!Array<string>>|
- *             undefined),
+ *   port: (number|!IThenable<number>),
+ *   args: !(Array<string>|IThenable<!Array<string>>),
+ *   jvmArgs: (!Array<string>|!IThenable<!Array<string>>|undefined),
  *   env: (!Object<string, string>|undefined),
  *   stdio: (string|!Array<string|number|!stream.Stream|null|undefined>|
  *           undefined)
@@ -575,15 +563,15 @@ class FileDetector extends input.FileDetector {
         return file;  // Not a valid file, return original input.
       }
 
-      var zip = new AdmZip();
-      zip.addLocalFile(file);
-      // Stored compression, see https://en.wikipedia.org/wiki/Zip_(file_format)
-      zip.getEntries()[0].header.method = 0;
-
-      var command = new cmd.Command(cmd.Name.UPLOAD_FILE)
-          .setParameter('file', zip.toBuffer().toString('base64'));
-      return driver.schedule(command,
-          'remote.FileDetector.handleFile(' + file + ')');
+      let zip = new Zip;
+      return zip.addFile(file)
+          .then(() => zip.toBuffer())
+          .then(buf => buf.toString('base64'))
+          .then(encodedZip => {
+            let command = new cmd.Command(cmd.Name.UPLOAD_FILE)
+                .setParameter('file', encodedZip);
+            return driver.execute(command);
+          });
     }, function(err) {
       if (err.code === 'ENOENT') {
         return file;  // Not a file; return original input.

package/safari.js

@@ -21,17 +21,28 @@
 
 'use strict';
 
-const http = require('./http');
-const io = require('./io');
-const {Capabilities, Capability} = require('./lib/capabilities');
 const command = require('./lib/command');
 const error = require('./lib/error');
-const logging = require('./lib/logging');
+const http = require('./http');
+const io = require('./io');
+const portprober = require('./net/portprober');
 const promise = require('./lib/promise');
+const remote = require('./remote');
 const Symbols = require('./lib/symbols');
 const webdriver = require('./lib/webdriver');
-const portprober = require('./net/portprober');
-const remote = require('./remote');
+const {Browser, Capabilities, Capability} = require('./lib/capabilities');
+
+
+/**
+ * _Synchronously_ attempts to locate the IE driver executable on the current
+ * system.
+ *
+ * @return {?string} the located executable, or `null`.
+ */
+function locateSynchronously() {
+  return process.platform === 'darwin'
+      ? io.findInPath('safaridriver', true) : null;
+}
 
 
 /**
@@ -39,7 +50,7 @@ const remote = require('./remote');
  * @throws {Error}
  */
 function findSafariDriver() {
-  let exe = io.findInPath('safaridriver', true);
+  let exe = locateSynchronously();
   if (!exe) {
     throw Error(
       `The safaridriver executable could not be found on the current PATH.
@@ -73,80 +84,19 @@ const TECHNOLOGY_PREVIEW_OPTIONS_KEY = 'technologyPreview';
 /**
  * Configuration options specific to the {@link Driver SafariDriver}.
  */
-class Options {
-  constructor() {
-    /** @private {Object<string, *>} */
-    this.options_ = null;
-
-    /** @private {./lib/logging.Preferences} */
-    this.logPrefs_ = null;
-
-    /** @private {?./lib/capabilities.ProxyConfig} */
-    this.proxy_ = null;
-  }
-
+class Options extends Capabilities {
   /**
-   * Extracts the SafariDriver specific options from the given capabilities
-   * object.
-   * @param {!Capabilities} capabilities The capabilities object.
-   * @return {!Options} The SafariDriver options.
-   */
-  static fromCapabilities(capabilities) {
-    var options = new Options();
-    var o = capabilities.get(OPTIONS_CAPABILITY_KEY);
-
-    if (o instanceof Options) {
-      options = o;
-    } else if (o) {
-      options.setCleanSession(o.cleanSession);
-      options.setTechnologyPreview(o[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
-    }
-
-    if (capabilities.has(Capability.PROXY)) {
-      options.setProxy(capabilities.get(Capability.PROXY));
-    }
-
-    if (capabilities.has(Capability.LOGGING_PREFS)) {
-      options.setLoggingPrefs(capabilities.get(Capability.LOGGING_PREFS));
-    }
-
-    return options;
-  }
-
-  /**
-   * Sets whether to force Safari to start with a clean session. Enabling this
-   * option will cause all global browser data to be deleted.
-   * @param {boolean} clean Whether to make sure the session has no cookies,
-   *     cache entries, local storage, or databases.
-   * @return {!Options} A self reference.
+   * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
+   *     capabilities to initialize this instance from.
    */
-  setCleanSession(clean) {
-    if (!this.options_) {
-      this.options_ = {};
-    }
-    this.options_['cleanSession'] = clean;
-    return this;
-  }
+  constructor(other = undefined) {
+    super(other);
 
-  /**
-   * Sets the logging preferences for the new session.
-   * @param {!./lib/logging.Preferences} prefs The logging preferences.
-   * @return {!Options} A self reference.
-   */
-  setLoggingPrefs(prefs) {
-    this.logPrefs_ = prefs;
-    return this;
-  }
+    /** @private {!Object} */
+    this.options_ = this.get(OPTIONS_CAPABILITY_KEY) || {};
 
-  /**
-   * Sets the proxy to use.
-   *
-   * @param {./lib/capabilities.ProxyConfig} proxy The proxy configuration to use.
-   * @return {!Options} A self reference.
-   */
-  setProxy(proxy) {
-    this.proxy_ = proxy;
-    return this;
+    this.set(OPTIONS_CAPABILITY_KEY, this.options_);
+    this.setBrowserName(Browser.SAFARI);
   }
 
   /**
@@ -157,52 +107,19 @@ class Options {
    * @return {!Options} A self reference.
    */
   setTechnologyPreview(useTechnologyPreview) {
-    if (!this.options_) {
-      this.options_ = {};
-    }
-
     this.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY] = !!useTechnologyPreview;
     return this;
   }
-
-  /**
-   * Converts this options instance to a {@link Capabilities} object.
-   * @param {Capabilities=} opt_capabilities The capabilities to
-   *     merge these options into, if any.
-   * @return {!Capabilities} The capabilities.
-   */
-  toCapabilities(opt_capabilities) {
-    var caps = opt_capabilities || Capabilities.safari();
-    if (this.logPrefs_) {
-      caps.set(Capability.LOGGING_PREFS, this.logPrefs_);
-    }
-    if (this.proxy_) {
-      caps.set(Capability.PROXY, this.proxy_);
-    }
-    if (this.options_) {
-      caps.set(OPTIONS_CAPABILITY_KEY, this);
-    }
-    return caps;
-  }
-
-  /**
-   * Converts this instance to its JSON wire protocol representation. Note this
-   * function is an implementation detail not intended for general use.
-   * @return {!Object<string, *>} The JSON wire protocol representation of this
-   *     instance.
-   */
-  [Symbols.serialize]() {
-    return this.options_ || {};
-  }
 }
 
 /**
- * @param  {(Options|Object<string, *>)=} o The options object
+ * @param  {(Capabilities|Object<string, *>)=} o The options object
  * @return {boolean}
  */
 function useTechnologyPreview(o) {
-  if (o instanceof Options) {
-    return !!(o.options_ && o.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
+  if (o instanceof Capabilities) {
+    let options = o.get(OPTIONS_CAPABILITY_KEY);
+    return !!(options && options[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
   }
 
   if (o && typeof o === 'object') {
@@ -212,7 +129,10 @@ function useTechnologyPreview(o) {
   return false;
 }
 
-const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver';
+
+const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE =
+    '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver';
+
 
 /**
  * A WebDriver client for Safari. This class should never be instantiated
@@ -227,21 +147,13 @@ class Driver extends webdriver.WebDriver {
   /**
    * Creates a new Safari session.
    *
-   * @param {(Options|Capabilities)=} opt_config The configuration
-   *     options for the new session.
-   * @param {promise.ControlFlow=} opt_flow The control flow to create
-   *     the driver under.
+   * @param {(Options|Capabilities)=} options The configuration options.
    * @return {!Driver} A new driver instance.
    */
-  static createSession(opt_config, opt_flow) {
-    let caps, exe;
-
-    if (opt_config instanceof Options) {
-      caps = opt_config.toCapabilities();
-    } else {
-      caps = opt_config || Capabilities.safari();
-    }
+  static createSession(options) {
+    let caps = options || new Options();
 
+    let exe;
     if (useTechnologyPreview(caps.get(OPTIONS_CAPABILITY_KEY))) {
       exe = SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE;
     }
@@ -250,8 +162,8 @@ class Driver extends webdriver.WebDriver {
     let executor = new http.Executor(
         service.start().then(url => new http.HttpClient(url)));
 
-    return /** @type {!Driver} */(webdriver.WebDriver.createSession(
-        executor, caps, opt_flow, this, () => service.kill()));
+    return /** @type {!Driver} */(super.createSession(
+        executor, caps, () => service.kill()));
   }
 }
 
@@ -262,3 +174,4 @@ class Driver extends webdriver.WebDriver {
 exports.Driver = Driver;
 exports.Options = Options;
 exports.ServiceBuilder = ServiceBuilder;
+exports.locateSynchronously = locateSynchronously;