selenium-webdriver 2.48.2 → 2.53.3

package/firefox/binary.js

@@ -17,49 +17,56 @@
 
 /**
  * @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;
+
+let foundBinary = null;
+let foundDevBinary = 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.
+ *
+ * @param {boolean=} opt_dev Whether to find the Developer Edition.
+ * @return {!Promise<?string>} A promise for the located executable.
+ *     The promise will resolve to {@code null} if Firefox was not found.
  */
-function defaultWindowsLocation() {
+function defaultWindowsLocation(opt_dev) {
   var files = [
     process.env['PROGRAMFILES'] || 'C:\\Program Files',
     process.env['PROGRAMFILES(X86)'] || 'C:\\Program Files (x86)'
   ].map(function(prefix) {
+    if (opt_dev) {
+      return path.join(prefix, 'Firefox Developer Edition\\firefox.exe');
+    }
     return path.join(prefix, 'Mozilla Firefox\\firefox.exe');
   });
   return io.exists(files[0]).then(function(exists) {
@@ -72,31 +79,47 @@ function defaultWindowsLocation() {
 
 /**
  * Locates the Firefox binary for the current system.
- * @return {!promise.Promise.<string>} A promise for the located binary. The
- *     promise will be rejected if Firefox cannot be located.
+ *
+ * @param {boolean=} opt_dev Whether to find the Developer Edition. This only
+ *     used on Windows and OSX.
+ * @return {!Promise<string>} A promise for the located binary. The promise will
+ *     be rejected if Firefox cannot be located.
  */
-function findFirefox() {
-  if (foundBinary) {
+function findFirefox(opt_dev) {
+  if (opt_dev && foundDevBinary) {
+    return foundDevBinary;
+  }
+
+  if (!opt_dev && foundBinary) {
     return foundBinary;
   }
 
+  let found;
   if (process.platform === 'darwin') {
-    var osxExe =  '/Applications/Firefox.app/Contents/MacOS/firefox-bin';
-    foundBinary = io.exists(osxExe).then(function(exists) {
-      return exists ? osxExe : null;
-    });
+    let exe = opt_dev
+        ? '/Applications/FirefoxDeveloperEdition.app/Contents/MacOS/firefox-bin'
+        : '/Applications/Firefox.app/Contents/MacOS/firefox-bin';
+    found = io.exists(exe).then(exists => exists ? exe : null);
+
   } else if (process.platform === 'win32') {
-    foundBinary = defaultWindowsLocation();
+    found = defaultWindowsLocation(opt_dev);
+
   } else {
-    foundBinary = promise.fulfilled(io.findInPath('firefox'));
+    found = Promise.resolve(io.findInPath('firefox'));
   }
 
-  return foundBinary = foundBinary.then(function(found) {
+  found = found.then(found => {
     if (found) {
       return found;
     }
     throw Error('Could not locate Firefox on the current system');
   });
+
+  if (opt_dev) {
+    return foundDevBinary = found;
+  } else {
+    return foundBinary = found;
+  }
 }
 
 
@@ -136,90 +159,118 @@ 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>}
+ * If created _without_ a path for the Firefox binary to use, this class will
+ * attempt to find Firefox when {@link #launch()} is called. For OSX and
+ * Windows, this class will look for Firefox in the current platform's default
+ * installation location (e.g. /Applications/Firefox.app on OSX). For all other
+ * platforms, the Firefox executable must be available on your system `PATH`.
+ *
+ * @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.
+   */
+  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'
+    });
 
+    /** @private {boolean} */
+    this.devEdition_ = false;
+  }
 
-/**
- * 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]);
+      }
     }
   }
-};
 
+  /**
+   * Specifies whether to use Firefox Developer Edition instead of the normal
+   * stable channel. Setting this option has no effect if this instance was
+   * created with a path to a specific Firefox binary.
+   *
+   * This method has no effect on Unix systems where the Firefox application
+   * has the same (default) name regardless of version.
+   *
+   * @param {boolean=} opt_use Whether to use the developer edition. Defaults to
+   *     true.
+   */
+  useDevEdition(opt_use) {
+    this.devEdition_ = opt_use === undefined || !!opt_use;
+  }
 
-/**
- * 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});
-    });
-  });
-};
+  /**
+   * Returns a promise for the Firefox executable used by this instance. The
+   * returned promise will be immediately resolved if the user supplied an
+   * executable path when this instance was created. Otherwise, an attempt will
+   * be made to find Firefox on the current system.
+   *
+   * @return {!promise.Promise<string>} a promise for the path to the Firefox
+   *     executable used by this instance.
+   */
+  locate() {
+    return promise.fulfilled(this.exe_ || findFirefox(this.devEdition_));
+  }
 
+  /**
+   * 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 this.locate().then(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 this.locate();
+  }
+}
 
 
 // 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);
 
 
 
@@ -86,6 +78,10 @@ function install(extension, dir) {
  */
 var AddonDetails;
 
+/** @typedef {{$: !Object<string, string>}} */
+var RdfRoot;
+
+
 
 /**
  * Extracts the details needed to install an add-on.
@@ -127,7 +123,7 @@ function getDetails(addonPath) {
       throw new AddonFormatError('Malformed manifest for add-on ' + addonPath);
     }
 
-    var namespaces = doc[keys[0]].$;
+    var namespaces = /** @type {!RdfRoot} */(doc[keys[0]]).$;
     var id = '';
     Object.keys(namespaces).some(function(ns) {
       if (namespaces[ns] !== url) {
@@ -147,7 +143,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;