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

package/CHANGES.md

@@ -1,3 +1,16 @@
+## v4.0.0-beta.1
+
+* JS Binding support for WebDriver Bidi in Firefox
+    - This requires Firefox 87 and Geckodriver 0.29 to be able to work
+* Update the supported CDP versions
+* Update tmp package version (#9155)
+* Adding support for /computedlabel (getAccessibleName) (#9073)
+* Adding support for computedrole (#8990)
+* Use subfolder for NPM package homepage (#8938)
+* Fix typo: tracingCategories -> traceCategories (#8976)
+* Package up mutation-listener for node. Fixes #8955
+* Adding support for `print` endpoint (#8880)
+
 ## v4.0.0-alpha.8
 
 * Rolling back native support for Opera Browser
@@ -7,7 +20,7 @@
     - setEdgeChromium
     - setScrollBehavior
     - For consistent naming, deprecating `addArguments(...args)` in favor of `addBrowserCommandSwitches(...args)`
-    
+
 * Added relative locators
 * Added Chrome DevTools Protocol (CDP) support
 * Added support for BASIC authentication.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Software Freedom Conservancy (SFC)
+
+   Licensed 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.

package/NOTICE

@@ -0,0 +1,2 @@
+Copyright 2011-2021 Software Freedom Conservancy
+Copyright 2004-2011 Selenium committers

package/chromium.js

@@ -82,11 +82,7 @@ const command = require('./lib/command')
 const error = require('./lib/error')
 const Symbols = require('./lib/symbols')
 const webdriver = require('./lib/webdriver')
-const WebSocket = require('ws')
-const cdp = require('./devtools/CDPConnection')
 const remote = require('./remote')
-const cdpTargets = ['page', 'browser']
-const fs = require('fs')
 
 /**
  * Custom command names supported by Chromium WebDriver.
@@ -112,9 +108,9 @@ const Command = {
  * @return {!command.Executor} The new command executor.
  */
 function createExecutor(url, vendorPrefix) {
-  let agent = new http.Agent({ keepAlive: true })
-  let client = url.then((url) => new http.HttpClient(url, agent))
-  let executor = new http.Executor(client)
+  const agent = new http.Agent({ keepAlive: true })
+  const client = url.then((url) => new http.HttpClient(url, agent))
+  const executor = new http.Executor(client)
   configureExecutor(executor, vendorPrefix)
   return executor
 }
@@ -394,7 +390,7 @@ class Options extends Capabilities {
    * - `enableTimeline`: Whether or not to collect events from Timeline domain.
    *     Note: when tracing is enabled, Timeline domain is implicitly disabled,
    *     unless `enableTimeline` is explicitly set to true.
-   * - `tracingCategories`: A comma-separated string of Chromium tracing
+   * - `traceCategories`: A comma-separated string of Chromium tracing
    *     categories for which trace events should be collected. An unspecified
    *     or empty string disables tracing.
    * - `bufferUsageReportingInterval`: The requested number of milliseconds
@@ -405,7 +401,7 @@ class Options extends Capabilities {
    * @param {{enableNetwork: boolean,
    *          enablePage: boolean,
    *          enableTimeline: boolean,
-   *          tracingCategories: string,
+   *          traceCategories: string,
    *          bufferUsageReportingInterval: number}} prefs The performance
    *     logging preferences.
    * @return {!Options} A self reference.
@@ -569,7 +565,7 @@ class Options extends Capabilities {
           return extension.toString('base64')
         }
         return io
-          .read(/** @type {string} */ (extension))
+          .read(/** @type {string} */(extension))
           .then((buffer) => buffer.toString('base64'))
       })
     }
@@ -622,7 +618,7 @@ class Driver extends webdriver.WebDriver {
    * implementation.
    * @override
    */
-  setFileDetector() {}
+  setFileDetector() { }
 
   /**
    * Schedules a command to launch Chrome App with given ID.
@@ -709,127 +705,6 @@ class Driver extends webdriver.WebDriver {
     )
   }
 
-  /**
-   * Creates a new WebSocket connection.
-   * @return {!Promise<resolved>} A new CDP instance.
-   */
-  async createCDPConnection(target) {
-    const caps = await this.getCapabilities()
-    const seOptions = caps['map_'].get('se:options') || new Map()
-    const vendorInfo =
-      caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
-      new Map()
-    const debuggerUrl = seOptions['cdp'] || vendorInfo['debuggerAddress']
-    this._wsUrl = await this.getWsUrl(debuggerUrl, target)
-
-    return new Promise((resolve, reject) => {
-      try {
-        this._wsConnection = new WebSocket(this._wsUrl)
-      } catch (err) {
-        reject(err)
-        return
-      }
-
-      this._wsConnection.on('open', () => {
-        this._cdpConnection = new cdp.CdpConnection(this._wsConnection)
-        resolve(this._cdpConnection)
-      })
-
-      this._wsConnection.on('error', (error) => {
-        reject(error)
-      })
-    })
-  }
-
-  /**
-   * Retrieves 'webSocketDebuggerUrl' by sending a http request using debugger address
-   * @param {string} debuggerAddress
-   * @param {string} target
-   * @return {string} Returns parsed webSocketDebuggerUrl obtained from the http request
-   */
-  async getWsUrl(debuggerAddress, target) {
-    if (target && cdpTargets.indexOf(target.toLowerCase()) === -1) {
-      throw new error.InvalidArgumentError('invalid target value')
-    }
-    let path = '/json/version'
-
-    if (target === 'page') {
-      path = '/json'
-    }
-    let request = new http.Request('GET', path)
-    let client = new http.HttpClient('http://' + debuggerAddress)
-    let response = await client.send(request)
-    let url = JSON.parse(response.body)['webSocketDebuggerUrl']
-    if (target.toLowerCase() === 'page') {
-      url = JSON.parse(response.body)[0]['webSocketDebuggerUrl']
-    }
-
-    return url
-  }
-
-  /**
-   * Sets a listener for Fetch.authRequired event from CDP
-   * If event is triggered, it enter username and password
-   * and allows the test to move forward
-   * @param {string} username
-   * @param {string} password
-   * @param connection CDP Connection
-   */
-  async register(username, password, connection) {
-    await connection.execute("Network.setCacheDisabled", this.getRandomNumber(1, 10), {
-      cacheDisabled: true,
-    }, null);
-
-    this._wsConnection.on('message', (message) => {
-      const params = JSON.parse(message)
-
-      if (params.method === 'Fetch.authRequired') {
-        const requestParams = params['params']
-        connection.execute('Fetch.continueWithAuth', this.getRandomNumber(1, 10), {
-          requestId: requestParams['requestId'],
-          authChallengeResponse: {
-            response: 'ProvideCredentials',
-            username: username,
-            password: password,
-        }})
-      } else if (params.method === 'Fetch.requestPaused') {
-        const requestPausedParams = params['params']
-        connection.execute('Fetch.continueRequest', this.getRandomNumber(1, 10), {
-          requestId: requestPausedParams['requestId'],
-        })
-      }
-    })
-
-    await connection.execute('Fetch.enable', 1, {
-      handleAuthRequests: true,
-    }, null)
-  }
-
-  /**
-   *
-   * @param connection
-   * @param callback
-   * @returns {Promise<void>}
-   */
-  async onLogEvent(connection, callback) {
-    await connection.execute('Runtime.enable', this.getRandomNumber(1, 10), {}, null)
-
-    this._wsConnection.on('message', (message) => {
-      const params = JSON.parse(message)
-
-      if (params.method === 'Runtime.consoleAPICalled') {
-        const consoleEventParams = params['params']
-        let event = {
-          type: consoleEventParams['type'],
-          timestamp: new Date(consoleEventParams['timestamp']),
-          args: consoleEventParams['args']
-        }
-
-        callback(event)
-      }
-    })
-  }
-
   /**
    * Set a permission state to the given value.
    *
@@ -848,72 +723,6 @@ class Driver extends webdriver.WebDriver {
     )
   }
 
-  /**
-   *
-   * @param connection
-   * @param callback
-   * @returns {Promise<void>}
-   */
-  async onLogException(connection, callback) {
-    await connection.execute('Runtime.enable', this.getRandomNumber(1, 10), {}, null)
-
-    this._wsConnection.on('message', (message) => {
-      const params = JSON.parse(message)
-
-      if (params.method === 'Runtime.exceptionThrown') {
-        const exceptionEventParams = params['params']
-        let event = {
-          exceptionDetails: exceptionEventParams['exceptionDetails'],
-          timestamp: new Date(exceptionEventParams['timestamp']),
-        }
-
-        callback(event)
-      }
-    })
-  }
-
-  /**
-   * @param connection
-   * @param callback
-   * @returns {Promise<void>}
-   */
-  async logMutationEvents(connection, callback) {
-    await connection.execute('Runtime.enable', this.getRandomNumber(1, 10), {}, null)
-    await connection.execute('Page.enable', this.getRandomNumber(1, 10), {}, null)
-
-    await connection.execute('Runtime.addBinding', this.getRandomNumber(1, 10), {
-      name: '__webdriver_attribute',
-    }, null)
-
-    const mutationListener = fs.readFileSync('../../cdp-support/mutation-listener.js', 'utf-8').toString()
-
-    this.executeScript(mutationListener)
-
-    await connection.execute('Page.addScriptToEvaluateOnNewDocument', this.getRandomNumber(1, 10), {
-      source: mutationListener,
-    }, null)
-
-    this._wsConnection.on('message', async (message) => {
-      const params = JSON.parse(message)
-      if (params.method === 'Runtime.bindingCalled') {
-        let payload = JSON.parse(params['params']['payload'])
-        let elements = await this.findElements({css: "*[data-__webdriver_id=" + payload['target']})
-
-        if (elements.length === 0) {
-          return
-        }
-
-        let event = {
-          element: elements[0],
-          attribute_name: payload['name'],
-          current_value: payload['value'],
-          old_value: payload['oldValue']
-        }
-        callback(event)
-      }
-    })
-  }
-
   /**
    * Sends a DevTools command to change the browser's download directory.
    *
@@ -1011,10 +820,6 @@ class Driver extends webdriver.WebDriver {
       'Driver.stopCasting(' + deviceName + ')'
     )
   }
-
-  getRandomNumber(min, max) {
-    return Math.floor(Math.random() * (max - min + 1) + min)
-  }
 }
 
 // PUBLIC API

package/edge.js

@@ -169,7 +169,7 @@ class ServiceBuilder extends chromium.ServiceBuilder {
    *   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 WebDriver for Edge could not be found on the current PATH. Please ' +

package/example/chrome_android.js

@@ -0,0 +1,45 @@
+// 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.
+
+/**
+ * @fileoverview A basic example of working with Chrome on Android. Before
+ * running this example, you must start adb and connect a device (or start an
+ * AVD).
+ */
+
+'use strict'
+
+const { Builder, By, Key, until } = require('..')
+const { Options } = require('../chrome')
+
+;(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)
+  } finally {
+    ;(await driver) && driver.quit()
+  }
+})().then(
+  (_) => console.log('SUCCESS'),
+  (err) => console.error('ERROR: ' + err)
+)

package/{lib/atoms/make-atoms-module.js → example/chrome_mobile_emulation.js}

@@ -15,21 +15,32 @@
 // specific language governing permissions and limitations
 // under the License.
 
-const fs = require('fs')
-const path = require('path')
+/**
+ * @fileoverview This is an example of emulating a mobile device using the
+ * ChromeDriver.
+ */
 
-if (process.argv.length < 3) {
-  process.stderr.write(
-    `Usage: node ${path.basename(__filename)} <src file> <dst file>\n`
-  )
-  // eslint-disable-next-line no-process-exit
-  process.exit(-1)
-}
+'use strict'
 
-const buffer = fs.readFileSync(process.argv[2])
-fs.writeFileSync(
-  process.argv[3],
-  `// GENERATED CODE - DO NOT EDIT
-module.exports = ${buffer.toString('utf8').trim()};
-`
+const { Builder, By, Key, until } = require('..')
+const { Options } = require('../chrome')
+
+;(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)
+  } finally {
+    ;(await driver) && driver.quit()
+  }
+})().then(
+  (_) => console.log('SUCCESS'),
+  (err) => console.error('ERROR: ' + err)
 )