selenium-webdriver 3.1.0 → 3.6.0

package/lib/test/data/key_logger.html

@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Testing Key Events</title>
+    <script type="text/javascript">
+        function appendMessage(message) {
+            document.getElementById('resultParagraph').innerHTML += message + " ";
+        }
+    </script>
+</head>
+<body>
+<div id="resultContainer" height="30">&nbsp;
+  <div id="result" style="width:300;height:60">
+    <p id="resultParagraph">&nbsp;</p>
+  </div>
+</div>
+                                                                                         
+<div>
+  <form action="resultPage.html" id="on-form">
+    <input id="theworks"
+           onfocus="appendMessage('focus')"
+           onkeydown="appendMessage('keydown')"
+           onkeypress="appendMessage('keypress')"
+           onkeyup="appendMessage('keyup')"
+           onblur="appendMessage('blur')"
+           onchange="appendMessage('change')"
+           />
+  </form>
+</div>
+</body>
+</html>
+
+

package/lib/test/data/nestedElements.html

@@ -5,6 +5,15 @@
   <div id="test_id_div">
   	<p id="test_id">inside</p>
   </div>
+  <div id="test_special_chars">
+    <p id="white space">space</p>
+    <p id="css#.chars">css escapes</p>
+  </div>
+  <div id="test_special_chars_2">
+    <p id="white space">second copy for testing plural findElements</p>
+    <p id="css#.chars">second copy</p>
+  </div>
+
 <form method="get" action="resultPage.html" name="form1" style="display: block">
     Here's a checkbox: <input type="checkbox" id="checky" name="checky" value="furrfu"/><br/>
     <select name="selectomatic" id="1">
@@ -152,4 +161,4 @@
   <span class="oneother">But not me</span>
 </div>
 </body>
-</html>
+</html>

package/lib/test/data/scrolling_tests/page_with_partially_hidden_element.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page with partially hidden element</title>
+</head>
+<body>
+  <div style="width:200px; height: 200px; overflow: auto;">
+    <div style="height: 175px; width: 240px;">Placeholder</div>
+    <div>
+      <button type="button" style="height: 40px; box-sizing: border-box" id="btn" onclick="window.location='target_page.html'">Click me!</button>
+    </div>
+  </div>
+</body>
+</html>

package/lib/test/data/single_text_input.html

@@ -0,0 +1,12 @@
+<html>
+<head>
+    <title>BasicKeyboardInterfaceTest</title>
+</head>
+<body>
+<form action="#">
+    <input type="text" id="textInput" />
+</form>
+</body>
+</html>
+
+

package/lib/test/index.js

@@ -31,9 +31,6 @@ var build = require('./build'),
     fileserver = require('./fileserver');
 
 
