selenium-webdriver 2.47.0 → 2.52.0

package/firefox/index.js

@@ -94,217 +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();
 
-  /** @private {!Binary} */
-  this.binary_ = binary;
+    caps.set('firefox_binary', null);
+    caps.set('firefox_profile', null);
 
-  var self = this;
-  var serverUrl = portprober.findFreePort().then(function(port) {
-    var prepareProfile;
-    if (typeof profile === 'string') {
-      prepareProfile = 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);
-      prepareProfile = profile.writeToDisk();
-    }
-
-    return prepareProfile.then(function(dir) {
-      self.profilePath_ = dir;
-      return binary.launch(dir);
-    }).then(function() {
-      var serverUrl = url.format({
-        protocol: 'http',
-        hostname: net.getLoopbackAddress(),
-        port: port,
-        pathname: '/hub'
-      });
-
-      return httpUtil.waitForServer(serverUrl, 45 * 1000).then(function() {
-        return serverUrl;
-      });
+      }
+    }).then(function(profileDir) {
+      self.profilePath_ = profileDir;
+      return binary.launch(profileDir);
     });
-  });
 
-  var executor = executors.createExecutor(serverUrl);
-  var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
+    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;
+          });
+        });
 
-  webdriver.WebDriver.call(this, driver.getSession(), executor, opt_flow);
-};
-util.inherits(Driver, webdriver.WebDriver);
+    var executor = executors.createExecutor(serverUrl);
+    var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
 
+    super(driver.getSession(), executor, opt_flow);
+    self = this;
 
-/**
- * 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.binary_.kill();
-        })
-        .thenFinally(function() {
-          if (self.profilePath_) {
-            return io.rmDir(self.profilePath_);
-          }
-        });
-  }, this);
-};
+    /** @private {?string} */
+    this.profilePath_ = null;
+
+    /** @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_);
+            }
+          });
+    }, this);
+  }
+}
 
 
 // PUBLIC API