selenium-webdriver 3.5.0 → 3.6.0

package/CHANGES.md

@@ -1,3 +1,42 @@
+## v3.6.0
+
+### Bug Fixes
+
+* The Capabilities factory methods should only specify the name of the browser.
+* Protect against the remote end sometimes not returning a list to findElements
+  commands.
+* Properly reset state in `remote.DriverService#kill()`
+* The firefox module will no longer apply the preferences required by the legacy
+  FirefoxDriver. These preferences were only required when using the legacy
+  driver, support for which was dropped in v3.5.0.
+
+### API Changes
+
+* Added new methods to `selenium-webdriver/firefox.Options`:
+  - addArguments()
+  - headless()
+  - windowSize()
+* Deprecated `selenium-webdriver/firefox/binary.Binary`
+* Removed `selenium-webdriver/firefox.Options#useGeckoDriver()`
+* Removed the unused `selenium-webdriver/firefox/profile.decode()`
+* Removed methods from `selenium-webdriver/firefox/profile.Profile` that had
+  no effect since support for the legacy FirefoxDriver was dropped in 3.5.0:
+  - setNativeEventsEnabled
+  - nativeEventsEnabled
+  - getPort
+  - setPort
+* Removed `selenium-webdriver/firefox.ServiceBuilder#setFirefoxBinary()`; custom
+  binaries should be configured through the `firefox.Options` class.
+* Removed `selenium-webdriver/firefox.Capability`. These hold overs from the
+  legacy FirefoxDriver are no longer supported.
+
+### Changes for W3C WebDriver Spec Compliance
+
+* Deprecated `error.ElementNotVisibleError` in favor of the more generic
+  `error.ElementNotInteractableError`.
+* Support the `httpOnly` option when adding a cookie.
+
+
 ## v3.5.0
 
 ### Notice

package/README.md

@@ -33,17 +33,14 @@ Automation in the Develop menu of Safari 10 before testing.
 The sample below and others are included in the `example` directory. You may
 also find the tests for selenium-webdriver informative.
 
-    var webdriver = require('selenium-webdriver'),
-        By = webdriver.By,
-        until = webdriver.until;
+    const {Builder, By, Key, until} = require('selenium-webdriver');
 
-    var driver = new webdriver.Builder()
+    let driver = new Builder()
         .forBrowser('firefox')
         .build();
 
     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);
     driver.quit();
 

package/example/async_await_test.js

@@ -34,7 +34,7 @@
 'use strict';
 
 const assert = require('assert');
-const {Builder, By, promise, until} = require('..');
+const {Builder, By, Key, promise, until} = require('..');
 
 // async/await do not work well when the promise manager is enabled.
 // See https://github.com/SeleniumHQ/selenium/issues/3037
@@ -57,12 +57,13 @@ describe('Google Search', function() {
   it('example', async function() {
     await driver.get('https://www.google.com/ncr');
 
-    await driver.findElement(By.name('q')).sendKeys('webdriver');
-    await driver.findElement(By.name('btnG')).click();
+    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
 
     await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
 
     let url = await driver.getCurrentUrl();
-    assert.equal(url, 'https://www.google.com/#q=webdriver');
+    assert.ok(
+        url.startsWith('https://www.google.com/search'),
+        'unexpected url: ' + url);
   });
 });

package/example/chrome_android.js

@@ -23,7 +23,7 @@
 
 'use strict';
 
