selenium-webdriver 3.5.0 → 4.0.0-alpha.4

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();
-          }
-        }, 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.5.0",
+  "version": "4.0.0-alpha.4",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -20,23 +20,28 @@
     "url": "https://github.com/SeleniumHQ/selenium.git"
   },
   "engines": {
-    "node": ">= 6.9.0"
+    "node": ">= 10.15.0"
   },
   "dependencies": {
-    "jszip": "^3.1.3",
-    "rimraf": "^2.5.4",
+    "jszip": "^3.1.5",
+    "rimraf": "^2.6.3",
     "tmp": "0.0.30",
-    "xml2js": "^0.4.17"
+    "xml2js": "^0.4.19"
   },
   "devDependencies": {
-    "express": "^4.14.0",
-    "mocha": "^3.1.2",
-    "multer": "^1.2.0",
-    "promises-aplus-tests": "^2.1.2",
-    "serve-index": "^1.8.0",
-    "sinon": "^1.17.6"
+    "express": "^4.16.4",
+    "jasmine": "^3.3.1",
+    "mocha": "^5.2.0",
+    "multer": "^1.4.1",
+    "serve-index": "^1.9.1",
+    "sinon": "^7.2.3"
   },
   "scripts": {
-    "test": "mocha -t 600000 --recursive test"
+    "test": "mocha -t 600000 --recursive test",
+    "test-jasmine": "jasmine JASMINE_CONFIG_PATH=jasmine.json"
+  },
+  "mocha": {
+    "recursive": true,
+    "timeout": 600000
   }
 }

package/remote/index.js

@@ -28,7 +28,6 @@ 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'));
   }
 }
 
@@ -510,35 +500,65 @@ class SeleniumServer extends DriverService {
 
 
 /**
- * Options for the Selenium server:
- *
- * - `loopback` - Whether the server should only be accessed on this host's
- *     loopback address.
- * - `port` - The port to start the server on (must be > 0). If the port is
- *     provided as a promise, the service will wait for the promise to resolve
- *     before starting.
- * - `args` - The arguments to pass to the service. If a promise is provided,
- *     the service will wait for it to resolve before starting.
- * - `jvmArgs` - The arguments to pass to the JVM. If a promise is provided,
- *     the service will wait for it to resolve before starting.
- * - `env` - The environment variables that should be visible to the server
- *     process. Defaults to inheriting the current process's environment.
- * - `stdio` - IO configuration for the spawned server process. For more
- *     information, refer to the documentation of `child_process.spawn`.
+ * A record object describing configuration options for a {@link SeleniumServer}
+ * instance.
  *
- * @typedef {{
- *   loopback: (boolean|undefined),
- *   port: (number|!promise.Promise<number>),
- *   args: !(Array<string>|promise.Promise<!Array<string>>),
- *   jvmArgs: (!Array<string>|
- *             !promise.Promise<!Array<string>>|
- *             undefined),
- *   env: (!Object<string, string>|undefined),
- *   stdio: (string|!Array<string|number|!stream.Stream|null|undefined>|
- *           undefined)
- * }}
+ * @record
  */
-SeleniumServer.Options;
+SeleniumServer.Options = class {
+  constructor() {
+    /**
+     * Whether the server should only be accessible on this host's loopback
+     * address.
+     *
+     * @type {(boolean|undefined)}
+     */
+    this.loopback;
+
+    /**
+     * The port to start the server on (must be > 0). If the port is provided as
+     * a promise, the service will wait for the promise to resolve before
+     * starting.
+     *
+     * @type {(number|!IThenable<number>)}
+     */
+    this.port;
+
+    /**
+     * The arguments to pass to the service. If a promise is provided,
+     * the service will wait for it to resolve before starting.
+     *
+     * @type {!(Array<string>|IThenable<!Array<string>>)}
+     */
+    this.args;
+
+    /**
+     * The arguments to pass to the JVM. If a promise is provided,
+     * the service will wait for it to resolve before starting.
+     *
+     * @type {(!Array<string>|!IThenable<!Array<string>>|undefined)}
+     */
+    this.jvmArgs;
+
+    /**
+     * The environment variables that should be visible to the server
+     * process. Defaults to inheriting the current process's environment.
+     *
+     * @type {(!Object<string, string>|undefined)}
+     */
+    this.env;
+
+    /**
+     * IO configuration for the spawned server process. If unspecified, IO will
+     * be ignored.
+     *
+     * @type {(string|!Array<string|number|!stream.Stream|null|undefined>|
+     *         undefined)}
+     * @see <https://nodejs.org/dist/latest-v8.x/docs/api/child_process.html#child_process_options_stdio>
+     */
+    this.stdio;
+  }
+};
 
 
 
@@ -582,8 +602,7 @@ class FileDetector extends input.FileDetector {
           .then(encodedZip => {
             let command = new cmd.Command(cmd.Name.UPLOAD_FILE)
                 .setParameter('file', encodedZip);
-            return driver.schedule(command,
-                'remote.FileDetector.handleFile(' + file + ')');
+            return driver.execute(command);
           });
     }, function(err) {
       if (err.code === 'ENOENT') {