selenium-webdriver 4.0.0-alpha.5 → 4.0.0-beta.1

package/devtools/CDPConnection.js

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Software Freedom Conservancy (SFC) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The SFC licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+class CDPConnection {
+  constructor(wsConnection) {
+    this._wsConnection = wsConnection
+  }
+
+  execute(method, id, params, callback) {
+    const message = {
+      method,
+      id: id,
+    }
+
+    const mergedMessage = Object.assign({ params: params }, message)
+
+    this._wsConnection.send(JSON.stringify(mergedMessage), callback)
+  }
+}
+
+exports.CdpConnection = CDPConnection

package/edge.js

@@ -17,26 +17,37 @@
 
 /**
  * @fileoverview Defines a {@linkplain Driver WebDriver} client for
- * Microsoft's Edge web browser. Before using this module,
- * you must download and install the latest
- * [MicrosoftEdgeDriver](http://go.microsoft.com/fwlink/?LinkId=619687) server.
- * Ensure that the MicrosoftEdgeDriver is on your
- * [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
+ * Microsoft's Edge web browser. Both Edge (Chromium), and Edge Legacy (EdgeHTML) are
+ * supported. Before using this module, you must download and install the correct
+ * [WebDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
+ * server.
+ *
+ * Ensure that the either MicrosoftWebDriver (EdgeHTML) or msedgedriver (Chromium)
+ * is on your [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29). MicrosoftWebDriver
+ * and Edge Legacy (EdgeHTML) will be used by default.
+ *
+ * You may use {@link Options} to specify whether Edge Chromium should be used:
+
+ *     var options = new edge.Options();
+ *     options.useEdgeChromium(true);
+ *     // configure browser options ...
+
+ * Note that Chromium-specific {@link Options} will be ignored when using Edge Legacy.
  *
  * There are three primary classes exported by this module:
  *
  * 1. {@linkplain ServiceBuilder}: configures the
  *     {@link ./remote.DriverService remote.DriverService}
- *     that manages the [MicrosoftEdgeDriver] child process.
+ *     that manages the [WebDriver] child process.
  *
  * 2. {@linkplain Options}: defines configuration options for each new
- *     MicrosoftEdgeDriver session, such as which
+ *     WebDriver session, such as which
  *     {@linkplain Options#setProxy proxy} to use when starting the browser.
  *
  * 3. {@linkplain Driver}: the WebDriver client; each new instance will control
  *     a unique browser session.
  *
- * __Customizing the MicrosoftEdgeDriver Server__ <a id="custom-server"></a>
+ * __Customizing the WebDriver Server__ <a id="custom-server"></a>
  *
  * By default, every MicrosoftEdge session will use a single driver service,
  * which is started the first time a {@link Driver} instance is created and
@@ -65,99 +76,120 @@
  * operation, users should start MicrosoftEdge using the
  * {@link ./builder.Builder selenium-webdriver.Builder}.
  *
- * [MicrosoftEdgeDriver]: https://msdn.microsoft.com/en-us/library/mt188085(v=vs.85).aspx
+ * [WebDriver (EdgeHTML)]: https://docs.microsoft.com/en-us/microsoft-edge/webdriver
+ * [WebDriver (Chromium)]: https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium
  */
 
-'use strict';
-
-const fs = require('fs');
-const util = require('util');
+'use strict'
 
-const http = require('./http');
-const io = require('./io');
-const portprober = require('./net/portprober');
-const promise = require('./lib/promise');
-const remote = require('./remote');
-const Symbols = require('./lib/symbols');
-const webdriver = require('./lib/webdriver');
-const {Browser, Capabilities} = require('./lib/capabilities');
-
-const EDGEDRIVER_EXE = 'MicrosoftWebDriver.exe';
+const http = require('./http')
+const io = require('./io')
+const webdriver = require('./lib/webdriver')
+const { Browser, Capabilities } = require('./lib/capabilities')
+const chromium = require('./chromium')
 
