selenium-webdriver 2.48.2 → 2.52.0

package/safari.js

@@ -26,37 +26,47 @@
 
 'use strict';
 
-var events = require('events');
-var fs = require('fs');
-var http = require('http');
-var path = require('path');
-var url = require('url');
-var util = require('util');
-var ws = require('ws');
-
-var webdriver = require('./');
-var promise = webdriver.promise;
-var _base = require('./_base');
-var io = require('./io');
-var exec = require('./io/exec');
-var portprober = require('./net/portprober');
+const events = require('events');
+const fs = require('fs');
+const http = require('http');
+const path = require('path');
+const url = require('url');
+const util = require('util');
+const ws = require('ws');
+
+const io = require('./io');
+const exec = require('./io/exec');
+const isDevMode = require('./lib/devmode');
+const Capabilities = require('./lib/capabilities').Capabilities;
+const Capability = require('./lib/capabilities').Capability;
+const command = require('./lib/command');
+const promise = require('./lib/promise');
+const Symbols = require('./lib/symbols');
+const webdriver = require('./lib/webdriver');
+const portprober = require('./net/portprober');
 
 
 /** @const */
-var CLIENT_PATH = _base.isDevMode()
+const CLIENT_PATH = isDevMode
     ? path.join(__dirname,
         '../../../build/javascript/safari-driver/client.js')
     : path.join(__dirname, 'lib/safari/client.js');
 
 
 /** @const */
-var LIBRARY_DIR = process.platform === 'darwin'
-    ? path.join('/Users', process.env['USER'], 'Library/Safari')
-    : path.join(process.env['APPDATA'], 'Apple Computer', 'Safari');
+const LIBRARY_DIR = (function() {
+  if (process.platform === 'darwin') {
+    return path.join('/Users', process.env['USER'], 'Library/Safari');
+  } else if (process.platform === 'win32') {
+    return path.join(process.env['APPDATA'], 'Apple Computer', 'Safari');
+  } else {
+    return '/dev/null';
+  }
+})();
 
 
 /** @const */
