selenium-webdriver 4.0.0-beta.1 → 4.0.0-beta.2

package/CHANGES.md

@@ -1,3 +1,15 @@
+## v4.0.0-beta.2
+
+* Removed support for Edge legacy.
+* Make the build silent for WebDriver Bidi generated code
+* resolve file path correctly (#9223)
+* Update example in edge.js (#9231)
+* Use a flat namespace for selenium options for finding WebDriver Bidi endpoint
+* Removing duplicate license text updated by update_copyright.js
+* Updating copyright text
+* Minor code cleanup
+* Removing duplicate variable declaration of IE from capabilities
+
 ## v4.0.0-beta.1
 
 * JS Binding support for WebDriver Bidi in Firefox

package/devtools/CDPConnection.js

@@ -1,21 +1,19 @@
-/*
- * 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.
- */
+// 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) {

package/edge.js

@@ -17,23 +17,19 @@
 
 /**
  * @fileoverview Defines a {@linkplain Driver WebDriver} client for
- * 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.
+ * Microsoft's Edge web browser. Edge (Chromium) is supported and support
+ * for Edge Legacy (EdgeHTML) as part of https://github.com/SeleniumHQ/selenium/issues/9166.
+ * 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.
+ * Ensure that the msedgedriver (Chromium)
+ * is on your [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
  *
- * You may use {@link Options} to specify whether Edge Chromium should be used:
+ * You may use {@link Options} to specify whether Edge Chromium options should be used:
 
- *     var options = new edge.Options();
- *     options.useEdgeChromium(true);
- *     // configure browser options ...
+ *     const edge = require('selenium-webdriver/edge');
+ *     const options = new edge.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
@@ -60,134 +56,121 @@
  * You may also create a {@link Driver} with its own driver service. This is
  * useful if you need to capture the server's log output for a specific session:
  *
- *     var edge = require('selenium-webdriver/edge');
+ *     const edge = require('selenium-webdriver/edge');
  *
- *     var service = new edge.ServiceBuilder()
+ *     const service = new edge.ServiceBuilder()
  *         .setPort(55555)
  *         .build();
  *
- *     var options = new edge.Options();
+ *     let options = new edge.Options();
  *     // configure browser options ...
  *
- *     var driver = edge.Driver.createSession(options, service);
+ *     let driver = edge.Driver.createSession(options, service);
  *
  * Users should only instantiate the {@link Driver} class directly when they
  * need a custom driver service configuration (as shown above). For normal
- * operation, users should start MicrosoftEdge using the
+ * operation, users should start msedgedriver using the
  * {@link ./builder.Builder selenium-webdriver.Builder}.
  *
- * [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 http = require('./http')
+const { Browser } = require('./lib/capabilities')
 const io = require('./io')
-const webdriver = require('./lib/webdriver')
-const { Browser, Capabilities } = require('./lib/capabilities')
 const chromium = require('./chromium')
+const http = require('./http')
+const webdriver = require('./lib/webdriver')
 
-const EDGE_CHROMIUM_BROWSER_NAME = 'msedge'
-const EDGEDRIVER_LEGACY_EXE = 'MicrosoftWebDriver.exe'
+/**
+ * Name of the EdgeDriver executable.
+ * @type {string}
+ * @const
+ */
 const EDGEDRIVER_CHROMIUM_EXE =
   process.platform === 'win32' ? 'msedgedriver.exe' : 'msedgedriver'
 
+/** @type {remote.DriverService} */
+let defaultService = null
+
 /**
- * _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`.
+ * Creates {@link selenium-webdriver/remote.DriverService} instances that manage
+ * a [ChromeDriver](https://chromedriver.chromium.org/)
+ * server in a child process.
  */
-function locateSynchronously(browserName) {
-  browserName = browserName || Browser.EDGE
-
-  if (browserName === EDGE_CHROMIUM_BROWSER_NAME) {
-    return io.findInPath(EDGEDRIVER_CHROMIUM_EXE, true)
+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 msedgedriver on the current
+   *     PATH.
+   * @throws {Error} If provided executable does not exist, or the msedgedriver
+   *     cannot be found on the PATH.
+   */
+  constructor(opt_exe) {
+    let exe = opt_exe || locateSynchronously()
+    if (!exe) {
+      throw Error(
+        `The WebDriver for Edge could not be found on the current PATH. Please download the `+
+        `latest version of ${EDGEDRIVER_CHROMIUM_EXE} from `+
+        `https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ `+
+        `and ensure it can be found on your PATH.`
+      )
+    }
+    super(exe)
+    this.setLoopback(true)
   }
-
-  return process.platform === 'win32'
-    ? io.findInPath(EDGEDRIVER_LEGACY_EXE, true)
-    : null
 }
 
 /**
- * Class for managing Edge specific options.
+ * Class for managing edge chromium specific options.
  */
 class Options extends chromium.Options {
   /**
-   * Instruct the EdgeDriver to use Edge Chromium if true.
-   * Otherwise, use Edge Legacy (EdgeHTML). Defaults to using Edge Legacy.
+   * Sets the path to the edge binary to use
+   *
+   * The binary path be absolute or relative to the msedgedriver server
+   * executable, but it must exist on the machine that will launch edge chromium.
    *
-   * @param {boolean} useEdgeChromium
+   * @param {string} path The path to the edgedriver binary to use.
    * @return {!Options} A self reference.
    */
-  setEdgeChromium(useEdgeChromium) {
-    this.set(Options.USE_EDGE_CHROMIUM, !!useEdgeChromium)
-    return this
+  setEdgeChromiumBinaryPath(path) {
+    return this.setBinaryPath(path)
   }
 }
 
-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}
+ * Creates a new WebDriver client for Microsoft's Edge.
  */
-function useEdgeChromium(o) {
-  if (o instanceof Capabilities) {
-    return !!o.get(Options.USE_EDGE_CHROMIUM)
-  }
+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=} 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) {
+    options = options || new Options()
+    let service = opt_service || getDefaultService()
+    let client = service.start().then((url) => new http.HttpClient(url))
+    let executor = new http.Executor(client)
 
-  if (o && typeof o === 'object') {
-    return !!o[Options.USE_EDGE_CHROMIUM]
+    return /** @type {!Driver} */ (super.createSession(executor, options, () =>
+      service.kill()
+    ))
   }
 
-  return false
-}
-
-/**
- * Creates {@link remote.DriverService} instances that manage a
- * 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 chromium.ServiceBuilder {
   /**
-   * @param {string=} opt_exe Path to the server executable to use. If omitted,
-   *   the builder will attempt to locate MicrosoftWebDriver on the current
-   *   PATH.
-   * @throws {Error} If provided executable does not exist, or the
-   *   MicrosoftWebDriver cannot be found on the PATH.
+   * This function is a no-op as file detectors are not supported by this
+   * implementation.
+   * @override
    */
-  constructor(opt_exe) {
-    const exe = opt_exe || locateSynchronously()
-    if (!exe) {
-      throw Error(
-        '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)
-  }
+  setFileDetector() {}
 }
 
-/** @type {remote.DriverService} */
-var defaultService = null
-
 /**
  * Sets the default service to use for new Edge instances.
  * @param {!remote.DriverService} service The service to use.
@@ -197,7 +180,7 @@ 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
@@ -216,45 +199,21 @@ function getDefaultService() {
   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.
+ * _Synchronously_ attempts to locate the chromedriver executable on the current
+ * system.
+ *
+ * @return {?string} the located executable, or `null`.
  */
-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=} 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) {
-    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)
-
-    return /** @type {!Driver} */ (super.createSession(executor, options, () =>
-      service.kill()
-    ))
-  }
-
-  /**
-   * This function is a no-op as file detectors are not supported by this
-   * implementation.
-   * @override
-   */
-  setFileDetector() {}
+function locateSynchronously() {
+  return io.findInPath(EDGEDRIVER_CHROMIUM_EXE, true)
 }
 
+Options.prototype.BROWSER_NAME_VALUE = Browser.EDGE
+Options.prototype.CAPABILITY_KEY = 'ms:edgeOptions'
+Driver.prototype.VENDOR_CAPABILITY_PREFIX = 'ms'
+
 // PUBLIC API
 
 exports.Driver = Driver