selenium-webdriver 2.48.2 → 2.52.0

package/firefox/binary.js

@@ -17,43 +17,43 @@
 
 /**
  * @fileoverview Manages Firefox binaries. This module is considered internal;
- * users should use {@link selenium-webdriver/firefox}.
+ * users should use {@link ./firefox selenium-webdriver/firefox}.
  */
 
 'use strict';
 
-var child = require('child_process'),
+const child = require('child_process'),
     fs = require('fs'),
     path = require('path'),
     util = require('util');
 
-var Serializable = require('..').Serializable,
-    promise = require('..').promise,
-    _base = require('../_base'),
+const isDevMode = require('../lib/devmode'),
+    promise = require('../lib/promise'),
+    Symbols = require('../lib/symbols'),
     io = require('../io'),
     exec = require('../io/exec');
 
 
 
 /** @const */
-var NO_FOCUS_LIB_X86 = _base.isDevMode() ?
+const NO_FOCUS_LIB_X86 = isDevMode ?
     path.join(__dirname, '../../../../cpp/prebuilt/i386/libnoblur.so') :
     path.join(__dirname, '../lib/firefox/i386/libnoblur.so') ;
 
 /** @const */
-var NO_FOCUS_LIB_AMD64 = _base.isDevMode() ?
+const NO_FOCUS_LIB_AMD64 = isDevMode ?
     path.join(__dirname, '../../../../cpp/prebuilt/amd64/libnoblur64.so') :
     path.join(__dirname, '../lib/firefox/amd64/libnoblur64.so') ;
 
