selenium-webdriver 2.48.2 → 2.53.3

package/firefox/profile.js

@@ -22,33 +22,31 @@
 
 'use strict';
 
-var AdmZip = require('adm-zip'),
-    AdmConstants = require('adm-zip/util/constants'),
+const AdmZip = require('adm-zip'),
     fs = require('fs'),
     path = require('path'),
-    util = require('util'),
     vm = require('vm');
 
-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'),
     extension = require('./extension');
 
 
 /** @const */
-var WEBDRIVER_PREFERENCES_PATH = _base.isDevMode()
+const WEBDRIVER_PREFERENCES_PATH = isDevMode
     ? path.join(__dirname, '../../../firefox-driver/webdriver.json')
     : path.join(__dirname, '../lib/firefox/webdriver.json');
 
 /** @const */
-var WEBDRIVER_EXTENSION_PATH = _base.isDevMode()
+const WEBDRIVER_EXTENSION_PATH = isDevMode
     ? path.join(__dirname,
         '../../../../build/javascript/firefox-driver/webdriver.xpi')
     : path.join(__dirname, '../lib/firefox/webdriver.xpi');
 
 /** @const */
-var WEBDRIVER_EXTENSION_NAME = 'fxdriver@googlecode.com';
+const WEBDRIVER_EXTENSION_NAME = 'fxdriver@googlecode.com';
 
 
 
@@ -61,8 +59,9 @@ var defaultPreferences = null;
  */
 function getDefaultPreferences() {
   if (!defaultPreferences) {
-    var contents = fs.readFileSync(WEBDRIVER_PREFERENCES_PATH, 'utf8');
-    defaultPreferences = JSON.parse(contents);
+    var contents = /** @type {string} */(
+        fs.readFileSync(WEBDRIVER_PREFERENCES_PATH, 'utf8'));
+    defaultPreferences = /** @type {!Object} */(JSON.parse(contents));
   }
   return defaultPreferences;
 }
@@ -71,7 +70,7 @@ function getDefaultPreferences() {
 /**
  * Parses a user.js file in a Firefox profile directory.
  * @param {string} f Path to the file to parse.
- * @return {!promise.Promise.<!Object>} A promise for the parsed preferences as
+ * @return {!promise.Promise<!Object>} A promise for the parsed preferences as
  *     a JSON object. If the file does not exist, an empty object will be
  *     returned.
  */
@@ -95,38 +94,27 @@ function loadUserPrefs(f) {
       }
     });
 
-    vm.runInContext(contents, context, f);
+    vm.runInContext(/** @type {string} */(contents), context, f);
     done.fulfill(prefs);
   });
   return done.promise;
 }
 
 