-const LEGACY_FIREFOX = 'legacy-' + webdriver.Browser.FIREFOX;
-
-
 /**
  * Browsers with native support.
  * @type {!Array.<webdriver.Browser>}
@@ -42,7 +39,6 @@ var NATIVE_BROWSERS = [
   webdriver.Browser.CHROME,
   webdriver.Browser.EDGE,
   webdriver.Browser.FIREFOX,
-  LEGACY_FIREFOX,
   webdriver.Browser.IE,
   webdriver.Browser.OPERA,
   webdriver.Browser.PHANTOM_JS,
@@ -50,10 +46,10 @@ var NATIVE_BROWSERS = [
 ];
 
 
+var noBuild = /^1|true$/i.test(process.env['SELENIUM_NO_BUILD']);
 var serverJar = process.env['SELENIUM_SERVER_JAR'];
 var remoteUrl = process.env['SELENIUM_REMOTE_URL'];
 var useLoopback = process.env['SELENIUM_USE_LOOP_BACK'] == '1';
-var noMarionette = /^0|false$/i.test(process.env['SELENIUM_GECKODRIVER']);
 var startServer = !!serverJar && !remoteUrl;
 var nativeRun = !serverJar && !remoteUrl;
 
@@ -75,9 +71,6 @@ var browsersToTest = (function() {
     if (parts[0] === 'edge') {
       parts[0] = webdriver.Browser.EDGE;
     }
-    if (noMarionette && parts[0] === webdriver.Browser.FIREFOX) {
-      parts[0] = LEGACY_FIREFOX;
-    }
     return parts.join(':');
   });
 
@@ -87,10 +80,6 @@ var browsersToTest = (function() {
       parts[0] = webdriver.Browser.IE;
     }
 
-    if (parts[0] === LEGACY_FIREFOX) {
-      return;
-    }
-
     if (NATIVE_BROWSERS.indexOf(parts[0]) == -1 && !permitRemoteBrowsers) {
       throw Error('Browser ' + parts[0] + ' requires a WebDriver server and ' +
           'neither the SELENIUM_REMOTE_URL nor the SELENIUM_SERVER_JAR ' +
@@ -156,10 +145,6 @@ function TestEnvironment(browserName, server) {
     return server || remoteUrl;
   };
 
-  this.isMarionette = function() {
-    return !noMarionette;
-  };
-
   this.browsers = function(var_args) {
     var browsersToIgnore = Array.prototype.slice.apply(arguments, [0]);
     return browsers(browserName, browsersToIgnore);
@@ -170,15 +155,7 @@ function TestEnvironment(browserName, server) {
     var realBuild = builder.build;
 
     builder.build = function() {
-      var parts = browserName.split(/:/, 3);
-
-      if (parts[0] === LEGACY_FIREFOX) {
-        var options = builder.getFirefoxOptions() || new firefox.Options();
-        options.useGeckoDriver(false);
-        builder.setFirefoxOptions(options);
-
-        parts[0] = webdriver.Browser.FIREFOX;
-      }
+      let parts = browserName.split(/:/, 3);
 
       builder.forBrowser(parts[0], parts[1], parts[2]);
       if (server) {
@@ -225,10 +202,10 @@ function suite(fn, opt_options) {
   try {
 
     before(function() {
-      if (isDevMode) {
+      if (isDevMode && !noBuild) {
         return build.of(
             '//javascript/atoms/fragments:is-displayed',
-            '//javascript/webdriver/atoms:getAttribute')
+            '//javascript/webdriver/atoms:get-attribute')
             .onlyOnce().go();
       }
     });
@@ -243,15 +220,6 @@ function suite(fn, opt_options) {
     browsers.forEach(function(browser) {
       describe('[' + browser + ']', function() {
 
-        if (isDevMode && nativeRun) {
-          if (browser === LEGACY_FIREFOX) {
-            before(function() {
-              return build.of('//javascript/firefox-driver:webdriver')
-                  .onlyOnce().go();
-            });
-          }
-        }
-
         var serverToUse = null;
 
         if (!!serverJar && !remoteUrl) {

package/lib/webdriver.js

@@ -750,20 +750,12 @@ class WebDriver {
    *     commands should execute under, including the initial session creation.
    *     Defaults to the {@link promise.controlFlow() currently active}
    *     control flow.
-   * @param {(function(new: WebDriver,
-   *                   !IThenable<!Session>,
-   *                   !command.Executor,
-   *                   promise.ControlFlow=))=} opt_ctor
-   *    A reference to the constructor of the specific type of WebDriver client
-   *    to instantiate. Will create a vanilla {@linkplain WebDriver} instance
-   *    if a constructor is not provided.
    * @param {(function(this: void): ?)=} opt_onQuit A callback to invoke when
    *    the newly created session is terminated. This should be used to clean
    *    up any resources associated with the session.
    * @return {!WebDriver} The driver for the newly created session.
    */
-  static createSession(
-        executor, capabilities, opt_flow, opt_ctor, opt_onQuit) {
+  static createSession(executor, capabilities, opt_flow, opt_onQuit) {
     let flow = opt_flow || promise.controlFlow();
     let cmd = new command.Command(command.Name.NEW_SESSION);
 
@@ -782,8 +774,7 @@ class WebDriver {
         return Promise.resolve(opt_onQuit.call(void 0)).then(_ => {throw err;});
       });
     }
-    const ctor = opt_ctor || WebDriver;
-    return new ctor(session, executor, flow, opt_onQuit);
+    return new this(session, executor, flow, opt_onQuit);
   }
 
   /** @override */
