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

package/lib/webdriver.js

@@ -35,6 +35,8 @@ const WebSocket = require('ws')
 const http = require('../http/index')
 const fs = require('fs')
 const { Capabilities } = require('./capabilities')
+const path = require('path')
+const { NoSuchElementError } = require('./error')
 
 // Capability names that are defined in the W3C spec.
 const W3C_CAPABILITY_NAMES = new Set([
@@ -970,16 +972,46 @@ class WebDriver {
   /** @override */
   findElement(locator) {
     let id
-    locator = by.checkedLocator(locator)
+    let cmd = null
+
+    if (locator instanceof RelativeBy) {
+      cmd = new command.Command(
+        command.Name.FIND_ELEMENTS_RELATIVE
+      ).setParameter('args', locator.marshall())
+    } else {
+      locator = by.checkedLocator(locator)
+    }
+
     if (typeof locator === 'function') {
       id = this.findElementInternal_(locator, this)
-    } else {
-      let cmd = new command.Command(command.Name.FIND_ELEMENT)
+      return new WebElementPromise(this, id)
+    } else if (cmd === null) {
+      cmd = new command.Command(command.Name.FIND_ELEMENT)
         .setParameter('using', locator.using)
         .setParameter('value', locator.value)
-      id = this.execute(cmd)
     }
-    return new WebElementPromise(this, id)
+
+    id = this.execute(cmd)
+    if (locator instanceof RelativeBy) {
+      return this.normalize_(id)
+    } else {
+      return new WebElementPromise(this, id)
+    }
+  }
+
+  /**
+   * @param {!Function} webElementPromise The webElement in unresolved state
+   * @return {!Promise<!WebElement>} First single WebElement from array of resolved promises
+   */
+  async normalize_(webElementPromise) {
+    let result = await webElementPromise
+    if (result.length === 0) {
+      throw new NoSuchElementError(
+        'Cannot locate an element with provided parameters'
+      )
+    } else {
+      return result[0]
+    }
   }
 
   /**
@@ -1159,12 +1191,13 @@ class WebDriver {
    */
   async createCDPConnection(target) {
     const caps = await this.getCapabilities()
-    const seOptions = caps['map_'].get('se:options') || new Map()
+    const seCdp = caps['map_'].get('se:cdp')
     const vendorInfo =
       caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
+      caps['map_'].get(this.VENDOR_CAPABILITY_PREFIX + ':edgeOptions') ||
       caps['map_'].get('moz:debuggerAddress') ||
       new Map()
-    const debuggerUrl = seOptions['cdp'] || vendorInfo['debuggerAddress'] || vendorInfo
+    const debuggerUrl = seCdp || vendorInfo['debuggerAddress'] || vendorInfo
     this._wsUrl = await this.getWsUrl(debuggerUrl, target)
 
     return new Promise((resolve, reject) => {
@@ -1196,12 +1229,21 @@ class WebDriver {
     if (target && cdpTargets.indexOf(target.toLowerCase()) === -1) {
       throw new error.InvalidArgumentError('invalid target value')
     }
-    let path = '/json/version'
-
+    let path
+    if (target === 'page') {
+      path = '/json'
+    } else {
+      path = '/json/version'
+    }
     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']
+    let url
+    if (target.toLowerCase() === 'page') {
+      url = JSON.parse(response.body)[0]['webSocketDebuggerUrl']
+    } else {
+      url = JSON.parse(response.body)['webSocketDebuggerUrl']
+    }
 
     return url
   }
@@ -1362,7 +1404,10 @@ class WebDriver {
         .toString()
     } catch {
       mutationListener = fs
-        .readFileSync('./atoms/mutation-listener.js', 'utf-8')
+        .readFileSync(
+          path.resolve(__dirname, './atoms/mutation-listener.js'),
+          'utf-8'
+        )
         .toString()
     }
 
@@ -2680,18 +2725,12 @@ class WebElement {
    * Take a screenshot of the visible region encompassed by this element's
    * bounding rectangle.
    *
-   * @param {boolean=} scroll Optional argument that indicates whether the
-   *     element should be scrolled into view before taking a screenshot.
-   *     Defaults to false.
    * @return {!Promise<string>} A promise that will be
    *     resolved to the screenshot as a base-64 encoded PNG.
    */
-  takeScreenshot(scroll = false) {
+  takeScreenshot() {
     return this.execute_(
-      new command.Command(command.Name.TAKE_ELEMENT_SCREENSHOT).setParameter(
-        'scroll',
-        scroll
-      )
+      new command.Command(command.Name.TAKE_ELEMENT_SCREENSHOT)
     )
   }
 }

package/opera.js

@@ -383,9 +383,9 @@ class Driver extends webdriver.WebDriver {
       caps = options.toCapabilities(caps)
     }
 
-    return /** @type {!Driver} */ (super.createSession(executor, caps, () =>
-      service.kill()
-    ))
+    return /** @type {!Driver} */ (
+      super.createSession(executor, caps, () => service.kill())
+    )
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-rc-1",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -23,24 +23,24 @@
     "node": ">= 10.15.0"
   },
   "dependencies": {
-    "jszip": "^3.5.0",
-    "rimraf": "^2.7.1",
+    "jszip": "^3.6.0",
+    "rimraf": "^3.0.2",
     "tmp": "^0.2.1",
-    "ws": "^7.3.1"
+    "ws": ">=7.4.6"
   },
   "devDependencies": {
-    "eslint": "^7.15.0",
-    "eslint-config-prettier": "^7.0.0",
-    "eslint-plugin-no-only-tests": "^2.4.0",
+    "eslint": "^7.26.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.2.0",
+    "eslint-plugin-prettier": "^3.4.0",
     "express": "^4.17.1",
-    "jasmine": "^3.6.1",
+    "jasmine": "^3.8.0",
     "mocha": "^8.1.0",
     "multer": "^1.4.2",
-    "prettier": "^2.2.1",
+    "prettier": "^2.3.0",
     "serve-index": "^1.9.1",
-    "sinon": "^7.5.0"
+    "sinon": "^10.0.0"
   },
   "scripts": {
     "lint": "eslint --ignore-pattern node_modules --ignore-pattern generator --ext js lib/http.js \"**/*.js\"",

package/remote/index.js

@@ -210,7 +210,7 @@ class DriverService {
           }
 
           return resolveCommandLineFlags(this.args_).then((args) => {
-            var command = exec(self.executable_, {
+            const command = exec(self.executable_, {
               args: args,
               env: self.env_,
               stdio: self.stdio_,
@@ -218,8 +218,8 @@ class DriverService {
 
             resolveCommand(command)
 
-            var earlyTermination = command.result().then(function (result) {
-              var error =
+            const earlyTermination = command.result().then(function (result) {
+              const error =
                 result.code == null
                   ? Error('Server was killed with ' + result.signal)
                   : Error('Server terminated early with status ' + result.code)
@@ -229,7 +229,7 @@ class DriverService {
               throw error
             })
 
-            var hostname = self.hostname_
+            let hostname = self.hostname_
             if (!hostname) {
               hostname =
                 (!self.loopbackOnly_ && net.getAddress()) ||
@@ -338,9 +338,8 @@ DriverService.Builder = class {
    * @this {THIS}
    * @template THIS
    */
-  addArguments(var_args) { // eslint-disable-line
-    let args = Array.prototype.slice.call(arguments, 0)
-    this.options_.args = this.options_.args.concat(args)
+  addArguments(...arguments_) {
+    this.options_.args = this.options_.args.concat(arguments_)
     return this
   }
 
@@ -449,7 +448,7 @@ DriverService.Builder = class {
 
 /**
  * Manages the life and death of the
- * <a href="http://selenium-release.storage.googleapis.com/index.html">
+ * <a href="https://www.selenium.dev/downloads/">
  * standalone Selenium server</a>.
  */
 class SeleniumServer extends DriverService {
@@ -563,7 +562,7 @@ SeleniumServer.Options = class {
 /**
  * A {@link webdriver.FileDetector} that may be used when running
  * against a remote
- * [Selenium server](http://selenium-release.storage.googleapis.com/index.html).
+ * [Selenium server](https://www.selenium.dev/downloads/).
  *
  * When a file path on the local machine running this script is entered with
  * {@link webdriver.WebElement#sendKeys WebElement#sendKeys}, this file detector

package/safari.js

@@ -154,9 +154,9 @@ class Driver extends webdriver.WebDriver {
       service.start().then((url) => new http.HttpClient(url))
     )
 
-    return /** @type {!Driver} */ (super.createSession(executor, caps, () =>
-      service.kill()
-    ))
+    return /** @type {!Driver} */ (
+      super.createSession(executor, caps, () => service.kill())
+    )
   }
 }
 

package/testing/index.js

@@ -47,7 +47,7 @@ const { Builder } = require('../index')
  * Describes a browser targeted by a {@linkplain suite test suite}.
  * @record
  */
-function TargetBrowser() { }
+function TargetBrowser() {}
 
 /**
  * The {@linkplain Browser name} of the targeted browser.
@@ -100,7 +100,7 @@ function getBrowsersToTestFromEnv() {
     const parts = spec.split(/:/, 3)
     let name = parts[0]
     if (name === 'ie') {
-      name = Browser.IE
+      name = Browser.INTERNET_EXPLORER
     } else if (name === 'edge') {
       name = Browser.EDGE
     }
@@ -120,13 +120,8 @@ function getAvailableBrowsers() {
   let targets = [
     [chrome.locateSynchronously, Browser.CHROME],
     [edge.locateSynchronously, Browser.EDGE],
-    [
-      () => edge.locateSynchronously('msedge'),
-      Browser.EDGE,
-      { 'ms:edgeChromium': true },
-    ],
     [firefox.locateSynchronously, Browser.FIREFOX],
-    [ie.locateSynchronously, Browser.IE],
+    [ie.locateSynchronously, Browser.INTERNET_EXPLORER],
     [safari.locateSynchronously, Browser.SAFARI],
     [opera.locateSynchronously, Browser.OPERA],
   ]
@@ -215,7 +210,7 @@ function init(force = false) {
   if (seleniumJar && seleniumUrl) {
     throw Error(
       'Ambiguous test configuration: both SELENIUM_REMOTE_URL' +
-      ' && SELENIUM_SERVER_JAR environment variables are set'
+        ' && SELENIUM_SERVER_JAR environment variables are set'
     )
   }
 
@@ -223,8 +218,8 @@ function init(force = false) {
   if ((seleniumJar || seleniumUrl) && envBrowsers.length === 0) {
     throw Error(
       'Ambiguous test configuration: when either the SELENIUM_REMOTE_URL or' +
-      ' SELENIUM_SERVER_JAR environment variable is set, the' +
-      ' SELENIUM_BROWSER variable must also be set.'
+        ' SELENIUM_SERVER_JAR environment variable is set, the' +
+        ' SELENIUM_BROWSER variable must also be set.'
     )
   }
 
@@ -241,7 +236,8 @@ function init(force = false) {
 }
 
 const TARGET_MAP = /** !WeakMap<!Environment, !TargetBrowser> */ new WeakMap()
-const URL_MAP = /** !WeakMap<!Environment, ?(string|remote.SeleniumServer)> */ new WeakMap()
+const URL_MAP =
+  /** !WeakMap<!Environment, ?(string|remote.SeleniumServer)> */ new WeakMap()
 
 /**
  * Defines the environment a {@linkplain suite test suite} is running against.
@@ -254,9 +250,9 @@ class Environment {
    *     Selenium server to test against.
    */
   constructor(browser, url = undefined) {
-    browser = /** @type {!TargetBrowser} */ (Object.seal(
-      Object.assign({}, browser)
-    ))
+    browser = /** @type {!TargetBrowser} */ (
+      Object.seal(Object.assign({}, browser))
+    )
 
     TARGET_MAP.set(this, browser)
     URL_MAP.set(this, url || null)
@@ -293,7 +289,6 @@ class Environment {
 
     const realBuild = builder.build
     builder.build = function () {
-
       builder.forBrowser(browser.name, browser.version, browser.platform)
 
       if (browser.capabilities) {
@@ -316,7 +311,7 @@ class Environment {
  * Configuration options for a {@linkplain ./index.suite test suite}.
  * @record
  */
-function SuiteOptions() { }
+function SuiteOptions() {}
 
 /**
  * The browsers to run the test suite against.
@@ -491,8 +486,8 @@ function getTestHook(name) {
   if (type !== 'function') {
     throw TypeError(
       `Expected global.${name} to be a function, but is ${type}.` +
-      ' This can happen if you try using this module when running with' +
-      ' node directly instead of using jasmine or mocha'
+        ' This can happen if you try using this module when running with' +
+        ' node directly instead of using jasmine or mocha'
     )
   }
   return fn