-var X_IGNORE_NO_FOCUS_LIB = 'x_ignore_nofocus.so';
+const X_IGNORE_NO_FOCUS_LIB = 'x_ignore_nofocus.so';
 
 var foundBinary = null;
 
 
 /**
  * Checks the default Windows Firefox locations in Program Files.
- * @return {!promise.Promise.<?string>} A promise for the located executable.
- *     The promise will resolve to {@code null} if Fireox was not found.
+ * @return {!Promise<?string>} A promise for the located executable.
+ *     The promise will resolve to {@code null} if Firefox was not found.
  */
 function defaultWindowsLocation() {
   var files = [
@@ -136,90 +136,82 @@ function installNoFocusLibs(profileDir) {
  * Provides a mechanism to configure and launch Firefox in a subprocess for
  * use with WebDriver.
  *
- * @param {string=} opt_exe Path to the Firefox binary to use. If not
- *     specified, will attempt to locate Firefox on the current system.
- * @constructor
- * @extends {Serializable.<string>}
+ * @final
  */
-var Binary = function(opt_exe) {
-  Serializable.call(this);
-
-  /** @private {(string|undefined)} */
-  this.exe_ = opt_exe;
-
-  /** @private {!Array.<string>} */
-  this.args_ = [];
-
-  /** @private {!Object.<string, string>} */
-  this.env_ = {};
-  Object.keys(process.env).forEach(function(key) {
-    this.env_[key] = process.env[key];
-  }.bind(this));
-  this.env_['MOZ_CRASHREPORTER_DISABLE'] = '1';
-  this.env_['MOZ_NO_REMOTE'] = '1';
-  this.env_['NO_EM_RESTART'] = '1';
-};
-util.inherits(Binary, Serializable);
-
+class Binary {
+  /**
+   * @param {string=} opt_exe Path to the Firefox binary to use. If not
+   *     specified, will attempt to locate Firefox on the current system.
+   */
+  constructor(opt_exe) {
+    /** @private {(string|undefined)} */
+    this.exe_ = opt_exe;
+
+    /** @private {!Array.<string>} */
+    this.args_ = [];
+
+    /** @private {!Object<string, string>} */
+    this.env_ = {};
+    Object.assign(this.env_, process.env, {
+      MOZ_CRASHREPORTER_DISABLE: '1',
+      MOZ_NO_REMOTE: '1',
+      NO_EM_RESTART: '1'
+    });
+  }
 
-/**
- * Add arguments to the command line used to start Firefox.
- * @param {...(string|!Array.<string>)} var_args Either the arguments to add as
- *     varargs, or the arguments as an array.
- */
-Binary.prototype.addArguments = function(var_args) {
-  for (var i = 0; i < arguments.length; i++) {
-    if (util.isArray(arguments[i])) {
-      this.args_ = this.args_.concat(arguments[i]);
-    } else {
-      this.args_.push(arguments[i]);
+  /**
+   * Add arguments to the command line used to start Firefox.
+   * @param {...(string|!Array.<string>)} var_args Either the arguments to add
+   *     as varargs, or the arguments as an array.
+   */
+  addArguments(var_args) {
+    for (var i = 0; i < arguments.length; i++) {
+      if (Array.isArray(arguments[i])) {
+        this.args_ = this.args_.concat(arguments[i]);
+      } else {
+        this.args_.push(arguments[i]);
+      }
     }
   }
-};
 
-
-/**
- * Launches Firefox and returns a promise that will be fulfilled when the
- * process terminates.
- * @param {string} profile Path to the profile directory to use.
- * @return {!promise.Promise.<!exec.Command>} A promise for the handle to the
- *     started subprocess.
- */
-Binary.prototype.launch = function(profile) {
-  var env = {};
-  Object.keys(this.env_).forEach(function(key) {
-    env[key] = this.env_[key];
-  }.bind(this));
-  env['XRE_PROFILE_PATH'] = profile;
-
-  var args = ['-foreground'].concat(this.args_);
-
-  return promise.when(this.exe_ || findFirefox(), function(firefox) {
-    if (process.platform === 'win32' || process.platform === 'darwin') {
-      return exec(firefox, {args: args, env: env});
-    }
-    return installNoFocusLibs(profile).then(function(ldLibraryPath) {
-      env['LD_LIBRARY_PATH'] = ldLibraryPath + ':' + env['LD_LIBRARY_PATH'];
-      env['LD_PRELOAD'] = X_IGNORE_NO_FOCUS_LIB;
-      return exec(firefox, {args: args, env: env});
+  /**
+   * Launches Firefox and returns a promise that will be fulfilled when the
+   * process terminates.
+   * @param {string} profile Path to the profile directory to use.
+   * @return {!promise.Promise<!exec.Command>} A promise for the handle to the
+   *     started subprocess.
+   */
+  launch(profile) {
+    let env = {};
+    Object.assign(env, this.env_, {XRE_PROFILE_PATH: profile});
+
+    let args = ['-foreground'].concat(this.args_);
+
+    return promise.when(this.exe_ || findFirefox(), function(firefox) {
+      if (process.platform === 'win32' || process.platform === 'darwin') {
+        return exec(firefox, {args: args, env: env});
+      }
+      return installNoFocusLibs(profile).then(function(ldLibraryPath) {
+        env['LD_LIBRARY_PATH'] = ldLibraryPath + ':' + env['LD_LIBRARY_PATH'];
+        env['LD_PRELOAD'] = X_IGNORE_NO_FOCUS_LIB;
+        return exec(firefox, {args: args, env: env});
+      });
     });
-  });
-};
-
+  }
 
-/**
- * Returns a promise for the wire representation of this binary. Note: the
- * FirefoxDriver only supports passing the path to the binary executable over
- * the wire; all command line arguments and environment variables will be
- * discarded.
- *
- * @return {!promise.Promise.<string>} A promise for this binary's wire
- *     representation.
- * @override
- */
-Binary.prototype.serialize = function() {
-  return promise.when(this.exe_ || findFirefox());
-};
+  /**
+   * Returns a promise for the wire representation of this binary. Note: the
+   * FirefoxDriver only supports passing the path to the binary executable over
+   * the wire; all command line arguments and environment variables will be
+   * discarded.
+   *
+   * @return {!promise.Promise<string>} A promise for this binary's wire
+   *     representation.
+   */
+  [Symbols.serialize]() {
+    return promise.fulfilled(this.exe_ || findFirefox());
+  }
+}
 
 
 // PUBLIC API

package/firefox/extension.js

@@ -19,35 +19,27 @@
 
 'use strict';
 
-var AdmZip = require('adm-zip'),
+const AdmZip = require('adm-zip'),
     fs = require('fs'),
     path = require('path'),
-    util = require('util'),
     xml = require('xml2js');
 
-var promise = require('..').promise,
+const promise = require('../lib/promise'),
     checkedCall = promise.checkedNodeCall,
     io = require('../io');
 
 
 /**
  * Thrown when there an add-on is malformed.
- * @param {string} msg The error message.
- * @constructor
- * @extends {Error}
  */
-function AddonFormatError(msg) {
-  Error.call(this);
-
-  Error.captureStackTrace(this, AddonFormatError);
-
-  /** @override */
-  this.name = AddonFormatError.name;
-
-  /** @override */
-  this.message = msg;
+class AddonFormatError extends Error {
+  /** @param {string} msg The error message. */
+  constructor(msg) {
+    super(msg);
+    /** @override */
+    this.name = this.constructor.name;
+  }
 }
-util.inherits(AddonFormatError, Error);
 
 
 
@@ -147,7 +139,7 @@ function getDetails(addonPath) {
 /**
  * Reads the manifest for a Firefox add-on.
  * @param {string} addonPath Path to a Firefox add-on as a xpi or an extension.
- * @return {!promise.Promise.<!Object>} A promise for the parsed manifest.
+ * @return {!promise.Promise<!Object>} A promise for the parsed manifest.
  */
 function readManifest(addonPath) {
   var manifest;

package/firefox/index.js

@@ -94,221 +94,221 @@
 
 'use strict';
 
-var url = require('url'),
-    util = require('util');
+const url = require('url');
 
-var Binary = require('./binary').Binary,
+const Binary = require('./binary').Binary,
     Profile = require('./profile').Profile,
     decodeProfile = require('./profile').decode,
-    webdriver = require('..'),
     executors = require('../executors'),
     httpUtil = require('../http/util'),
     io = require('../io'),
+    capabilities = require('../lib/capabilities'),
+    logging = require('../lib/logging'),
+    promise = require('../lib/promise'),
+    webdriver = require('../lib/webdriver'),
     net = require('../net'),
     portprober = require('../net/portprober');
 
 
 /**
  * Configuration options for the FirefoxDriver.
- * @constructor
  */
-var Options = function() {
-  /** @private {Profile} */
-  this.profile_ = null;
+class Options {
+    constructor() {
+    /** @private {Profile} */
+    this.profile_ = null;
 
-  /** @private {Binary} */
-  this.binary_ = null;
+    /** @private {Binary} */
+    this.binary_ = null;
 
-  /** @private {webdriver.logging.Preferences} */
-  this.logPrefs_ = null;
+    /** @private {logging.Preferences} */
+    this.logPrefs_ = null;
 
-  /** @private {webdriver.ProxyConfig} */
-  this.proxy_ = null;
-};
-
-
-/**
- * Sets the profile to use. The profile may be specified as a
- * {@link Profile} object or as the path to an existing Firefox profile to use
- * as a template.
- *
- * @param {(string|!Profile)} profile The profile to use.
- * @return {!Options} A self reference.
- */
-Options.prototype.setProfile = function(profile) {
-  if (typeof profile === 'string') {
-    profile = new Profile(profile);
+    /** @private {?capabilities.ProxyConfig} */
+    this.proxy_ = null;
   }
-  this.profile_ = profile;
-  return this;
-};
-
 
-/**
- * Sets the binary to use. The binary may be specified as the path to a Firefox
- * executable, or as a {@link Binary} object.
- *
- * @param {(string|!Binary)} binary The binary to use.
- * @return {!Options} A self reference.
- */
-Options.prototype.setBinary = function(binary) {
-  if (typeof binary === 'string') {
-    binary = new Binary(binary);
+  /**
+   * Sets the profile to use. The profile may be specified as a
+   * {@link Profile} object or as the path to an existing Firefox profile to use
+   * as a template.
+   *
+   * @param {(string|!Profile)} profile The profile to use.
+   * @return {!Options} A self reference.
+   */
+  setProfile(profile) {
+    if (typeof profile === 'string') {
+      profile = new Profile(profile);
+    }
+    this.profile_ = profile;
+    return this;
   }
-  this.binary_ = binary;
-  return this;
-};
-
-
-/**
- * Sets the logging preferences for the new session.
- * @param {webdriver.logging.Preferences} prefs The logging preferences.
- * @return {!Options} A self reference.
- */
-Options.prototype.setLoggingPreferences = function(prefs) {
-  this.logPrefs_ = prefs;
-  return this;
-};
-
-
-/**
- * Sets the proxy to use.
- *
- * @param {webdriver.ProxyConfig} proxy The proxy configuration to use.
- * @return {!Options} A self reference.
- */
-Options.prototype.setProxy = function(proxy) {
-  this.proxy_ = proxy;
-  return this;
-};
-
 
-/**
- * Converts these options to a {@link webdriver.Capabilities} instance.
- *
- * @return {!webdriver.Capabilities} A new capabilities object.
- */
-Options.prototype.toCapabilities = function(opt_remote) {
-  var caps = webdriver.Capabilities.firefox();
-  if (this.logPrefs_) {
-    caps.set(webdriver.Capability.LOGGING_PREFS, this.logPrefs_);
+  /**
+   * Sets the binary to use. The binary may be specified as the path to a Firefox
+   * executable, or as a {@link Binary} object.
+   *
+   * @param {(string|!Binary)} binary The binary to use.
+   * @return {!Options} A self reference.
+   */
+  setBinary(binary) {
+    if (typeof binary === 'string') {
+      binary = new Binary(binary);
+    }
+    this.binary_ = binary;
+    return this;
   }
-  if (this.proxy_) {
-    caps.set(webdriver.Capability.PROXY, this.proxy_);
+
+  /**
+   * Sets the logging preferences for the new session.
+   * @param {logging.Preferences} prefs The logging preferences.
+   * @return {!Options} A self reference.
+   */
+  setLoggingPreferences(prefs) {
+    this.logPrefs_ = prefs;
+    return this;
   }
-  if (this.binary_) {
-    caps.set('firefox_binary', this.binary_);
+
+  /**
+   * Sets the proxy to use.
+   *
+   * @param {capabilities.ProxyConfig} proxy The proxy configuration to use.
+   * @return {!Options} A self reference.
+   */
+  setProxy(proxy) {
+    this.proxy_ = proxy;
+    return this;
   }
-  if (this.profile_) {
-    caps.set('firefox_profile', this.profile_);
+
+  /**
+   * Converts these options to a {@link capabilities.Capabilities} instance.
+   *
+   * @return {!capabilities.Capabilities} A new capabilities object.
+   */
+  toCapabilities() {
+    var caps = capabilities.Capabilities.firefox();
+    if (this.logPrefs_) {
+      caps.set(capabilities.Capability.LOGGING_PREFS, this.logPrefs_);
+    }
+    if (this.proxy_) {
+      caps.set(capabilities.Capability.PROXY, this.proxy_);
+    }
+    if (this.binary_) {
+      caps.set('firefox_binary', this.binary_);
+    }
+    if (this.profile_) {
+      caps.set('firefox_profile', this.profile_);
+    }
+    return caps;
   }
-  return caps;
-};
+}
 
 
 /**
  * A WebDriver client for Firefox.
- *
- * @param {(Options|webdriver.Capabilities|Object)=} opt_config The
- *    configuration options for this driver, specified as either an
- *    {@link Options} or {@link webdriver.Capabilities}, or as a raw hash
- *    object.
- * @param {webdriver.promise.ControlFlow=} opt_flow The flow to
- *     schedule commands through. Defaults to the active flow object.
- * @constructor
- * @extends {webdriver.WebDriver}
  */
-var Driver = function(opt_config, opt_flow) {
-  var caps;
-  if (opt_config instanceof Options) {
-    caps = opt_config.toCapabilities();
-  } else {
-    caps = new webdriver.Capabilities(opt_config);
-  }
-
-  var binary = caps.get('firefox_binary') || new Binary();
-  if (typeof binary === 'string') {
-    binary = new Binary(binary);
-  }
-
-  var profile = caps.get('firefox_profile') || new Profile();
+class Driver extends webdriver.WebDriver {
+  /**
+   * @param {(Options|capabilities.Capabilities|Object)=} opt_config The
+   *    configuration options for this driver, specified as either an
+   *    {@link Options} or {@link capabilities.Capabilities}, or as a raw hash
+   *    object.
+   * @param {promise.ControlFlow=} opt_flow The flow to
+   *     schedule commands through. Defaults to the active flow object.
+   */
+  constructor(opt_config, opt_flow) {
+    let caps;
+    if (opt_config instanceof Options) {
+      caps = opt_config.toCapabilities();
+    } else {
+      caps = new capabilities.Capabilities(opt_config);
+    }
 
-  caps.set('firefox_binary', null);
-  caps.set('firefox_profile', null);
+    let binary = caps.get('firefox_binary') || new Binary();
+    if (typeof binary === 'string') {
+      binary = new Binary(binary);
+    }
 
-  /** @private {?string} */
-  this.profilePath_ = null;
+    let profile = caps.get('firefox_profile') || new Profile();
 
-  var self = this;
-  var freePort = portprober.findFreePort();
+    caps.set('firefox_binary', null);
+    caps.set('firefox_profile', null);
 
-  /** @private */
-  this.command_ = freePort.then(function(port) {
-    if (typeof profile === 'string') {
-      return decodeProfile(profile).then(function(dir) {
-        var profile = new Profile(dir);
+    let self;  // Cannot assign to 'this' until after we call super.
+    let freePort = portprober.findFreePort();
+    let command = freePort.then(function(port) {
+      if (typeof profile === 'string') {
+        return decodeProfile(profile).then(function(dir) {
+          var profile = new Profile(dir);
+          profile.setPreference('webdriver_firefox_port', port);
+          return profile.writeToDisk();
+        });
+      } else {
         profile.setPreference('webdriver_firefox_port', port);
         return profile.writeToDisk();
-      });
-    } else {
-      profile.setPreference('webdriver_firefox_port', port);
-      return profile.writeToDisk();
-    }
-  }).then(function(profileDir) {
-    self.profilePath_ = profileDir;
-    return binary.launch(profileDir);
-  });
-
-  var serverUrl = this.command_
-      .then(function() { return freePort; })
-      .then(function(port) {
-        var serverUrl = url.format({
-          protocol: 'http',
-          hostname: net.getLoopbackAddress(),
-          port: port,
-          pathname: '/hub'
-        });
+      }
+    }).then(function(profileDir) {
+      self.profilePath_ = profileDir;
+      return binary.launch(profileDir);
+    });
+
+    let serverUrl = command
+        .then(function() { return freePort; })
+        .then(function(/** number */port) {
+          var serverUrl = url.format({
+            protocol: 'http',
+            hostname: net.getLoopbackAddress(),
+            port: port + '',
+            pathname: '/hub'
+          });
 
-        return httpUtil.waitForServer(serverUrl, 45 * 1000).then(function() {
-          return serverUrl;
+          return httpUtil.waitForServer(serverUrl, 45 * 1000).then(function() {
+            return serverUrl;
+          });
         });
-      });
 
-  var executor = executors.createExecutor(serverUrl);
-  var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
+    var executor = executors.createExecutor(serverUrl);
+    var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
 
-  webdriver.WebDriver.call(this, driver.getSession(), executor, opt_flow);
-};
-util.inherits(Driver, webdriver.WebDriver);
+    super(driver.getSession(), executor, opt_flow);
+    self = this;
 
+    /** @private {?string} */
+    this.profilePath_ = null;
 
-/**
- * This function is a no-op as file detectors are not supported by this
- * implementation.
- * @override
- */
-Driver.prototype.setFileDetector = function() {
-};
-
-
-/** @override */
-Driver.prototype.quit = function() {
-  return this.call(function() {
-    var self = this;
-    return Driver.super_.prototype.quit.call(this)
-        .thenFinally(function() {
-          return self.command_.then(function(command) {
-            command.kill();
-            return command.result();
+    /** @private */
+    this.command_ = command;
+  }
+
+  /**
+   * This function is a no-op as file detectors are not supported by this
+   * implementation.
+   * @override
+   */
+  setFileDetector() {
+  }
+
+  /** @override */
+  quit() {
+    // TODO: use super.quit when closure compiler knows how to transpile it.
+    // let superQuit = super.quit;
+    return this.call(function() {
+      let self = this;
+      return webdriver.WebDriver.prototype.quit.call(this)
+          .thenFinally(function() {
+            return self.command_.then(function(command) {
+              command.kill();
+              return command.result();
+            });
+          })
+          .thenFinally(function() {
+            if (self.profilePath_) {
+              return io.rmDir(self.profilePath_);
+            }
           });
-        })
-        .thenFinally(function() {
-          if (self.profilePath_) {
-            return io.rmDir(self.profilePath_);
-          }
-        });
-  }, this);
-};
+    }, this);
+  }
+}
 
 
 // PUBLIC API