@@ -1054,13 +1045,15 @@ class WebDriver {
       let cmd = new command.Command(command.Name.FIND_ELEMENTS).
           setParameter('using', locator.using).
           setParameter('value', locator.value);
-      let res = this.schedule(cmd, 'WebDriver.findElements(' + locator + ')');
-      return res.catch(function(e) {
-        if (e instanceof error.NoSuchElementError) {
-          return [];
-        }
-        throw e;
-      });
+      return this.schedule(cmd, 'WebDriver.findElements(' + locator + ')')
+          .then(
+              (res) => Array.isArray(res) ? res : [],
+              (e) =>  {
+                if (e instanceof error.NoSuchElementError) {
+                  return [];
+                }
+                throw e;
+              });
     }
   }
 
@@ -1200,14 +1193,14 @@ class Options {
    * __Sample Usage:__
    *
    *     // Set a basic cookie.
-   *     driver.options().addCookie({name: 'foo', value: 'bar'});
+   *     driver.manage().addCookie({name: 'foo', value: 'bar'});
    *
    *     // Set a cookie that expires in 10 minutes.
    *     let expiry = new Date(Date.now() + (10 * 60 * 1000));
-   *     driver.options().addCookie({name: 'foo', value: 'bar', expiry});
+   *     driver.manage().addCookie({name: 'foo', value: 'bar', expiry});
    *
    *     // The cookie expiration may also be specified in seconds since epoch.
-   *     driver.options().addCookie({
+   *     driver.manage().addCookie({
    *       name: 'foo',
    *       value: 'bar',
    *       expiry: Math.floor(Date.now() / 1000)
@@ -1220,36 +1213,29 @@ class Options {
    *     invalid.
    * @throws {TypeError} if `spec` is not a cookie object.
    */
-  addCookie(spec) {
-    if (!spec || typeof spec !== 'object') {
-      throw TypeError('addCookie called with non-cookie parameter');
-    }
-
+  addCookie({name, value, path, domain, secure, httpOnly, expiry}) {
     // We do not allow '=' or ';' in the name.
-    let name = spec.name;
     if (/[;=]/.test(name)) {
       throw new error.InvalidArgumentError(
           'Invalid cookie name "' + name + '"');
     }
 
     // We do not allow ';' in value.
-    let value = spec.value;
     if (/;/.test(value)) {
       throw new error.InvalidArgumentError(
           'Invalid cookie value "' + value + '"');
     }
 
     let cookieString = name + '=' + value +
-        (spec.domain ? ';domain=' + spec.domain : '') +
-        (spec.path ? ';path=' + spec.path : '') +
-        (spec.secure ? ';secure' : '');
-
-    let expiry;
-    if (typeof spec.expiry === 'number') {
-      expiry = Math.floor(spec.expiry);
-      cookieString += ';expires=' + new Date(spec.expiry * 1000).toUTCString();
-    } else if (spec.expiry instanceof Date) {
-      let date = /** @type {!Date} */(spec.expiry);
+        (domain ? ';domain=' + domain : '') +
+        (path ? ';path=' + path : '') +
+        (secure ? ';secure' : '');
+
+    if (typeof expiry === 'number') {
+      expiry = Math.floor(expiry);
+      cookieString += ';expires=' + new Date(expiry * 1000).toUTCString();
+    } else if (expiry instanceof Date) {
+      let date = /** @type {!Date} */(expiry);
       expiry = Math.floor(date.getTime() / 1000);
       cookieString += ';expires=' + date.toUTCString();
     }
@@ -1259,9 +1245,10 @@ class Options {
             setParameter('cookie', {
               'name': name,
               'value': value,
-              'path': spec.path,
-              'domain': spec.domain,
-              'secure': !!spec.secure,
+              'path': path,
+              'domain': domain,
+              'secure': !!secure,
+              'httpOnly': !!httpOnly,
               'expiry': expiry
             }),
         'WebDriver.manage().addCookie(' + cookieString + ')');
@@ -1326,6 +1313,91 @@ class Options {
     });
   }
 
+  /**
+   * Schedules a command to fetch the timeouts currently configured for the
+   * current session.
+   *
+   * @return {!promise.Thenable<{script: number,
+   *                             pageLoad: number,
+   *                             implicit: number}>} A promise that will be
+   *     resolved with the timeouts currently configured for the current
+   *     session.
+   * @see #setTimeouts()
+   */
+  getTimeouts() {
+    return this.driver_.schedule(
+        new command.Command(command.Name.GET_TIMEOUT),
+        `WebDriver.manage().getTimeouts()`)
+  }
+
+  /**
+   * Schedules a command to set timeout durations associated with the current
+   * session.
+   *
+   * The following timeouts are supported (all timeouts are specified in
+   * milliseconds):
+   *
+   * -  `implicit` specifies the maximum amount of time to wait for an element
+   *    locator to succeed when {@linkplain WebDriver#findElement locating}
+   *    {@linkplain WebDriver#findElements elements} on the page.
+   *    Defaults to 0 milliseconds.
+   *
+   * -  `pageLoad` specifies the maximum amount of time to wait for a page to
+   *    finishing loading. Defaults to 300000 milliseconds.
+   *
+   * -  `script` specifies the maximum amount of time to wait for an
+   *    {@linkplain WebDriver#executeScript evaluated script} to run. If set to
+   *    `null`, the script timeout will be indefinite.
+   *    Defaults to 30000 milliseconds.
+   *
+   * @param {{script: (number|null|undefined),
+   *          pageLoad: (number|null|undefined),
+   *          implicit: (number|null|undefined)}} conf
+   *     The desired timeout configuration.
+   * @return {!promise.Thenable<void>} A promise that will be resolved when the
+   *     timeouts have been set.
+   * @throws {!TypeError} if an invalid options object is provided.
+   * @see #getTimeouts()
+   * @see <https://w3c.github.io/webdriver/webdriver-spec.html#dfn-set-timeouts>
+   */
+  setTimeouts({script, pageLoad, implicit} = {}) {
+    let cmd = new command.Command(command.Name.SET_TIMEOUT);
+
+    let valid = false;
+    function setParam(key, value) {
+      if (value === null || typeof value === 'number') {
+        valid = true;
+        cmd.setParameter(key, value);
+      } else if (typeof value !== 'undefined') {
+        throw TypeError(
+            'invalid timeouts configuration:'
+                + ` expected "${key}" to be a number, got ${typeof value}`);
+      }
+    }
+    setParam('implicit', implicit);
+    setParam('pageLoad', pageLoad);
+    setParam('script', script);
+
+    if (valid) {
+      return this.driver_.schedule(cmd, `WebDriver.manage().setTimeouts()`)
+          .catch(() => {
+            // Fallback to the legacy method.
+            let cmds = [];
+            if (typeof script === 'number') {
+              cmds.push(legacyTimeout(this.driver_, 'script', script));
+            }
+            if (typeof implicit === 'number') {
+              cmds.push(legacyTimeout(this.driver_, 'implicit', implicit));
+            }
+            if (typeof pageLoad === 'number') {
+              cmds.push(legacyTimeout(this.driver_, 'page load', pageLoad));
+            }
+            return Promise.all(cmds);
+          });
+    }
+    throw TypeError('no timeouts specified');
+  }
+
   /**
    * @return {!Logs} The interface for managing driver
    *     logs.
@@ -1336,6 +1408,7 @@ class Options {
 
   /**
    * @return {!Timeouts} The interface for managing driver timeouts.
+   * @deprecated Use {@link #setTimeouts()} instead.
    */
   timeouts() {
     return new Timeouts(this.driver_);
@@ -1350,6 +1423,22 @@ class Options {
 }
 
 
+/**
+ * @param {!WebDriver} driver
+ * @param {string} type
+ * @param {number} ms
+ * @return {!promise.Thenable<void>}
+ */
+function legacyTimeout(driver, type, ms) {
+  return driver.schedule(
+      new command.Command(command.Name.SET_TIMEOUT)
+          .setParameter('type', type)
+          .setParameter('ms', ms),
+      `WebDriver.manage().setTimeouts({${type}: ${ms}})`);
+}
+
+
+
 /**
  * A record object describing a browser cookie.
  *
@@ -1413,8 +1502,7 @@ Options.Cookie.prototype.httpOnly;
  * When the cookie expires.
  *
  * When {@linkplain Options#addCookie() adding a cookie}, this may be specified
- * in _seconds_ since Unix epoch (January 1, 1970). The expiry will default to
- * 20 years in the future if omitted.
+ * as a {@link Date} object, or in _seconds_ since Unix epoch (January 1, 1970).
  *
  * The expiry is always returned in seconds since epoch when
  * {@linkplain Options#getCookies() retrieving cookies} from the browser.
@@ -1432,6 +1520,9 @@ Options.Cookie.prototype.expiry;
  *
  *    webdriver.manage().timeouts()
  *
+ * @deprecated This has been deprecated in favor of
+ *     {@link Options#setTimeouts()}, which supports setting multiple timeouts
+ *     at once.
  * @see WebDriver#manage()
  * @see Options#timeouts()
  */
@@ -1465,9 +1556,11 @@ class Timeouts {
    * @param {number} ms The amount of time to wait, in milliseconds.
    * @return {!promise.Thenable<void>} A promise that will be resolved
    *     when the implicit wait timeout has been set.
+   * @deprecated Use {@link Options#setTimeouts()
+   *     driver.manage().setTimeouts({implicit: ms})}.
    */
   implicitlyWait(ms) {
-    return this._scheduleCommand(ms, 'implicit', 'implicitlyWait');
+    return this.driver_.manage().setTimeouts({implicit: ms});
   }
 
   /**
@@ -1478,9 +1571,11 @@ class Timeouts {
    * @param {number} ms The amount of time to wait, in milliseconds.
    * @return {!promise.Thenable<void>} A promise that will be resolved
    *     when the script timeout has been set.
+   * @deprecated Use {@link Options#setTimeouts()
+   *     driver.manage().setTimeouts({script: ms})}.
    */
   setScriptTimeout(ms) {
-    return this._scheduleCommand(ms, 'script', 'setScriptTimeout');
+    return this.driver_.manage().setTimeouts({script: ms});
   }
 
   /**
@@ -1491,17 +1586,11 @@ class Timeouts {
    * @param {number} ms The amount of time to wait, in milliseconds.
    * @return {!promise.Thenable<void>} A promise that will be resolved
    *     when the timeout has been set.
+   * @deprecated Use {@link Options#setTimeouts()
+   *     driver.manage().setTimeouts({pageLoad: ms})}.
    */
   pageLoadTimeout(ms) {
-    return this._scheduleCommand(ms, 'page load', 'pageLoadTimeout');
-  }
-
-  _scheduleCommand(ms, timeoutIdentifier, timeoutName) {
-    return this.driver_.schedule(
-        new command.Command(command.Name.SET_TIMEOUT).
-            setParameter('type', timeoutIdentifier).
-            setParameter('ms', ms),
-        `WebDriver.manage().timeouts().${timeoutName}(${ms})`);
+    return this.driver_.manage().setTimeouts({pageLoad: ms});
   }
 }
 
@@ -1989,7 +2078,8 @@ class WebElement {
           command.Name.FIND_CHILD_ELEMENTS).
           setParameter('using', locator.using).
           setParameter('value', locator.value);
-      return this.schedule_(cmd, 'WebElement.findElements(' + locator + ')');
+      return this.schedule_(cmd, 'WebElement.findElements(' + locator + ')')
+          .then(result => Array.isArray(result) ? result : []);
     }
   }
 
@@ -2083,6 +2173,7 @@ class WebElement {
     if (!this.driver_.fileDetector_) {
       return this.schedule_(
           new command.Command(command.Name.SEND_KEYS_TO_ELEMENT).
+              setParameter('text', keys.then(keys => keys.join(''))).
               setParameter('value', keys),
           'WebElement.sendKeys()');
     }
@@ -2098,6 +2189,7 @@ class WebElement {
       }).then(function(keys) {
         return element.schedule_(
             new command.Command(command.Name.SEND_KEYS_TO_ELEMENT).
+                setParameter('text', keys).
                 setParameter('value', keys.split('')),
             'WebElement.sendKeys()');
       });

package/net/portprober.js

@@ -191,7 +191,7 @@ function findFreePort(opt_host) {
           } else {
             findPort();
           }
-        });
+        }, findPort);
       }
     });
   });