-const {Builder, By, promise, until} = require('..');
+const {Builder, By, Key, promise, until} = require('..');
 const {Options} = require('../chrome');
 
 promise.consume(function* () {
@@ -34,8 +34,7 @@ promise.consume(function* () {
         .setChromeOptions(new Options().androidChrome())
         .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);
   } finally {
     yield driver && driver.quit();

package/example/chrome_mobile_emulation.js

@@ -22,7 +22,7 @@
 
 'use strict';
 
-const {Builder, By, promise, until} = require('..');
+const {Builder, By, Key, promise, until} = require('..');
 const {Options} = require('../chrome');
 
 promise.consume(function* () {
@@ -34,8 +34,7 @@ promise.consume(function* () {
             new Options().setMobileEmulation({deviceName: 'Nexus 5X'}))
         .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);
   } finally {
     yield driver && driver.quit();

package/example/firefox_channels.js

@@ -27,7 +27,7 @@
 
 'use strict';
 
-const {Builder, By, promise, until} = require('..');
+const {Builder, By, Key, promise, until} = require('..');
 const {Channel, Options} = require('../firefox');
 
 let i = 0;
@@ -45,8 +45,8 @@ function doSearch(driver) {
     .then(_ => promise.delayed(750))
     // Now do the rest.
     .then(_ => driver.get('http://www.google.com/ncr'))
-    .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-    .then(_ => driver.findElement(By.name('btnG')).click())
+    .then(_ =>
+        driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
     .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
     .then(_ => driver.quit());
 }

package/example/google_search.js

@@ -37,14 +37,14 @@
  *     node selenium-webdriver/example/google_search.js
  */
 
-const {Builder, By, until} = require('..');
+const {Builder, By, Key, until} = require('..');
 
 var driver = new Builder()
     .forBrowser('firefox')
     .build();
 
 driver.get('http://www.google.com/ncr')
-    .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-    .then(_ => driver.findElement(By.name('btnG')).click())
+    .then(_ =>
+        driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
     .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
     .then(_ => driver.quit());

package/example/google_search_generator.js

@@ -28,7 +28,7 @@
 
 'use strict';
 
-const {Builder, By, promise, until} = require('..');
+const {Builder, By, Key, promise, until} = require('..');
 
 promise.consume(function* () {
   let driver;
@@ -38,10 +38,7 @@ promise.consume(function* () {
     yield driver.get('http://www.google.com/ncr');
 
     let q = yield driver.findElement(By.name('q'));
-    yield q.sendKeys('webdriver');
-
-    let btnG = yield driver.findElement(By.name('btnG'));
-    yield btnG.click();
+    yield q.sendKeys('webdriver', Key.RETURN);
 
     yield driver.wait(until.titleIs('webdriver - Google Search'), 1000);
   } finally {

package/example/google_search_test.js

@@ -29,7 +29,7 @@
  *         mocha -t 10000 selenium-webdriver/example/google_search_test.js
  */
 
-const {Builder, By, until} = require('..');
+const {Builder, By, Key, until} = require('..');
 const test = require('../testing');
 
 test.describe('Google Search', function() {
@@ -42,8 +42,8 @@ test.describe('Google Search', function() {
   // You can write tests either using traditional promises.
   it('works with promises', function() {
     return driver.get('http://www.google.com/ncr')
-        .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-        .then(_ => driver.findElement(By.name('btnG')).click())
+        .then(_ =>
+            driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
         .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000));
   });
 
@@ -52,8 +52,7 @@ test.describe('Google Search', function() {
   // generator.
   test.it('works with generators', function*() {
     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);
   });
 

package/example/{chrome_headless.js → headless.js}

@@ -16,18 +16,24 @@
 // under the License.
 
 /**
- * @fileoverview An example of running Chrome in headless mode.
+ * @fileoverview An example of running Chrome or Firefox in headless mode.
  *
- * Before running this script, ensure you have Chrome 59+ installed and that
+ * To run with Chrome, ensure you have Chrome 59+ installed and that
  * chromedriver 2.30+ is present on your system PATH:
  * <https://sites.google.com/a/chromium.org/chromedriver/downloads>
  *
- * Usage:
- *   node selenium-webdriver/example/chrome_headless.js
+ *     SELENIUM_BROWSER=chrome node selenium-webdriver/example/headless.js
+ *
+ * To run with Firefox, ensure you have Firefox 57+ installed and that
+ * geckodriver 0.19.0+ is present on your system PATH:
+ * <https://github.com/mozilla/geckodriver/releases>
+ *
+ *     SELENIUM_BROWSER=firefox node selenium-webdriver/example/headless.js
  */
 
 const chrome = require('../chrome');
-const {Builder, By, until} = require('..');
+const firefox = require('../firefox');
+const {Builder, By, Key, until} = require('..');
 
 const width = 640;
 const height = 480;
@@ -36,11 +42,13 @@ let driver = new Builder()
     .forBrowser('chrome')
     .setChromeOptions(
         new chrome.Options().headless().windowSize({width, height}))
+    .setFirefoxOptions(
+        new firefox.Options().headless().windowSize({width, height}))
     .build();
 
 driver.get('http://www.google.com/ncr')
-    .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-    .then(_ => driver.findElement(By.name('btnG')).click())
+    .then(_ =>
+        driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
     .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
     .then(
         _ => driver.quit(),

package/example/logging.js

@@ -21,7 +21,7 @@
 
 'use strict';
 
-const {Builder, By, logging, until} = require('..');
+const {Builder, By, Key, logging, until} = require('..');
 
 logging.installConsoleHandler();
 logging.getLogger('webdriver.http').setLevel(logging.Level.ALL);
@@ -29,7 +29,7 @@ logging.getLogger('webdriver.http').setLevel(logging.Level.ALL);
 var driver = new Builder().forBrowser('firefox').build();
 
 driver.get('http://www.google.com/ncr')
-    .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-    .then(_ => driver.findElement(By.name('btnG')).click())
+    .then(_ =>
+        driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
     .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
     .then(_ => driver.quit());

package/example/parallel_flows.js

@@ -23,18 +23,16 @@
  * (see <https://github.com/SeleniumHQ/selenium/issues/2969>).
  */
 
-var webdriver = require('..'),
-    By = webdriver.By,
-    until = webdriver.until;
+const {Builder, By, Key, promise, until} = require('..');
 
 for (var i = 0; i < 3; i++) {
   (function(n) {
-    var flow = new webdriver.promise.ControlFlow()
+    var flow = new promise.ControlFlow()
         .on('uncaughtException', function(e) {
           console.log('uncaughtException in flow %d: %s', n, e);
         });
 
-    var driver = new webdriver.Builder().
+    var driver = new Builder().
         forBrowser('firefox').
         setControlFlow(flow).  // Comment out this line to see the difference.
         build();
@@ -44,8 +42,7 @@ for (var i = 0; i < 3; i++) {
     driver.manage().window().setPosition(300 * i, 400 * i);
 
     driver.get('http://www.google.com');
-    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);
 
     driver.quit();

package/firefox/binary.js

@@ -203,6 +203,8 @@ function installNoFocusLibs(profileDir) {
  * `PATH`.
  *
  * @final
+ * @deprecated This class will be removed in 4.0. Use the binary management
+ *     functions available on the {@link ./index.Options firefox.Options} class.
  */
 class Binary {
   /**
@@ -242,6 +244,7 @@ class Binary {
    * Add arguments to the command line used to start Firefox.
    * @param {...(string|!Array.<string>)} var_args Either the arguments to add
    *     as varargs, or the arguments as an array.
+   * @deprecated Use {@link ./index.Options#addArguments}.
    */
   addArguments(var_args) {
     for (var i = 0; i < arguments.length; i++) {