selenium-webdriver 4.0.0 → 4.1.0

package/CHANGES.md

@@ -1,3 +1,20 @@
+## v4.1.0
+
+* add support for handling Shadow DOM elements
+* Capture browser console logs when using BiDi onLogEvent api
+* add CDP support for v96 and remove v93
+* remove useless package, change io public api import to more common approach (#10037)
+* Fix flaky CDP dom mutation (#10029)
+* Fix edge test failures (#10012)
+* code cleanup second iteration (#9979)
+* Ensure correct serialization of extensions in chromium.Options (#6676)
+* Remove explicit id passing for CDP commands
+* Attach to page target while creating a CDP connection (#10005)
+* Add support for form submit in W3C mode (fixes #9916) (#9936)
+* Fixes relative locator 'locateWith' export
+* update doc string for CDP Commands (#9929)
+
+
 ## v4.0.0
 
 * Fixes cdp for Chrome and Firefox (#9909)
@@ -516,7 +533,7 @@ This release requires [geckodriver 0.15.0](https://github.com/mozilla/geckodrive
   DriverService instances that run in a child-process. The
   `chrome.ServiceBuilder`, `edge.ServiceBuilder`, and `opera.ServiceBuilder`
   classes now all extend this base class with browser-specific options.
-* For each of the ServiceBuilder clases, renamed `usingPort` and
+* For each of the ServiceBuilder classes, renamed `usingPort` and
   `withEnvironment` to `setPort` and `setEnvironment`, respectively.
 * Renamed `chrome.ServiceBuilder#setUrlBasePath` to `#setPath`
 * Changed the signature of the `firefox.Driver` from `(config, flow, executor)`

package/chrome.js

@@ -236,9 +236,10 @@ class Driver extends chromium.Driver {
    */
   static createSession(opt_config, opt_serviceExecutor) {
     let caps = opt_config || new Options()
-    return /** @type {!Driver} */ (
-      super.createSession(caps, opt_serviceExecutor)
-    )
+    return /** @type {!Driver} */ (super.createSession(
+      caps,
+      opt_serviceExecutor
+    ))
   }
 }
 

package/chromium.js

@@ -358,8 +358,11 @@ class Options extends Capabilities {
    * @return {!Options} A self reference.
    */
   addExtensions(...args) {
-    let current = this.options_.extensions || []
-    this.options_.extensions = current.concat(...args)
+    let extensions = this.options_.extensions || new Extensions()
+    extensions.add(...args)
+    if (extensions.length) {
+      this.options_.extensions = extensions
+    }
     return this
   }
 
@@ -584,28 +587,47 @@ class Options extends Capabilities {
     }
     return this
   }
+}
+
+/**
+ * A list of extensions to install when launching the browser.
+ */
+class Extensions {
+  constructor() {
+    this.extensions = []
+  }
+
+  /**
+   * @return {number} The length of the extensions list.
+   */
+  get length() {
+    return this.extensions.length
+  }
 
   /**
-   * Converts this instance to its JSON wire protocol representation. Note this
-   * function is an implementation not intended for general use.
+   * Add additional extensions to install when launching the browser. Each
+   * extension should be specified as the path to the packed CRX file, or a
+   * Buffer for an extension.
    *
-   * @return {!Object} The JSON wire protocol representation of this instance.
-   * @suppress {checkTypes} Suppress [] access on a struct.
+   * @param {...(string|!Buffer|!Array<(string|!Buffer)>)} args The
+   *     extensions to add.
+   */
+  add(...args) {
+    this.extensions = this.extensions.concat(...args)
+  }
+
+  /**
+   * @return {!Object} A serialized representation of this Extensions object.
    */
   [Symbols.serialize]() {
-    if (this.options_.extensions && this.options_.extensions.length) {
-      this.options_.extensions = this.options_.extensions.map(function (
-        extension
-      ) {
-        if (Buffer.isBuffer(extension)) {
-          return extension.toString('base64')
-        }
-        return io
-          .read(/** @type {string} */ (extension))
-          .then((buffer) => buffer.toString('base64'))
-      })
-    }
-    return super[Symbols.serialize]()
+    return this.extensions.map(function (extension) {
+      if (Buffer.isBuffer(extension)) {
+        return extension.toString('base64')
+      }
+      return io
+        .read(/** @type {string} */ (extension))
+        .then((buffer) => buffer.toString('base64'))
+    })
   }
 }
 
@@ -725,11 +747,11 @@ class Driver extends webdriver.WebDriver {
   }
 
   /**
-   * ends an arbitrary devtools command to the browser and get the result.
+   * Sends an arbitrary devtools command to the browser and get the result.
    *
    * @param {string} cmd The name of the command to send.
    * @param {Object=} params The command parameters.
-   * @return {!Promise<void>} A promise that will be resolved when the command
+   * @return {!Promise<string>} A promise that will be resolved when the command
    *     has finished.
    * @see <https://chromedevtools.github.io/devtools-protocol/>
    */

package/devtools/CDPConnection.js

@@ -18,16 +18,21 @@
 class CDPConnection {
   constructor(wsConnection) {
     this._wsConnection = wsConnection
+    this.cmd_id = 0
+    this.targetID = null;
+    this.sessionId = null
   }
 
-  execute(method, id, params, callback) {
-    const message = {
+  execute(method, params, callback) {
+    let message = {
       method,
-      id: id,
+      id: this.cmd_id++,
+    }
+    if (this.sessionId) {
+      message['sessionId'] = this.sessionId
     }
 
     const mergedMessage = Object.assign({ params: params }, message)
-
     this._wsConnection.send(JSON.stringify(mergedMessage), callback)
   }
 }

package/devtools/networkinterceptor.js

@@ -16,74 +16,73 @@
 // under the License.
 
 class HttpResponse {
-    /**
-     * Creates a HTTP Response that will be used to
-     * mock out network interceptions.
-     * @param {*} urlToIntercept
-     */
-    constructor(urlToIntercept = "") {
-        this.returnBody = ""
-        this.returnHeaders = []
-        this.returnMethod = "GET"
-        this.returnStatus = 200
-        this.urlToIntercept = urlToIntercept
-    }
+  /**
+   * Creates a HTTP Response that will be used to
+   * mock out network interceptions.
+   * @param {*} urlToIntercept
+   */
+  constructor(urlToIntercept = '') {
+    this.returnBody = ''
+    this.returnHeaders = []
+    this.returnMethod = 'GET'
+    this.returnStatus = 200
+    this.urlToIntercept = urlToIntercept
+  }
 
-    /**
-     * Add headers that will be returned when we intercept
-     * a HTTP Request
-     * @param {*} header
-     * @param {*} value
-     */
-    addHeaders(header, value) {
-        this.returnHeaders.push({ name: header, value: value })
-    }
+  /**
+   * Add headers that will be returned when we intercept
+   * a HTTP Request
+   * @param {*} header
+   * @param {*} value
+   */
+  addHeaders(header, value) {
+    this.returnHeaders.push({ name: header, value: value })
+  }
 
-    get headers() {
-        return this.returnHeaders
-    }
+  get headers() {
+    return this.returnHeaders
+  }
 
-    /**
-     * Set the STATUS value of the returned HTTP Request
-     * @param {*} value
-     */
-    set status(value) {
-        // Add in check that his should be a number
-        this.returnStatus = value
-    }
+  /**
+   * Set the STATUS value of the returned HTTP Request
+   * @param {*} value
+   */
+  set status(value) {
+    // Add in check that his should be a number
+    this.returnStatus = value
+  }
 
-    get status() {
-        return this.returnStatus
-    }
+  get status() {
+    return this.returnStatus
+  }
 
-    /**
-     * Sets the value of the body of the HTTP Request that
-     * will be returned.
-     * @param {*} value
-     */
-    set body(value) {
-        this.returnBody = value
-    }
+  /**
+   * Sets the value of the body of the HTTP Request that
+   * will be returned.
+   * @param {*} value
+   */
+  set body(value) {
+    this.returnBody = value
+  }
 
-    get body() {
-        let buff = Buffer.from(this.returnBody, "utf-8")
-        return buff.toString("base64")
-    }
+  get body() {
+    let buff = Buffer.from(this.returnBody, 'utf-8')
+    return buff.toString('base64')
+  }
 
-    /**
-     * Sets the method of the HTTP Request
-     * @param {*} value the method of the request.
-     */
-    set method(value) {
-        this.returnMethod = value
-    }
-
-    /**
-     * Returns the Method to be used in the intercept
-     */
-    get method() {
-        return this.returnMethod
-    }
+  /**
+   * Sets the method of the HTTP Request
+   * @param {*} value the method of the request.
+   */
+  set method(value) {
+    this.returnMethod = value
+  }
 
+  /**
+   * Returns the Method to be used in the intercept
+   */
+  get method() {
+    return this.returnMethod
+  }
 }
 exports.HttpResponse = HttpResponse

package/http/index.js

@@ -37,7 +37,7 @@ const httpLib = require('../lib/http')
  *            path: (?string|undefined),
  *            pathname: (?string|undefined)}}
  */
-var RequestOptions // eslint-disable-line
+let RequestOptions // eslint-disable-line
 
 /**
  * @param {string} aUrl The request URL to parse.
@@ -100,9 +100,7 @@ class HttpClient {
      */
     this.keepAlive = this.client_options['keep-alive']
 
-    /**
-     * @private {?RequestOptions}
-     */
+    /**  @private {?RequestOptions} */
     this.proxyOptions_ = opt_proxy ? getRequestOptions(opt_proxy) : null
   }
 
@@ -219,9 +217,10 @@ function sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries) {
   let requestFn = options.protocol === 'https:' ? https.request : http.request
   var request = requestFn(options, function onResponse(response) {
     if (response.statusCode == 302 || response.statusCode == 303) {
+      let location
       try {
         // eslint-disable-next-line node/no-deprecated-api
-        var location = url.parse(response.headers['location'])
+        location = url.parse(response.headers['location'])
       } catch (ex) {
         onError(
           Error(
@@ -240,7 +239,7 @@ function sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries) {
         location.auth = options.auth
       }
 
-      request.abort()
+      request.destroy()
       sendRequest(
         {
           method: 'GET',
@@ -265,10 +264,10 @@ function sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries) {
       return
     }
 
-    var body = []
+    const body = []
     response.on('data', body.push.bind(body))
     response.on('end', function () {
-      var resp = new httpLib.Response(
+      const resp = new httpLib.Response(
         /** @type {number} */ (response.statusCode),
         /** @type {!Object<string>} */ (response.headers),
         Buffer.concat(body).toString('utf8').replace(/\0/g, '')
@@ -288,7 +287,7 @@ function sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries) {
         sendRequest(options, onOk, onError, opt_data, opt_proxy, opt_retries)
       }, 15)
     } else {
-      var message = e.message
+      let message = e.message
       if (e.code) {
         message = e.code + ' ' + message
       }
@@ -339,8 +338,8 @@ function isRetryableNetworkError(err) {
 
 // PUBLIC API
 
-exports.Agent = http.Agent
-exports.Executor = httpLib.Executor
-exports.HttpClient = HttpClient
-exports.Request = httpLib.Request
-exports.Response = httpLib.Response
+module.exports.Agent = http.Agent
+module.exports.Executor = httpLib.Executor
+module.exports.HttpClient = HttpClient
+module.exports.Request = httpLib.Request
+module.exports.Response = httpLib.Response

package/http/util.js

@@ -21,12 +21,12 @@
 
 'use strict'
 
-const Executor = require('./index').Executor,
-  HttpClient = require('./index').HttpClient,
-  HttpRequest = require('./index').Request,
-  Command = require('../lib/command').Command,
-  CommandName = require('../lib/command').Name,
-  error = require('../lib/error')
+const Executor = require('./index').Executor
+const HttpClient = require('./index').HttpClient
+const HttpRequest = require('./index').Request
+const Command = require('../lib/command').Command
+const CommandName = require('../lib/command').Name
+const error = require('../lib/error')
 
 /**
  * Queries a WebDriver server for its current status.
@@ -43,18 +43,6 @@ function getStatus(url) {
 
 class CancellationError {}
 
-// PUBLIC API
-
-/**
- * Queries a WebDriver server for its current status.
- * @param {string} url Base URL of the server to query.
- * @return {!Promise<!Object>} A promise that resolves with
- *     a hash of the server status.
- */
-exports.getStatus = getStatus
-
-exports.CancellationError = CancellationError
-
 /**
  * Waits for a WebDriver server to be healthy and accepting requests.
  * @param {string} url Base URL of the server to query.
@@ -65,7 +53,7 @@ exports.CancellationError = CancellationError
  * @return {!Promise} A promise that will resolve when the server is ready, or
  *     if the wait is cancelled.
  */
-exports.waitForServer = function (url, timeout, opt_cancelToken) {
+function waitForServer(url, timeout, opt_cancelToken) {
   return new Promise((onResolve, onReject) => {
     let start = Date.now()
 
@@ -120,7 +108,7 @@ exports.waitForServer = function (url, timeout, opt_cancelToken) {
  * @return {!Promise} A promise that will resolve when a 2xx is received from
  *     the given URL, or if the wait is cancelled.
  */
-exports.waitForUrl = function (url, timeout, opt_cancelToken) {
+function waitForUrl(url, timeout, opt_cancelToken) {
   return new Promise((onResolve, onReject) => {
     let client = new HttpClient(url)
     let request = new HttpRequest('GET', '')
@@ -170,3 +158,9 @@ exports.waitForUrl = function (url, timeout, opt_cancelToken) {
     }
   })
 }
+
+// PUBLIC API
+module.exports.getStatus = getStatus
+module.exports.CancellationError = CancellationError
+module.exports.waitForServer = waitForServer
+module.exports.waitForUrl = waitForUrl

package/index.js

@@ -103,7 +103,7 @@ function ensureFileDetectorsAreEnabled(ctor) {
  */
 class ThenableWebDriver {
   /** @param {...?} args */
-  static createSession(...args) { } // eslint-disable-line
+  static createSession(...args) {} // eslint-disable-line
 }
 
 /**
@@ -339,10 +339,10 @@ class Builder {
   getCapabilities() {
     return this.capabilities_
   }
-  
+
   /**
-   * Sets the desired capability when requesting a new session. 
-   * If there is already a capability named key, its value will be overwritten with value. 
+   * Sets the desired capability when requesting a new session.
+   * If there is already a capability named key, its value will be overwritten with value.
    * This is a convenience wrapper around builder.getCapabilities().set(key, value) to support Builder method chaining.
    * @param {string} key The capability key.
    * @param {*} value The capability value.
@@ -630,7 +630,7 @@ class Builder {
     if (typeof browser !== 'string') {
       throw TypeError(
         `Target browser must be a string, but is <${typeof browser}>;` +
-        ' did you forget to call forBrowser()?'
+          ' did you forget to call forBrowser()?'
       )
     }
 
@@ -751,8 +751,8 @@ class Builder {
       default:
         throw new Error(
           'Do not know how to build driver: ' +
-          browser +
-          '; did you forget to call usingServer(url)?'
+            browser +
+            '; did you forget to call usingServer(url)?'
         )
     }
   }
@@ -808,9 +808,9 @@ function checkOptions(caps, key, optionType, setMethod) {
   if (val instanceof optionType) {
     throw new error.InvalidArgumentError(
       'Options class extends Capabilities and should not be set as key ' +
-      `"${key}"; set browser-specific options with ` +
-      `Builder.${setMethod}(). For more information, see the ` +
-      'documentation attached to the function that threw this error'
+        `"${key}"; set browser-specific options with ` +
+        `Builder.${setMethod}(). For more information, see the ` +
+        'documentation attached to the function that threw this error'
     )
   }
 }
@@ -822,7 +822,7 @@ exports.Builder = Builder
 exports.Button = input.Button
 exports.By = by.By
 exports.withTagName = by.withTagName
-exports.withLocator = by.withLocator
+exports.locateWith = by.locateWith
 exports.Capabilities = capabilities.Capabilities
 exports.Capability = capabilities.Capability
 exports.Condition = webdriver.Condition

package/io/exec.js

@@ -76,8 +76,7 @@ class Result {
   }
 }
 
-const COMMAND_RESULT =
-  /** !WeakMap<!Command, !Promise<!Result>> */ new WeakMap()
+const COMMAND_RESULT = /** !WeakMap<!Command, !Promise<!Result>> */ new WeakMap()
 const KILL_HOOK = /** !WeakMap<!Command, function(string)> */ new WeakMap()
 
 /**