selenium-webdriver 2.47.0 → 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 = [
@@ -133,119 +133,85 @@ function installNoFocusLibs(profileDir) {
 
 
 /**
- * Manages a Firefox subprocess configured for use with WebDriver.
+ * 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';
-
-  /** @private {promise.Promise.<!exec.Command>} */
-  this.command_ = null;
-};
-util.inherits(Binary, Serializable);
-
-
-/**
- * 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]);
-    }
+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'
+    });
   }
-};
-
 
-/**
- * Launches Firefox and eturns a promise that will be fulfilled when the process
- * terminates.
- * @param {string} profile Path to the profile directory to use.
- * @return {!promise.Promise.<!exec.Result>} A promise for the process result.
- * @throws {Error} If this instance has already been started.
- */
-Binary.prototype.launch = function(profile) {
-  if (this.command_) {
-    throw Error('Firefox is already running');
+  /**
+   * 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]);
+      }
+    }
   }
 
-  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_);
-
-  this.command_ = 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});
+      });
     });
-  });
-
-  return this.command_.then(function() {
-    // Don't return the actual command handle, just a promise to signal it has
-    // been started.
-  });
-};
-
-
-/**
- * Kills the managed Firefox process.
- * @return {!promise.Promise} A promise for when the process has terminated.
- */
-Binary.prototype.kill = function() {
-  if (!this.command_) {
-    return promise.defer();  // Not running.
   }
-  return this.command_.then(function(command) {
-    command.kill();
-    return command.result();
-  });
-};
 
-
-/**
- * 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);
 
 
 
@@ -69,7 +61,6 @@ function install(extension, dir) {
         return io.copy(extension, dst + '.xpi').then(returnId);
       } else {
         return checkedCall(fs.readFile, extension).then(function(buff) {
-          var zip = new AdmZip(buff);
           // TODO: find an async library for inflating a zip archive.
           new AdmZip(buff).extractAllTo(dst, true);
         }).then(returnId);
@@ -148,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;