-var SESSION_DATA_FILES = (function() {
+const SESSION_DATA_FILES = (function() {
   if (process.platform === 'darwin') {
     var libraryDir = path.join('/Users', process.env['USER'], 'Library');
     return [
@@ -95,97 +105,95 @@ var Host;
 /**
  * A basic HTTP/WebSocket server used to communicate with the SafariDriver
  * browser extension.
- * @constructor
- * @extends {events.EventEmitter}
  */
-var Server = function() {
-  events.EventEmitter.call(this);
-
-  var server = http.createServer(function(req, res) {
-    if (req.url === '/favicon.ico') {
-      res.writeHead(204);
-      res.end();
-      return;
-    }
-
-    var query = url.parse(req.url).query || '';
-    if (query.indexOf('url=') == -1) {
-      var address = server.address()
-      var host = address.address + ':' + address.port;
-      res.writeHead(302, {'Location': 'http://' + host + '?url=ws://' + host});
-      res.end();
-    }
-
-    fs.readFile(CLIENT_PATH, 'utf8', function(err, data) {
-      if (err) {
-        res.writeHead(500, {'Content-Type': 'text/plain'});
-        res.end(err.stack);
+class Server extends events.EventEmitter {
+  constructor() {
+    super();
+    var server = http.createServer(function(req, res) {
+      if (req.url === '/favicon.ico') {
+        res.writeHead(204);
+        res.end();
         return;
       }
-      var content = '<!DOCTYPE html><body><script>' + data + '</script>';
-      res.writeHead(200, {
-        'Content-Type': 'text/html; charset=utf-8',
-        'Content-Length': Buffer.byteLength(content, 'utf8'),
-      });
-      res.end(content);
-    });
-  });
-
-  var wss = new ws.Server({server: server});
-  wss.on('connection', this.emit.bind(this, 'connection'));
 
-  /**
-   * Starts the server on a random port.
-   * @return {!webdriver.promise.Promise<Host>} A promise that will resolve
-   *     with the server host when it has fully started.
-   */
-  this.start = function() {
-    if (server.address()) {
-      return promise.fulfilled(server.address());
-    }
-    return portprober.findFreePort('localhost').then(function(port) {
-      return promise.checkedNodeCall(
-          server.listen.bind(server, port, 'localhost'));
-    }).then(function() {
-      return server.address();
-    });
-  };
+      var query = url.parse(/** @type {string} */(req.url)).query || '';
+      if (query.indexOf('url=') == -1) {
+        var address = server.address()
+        var host = address.address + ':' + address.port;
+        res.writeHead(
+            302, {'Location': 'http://' + host + '?url=ws://' + host});
+        res.end();
+      }
 
-  /**
-   * Stops the server.
-   * @return {!webdriver.promise.Promise} A promise that will resolve when the
-   *     server has closed all connections.
-   */
-  this.stop = function() {
-    return new promise.Promise(function(fulfill) {
-      server.close(fulfill);
+      fs.readFile(CLIENT_PATH, 'utf8', function(err, data) {
+        if (err) {
+          res.writeHead(500, {'Content-Type': 'text/plain'});
+          res.end(err.stack);
+          return;
+        }
+        var content = '<!DOCTYPE html><body><script>' + data + '</script>';
+        res.writeHead(200, {
+          'Content-Type': 'text/html; charset=utf-8',
+          'Content-Length': Buffer.byteLength(content, 'utf8'),
+        });
+        res.end(content);
+      });
     });
-  };
 
-  /**
-   * @return {Host} This server's host info.
-   * @throws {Error} If the server is not running.
-   */
-  this.address = function() {
-    var addr = server.address();
-    if (!addr) {
-      throw Error('There server is not running!');
-    }
-    return addr;
-  };
-};
-util.inherits(Server, events.EventEmitter);
+    var wss = new ws.Server({server: server});
+    wss.on('connection', this.emit.bind(this, 'connection'));
+
+    /**
+     * Starts the server on a random port.
+     * @return {!promise.Promise<Host>} A promise that will resolve
+     *     with the server host when it has fully started.
+     */
+    this.start = function() {
+      if (server.address()) {
+        return promise.fulfilled(server.address());
+      }
+      return portprober.findFreePort('localhost').then(function(port) {
+        return promise.checkedNodeCall(
+            server.listen.bind(server, port, 'localhost'));
+      }).then(function() {
+        return server.address();
+      });
+    };
+
+    /**
+     * Stops the server.
+     * @return {!promise.Promise} A promise that will resolve when
+     *     the server has closed all connections.
+     */
+    this.stop = function() {
+      return new promise.Promise(function(fulfill) {
+        server.close(fulfill);
+      });
+    };
+
+    /**
+     * @return {Host} This server's host info.
+     * @throws {Error} If the server is not running.
+     */
+    this.address = function() {
+      var addr = server.address();
+      if (!addr) {
+        throw Error('There server is not running!');
+      }
+      return addr;
+    };
+  }
+}
 
 
 /**
- * @return {!promise.Promise<string>} A promise that will resolve with the path
+ * @return {!Promise<string>} A promise that will resolve with the path
  *     to Safari on the current system.
  */
 function findSafariExecutable() {
   switch (process.platform) {
     case 'darwin':
-      return promise.fulfilled(
-          '/Applications/Safari.app/Contents/MacOS/Safari');
+      return Promise.resolve('/Applications/Safari.app/Contents/MacOS/Safari');
 
     case 'win32':
       var files = [
@@ -204,7 +212,7 @@ function findSafariExecutable() {
       });
 
     default:
-      return promise.rejected(
+      return Promise.reject(
           Error('Safari is not supported on the current platform: ' +
               process.platform));
   }
@@ -212,16 +220,15 @@ function findSafariExecutable() {
 
 
 /**
- * @param {string} url The URL to connect to.
- * @return {!promise.Promise<string>} A promise for the path to a file that
- *     Safari can open on start-up to trigger a new connection to the WebSocket
- *     server.
+ * @param {string} serverUrl The URL to connect to.
+ * @return {!Promise<string>} A promise for the path to a file that Safari can
+ *     open on start-up to trigger a new connection to the WebSocket server.
  */
-function createConnectFile(url) {
+function createConnectFile(serverUrl) {
   return io.tmpFile({postfix: '.html'}).then(function(f) {
     var writeFile =  promise.checkedNodeCall(fs.writeFile,
         f,
-        '<!DOCTYPE html><script>window.location = "' + url + '";</script>',
+        '<!DOCTYPE html><script>window.location = "' + serverUrl + '";</script>',
         {encoding: 'utf8'});
     return writeFile.then(function() {
       return f;
@@ -252,53 +259,69 @@ function cleanSession(desiredCapabilities) {
 }
 
 
+/** @return {string} . */
+function getRandomString() {
+  let seed = Date.now();
+  return Math.floor(Math.random() * seed).toString(36)
+      + Math.abs(Math.floor(Math.random() * seed) ^ Date.now()).toString(36);
+}
+
+
 /**
- * @constructor
- * @implements {webdriver.CommandExecutor}
+ * @implements {command.Executor}
  */
-var CommandExecutor = function() {
-  /** @private {Server} */
-  this.server_ = null;
-
-  /** @private {ws.WebSocket} */
-  this.socket_ = null;
-
-  /** @private {promise.Promise.<!exec.Command>} */
-  this.safari_ = null;
-};
-
-
-/** @override */
-CommandExecutor.prototype.execute = function(command, callback) {
-  var safariCommand = JSON.stringify({
-    'origin': 'webdriver',
-    'type': 'command',
-    'command': {
-      'id': _base.require('goog.string').getRandomString(),
-      'name': command.getName(),
-      'parameters': command.getParameters()
-    }
-  });
-  var self = this;
+class CommandExecutor {
+  constructor() {
+    this.server_ = null;
 
-  switch (command.getName()) {
-    case webdriver.CommandName.NEW_SESSION:
-      this.startSafari_(command).then(sendCommand, callback);
-      break;
+    /** @private {ws.WebSocket} */
+    this.socket_ = null;
 
-    case webdriver.CommandName.QUIT:
-      this.destroySession_().then(function() {
-        callback(null, _base.require('bot.response').createResponse(null));
-      }, callback);
-      break;
+    /** @private {promise.Promise.<!exec.Command>} */
+    this.safari_ = null;
+  }
 
-    default:
-      sendCommand();
-      break;
+  /** @override */
+  execute(cmd) {
+    var self = this;
+    return new promise.Promise(function(fulfill, reject) {
+      var safariCommand = JSON.stringify({
+        'origin': 'webdriver',
+        'type': 'command',
+        'command': {
+          'id': getRandomString(),
+          'name': cmd.getName(),
+          'parameters': cmd.getParameters()
+        }
+      });
+
+      switch (cmd.getName()) {
+        case command.Name.NEW_SESSION:
+          self.startSafari_(cmd)
+              .then(() => self.sendCommand_(safariCommand))
+              .then(fulfill, reject);
+          break;
+
+        case command.Name.QUIT:
+          self.destroySession_()
+              .then(() => fulfill({status: 0, value: null}), reject);
+          break;
+
+        default:
+          self.sendCommand_(safariCommand).then(fulfill, reject);
+          break;
+      }
+    });
   }
 
-  function sendCommand() {
-    new promise.Promise(function(fulfill, reject) {
+  /**
+   * @param {string} data .
+   * @return {!promise.Promise} .
+   * @private
+   */
+  sendCommand_(data) {
+    let self = this;
+    return new promise.Promise(function(fulfill, reject) {
       // TODO: support reconnecting with the extension.
       if (!self.socket_) {
         self.destroySession_().thenFinally(function() {
@@ -307,7 +330,7 @@ CommandExecutor.prototype.execute = function(command, callback) {
         return;
       }
 
-      self.socket_.send(safariCommand, function(err) {
+      self.socket_.send(data, function(err) {
         if (err) {
           reject(err);
           return;
@@ -323,212 +346,198 @@ CommandExecutor.prototype.execute = function(command, callback) {
         }
         fulfill(data['response']);
       });
-
-    }).then(function(value) {
-      callback(null, value);
-    }, callback);
+    });
   }
-};
 
+  /**
+   * @param {!command.Command} command .
+   * @private
+   */
+  startSafari_(command) {
+    this.server_ = new Server();
+
+    this.safari_ = this.server_.start().then(function(address) {
+      var tasks = cleanSession(
+          /** @type {!Object} */(
+                command.getParameters()['desiredCapabilities']));
+      tasks.push(
+        findSafariExecutable(),
+        createConnectFile(
+            'http://' + address.address + ':' + address.port));
+      return promise.all(tasks).then(function(tasks) {
+        var exe = tasks[tasks.length - 2];
+        var html = tasks[tasks.length - 1];
+        return exec(exe, {args: [html]});
+      });
+    });
 
-/**
- * @param {!webdriver.Command} command .
- * @private
- */
-CommandExecutor.prototype.startSafari_ = function(command) {
-  this.server_ = new Server();
-
-  this.safari_ = this.server_.start().then(function(address) {
-    var tasks = cleanSession(command.getParameters()['desiredCapabilities']);
-    tasks.push(
-      findSafariExecutable(),
-      createConnectFile(
-          'http://' + address.address + ':' + address.port));
-    return promise.all(tasks).then(function(tasks) {
-      var exe = tasks[tasks.length - 2];
-      var html = tasks[tasks.length - 1];
-      return exec(exe, {args: [html]});
+    var connected = promise.defer();
+    var self = this;
+    var start = Date.now();
+    var timer = setTimeout(function() {
+      connected.reject(Error(
+        'Failed to connect to the SafariDriver after ' + (Date.now() - start) +
+        ' ms; Have you installed the latest extension from ' +
+        'http://selenium-release.storage.googleapis.com/index.html?'));
+    }, 10 * 1000);
+    this.server_.once('connection', function(socket) {
+      clearTimeout(timer);
+      self.socket_ = socket;
+      socket.once('close', function() {
+        self.socket_ = null;
+      });
+      connected.fulfill();
     });
-  });
+    return connected.promise;
+  }
 
-  var connected = promise.defer();
-  var self = this;
-  var start = Date.now();
-  var timer = setTimeout(function() {
-    connected.reject(Error(
-      'Failed to connect to the SafariDriver after ' + (Date.now() - start) +
-      ' ms; Have you installed the latest extension from ' +
-      'http://selenium-release.storage.googleapis.com/index.html?'));
-  }, 10 * 1000);
-  this.server_.once('connection', function(socket) {
-    clearTimeout(timer);
-    self.socket_ = socket;
-    socket.once('close', function() {
+  /**
+   * Destroys the active session by stopping the WebSocket server and killing the
+   * Safari subprocess.
+   * @private
+   */
+  destroySession_() {
+    var tasks = [];
+    if (this.server_) {
+      tasks.push(this.server_.stop());
+    }
+    if (this.safari_) {
+      tasks.push(this.safari_.then(function(safari) {
+        safari.kill();
+        return safari.result();
+      }));
+    }
+    var self = this;
+    return promise.all(tasks).thenFinally(function() {
+      self.server_ = null;
       self.socket_ = null;
+      self.safari_ = null;
     });
-    connected.fulfill();
-  });
-  return connected.promise;
-};
-
-
-/**
- * Destroys the active session by stopping the WebSocket server and killing the
- * Safari subprocess.
- * @private
- */
-CommandExecutor.prototype.destroySession_ = function() {
-  var tasks = [];
-  if (this.server_) {
-    tasks.push(this.server_.stop());
-  }
-  if (this.safari_) {
-    tasks.push(this.safari_.then(function(safari) {
-      safari.kill();
-      return safari.result();
-    }));
   }
-  var self = this;
-  return promise.all(tasks).thenFinally(function() {
-    self.server_ = null;
-    self.socket_ = null;
-    self.safari_ = null;
-  });
-};
+}
+
 
 
 /** @const */
-var OPTIONS_CAPABILITY_KEY = 'safari.options';
+const OPTIONS_CAPABILITY_KEY = 'safari.options';
 
 
 
 /**
  * Configuration options specific to the {@link Driver SafariDriver}.
- * @constructor
- * @extends {webdriver.Serializable}
  */
-var Options = function() {
-  webdriver.Serializable.call(this);
+class Options {
+  constructor() {
+    /** @private {Object<string, *>} */
+    this.options_ = null;
 
-  /** @private {Object<string, *>} */
-  this.options_ = null;
+    /** @private {./lib/logging.Preferences} */
+    this.logPrefs_ = null;
+  }
 
-  /** @private {webdriver.logging.Preferences} */
-  this.logPrefs_ = null;
-};
-util.inherits(Options, webdriver.Serializable);
+  /**
+   * Extracts the SafariDriver specific options from the given capabilities
+   * object.
+   * @param {!Capabilities} capabilities The capabilities object.
+   * @return {!Options} The ChromeDriver options.
+   */
+  static fromCapabilities(capabilities) {
+    var options = new Options();
+
+    var o = capabilities.get(OPTIONS_CAPABILITY_KEY);
+    if (o instanceof Options) {
+      options = o;
+    } else if (o) {
+      options.setCleanSession(o.cleanSession);
+    }
 
+    if (capabilities.has(Capability.LOGGING_PREFS)) {
+      options.setLoggingPrefs(capabilities.get(Capability.LOGGING_PREFS));
+    }
 
-/**
- * Extracts the SafariDriver specific options from the given capabilities
- * object.
- * @param {!webdriver.Capabilities} capabilities The capabilities object.
- * @return {!Options} The ChromeDriver options.
- */
-Options.fromCapabilities = function(capabilities) {
-  var options = new Options();
-
-  var o = capabilities.get(OPTIONS_CAPABILITY_KEY);
-  if (o instanceof Options) {
-    options = o;
-  } else if (o) {
-    options.setCleanSession(o.cleanSession);
+    return options;
   }
 
-  if (capabilities.has(webdriver.Capability.LOGGING_PREFS)) {
-    options.setLoggingPrefs(
-        capabilities.get(webdriver.Capability.LOGGING_PREFS));
+  /**
+   * Sets whether to force Safari to start with a clean session. Enabling this
+   * option will cause all global browser data to be deleted.
+   * @param {boolean} clean Whether to make sure the session has no cookies,
+   *     cache entries, local storage, or databases.
+   * @return {!Options} A self reference.
+   */
+  setCleanSession(clean) {
+    if (!this.options_) {
+      this.options_ = {};
+    }
+    this.options_['cleanSession'] = clean;
+    return this;
   }
 
-  return options;
-};
-
-
-/**
- * Sets whether to force Safari to start with a clean session. Enabling this
- * option will cause all global browser data to be deleted.
- * @param {boolean} clean Whether to make sure the session has no cookies,
- *     cache entries, local storage, or databases.
- * @return {!Options} A self reference.
- */
-Options.prototype.setCleanSession = function(clean) {
-  if (!this.options_) {
-    this.options_ = {};
+  /**
+   * Sets the logging preferences for the new session.
+   * @param {!./lib/logging.Preferences} prefs The logging preferences.
+   * @return {!Options} A self reference.
+   */
+  setLoggingPrefs(prefs) {
+    this.logPrefs_ = prefs;
+    return this;
   }
-  this.options_['cleanSession'] = clean;
-  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.setLoggingPrefs = function(prefs) {
-  this.logPrefs_ = prefs;
-  return this;
-};
-
 
-/**
- * Converts this options instance to a {@link webdriver.Capabilities} object.
- * @param {webdriver.Capabilities=} opt_capabilities The capabilities to merge
- *     these options into, if any.
- * @return {!webdriver.Capabilities} The capabilities.
- */
-Options.prototype.toCapabilities = function(opt_capabilities) {
-  var capabilities = opt_capabilities || webdriver.Capabilities.safari();
-  if (this.logPrefs_) {
-    capabilities.set(webdriver.Capability.LOGGING_PREFS, this.logPrefs_);
-  }
-  if (this.options_) {
-    capabilities.set(OPTIONS_CAPABILITY_KEY, this);
+  /**
+   * Converts this options instance to a {@link Capabilities} object.
+   * @param {Capabilities=} opt_capabilities The capabilities to
+   *     merge these options into, if any.
+   * @return {!Capabilities} The capabilities.
+   */
+  toCapabilities(opt_capabilities) {
+    var caps = opt_capabilities || Capabilities.safari();
+    if (this.logPrefs_) {
+      caps.set(Capability.LOGGING_PREFS, this.logPrefs_);
+    }
+    if (this.options_) {
+      caps.set(OPTIONS_CAPABILITY_KEY, this);
+    }
+    return caps;
   }
-  return capabilities;
-};
-
-
-/**
- * Converts this instance to its JSON wire protocol representation. Note this
- * function is an implementation detail not intended for general use.
- * @return {!Object<string, *>} The JSON wire protocol representation of this
- *     instance.
- * @override
- */
-Options.prototype.serialize = function() {
-  return this.options_ || {};
-};
 
+  /**
+   * Converts this instance to its JSON wire protocol representation. Note this
+   * function is an implementation detail not intended for general use.
+   * @return {!Object<string, *>} The JSON wire protocol representation of this
+   *     instance.
+   */
+  [Symbols.serialize]() {
+    return this.options_ || {};
+  }
+}
 
 
 /**
  * A WebDriver client for Safari. This class should never be instantiated
- * directly; instead, use the {@link selenium-webdriver.Builder}:
+ * directly; instead, use the {@linkplain ./builder.Builder Builder}:
  *
  *     var driver = new Builder()
  *         .forBrowser('safari')
  *         .build();
  *
- * @param {(Options|webdriver.Capabilities)=} opt_config The configuration
- *     options for the new session.
- * @param {webdriver.promise.ControlFlow=} opt_flow The control flow to create
- *     the driver under.
- * @constructor
- * @extends {webdriver.WebDriver}
  */
-var Driver = function(opt_config, opt_flow) {
-  var executor = new CommandExecutor();
-  var capabilities =
-      opt_config instanceof Options ? opt_config.toCapabilities() :
-      (opt_config || webdriver.Capabilities.safari());
-
-  var driver = webdriver.WebDriver.createSession(
-      executor, capabilities, opt_flow);
-  webdriver.WebDriver.call(
-      this, driver.getSession(), executor, driver.controlFlow());
-};
-util.inherits(Driver, webdriver.WebDriver);
+class Driver extends webdriver.WebDriver {
+  /**
+   * @param {(Options|Capabilities)=} opt_config The configuration
+   *     options for the new session.
+   * @param {promise.ControlFlow=} opt_flow The control flow to create
+   *     the driver under.
+   */
+  constructor(opt_config, opt_flow) {
+    var executor = new CommandExecutor();
+    var caps =
+        opt_config instanceof Options ? opt_config.toCapabilities() :
+        (opt_config || Capabilities.safari());
+
+    var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
+    super(driver.getSession(), executor, driver.controlFlow());
+  }
+}
 
 
 // Public API