+const EDGE_CHROMIUM_BROWSER_NAME = 'msedge'
+const EDGEDRIVER_LEGACY_EXE = 'MicrosoftWebDriver.exe'
+const EDGEDRIVER_CHROMIUM_EXE =
+  process.platform === 'win32' ? 'msedgedriver.exe' : 'msedgedriver'
 
 /**
- * _Synchronously_ attempts to locate the edge driver executable on the current
- * system.
+ * _Synchronously_ attempts to locate the Edge driver executable
+ * on the current system. Searches for the legacy MicrosoftWebDriver by default.
  *
+ * @param {string=} browserName Name of the Edge driver executable to locate.
+ *   May be either 'msedge' to locate the Edge Chromium driver, or 'MicrosoftEdge' to
+ *   locate the Edge Legacy driver. If omitted, will attempt to locate Edge Legacy.
  * @return {?string} the located executable, or `null`.
  */
-function locateSynchronously() {
+function locateSynchronously(browserName) {
+  browserName = browserName || Browser.EDGE
+
+  if (browserName === EDGE_CHROMIUM_BROWSER_NAME) {
+    return io.findInPath(EDGEDRIVER_CHROMIUM_EXE, true)
+  }
+
   return process.platform === 'win32'
-      ? io.findInPath(EDGEDRIVER_EXE, true) : null;
+    ? io.findInPath(EDGEDRIVER_LEGACY_EXE, true)
+    : null
 }
 
-
 /**
- * Class for managing MicrosoftEdgeDriver specific options.
+ * Class for managing Edge specific options.
  */
-class Options extends Capabilities {
+class Options extends chromium.Options {
   /**
-   * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
-   *     capabilities to initialize this instance from.
+   * Instruct the EdgeDriver to use Edge Chromium if true.
+   * Otherwise, use Edge Legacy (EdgeHTML). Defaults to using Edge Legacy.
+   *
+   * @param {boolean} useEdgeChromium
+   * @return {!Options} A self reference.
    */
-  constructor(other = undefined) {
-    super(other);
-    this.setBrowserName(Browser.EDGE);
+  setEdgeChromium(useEdgeChromium) {
+    this.set(Options.USE_EDGE_CHROMIUM, !!useEdgeChromium)
+    return this
   }
 }
 
+Options.USE_EDGE_CHROMIUM = 'ms:edgeChromium'
+Options.prototype.BROWSER_NAME_VALUE = Browser.EDGE
+Options.prototype.CAPABILITY_KEY = 'ms:edgeOptions'
+Options.prototype.VENDOR_CAPABILITY_PREFIX = 'ms'
+
+/**
+ * @param  {(Capabilities|Object<string, *>)=} o The options object
+ * @return {boolean}
+ */
+function useEdgeChromium(o) {
+  if (o instanceof Capabilities) {
+    return !!o.get(Options.USE_EDGE_CHROMIUM)
+  }
+
+  if (o && typeof o === 'object') {
+    return !!o[Options.USE_EDGE_CHROMIUM]
+  }
+
+  return false
+}
 
 /**
  * Creates {@link remote.DriverService} instances that manage a
- * MicrosoftEdgeDriver server in a child process.
+ * WebDriver server in a child process. Used for driving both
+ * Microsoft Edge Legacy and Chromium. A ServiceBuilder constructed
+ * with default parameters will launch a MicrosoftWebDriver child
+ * process for driving Edge Legacy. You may pass in a path to
+ * msedgedriver.exe to use Edge Chromium instead.
  */
-class ServiceBuilder extends remote.DriverService.Builder {
+class ServiceBuilder extends chromium.ServiceBuilder {
   /**
    * @param {string=} opt_exe Path to the server executable to use. If omitted,
-   *   the builder will attempt to locate the MicrosoftEdgeDriver on the current
+   *   the builder will attempt to locate MicrosoftWebDriver on the current
    *   PATH.
    * @throws {Error} If provided executable does not exist, or the
-   *   MicrosoftEdgeDriver cannot be found on the PATH.
+   *   MicrosoftWebDriver cannot be found on the PATH.
    */
   constructor(opt_exe) {
-    let exe = opt_exe || locateSynchronously();
+    const exe = opt_exe || locateSynchronously()
     if (!exe) {
       throw Error(
-        'The ' + EDGEDRIVER_EXE + ' could not be found on the current PATH. ' +
-        'Please download the latest version of the MicrosoftEdgeDriver from ' +
-        'https://www.microsoft.com/en-us/download/details.aspx?id=48212 and ' +
-        'ensure it can be found on your PATH.');
+        'The WebDriver for Edge could not be found on the current PATH. Please ' +
+          'download the latest version of ' +
+          EDGEDRIVER_LEGACY_EXE +
+          ' from ' +
+          'https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ and ' +
+          'ensure it can be found on your PATH.'
+      )
     }
 
-    super(exe);
-
-    // Binding to the loopback address will fail if not running with
-    // administrator privileges. Since we cannot test for that in script
-    // (or can we?), force the DriverService to use "localhost".
-    this.setHostname('localhost');
-  }
-
-  /**
-   * Enables verbose logging.
-   * @return {!ServiceBuilder} A self reference.
-   */
-  enableVerboseLogging() {
-    return this.addArguments('--verbose');
+    super(exe)
   }
 }
 
-
 /** @type {remote.DriverService} */
-var defaultService = null;
-
+var defaultService = null
 
 /**
- * Sets the default service to use for new MicrosoftEdgeDriver instances.
+ * Sets the default service to use for new Edge instances.
  * @param {!remote.DriverService} service The service to use.
  * @throws {Error} If the default service is currently running.
  */
@@ -165,25 +197,32 @@ function setDefaultService(service) {
   if (defaultService && defaultService.isRunning()) {
     throw Error(
       'The previously configured EdgeDriver service is still running. ' +
-      'You must shut it down before you may adjust its configuration.');
+        'You must shut it down before you may adjust its configuration.'
+    )
   }
-  defaultService = service;
+  defaultService = service
 }
 
-
 /**
- * Returns the default MicrosoftEdgeDriver service. If such a service has
+ * Returns the default Microsoft Edge driver service. If such a service has
  * not been configured, one will be constructed using the default configuration
- * for an MicrosoftEdgeDriver executable found on the system PATH.
- * @return {!remote.DriverService} The default MicrosoftEdgeDriver service.
+ * for a MicrosoftWebDriver executable found on the system PATH.
+ * @return {!remote.DriverService} The default Microsoft Edge driver service.
  */
 function getDefaultService() {
   if (!defaultService) {
-    defaultService = new ServiceBuilder().build();
+    defaultService = new ServiceBuilder().build()
   }
-  return defaultService;
+  return defaultService
 }
 
+function createServiceFromCapabilities(options) {
+  let exe
+  if (useEdgeChromium(options)) {
+    exe = locateSynchronously(EDGE_CHROMIUM_BROWSER_NAME)
+  }
+  return new ServiceBuilder(exe).build()
+}
 
 /**
  * Creates a new WebDriver client for Microsoft's Edge.
@@ -193,18 +232,19 @@ class Driver extends webdriver.WebDriver {
    * Creates a new browser session for Microsoft's Edge browser.
    *
    * @param {(Capabilities|Options)=} options The configuration options.
-   * @param {remote.DriverService=} service The session to use; will use
-   *     the {@linkplain #getDefaultService default service} by default.
+   * @param {remote.DriverService=} opt_service The service to use; will create
+   *     a new Legacy or Chromium service based on {@linkplain Options} by default.
    * @return {!Driver} A new driver instance.
    */
   static createSession(options, opt_service) {
-    let service = opt_service || getDefaultService();
-    let client = service.start().then(url => new http.HttpClient(url));
-    let executor = new http.Executor(client);
+    options = options || new Options()
+    let service = opt_service || createServiceFromCapabilities(options)
+    let client = service.start().then((url) => new http.HttpClient(url))
+    let executor = new http.Executor(client)
 
-    options = options || new Options();
-    return /** @type {!Driver} */(super.createSession(
-        executor, options, () => service.kill()));
+    return /** @type {!Driver} */ (super.createSession(executor, options, () =>
+      service.kill()
+    ))
   }
 
   /**
@@ -215,13 +255,11 @@ class Driver extends webdriver.WebDriver {
   setFileDetector() {}
 }
 
-
 // PUBLIC API
 
-
-exports.Driver = Driver;
-exports.Options = Options;
-exports.ServiceBuilder = ServiceBuilder;
-exports.getDefaultService = getDefaultService;
-exports.setDefaultService = setDefaultService;
-exports.locateSynchronously = locateSynchronously;
+exports.Driver = Driver
+exports.Options = Options
+exports.ServiceBuilder = ServiceBuilder
+exports.getDefaultService = getDefaultService
+exports.setDefaultService = setDefaultService
+exports.locateSynchronously = locateSynchronously

package/example/chrome_android.js

@@ -21,22 +21,25 @@
  * AVD).
  */
 
-'use strict';
+'use strict'
 
-const {Builder, By, Key, until} = require('..');
-const {Options} = require('../chrome');
+const { Builder, By, Key, until } = require('..')
+const { Options } = require('../chrome')
 
-(async function() {
-  let driver;
+;(async function () {
+  let driver
   try {
     driver = await new Builder()
-        .forBrowser('chrome')
-        .setChromeOptions(new Options().androidChrome())
-        .build();
-    await driver.get('http://www.google.com/ncr');
-    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
-    await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
+      .forBrowser('chrome')
+      .setChromeOptions(new Options().androidChrome())
+      .build()
+    await driver.get('http://www.google.com/ncr')
+    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
+    await driver.wait(until.titleIs('webdriver - Google Search'), 1000)
   } finally {
-    await driver && driver.quit();
+    ;(await driver) && driver.quit()
   }
-})().then(_ => console.log('SUCCESS'), err => console.error('ERROR: ' + err));
+})().then(
+  (_) => console.log('SUCCESS'),
+  (err) => console.error('ERROR: ' + err)
+)

package/example/chrome_mobile_emulation.js

@@ -20,23 +20,27 @@
  * ChromeDriver.
  */
 
-'use strict';
+'use strict'
 
-const {Builder, By, Key, until} = require('..');
-const {Options} = require('../chrome');
+const { Builder, By, Key, until } = require('..')
+const { Options } = require('../chrome')
 
-(async function() {
-  let driver;
+;(async function () {
+  let driver
   try {
     driver = await new Builder()
-        .forBrowser('chrome')
-        .setChromeOptions(
-            new Options().setMobileEmulation({deviceName: 'Nexus 5X'}))
-        .build();
-    await driver.get('http://www.google.com/ncr');
-    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
-    await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
+      .forBrowser('chrome')
+      .setChromeOptions(
+        new Options().setMobileEmulation({ deviceName: 'Nexus 5X' })
+      )
+      .build()
+    await driver.get('http://www.google.com/ncr')
+    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
+    await driver.wait(until.titleIs('webdriver - Google Search'), 1000)
   } finally {
-    await driver && driver.quit();
+    ;(await driver) && driver.quit()
   }
-})().then(_ => console.log('SUCCESS'), err => console.error('ERROR: ' + err));
+})().then(
+  (_) => console.log('SUCCESS'),
+  (err) => console.error('ERROR: ' + err)
+)

package/example/firefox_channels.js

@@ -24,20 +24,22 @@
  * - https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly
  */
 
+'use strict'
 
-'use strict';
+const { Builder, By, Key, promise, until } = require('..')
+const { Channel, Options } = require('../firefox')
 
-const {Builder, By, Key, promise, until} = require('..');
-const {Channel, Options} = require('../firefox');
-
-let i = 0;
+let i = 0
 function resposition(driver) {
-  return driver.manage().window().setRect({
-    width: 600,
-    height: 400,
-    x: 300 * (i++),
-    y: 0
-  });
+  return driver
+    .manage()
+    .window()
+    .setRect({
+      width: 600,
+      height: 400,
+      x: 300 * i++,
+      y: 0,
+    })
 }
 
 async function doSearch(driver) {
@@ -45,33 +47,38 @@ async function doSearch(driver) {
     // Start on the base about page.
     await driver.get('about:')
     // Reposition so users can see the three windows.
-    await resposition(driver);
+    await resposition(driver)
     // Pause so users can see the magic.
-    await promise.delayed(750);
+    await promise.delayed(750)
     // Now do the rest.
-    await driver.get('http://www.google.com/ncr');
-    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
-    await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
-    console.log('Success!');
+    await driver.get('http://www.google.com/ncr')
+    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
+    await driver.wait(until.titleIs('webdriver - Google Search'), 1000)
+    console.log('Success!')
   } catch (ex) {
-    console.log('An error occured! ' + ex);
+    console.log('An error occured! ' + ex)
   } finally {
-    await driver.quit();
+    await driver.quit()
   }
 }
 
 function createDriver(channel) {
-  let options = new Options().setBinary(channel);
-  return new Builder().forBrowser('firefox').setFirefoxOptions(options).build();
+  let options = new Options().setBinary(channel)
+  return new Builder().forBrowser('firefox').setFirefoxOptions(options).build()
 }
 
 Promise.all([
   doSearch(createDriver(Channel.RELEASE)),
-  doSearch(createDriver(Channel.AURORA)),  // Developer Edition.
+  doSearch(createDriver(Channel.AURORA)), // Developer Edition.
   doSearch(createDriver(Channel.NIGHTLY)),
-]).then(_ => {
-  console.log('All done!');
-}, err => {
-  console.error('An error occured! ' + err);
-  setTimeout(() => {throw err}, 0);
-});
+]).then(
+  (_) => {
+    console.log('All done!')
+  },
+  (err) => {
+    console.error('An error occured! ' + err)
+    setTimeout(() => {
+      throw err
+    }, 0)
+  }
+)

