selenium-webdriver 4.0.0-beta.3 → 4.0.0

package/lib/webdriver.js

@@ -29,26 +29,28 @@ const input = require('./input')
 const logging = require('./logging')
 const promise = require('./promise')
 const Symbols = require('./symbols')
-const cdpTargets = ['page', 'browser']
 const cdp = require('../devtools/CDPConnection')
 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')
+const cdpTargets = ['page', 'browser']
 
 // Capability names that are defined in the W3C spec.
 const W3C_CAPABILITY_NAMES = new Set([
   'acceptInsecureCerts',
   'browserName',
   'browserVersion',
-  'platformName',
   'pageLoadStrategy',
+  'platformName',
   'proxy',
   'setWindowRect',
-  'timeouts',
   'strictFileInteractability',
+  'timeouts',
   'unhandledPromptBehavior',
+  'webSocketUrl'
 ])
 
 /**
@@ -649,7 +651,6 @@ function filterNonW3CCaps(capabilities) {
  * @implements {IWebDriver}
  */
 class WebDriver {
-
   /**
    * @param {!(./session.Session|IThenable<!./session.Session>)} session Either
    *     a known session or a promise that will be resolved to a session.
@@ -972,16 +973,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]
+    }
   }
 
   /**
@@ -1166,10 +1197,9 @@ class WebDriver {
       caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
       caps['map_'].get(this.VENDOR_CAPABILITY_PREFIX + ':edgeOptions') ||
       caps['map_'].get('moz:debuggerAddress') ||
-      new Map();
+      new Map()
     const debuggerUrl = seCdp || vendorInfo['debuggerAddress'] || vendorInfo
-    this._wsUrl = await this.getWsUrl(debuggerUrl, target)
-
+    this._wsUrl = await this.getWsUrl(debuggerUrl, target, caps)
     return new Promise((resolve, reject) => {
       try {
         this._wsConnection = new WebSocket(this._wsUrl)
@@ -1192,30 +1222,38 @@ class WebDriver {
   /**
    * Retrieves 'webSocketDebuggerUrl' by sending a http request using debugger address
    * @param {string} debuggerAddress
-   * @param {string} target
+   * @param target
+   * @param caps
    * @return {string} Returns parsed webSocketDebuggerUrl obtained from the http request
    */
-  async getWsUrl(debuggerAddress, target) {
+  async getWsUrl(debuggerAddress, target, caps) {
     if (target && cdpTargets.indexOf(target.toLowerCase()) === -1) {
       throw new error.InvalidArgumentError('invalid target value')
     }
+
+    if (debuggerAddress.match(/\/se\/cdp/)) {
+      return debuggerAddress;
+    }
+
     let path
-    if (target === 'page') {
+    if (target === 'page' && caps['map_'].get('browserName')!=='firefox' ){
       path = '/json'
-    } else {
+    } else if(target === 'page' && caps['map_'].get('browserName')==='firefox'){
+      path = '/json/list'
+    }
+    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
+
     if (target.toLowerCase() === 'page') {
-      url = JSON.parse(response.body)[0]['webSocketDebuggerUrl']
+      return JSON.parse(response.body)[0]['webSocketDebuggerUrl']
     } else {
-      url = JSON.parse(response.body)['webSocketDebuggerUrl']
+      return JSON.parse(response.body)['webSocketDebuggerUrl']
     }
-
-    return url
   }
 
   /**
@@ -1227,14 +1265,6 @@ class WebDriver {
    * @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)
@@ -1273,8 +1303,69 @@ class WebDriver {
       },
       null
     )
+    await connection.execute(
+      'Network.setCacheDisabled',
+      this.getRandomNumber(1, 10),
+      {
+        cacheDisabled: true,
+      },
+      null
+    )
   }
 
+  /**
+   * Handle Network interception requests
+   * @param connection WebSocket connection to the browser
+   * @param httpResponse Object representing what we are intercepting
+   *                     as well as what should be returned.
+   * @param callback callback called when we intercept requests.
+   */
+  async onIntercept(connection, httpResponse, callback) {
+
+    this._wsConnection.on('message', (message) => {
+      const params = JSON.parse(message)
+      if (params.method === 'Fetch.requestPaused') {
+        const requestPausedParams = params['params']
+        if (requestPausedParams.request.url == httpResponse.urlToIntercept) {
+          connection.execute(
+            'Fetch.continueRequest',
+            this.getRandomNumber(1, 10),
+            {
+              requestId: requestPausedParams['requestId'],
+              url: httpResponse.urlToIntercept,
+              method: httpResponse.method,
+              headers: httpResponse.headers,
+              postData: httpResponse.body
+            }
+          )
+          callback()
+        } else {
+          connection.execute(
+            'Fetch.continueRequest',
+            this.getRandomNumber(1, 10),
+            {
+              requestId: requestPausedParams['requestId'],
+            }
+          )
+        }
+      }
+    })
+
+    await connection.execute(
+      'Fetch.enable',
+      1,
+      {},
+      null
+    )
+    await connection.execute(
+      'Network.setCacheDisabled',
+      this.getRandomNumber(1, 10),
+      {
+        cacheDisabled: true,
+      },
+      null
+    )
+  }
   /**
    *
    * @param connection
@@ -1282,12 +1373,7 @@ class WebDriver {
    * @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)
@@ -1303,6 +1389,12 @@ class WebDriver {
         callback(event)
       }
     })
+    await connection.execute(
+      'Runtime.enable',
+      this.getRandomNumber(1, 10),
+      {},
+      null
+    )
   }
 
   /**
@@ -1374,7 +1466,10 @@ class WebDriver {
         .toString()
     } catch {
       mutationListener = fs
-        .readFileSync(path.resolve(__dirname, './atoms/mutation-listener.js'), 'utf-8')
+        .readFileSync(
+          path.resolve(__dirname, './atoms/mutation-listener.js'),
+          'utf-8'
+        )
         .toString()
     }
 
@@ -2692,18 +2787,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.3",
+  "version": "4.0.0",
   "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

@@ -448,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 {
@@ -562,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

@@ -40,7 +40,7 @@ const ie = require('../ie')
 const remote = require('../remote')
 const safari = require('../safari')
 const opera = require('../opera')
-const { Browser } = require('../lib/capabilities')
+const { Browser, Capabilities } = require('../lib/capabilities')
 const { Builder } = require('../index')
 
 /**
@@ -236,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.
@@ -249,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)
@@ -289,7 +290,7 @@ class Environment {
     const realBuild = builder.build
     builder.build = function () {
 
-      builder.forBrowser(browser.name, browser.version, browser.platform)
+      builder.withCapabilities(Capabilities[browser.name].apply(Capabilities))
 
       if (browser.capabilities) {
         builder.getCapabilities().merge(browser.capabilities)