package/opera.js

@@ -383,7 +383,7 @@ class Driver extends webdriver.WebDriver {
     }
 
     return /** @type {!Driver} */(
-        webdriver.WebDriver.createSession(executor, caps, opt_flow, this));
+        super.createSession(executor, caps, opt_flow));
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "3.1.0",
+  "version": "3.6.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -23,7 +23,7 @@
     "node": ">= 6.9.0"
   },
   "dependencies": {
-    "adm-zip": "^0.4.7",
+    "jszip": "^3.1.3",
     "rimraf": "^2.5.4",
     "tmp": "0.0.30",
     "xml2js": "^0.4.17"

package/phantomjs.js

@@ -217,8 +217,8 @@ class Driver extends webdriver.WebDriver {
     });
 
     var executor = createExecutor(service.start());
-    return /** @type {!Driver} */(webdriver.WebDriver.createSession(
-        executor, caps, opt_flow, this, () => service.kill()));
+    return /** @type {!Driver} */(super.createSession(
+        executor, caps, opt_flow, () => service.kill()));
   }
 
   /**

package/remote/index.js

@@ -17,7 +17,6 @@
 
 'use strict';
 
-const AdmZip = require('adm-zip');
 const fs = require('fs');
 const path = require('path');
 const url = require('url');
@@ -26,6 +25,7 @@ const util = require('util');
 const httpUtil = require('../http/util');
 const io = require('../io');
 const exec = require('../io/exec');
+const {Zip} = require('../io/zip');
 const cmd = require('../lib/command');
 const input = require('../lib/input');
 const promise = require('../lib/promise');
@@ -278,9 +278,10 @@ class DriverService {
     if (!this.address_ || !this.command_) {
       return Promise.resolve(); // Not currently running.
     }
-    return this.command_.then(function(command) {
-      command.kill('SIGTERM');
-    });
+    let cmd = this.command_;
+    this.address_ = null;
+    this.command_ = null;
+    return cmd.then(c => c.kill('SIGTERM'));
   }
 
   /**
@@ -492,7 +493,12 @@ class SeleniumServer extends DriverService {
           return jvmArgs.concat('-jar', jar, '-port', port).concat(args);
         });
 
-    super('java', {
+    let java = 'java';
+    if (process.env['JAVA_HOME']) {
+      java = path.join(process.env['JAVA_HOME'], 'bin/java');
+    }
+
+    super(java, {
       loopback: options.loopback,
       port: port,
       args: args,
@@ -570,15 +576,16 @@ class FileDetector extends input.FileDetector {
         return file;  // Not a valid file, return original input.
       }
 
-      var zip = new AdmZip();
-      zip.addLocalFile(file);
-      // Stored compression, see https://en.wikipedia.org/wiki/Zip_(file_format)
-      zip.getEntries()[0].header.method = 0;
-
-      var command = new cmd.Command(cmd.Name.UPLOAD_FILE)
-          .setParameter('file', zip.toBuffer().toString('base64'));
-      return driver.schedule(command,
-          'remote.FileDetector.handleFile(' + file + ')');
+      let zip = new Zip;
+      return zip.addFile(file)
+          .then(() => zip.toBuffer())
+          .then(buf => buf.toString('base64'))
+          .then(encodedZip => {
+            let command = new cmd.Command(cmd.Name.UPLOAD_FILE)
+                .setParameter('file', encodedZip);
+            return driver.schedule(command,
+                'remote.FileDetector.handleFile(' + file + ')');
+          });
     }, function(err) {
       if (err.code === 'ENOENT') {
         return file;  // Not a file; return original input.

package/safari.js

@@ -250,8 +250,8 @@ class Driver extends webdriver.WebDriver {
     let executor = new http.Executor(
         service.start().then(url => new http.HttpClient(url)));
 
-    return /** @type {!Driver} */(webdriver.WebDriver.createSession(
-        executor, caps, opt_flow, this, () => service.kill()));
+    return /** @type {!Driver} */(super.createSession(
+        executor, caps, opt_flow, () => service.kill()));
   }
 }