package/example/google_search.js

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

@@ -33,27 +33,25 @@
  *         mocha -t 10000 selenium-webdriver/example/google_search_test.js
  */
 
-const assert = require('assert');
+const { Browser, By, Key, until } = require('..')
+const { ignore, suite } = require('../testing')
 
-const {Browser, By, Key, until} = require('..');
-const {ignore, suite} = require('../testing');
+suite(function (env) {
+  describe('Google Search', function () {
+    let driver
 
-suite(function(env) {
-  describe('Google Search', function() {
-    let driver;
-
-    before(async function() {
+    before(async function () {
       // env.builder() returns a Builder instance preconfigured for the
       // envrionment's target browser (you may still define browser specific
       // options if necessary (i.e. firefox.Options or chrome.Options)).
-      driver = await env.builder().build();
-    });
+      driver = await env.builder().build()
+    })
 
-    it('demo', async function() {
-      await driver.get('https://www.google.com/ncr');
-      await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
-      await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
-    });
+    it('demo', async function () {
+      await driver.get('https://www.google.com/ncr')
+      await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
+      await driver.wait(until.titleIs('webdriver - Google Search'), 1000)
+    })
 
     // The ignore function returns wrappers around describe & it that will
     // suppress tests if the provided predicate returns true. You may provide
@@ -62,11 +60,11 @@ suite(function(env) {
     // specified browsers.
     //
     // This example is always configured to skip Chrome.
-    ignore(env.browsers(Browser.CHROME)).it('demo 2', async function() {
-      await driver.get('https://www.google.com/ncr');
-      await driver.wait(until.urlIs('https://www.google.com/'), 1500);
-    });
+    ignore(env.browsers(Browser.CHROME)).it('demo 2', async function () {
+      await driver.get('https://www.google.com/ncr')
+      await driver.wait(until.urlIs('https://www.google.com/'), 1500)
+    })
 
-    after(() => driver && driver.quit());
-  });
-});
+    after(() => driver && driver.quit())
+  })
+})