-/**
- * Copies the properties of one object into another.
- * @param {!Object} a The destination object.
- * @param {!Object} b The source object to apply as a mixin.
- */
-function mixin(a, b) {
-  Object.keys(b).forEach(function(key) {
-    a[key] = b[key];
-  });
-}
-
 
 /**
- * @param {!Object} defaults The default preferences to write. Will be
+ * @param {!Object} prefs The default preferences to write. Will be
  *     overridden by user.js preferences in the template directory and the
  *     frozen preferences required by WebDriver.
  * @param {string} dir Path to the directory write the file to.
- * @return {!promise.Promise.<string>} A promise for the profile directory,
+ * @return {!promise.Promise<string>} A promise for the profile directory,
  *     to be fulfilled when user preferences have been written.
  */
 function writeUserPrefs(prefs, dir) {
   var userPrefs = path.join(dir, 'user.js');
   return loadUserPrefs(userPrefs).then(function(overrides) {
-    mixin(prefs, overrides);
-    mixin(prefs, getDefaultPreferences()['frozen']);
+    Object.assign(prefs, overrides);
+    Object.assign(prefs, getDefaultPreferences()['frozen']);
 
     var contents = Object.keys(prefs).map(function(key) {
       return 'user_pref(' + JSON.stringify(key) + ', ' +
@@ -151,54 +139,48 @@ function writeUserPrefs(prefs, dir) {
  * @param {string} dir The profile directory to install to.
  * @param {boolean=} opt_excludeWebDriverExt Whether to skip installation of
  *     the default WebDriver extension.
- * @return {!promise.Promise.<string>} A promise for the main profile directory
+ * @return {!Promise<string>} A promise for the main profile directory
  *     once all extensions have been installed.
  */
 function installExtensions(extensions, dir, opt_excludeWebDriverExt) {
   var hasWebDriver = !!opt_excludeWebDriverExt;
   var next = 0;
   var extensionDir = path.join(dir, 'extensions');
-  var done = promise.defer();
-
-  return io.exists(extensionDir).then(function(exists) {
-    if (!exists) {
-      return promise.checkedNodeCall(fs.mkdir, extensionDir);
-    }
-  }).then(function() {
-    installNext();
-    return done.promise;
-  });
-
-  function installNext() {
-    if (!done.isPending()) {
-      return;
-    }
 
-    if (next >= extensions.length) {
-      if (hasWebDriver) {
-        done.fulfill(dir);
+  return new Promise(function(fulfill, reject) {
+    io.exists(extensionDir).then(function(exists) {
+      if (!exists) {
+        return promise.checkedNodeCall(fs.mkdir, extensionDir);
+      }
+    }).then(installNext);
+
+    function installNext() {
+      if (next >= extensions.length) {
+        if (hasWebDriver) {
+          fulfill(dir);
+        } else {
+          install(WEBDRIVER_EXTENSION_PATH);
+        }
       } else {
-        install(WEBDRIVER_EXTENSION_PATH);
+        install(extensions[next++]);
       }
-    } else {
-      install(extensions[next++]);
     }
-  }
 
-  function install(ext) {
-    extension.install(ext, extensionDir).then(function(id) {
-      hasWebDriver = hasWebDriver || (id === WEBDRIVER_EXTENSION_NAME);
-      installNext();
-    }, done.reject);
- }
+    function install(ext) {
+      extension.install(ext, extensionDir).then(function(id) {
+        hasWebDriver = hasWebDriver || (id === WEBDRIVER_EXTENSION_NAME);
+        installNext();
+      }, reject);
+    }
+  });
 }
 
 
 /**
  * Decodes a base64 encoded profile.
  * @param {string} data The base64 encoded string.
- * @return {!promise.Promise.<string>} A promise for the path to the decoded
- *     profile directory.
+ * @return {!Promise<string>} A promise for the path to the decoded profile
+ *     directory.
  */
 function decode(data) {
   return io.tmpFile().then(function(file) {
@@ -216,213 +198,211 @@ function decode(data) {
 
 
 /**
- * Models a Firefox proifle directory for use with the FirefoxDriver. The
- * {@code Proifle} directory uses an in-memory model until {@link #writeToDisk}
+ * Models a Firefox profile directory for use with the FirefoxDriver. The
+ * {@code Profile} directory uses an in-memory model until {@link #writeToDisk}
  * is called.
- * @param {string=} opt_dir Path to an existing Firefox profile directory to
- *     use a template for this profile. If not specified, a blank profile will
- *     be used.
- * @constructor
- * @extends {Serializable.<string>}
  */
-var Profile = function(opt_dir) {
-  Serializable.call(this);
-
-  /** @private {!Object} */
-  this.preferences_ = {};
-
-  mixin(this.preferences_, getDefaultPreferences()['mutable']);
-  mixin(this.preferences_, getDefaultPreferences()['frozen']);
-
-  /** @private {boolean} */
-  this.nativeEventsEnabled_ = true;
-
-  /** @private {(string|undefined)} */
-  this.template_ = opt_dir;
-
-  /** @private {number} */
-  this.port_ = 0;
-
-  /** @private {!Array.<string>} */
-  this.extensions_ = [];
-};
-util.inherits(Profile, Serializable);
-
-
-/**
- * Registers an extension to be included with this profile.
- * @param {string} extension Path to the extension to include, as either an
- *     unpacked extension directory or the path to a xpi file.
- */
-Profile.prototype.addExtension = function(extension) {
-  this.extensions_.push(extension);
-};
-
-
-/**
- * Sets a desired preference for this profile.
- * @param {string} key The preference key.
- * @param {(string|number|boolean)} value The preference value.
- * @throws {Error} If attempting to set a frozen preference.
- */
-Profile.prototype.setPreference = function(key, value) {
-  var frozen = getDefaultPreferences()['frozen'];
-  if (frozen.hasOwnProperty(key) && frozen[key] !== value) {
-    throw Error('You may not set ' + key + '=' + JSON.stringify(value)
-        + '; value is frozen for proper WebDriver functionality ('
-        + key + '=' + JSON.stringify(frozen[key]) + ')');
+class Profile {
+  /**
+   * @param {string=} opt_dir Path to an existing Firefox profile directory to
+   *     use a template for this profile. If not specified, a blank profile will
+   *     be used.
+   */
+  constructor(opt_dir) {
+    /** @private {!Object} */
+    this.preferences_ = {};
+
+    Object.assign(this.preferences_, getDefaultPreferences()['mutable']);
+    Object.assign(this.preferences_, getDefaultPreferences()['frozen']);
+
+    /** @private {boolean} */
+    this.nativeEventsEnabled_ = true;
+
+    /** @private {(string|undefined)} */
+    this.template_ = opt_dir;
+
+    /** @private {number} */
+    this.port_ = 0;
+
+    /** @private {!Array<string>} */
+    this.extensions_ = [];
   }
-  this.preferences_[key] = value;
-};
-
-
-/**
- * Returns the currently configured value of a profile preference. This does
- * not include any defaults defined in the profile's template directory user.js
- * file (if a template were specified on construction).
- * @param {string} key The desired preference.
- * @return {(string|number|boolean|undefined)} The current value of the
- *     requested preference.
- */
-Profile.prototype.getPreference = function(key) {
-  return this.preferences_[key];
-};
 
+  /**
+   * Registers an extension to be included with this profile.
+   * @param {string} extension Path to the extension to include, as either an
+   *     unpacked extension directory or the path to a xpi file.
+   */
+  addExtension(extension) {
+    this.extensions_.push(extension);
+  }
 
-/**
- * @return {number} The port this profile is currently configured to use, or
- *     0 if the port will be selected at random when the profile is written
- *     to disk.
- */
-Profile.prototype.getPort = function() {
-  return this.port_;
-};
-
-
-/**
- * Sets the port to use for the WebDriver extension loaded by this profile.
- * @param {number} port The desired port, or 0 to use any free port.
- */
-Profile.prototype.setPort = function(port) {
-  this.port_ = port;
-};
-
-
-/**
- * @return {boolean} Whether the FirefoxDriver is configured to automatically
- *     accept untrusted SSL certificates.
- */
-Profile.prototype.acceptUntrustedCerts = function() {
-  return !!this.preferences_['webdriver_accept_untrusted_certs'];
-};
-
-
-/**
- * Sets whether the FirefoxDriver should automatically accept untrusted SSL
- * certificates.
- * @param {boolean} value .
- */
-Profile.prototype.setAcceptUntrustedCerts = function(value) {
-  this.preferences_['webdriver_accept_untrusted_certs'] = !!value;
-};
-
+  /**
+   * Sets a desired preference for this profile.
+   * @param {string} key The preference key.
+   * @param {(string|number|boolean)} value The preference value.
+   * @throws {Error} If attempting to set a frozen preference.
+   */
+  setPreference(key, value) {
+    var frozen = getDefaultPreferences()['frozen'];
+    if (frozen.hasOwnProperty(key) && frozen[key] !== value) {
+      throw Error('You may not set ' + key + '=' + JSON.stringify(value)
+          + '; value is frozen for proper WebDriver functionality ('
+          + key + '=' + JSON.stringify(frozen[key]) + ')');
+    }
+    this.preferences_[key] = value;
+  }
 
-/**
- * Sets whether to assume untrusted certificates come from untrusted issuers.
- * @param {boolean} value .
- */
-Profile.prototype.setAssumeUntrustedCertIssuer = function(value) {
-  this.preferences_['webdriver_assume_untrusted_issuer'] = !!value;
-};
+  /**
+   * Returns the currently configured value of a profile preference. This does
+   * not include any defaults defined in the profile's template directory user.js
+   * file (if a template were specified on construction).
+   * @param {string} key The desired preference.
+   * @return {(string|number|boolean|undefined)} The current value of the
+   *     requested preference.
+   */
+  getPreference(key) {
+    return this.preferences_[key];
+  }
 
+  /**
+   * Specifies which host the driver should listen for commands on. If not
+   * specified, the driver will default to "localhost". This option should be
+   * specified when "localhost" is not mapped to the loopback address
+   * (127.0.0.1) in `/etc/hosts`.
+   *
+   * @param {string} host the host the driver should listen for commands on
+   */
+  setHost(host) {
+    this.preferences_['webdriver_firefox_allowed_hosts'] = host;
+  }
 
-/**
- * @return {boolean} Whether to assume untrusted certs come from untrusted
- *     issuers.
- */
-Profile.prototype.assumeUntrustedCertIssuer = function() {
-  return !!this.preferences_['webdriver_assume_untrusted_issuer'];
-};
+  /**
+   * @return {number} The port this profile is currently configured to use, or
+   *     0 if the port will be selected at random when the profile is written
+   *     to disk.
+   */
+  getPort() {
+    return this.port_;
+  }
 
+  /**
+   * Sets the port to use for the WebDriver extension loaded by this profile.
+   * @param {number} port The desired port, or 0 to use any free port.
+   */
+  setPort(port) {
+    this.port_ = port;
+  }
 
-/**
- * Sets whether to use native events with this profile.
- * @param {boolean} enabled .
- */
-Profile.prototype.setNativeEventsEnabled = function(enabled) {
-  this.nativeEventsEnabled_ = enabled;
-};
+  /**
+   * @return {boolean} Whether the FirefoxDriver is configured to automatically
+   *     accept untrusted SSL certificates.
+   */
+  acceptUntrustedCerts() {
+    return !!this.preferences_['webdriver_accept_untrusted_certs'];
+  }
 
+  /**
+   * Sets whether the FirefoxDriver should automatically accept untrusted SSL
+   * certificates.
+   * @param {boolean} value .
+   */
+  setAcceptUntrustedCerts(value) {
+    this.preferences_['webdriver_accept_untrusted_certs'] = !!value;
+  }
 
-/**
- * Returns whether native events are enabled in this profile.
- * @return {boolean} .
- */
-Profile.prototype.nativeEventsEnabled = function() {
-  return this.nativeEventsEnabled_;
-};
+  /**
+   * Sets whether to assume untrusted certificates come from untrusted issuers.
+   * @param {boolean} value .
+   */
+  setAssumeUntrustedCertIssuer(value) {
+    this.preferences_['webdriver_assume_untrusted_issuer'] = !!value;
+  }
 
+  /**
+   * @return {boolean} Whether to assume untrusted certs come from untrusted
+   *     issuers.
+   */
+  assumeUntrustedCertIssuer() {
+    return !!this.preferences_['webdriver_assume_untrusted_issuer'];
+  }
 
-/**
- * Writes this profile to disk.
- * @param {boolean=} opt_excludeWebDriverExt Whether to exclude the WebDriver
- *     extension from the generated profile. Used to reduce the size of an
- *     {@link #encode() encoded profile} since the server will always install
- *     the extension itself.
- * @return {!promise.Promise.<string>} A promise for the path to the new
- *     profile directory.
- */
-Profile.prototype.writeToDisk = function(opt_excludeWebDriverExt) {
-  var profileDir = io.tmpDir();
-  if (this.template_) {
-    profileDir = profileDir.then(function(dir) {
-      return io.copyDir(
-          this.template_, dir, /(parent\.lock|lock|\.parentlock)/);
-    }.bind(this));
+  /**
+   * Sets whether to use native events with this profile.
+   * @param {boolean} enabled .
+   */
+  setNativeEventsEnabled(enabled) {
+    this.nativeEventsEnabled_ = enabled;
   }
 
-  // Freeze preferences for async operations.
-  var prefs = {};
-  mixin(prefs, this.preferences_);
+  /**
+   * Returns whether native events are enabled in this profile.
+   * @return {boolean} .
+   */
+  nativeEventsEnabled() {
+    return this.nativeEventsEnabled_;
+  }
 
-  // Freeze extensions for async operations.
-  var extensions = this.extensions_.concat();
+  /**
+   * Writes this profile to disk.
+   * @param {boolean=} opt_excludeWebDriverExt Whether to exclude the WebDriver
+   *     extension from the generated profile. Used to reduce the size of an
+   *     {@link #encode() encoded profile} since the server will always install
+   *     the extension itself.
+   * @return {!Promise<string>} A promise for the path to the new profile
+   *     directory.
+   */
+  writeToDisk(opt_excludeWebDriverExt) {
+    var profileDir = io.tmpDir();
+    if (this.template_) {
+      profileDir = profileDir.then(function(dir) {
+        return io.copyDir(
+            /** @type {string} */(this.template_),
+            dir, /(parent\.lock|lock|\.parentlock)/);
+      }.bind(this));
+    }
 
-  return profileDir.then(function(dir) {
-    return writeUserPrefs(prefs, dir);
-  }).then(function(dir) {
-    return installExtensions(extensions, dir, !!opt_excludeWebDriverExt);
-  });
-};
+    // Freeze preferences for async operations.
+    var prefs = {};
+    Object.assign(prefs, this.preferences_);
 
+    // Freeze extensions for async operations.
+    var extensions = this.extensions_.concat();
 
-/**
- * Encodes this profile as a zipped, base64 encoded directory.
- * @return {!promise.Promise.<string>} A promise for the encoded profile.
- */
-Profile.prototype.encode = function() {
-  return this.writeToDisk(true).then(function(dir) {
-    var zip = new AdmZip();
-    zip.addLocalFolder(dir, '');
-    zip.getEntries()[0].header.method = AdmConstants.STORED;
-    return io.tmpFile().then(function(file) {
-      zip.writeZip(file);  // Sync! Why oh why :-(
-      return promise.checkedNodeCall(fs.readFile, file);
+    return profileDir.then(function(dir) {
+      return writeUserPrefs(prefs, dir);
+    }).then(function(dir) {
+      return installExtensions(extensions, dir, !!opt_excludeWebDriverExt);
     });
-  }).then(function(data) {
-    return new Buffer(data).toString('base64');
-  });
-};
+  }
 
+  /**
+   * Encodes this profile as a zipped, base64 encoded directory.
+   * @return {!Promise<string>} A promise for the encoded profile.
+   */
+  encode() {
+    return this.writeToDisk(true).then(function(dir) {
+      var zip = new AdmZip();
+      zip.addLocalFolder(dir, '');
+      // Stored compression, see https://en.wikipedia.org/wiki/Zip_(file_format)
+      zip.getEntries()[0].header.method = 0;
+      return io.tmpFile().then(function(file) {
+        zip.writeZip(file);  // Sync! Why oh why :-(
+        return promise.checkedNodeCall(fs.readFile, file);
+      });
+    }).then(function(data) {
+      return new Buffer(data).toString('base64');
+    });
+  }
 
-/**
- * Encodes this profile as a zipped, base64 encoded directory.
- * @return {!promise.Promise.<string>} A promise for the encoded profile.
- * @override
- */
-Profile.prototype.serialize = function() {
-  return this.encode();
-};
+  /**
+   * Encodes this profile as a zipped, base64 encoded directory.
+   * @return {!Promise<string>} A promise for the encoded profile.
+   */
+  [Symbols.serialize]() {
+    return this.encode();
+  }
+}
 
 
 // PUBLIC API