selenium-webdriver 3.5.0 → 3.6.0

package/lib/error.js

@@ -51,11 +51,27 @@ class ElementNotSelectableError extends WebDriverError {
 }
 
 
+/**
+ * Indicates a command could not be completed because the target element is
+ * not pointer or keyboard interactable. This will often occur if an element
+ * is present in the DOM, but not rendered (i.e. its CSS style has
+ * "display: none").
+ */
+class ElementNotInteractableError extends WebDriverError {
+  /** @param {string=} opt_error the error message, if any. */
+  constructor(opt_error) {
+    super(opt_error);
+  }
+}
+
+
 /**
  * An element command could not be completed because the element is not visible
  * on the page.
+ *
+ * @deprecated Use {@link ElementNotInteractable} instead.
  */
-class ElementNotVisibleError extends WebDriverError {
+class ElementNotVisibleError extends ElementNotInteractableError {
   /** @param {string=} opt_error the error message, if any. */
   constructor(opt_error) {
     super(opt_error);
@@ -400,6 +416,7 @@ const LEGACY_ERROR_CODE_TO_TYPE = new Map([
 
 const ERROR_CODE_TO_TYPE = new Map([
     ['unknown error', WebDriverError],
+    ['element not interactable', ElementNotInteractableError],
     ['element not selectable', ElementNotSelectableError],
     ['element not visible', ElementNotVisibleError],
     ['invalid argument', InvalidArgumentError],
@@ -547,6 +564,7 @@ module.exports = {
   ErrorCode: ErrorCode,
 
   WebDriverError: WebDriverError,
+  ElementNotInteractableError: ElementNotInteractableError,
   ElementNotSelectableError: ElementNotSelectableError,
   ElementNotVisibleError: ElementNotVisibleError,
   InvalidArgumentError: InvalidArgumentError,

package/lib/http.js

@@ -35,7 +35,7 @@ const WebElement = require('./webdriver').WebElement;
 const {getAttribute, isDisplayed} = /** @suppress {undefinedVars|uselessCode} */(function() {
   try {
     return {
-      getAttribute: require('./atoms/getAttribute.js'),
+      getAttribute: require('./atoms/get-attribute.js'),
       isDisplayed: require('./atoms/is-displayed.js')
     };
   } catch (ex) {

package/lib/promise.js

@@ -33,13 +33,12 @@
  * > style tests:
  * >
  * > ```js
- * > const {Builder, By, promise, until} = require('selenium-webdriver');
+ * > const {Builder, By, Key, promise, until} = require('selenium-webdriver');
  * >
  * > let result = promise.consume(function* doGoogleSearch() {
  * >   let driver = new Builder().forBrowser('firefox').build();
  * >   yield driver.get('http://www.google.com/ncr');
- * >   yield driver.findElement(By.name('q')).sendKeys('webdriver');
- * >   yield driver.findElement(By.name('btnG')).click();
+ * >   yield driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
  * >   yield driver.wait(until.titleIs('webdriver - Google Search'), 1000);
  * >   yield driver.quit();
  * > });
@@ -63,8 +62,7 @@
  * control flow, allowing users to write
  *
  *     driver.get('http://www.google.com/ncr');
- *     driver.findElement({name: 'q'}).sendKeys('webdriver');
- *     driver.findElement({name: 'btnGn'}).click();
+ *     driver.findElement({name: 'q'}).sendKeys('webdriver', Key.RETURN);
  *
  * instead of
  *
@@ -73,13 +71,7 @@
  *       return driver.findElement({name: 'q'});
  *     })
  *     .then(function(q) {
- *       return q.sendKeys('webdriver');
- *     })
- *     .then(function() {
- *       return driver.findElement({name: 'btnG'});
- *     })
- *     .then(function(btnG) {
- *       return btnG.click();
+ *       return q.sendKeys('webdriver', Key.RETURN);
  *     });
  *
  * ## Tasks and Task Queues

package/lib/test/data/content-editable.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Testing content editable</title>
+</head>
+<body>
+  <div id="editable" contenteditable="true">
+    Why <span>hello</span></div>
+</body>
+</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/index.js

@@ -205,7 +205,7 @@ function suite(fn, opt_options) {
       if (isDevMode && !noBuild) {
         return build.of(
             '//javascript/atoms/fragments:is-displayed',
-            '//javascript/webdriver/atoms:getAttribute')
+            '//javascript/webdriver/atoms:get-attribute')
             .onlyOnce().go();
       }
     });

package/lib/webdriver.js

@@ -1045,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;
+              });
     }
   }
 
@@ -1191,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)
@@ -1211,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();
     }
@@ -1250,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 + ')');
@@ -1506,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.
@@ -2083,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 : []);
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [

package/remote/index.js

@@ -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'));
   }
 
   /**

package/test/firefox/firefox_test.js

@@ -52,6 +52,17 @@ test.suite(function(env) {
         }
       });
 
+      /**
+       * @param {...string} extensions the extensions to install.
+       * @return {!firefox.Profile} a new profile.
+       */
+      function profileWithExtensions(...extensions) {
+        let profile = new firefox.Profile();
+        profile.setPreference('xpinstall.signatures.required', false);
+        extensions.forEach(ext => profile.addExtension(ext));
+        return profile;
+      }
+
       /**
        * Runs a test that requires Firefox Developer Edition. The test will be
        * skipped if dev cannot be found on the current system.
@@ -99,9 +110,7 @@ test.suite(function(env) {
       });
 
       test.it('can start Firefox with a jetpack extension', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(JETPACK_EXTENSION);
-
+        let profile = profileWithExtensions(JETPACK_EXTENSION);
         let options = new firefox.Options().setProfile(profile);
 
         return runWithFirefoxDev(options, function*() {
@@ -115,9 +124,7 @@ test.suite(function(env) {
       });
 
       test.it('can start Firefox with a normal extension', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(NORMAL_EXTENSION);
-
+        let profile = profileWithExtensions(NORMAL_EXTENSION);
         let options = new firefox.Options().setProfile(profile);
 
         return runWithFirefoxDev(options, function*() {
@@ -131,9 +138,7 @@ test.suite(function(env) {
       });
 
       test.it('can start Firefox with a webextension extension', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(WEBEXTENSION_EXTENSION);
-
+        let profile = profileWithExtensions(WEBEXTENSION_EXTENSION);
         let options = new firefox.Options().setProfile(profile);
 
         return runWithFirefoxDev(options, function*() {
@@ -147,10 +152,8 @@ test.suite(function(env) {
       });
 
       test.it('can start Firefox with multiple extensions', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(JETPACK_EXTENSION);
-        profile.addExtension(NORMAL_EXTENSION);
-
+        let profile =
+            profileWithExtensions(JETPACK_EXTENSION, NORMAL_EXTENSION);
         let options = new firefox.Options().setProfile(profile);
 
         return runWithFirefoxDev(options, function*() {
@@ -168,26 +171,6 @@ test.suite(function(env) {
         });
       });
 
-      test.it('can be used alongside preset capabilities', function*() {
-        let binary = yield firefox.Channel.AURORA.locate();
-
-        let profile = new firefox.Profile();
-        profile.addExtension(JETPACK_EXTENSION);
-        profile.setPreference('general.useragent.override', 'foo;bar');
-
-        driver = yield env.builder()
-            .withCapabilities({'moz:firefoxOptions': {binary}})
-            .setFirefoxOptions(new firefox.Options().setProfile(profile))
-            .build();
-
-        yield loadJetpackPage(driver,
-            'data:text/html;charset=UTF-8,<html><div>content</div></html>');
-
-        let text =
-            yield driver.findElement({id: 'jetpack-sample-banner'}).getText();
-        assert(text).equalTo('Hello, world!');
-      });
-
       function loadJetpackPage(driver, url) {
         // On linux the jetpack extension does not always run the first time
         // we load a page. If this happens, just reload the page (a simple

package/test/lib/error_test.js

@@ -38,6 +38,7 @@ describe('error', function() {
     });
 
     test('unknown error', error.WebDriverError);
+    test('element not interactable', error.ElementNotInteractableError);
     test('element not selectable', error.ElementNotSelectableError);
     test('element not visible', error.ElementNotVisibleError);
     test('invalid argument', error.InvalidArgumentError);

package/testing/index.js

@@ -41,7 +41,7 @@
  * The provided wrappers leverage the {@link webdriver.promise.ControlFlow}
  * to simplify writing asynchronous tests:
  *
- *     var {Builder, By, until} = require('selenium-webdriver');
+ *     var {Builder, By, Key, until} = require('selenium-webdriver');
  *     var test = require('selenium-webdriver/testing');
  *
  *     test.describe('Google Search', function() {
@@ -57,8 +57,7 @@
  *
  *       test.it('should append query to title', function() {
  *         driver.get('http://www.google.com/ncr');
- *         driver.findElement(By.name('q')).sendKeys('webdriver');
- *         driver.findElement(By.name('btnG')).click();
+ *         driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
  *         driver.wait(until.titleIs('webdriver - Google Search'), 1000);
  *       });
  *     });

package/lib/firefox/webdriver.json

@@ -1,70 +0,0 @@
-{
-  "frozen": {
-    "app.update.auto": false,
-    "app.update.enabled": false,
-    "browser.displayedE10SNotice": 4,
-    "browser.download.manager.showWhenStarting": false,
-    "browser.EULA.override": true,
-    "browser.EULA.3.accepted": true,
-    "browser.link.open_external": 2,
-    "browser.link.open_newwindow": 2,
-    "browser.offline": false,
-    "browser.reader.detectedFirstArticle": true,
-    "browser.safebrowsing.enabled": false,
-    "browser.safebrowsing.malware.enabled": false,
-    "browser.search.update": false,
-    "browser.selfsupport.url" : "",
-    "browser.sessionstore.resume_from_crash": false,
-    "browser.shell.checkDefaultBrowser": false,
-    "browser.tabs.warnOnClose": false,
-    "browser.tabs.warnOnOpen": false,
-    "datareporting.healthreport.service.enabled": false,
-    "datareporting.healthreport.uploadEnabled": false,
-    "datareporting.healthreport.service.firstRun": false,
-    "datareporting.healthreport.logging.consoleEnabled": false,
-    "datareporting.policy.dataSubmissionEnabled": false,
-    "datareporting.policy.dataSubmissionPolicyAccepted": false,
-    "devtools.errorconsole.enabled": true,
-    "dom.disable_open_during_load": false,
-    "extensions.autoDisableScopes": 10,
-    "extensions.blocklist.enabled": false,
-    "extensions.checkCompatibility.nightly": false,
-    "extensions.logging.enabled": true,
-    "extensions.update.enabled": false,
-    "extensions.update.notifyUser": false,
-    "javascript.enabled": true,
-    "network.manage-offline-status": false,
-    "network.http.phishy-userpass-length": 255,
-    "offline-apps.allow_by_default": true,
-    "prompts.tab_modal.enabled": false,
-    "security.fileuri.origin_policy": 3,
-    "security.fileuri.strict_origin_policy": false,
-    "signon.rememberSignons": false,
-    "toolkit.networkmanager.disable": true,
-    "toolkit.telemetry.prompted": 2,
-    "toolkit.telemetry.enabled": false,
-    "toolkit.telemetry.rejected": true,
-    "xpinstall.signatures.required": false,
-    "xpinstall.whitelist.required": false
-  },
-  "mutable": {
-    "browser.dom.window.dump.enabled": true,
-    "browser.laterrun.enabled": false,
-    "browser.newtab.url": "about:blank",
-    "browser.newtabpage.enabled": false,
-    "browser.startup.page": 0,
-    "browser.startup.homepage": "about:blank",
-    "browser.startup.homepage_override.mstone": "ignore",
-    "browser.usedOnWindows10.introURL": "about:blank",
-    "dom.max_chrome_script_run_time": 30,
-    "dom.max_script_run_time": 30,
-    "dom.report_all_js_exceptions": true,
-    "javascript.options.showInConsole": true,
-    "network.captive-portal-service.enabled": false,
-    "security.csp.enable": false,
-    "startup.homepage_welcome_url": "about:blank",
-    "startup.homepage_welcome_url.additional": "about:blank",
-    "webdriver_accept_untrusted_certs": true,
-    "webdriver_assume_untrusted_issuer": true
-  }
-}