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

package/lib/webdriver.js

@@ -29,6 +29,11 @@ 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')
 
 // Capability names that are defined in the W3C spec.
@@ -239,30 +244,30 @@ class IWebDriver {
    *     result.
    * @template T
    */
-  execute(command) {} // eslint-disable-line
+  execute(command) { } // eslint-disable-line
 
   /**
    * Sets the {@linkplain input.FileDetector file detector} that should be
    * used with this instance.
    * @param {input.FileDetector} detector The detector to use or `null`.
    */
-  setFileDetector(detector) {} // eslint-disable-line
+  setFileDetector(detector) { } // eslint-disable-line
 
   /**
    * @return {!command.Executor} The command executor used by this instance.
    */
-  getExecutor() {}
+  getExecutor() { }
 
   /**
    * @return {!Promise<!Session>} A promise for this client's session.
    */
-  getSession() {}
+  getSession() { }
 
   /**
    * @return {!Promise<!Capabilities>} A promise that will resolve with
    *     the this instance's capabilities.
    */
-  getCapabilities() {}
+  getCapabilities() { }
 
   /**
    * Terminates the browser session. After calling quit, this instance will be
@@ -272,7 +277,7 @@ class IWebDriver {
    * @return {!Promise<void>} A promise that will be resolved when the
    *     command has completed.
    */
-  quit() {}
+  quit() { }
 
   /**
    * Creates a new action sequence using this driver. The sequence will not be
@@ -285,7 +290,7 @@ class IWebDriver {
    *     for details).
    * @return {!input.Actions} A new action sequence for this instance.
    */
-  actions(options) {} // eslint-disable-line
+  actions(options) { } // eslint-disable-line
 
   /**
    * Executes a snippet of JavaScript in the context of the currently selected
@@ -323,7 +328,7 @@ class IWebDriver {
    *    scripts return value.
    * @template T
    */
-  executeScript(script, ...args) {} // eslint-disable-line
+  executeScript(script, ...args) { } // eslint-disable-line
 
   /**
    * Executes a snippet of asynchronous JavaScript in the context of the
@@ -400,7 +405,7 @@ class IWebDriver {
    *     value.
    * @template T
    */
-  executeAsyncScript(script, ...args) {} // eslint-disable-line
+  executeAsyncScript(script, ...args) { } // eslint-disable-line
 
   /**
    * Waits for a condition to evaluate to a "truthy" value. The condition may be
@@ -451,7 +456,7 @@ class IWebDriver {
     timeout = undefined, // eslint-disable-line
     message = undefined, // eslint-disable-line
     pollTimeout = undefined // eslint-disable-line
-  ) {}
+  ) { }
 
   /**
    * Makes the driver sleep for the given amount of time.
@@ -460,7 +465,7 @@ class IWebDriver {
    * @return {!Promise<void>} A promise that will be resolved when the sleep has
    *     finished.
    */
-  sleep(ms) {} // eslint-disable-line
+  sleep(ms) { } // eslint-disable-line
 
   /**
    * Retrieves the current window handle.
@@ -468,7 +473,7 @@ class IWebDriver {
    * @return {!Promise<string>} A promise that will be resolved with the current
    *     window handle.
    */
-  getWindowHandle() {}
+  getWindowHandle() { }
 
   /**
    * Retrieves a list of all available window handles.
@@ -476,7 +481,7 @@ class IWebDriver {
    * @return {!Promise<!Array<string>>} A promise that will be resolved with an
    *     array of window handles.
    */
-  getAllWindowHandles() {}
+  getAllWindowHandles() { }
 
   /**
    * Retrieves the current page's source. The returned source is a representation
@@ -486,7 +491,7 @@ class IWebDriver {
    * @return {!Promise<string>} A promise that will be resolved with the current
    *     page source.
    */
-  getPageSource() {}
+  getPageSource() { }
 
   /**
    * Closes the current window.
@@ -494,7 +499,7 @@ class IWebDriver {
    * @return {!Promise<void>} A promise that will be resolved when this command
    *     has completed.
    */
-  close() {}
+  close() { }
 
   /**
    * Navigates to the given URL.
@@ -503,7 +508,7 @@ class IWebDriver {
    * @return {!Promise<void>} A promise that will be resolved when the document
    *     has finished loading.
    */
-  get(url) {} // eslint-disable-line
+  get(url) { } // eslint-disable-line
 
   /**
    * Retrieves the URL for the current page.
@@ -511,7 +516,7 @@ class IWebDriver {
    * @return {!Promise<string>} A promise that will be resolved with the
    *     current URL.
    */
-  getCurrentUrl() {}
+  getCurrentUrl() { }
 
   /**
    * Retrieves the current page title.
@@ -519,7 +524,7 @@ class IWebDriver {
    * @return {!Promise<string>} A promise that will be resolved with the current
    *     page's title.
    */
-  getTitle() {}
+  getTitle() { }
 
   /**
    * Locates an element on the page. If the element cannot be found, a
@@ -559,7 +564,7 @@ class IWebDriver {
    *     commands against the located element. If the element is not found, the
    *     element will be invalidated and all scheduled commands aborted.
    */
-  findElement(locator) {} // eslint-disable-line
+  findElement(locator) { } // eslint-disable-line
 
   /**
    * Search for multiple elements on the page. Refer to the documentation on
@@ -569,7 +574,7 @@ class IWebDriver {
    * @return {!Promise<!Array<!WebElement>>} A promise that will resolve to an
    *     array of WebElements.
    */
-  findElements(locator) {} // eslint-disable-line
+  findElements(locator) { } // eslint-disable-line
 
   /**
    * Takes a screenshot of the current page. The driver makes a best effort to
@@ -583,23 +588,23 @@ class IWebDriver {
    * @return {!Promise<string>} A promise that will be resolved to the
    *     screenshot as a base-64 encoded PNG.
    */
-  takeScreenshot() {}
+  takeScreenshot() { }
 
   /**
    * @return {!Options} The options interface for this instance.
    */
-  manage() {}
+  manage() { }
 
   /**
    * @return {!Navigation} The navigation interface for this instance.
    */
-  navigate() {}
+  navigate() { }
 
   /**
    * @return {!TargetLocator} The target locator interface for this
    *     instance.
    */
-  switchTo() {}
+  switchTo() { }
 
   /**
    *
@@ -618,7 +623,7 @@ class IWebDriver {
    *         shrinkToFit: (boolean|undefined)
    *         pageRanges: (<Array>|undefined)}} options.
    */
-  printPage(options) {} // eslint-disable-line
+  printPage(options) { } // eslint-disable-line
 }
 
 /**
@@ -658,7 +663,7 @@ class WebDriver {
     // If session is a rejected promise, add a no-op rejection handler.
     // This effectively hides setup errors until users attempt to interact
     // with the session.
-    this.session_.catch(function () {})
+    this.session_.catch(function () { })
 
     /** @private {!command.Executor} */
     this.executor_ = executor
@@ -754,12 +759,12 @@ class WebDriver {
       this.session_ = Promise.reject(
         new error.NoSuchSessionError(
           'This driver instance does not have a valid session ID ' +
-            '(did you call WebDriver.quit()?) and may no longer be used.'
+          '(did you call WebDriver.quit()?) and may no longer be used.'
         )
       )
 
       // Only want the session rejection to bubble if accessed.
-      this.session_.catch(function () {})
+      this.session_.catch(function () { })
 
       if (this.onQuit_) {
         return this.onQuit_.call(void 0)
@@ -820,18 +825,15 @@ class WebDriver {
             let timeoutMessage = resolveWaitMessage(message)
             reject(
               new error.TimeoutError(
-                `${timeoutMessage}Timed out waiting for promise to resolve after ${
-                  Date.now() - start
+                `${timeoutMessage}Timed out waiting for promise to resolve after ${Date.now() - start
                 }ms`
               )
             )
           } catch (ex) {
             reject(
               new error.TimeoutError(
-                `${
-                  ex.message
-                }\nTimed out waiting for promise to resolve after ${
-                  Date.now() - start
+                `${ex.message
+                }\nTimed out waiting for promise to resolve after ${Date.now() - start
                 }ms`
               )
             )
@@ -861,7 +863,7 @@ class WebDriver {
     if (typeof fn !== 'function') {
       throw TypeError(
         'Wait condition must be a promise-like object, function, or a ' +
-          'Condition object'
+        'Condition object'
       )
     }
 
@@ -913,7 +915,7 @@ class WebDriver {
           if (!(value instanceof WebElement)) {
             throw TypeError(
               'WebElementCondition did not resolve to a WebElement: ' +
-                Object.prototype.toString.call(value)
+              Object.prototype.toString.call(value)
             )
           }
           return value
@@ -925,7 +927,7 @@ class WebDriver {
 
   /** @override */
   sleep(ms) {
-    return new Promise((resolve) => setTimeout(() => resolve(), ms))
+    return new Promise((resolve) => setTimeout(resolve, ms))
   }
 
   /** @override */
@@ -1150,6 +1152,257 @@ class WebDriver {
       new command.Command(command.Name.PRINT_PAGE).setParameters(resultObj)
     )
   }
+
+  /**
+   * 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') ||
+      caps['map_'].get('moz:debuggerAddress') ||
+      new Map()
+    const debuggerUrl = seOptions['cdp'] || vendorInfo['debuggerAddress'] || vendorInfo
+    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'
+
+    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']
+
+    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)
+      }
+    })
+  }
+
+  /**
+   *
+   * @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
+    )
+
+    let mutationListener = ''
+    try {
+      // Depending on what is running the code it could appear in 2 different places which is why we try
+      // here and then the other location
+      mutationListener = fs
+        .readFileSync(
+          './javascript/node/selenium-webdriver/lib/atoms/mutation-listener.js',
+          'utf-8'
+        )
+        .toString()
+    } catch {
+      mutationListener = fs
+        .readFileSync('./atoms/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)
+      }
+    })
+  }
+
+  getRandomNumber(min, max) {
+    return Math.floor(Math.random() * (max - min + 1) + min)
+  }
 }
 
 /**
@@ -1431,7 +1684,7 @@ class Options {
       } else if (typeof value !== 'undefined') {
         throw TypeError(
           'invalid timeouts configuration:' +
-            ` expected "${key}" to be a number, got ${typeof value}`
+          ` expected "${key}" to be a number, got ${typeof value}`
         )
       }
     }
@@ -1492,7 +1745,7 @@ function legacyTimeout(driver, type, ms) {
  *
  * @record
  */
-Options.Cookie = function () {}
+Options.Cookie = function () { }
 
 /**
  * The name of the cookie.
@@ -2197,18 +2450,18 @@ class WebElement {
    */
   async sendKeys(...args) {
     let keys = []
-    ;(await Promise.all(args)).forEach((key) => {
-      let type = typeof key
-      if (type === 'number') {
-        key = String(key)
-      } else if (type !== 'string') {
-        throw TypeError('each key must be a number of string; got ' + type)
-      }
+      ; (await Promise.all(args)).forEach((key) => {
+        let type = typeof key
+        if (type === 'number') {
+          key = String(key)
+        } else if (type !== 'string') {
+          throw TypeError('each key must be a number of string; got ' + type)
+        }
 
-      // The W3C protocol requires keys to be specified as an array where
-      // each element is a single key.
-      keys.push(...key.split(''))
-    })
+        // The W3C protocol requires keys to be specified as an array where
+        // each element is a single key.
+        keys.push(...key.split(''))
+      })
 
     if (!this.driver_.fileDetector_) {
       return this.execute_(
@@ -2324,6 +2577,25 @@ class WebElement {
     return this.execute_(new command.Command(command.Name.GET_ELEMENT_TEXT))
   }
 
+  /**
+   * Get the computed WAI-ARIA role of element.
+   *
+   * @return {!Promise<string>} A promise that will be
+   *     resolved with the element's computed role.
+   */
+  getAriaRole() {
+    return this.execute_(new command.Command(command.Name.GET_COMPUTED_ROLE))
+  }
+
+  /**
+   * Get the computed WAI-ARIA label of element.
+   *
+   * @return {!Promise<string>} A promise that will be
+   *     resolved with the element's computed label.
+   */
+  getAccessibleName() {
+    return this.execute_(new command.Command(command.Name.GET_COMPUTED_LABEL))
+  }
   /**
    * Returns an object describing an element's location, in pixels relative to
    * the document element, and the element's size in pixels.

package/net/portprober.js

@@ -52,21 +52,21 @@ function isFree(port, opt_host) {
 
 function findFreePort(opt_host) {
   return new Promise((resolve, reject) => {
-    const server = net.createServer();
-    server.on('listening', function() {
-      resolve(server.address().port);
-      server.close();
-    });
+    const server = net.createServer()
+    server.on('listening', function () {
+      resolve(server.address().port)
+      server.close()
+    })
     server.on('error', (e) => {
       if (e.code === 'EADDRINUSE' || e.code === 'EACCES') {
         resolve('Unable to find a free port')
       } else {
         reject(e)
       }
-    });
+    })
     // By providing 0 we let the operative system find an arbitrary port
-    server.listen(0, opt_host);
-  });
+    server.listen(0, opt_host)
+  })
 }
 
 // PUBLIC API

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.0.0-alpha.8",
+  "version": "4.0.0-beta.1",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -10,7 +10,7 @@
     "webdriver",
     "webdriverjs"
   ],
-  "homepage": "https://github.com/SeleniumHQ/selenium",
+  "homepage": "https://github.com/SeleniumHQ/selenium/tree/trunk/javascript/node/selenium-webdriver#readme",
   "bugs": {
     "url": "https://github.com/SeleniumHQ/selenium/issues"
   },
@@ -25,25 +25,25 @@
   "dependencies": {
     "jszip": "^3.5.0",
     "rimraf": "^2.7.1",
-    "tmp": "^0.1.0",
+    "tmp": "^0.2.1",
     "ws": "^7.3.1"
   },
   "devDependencies": {
-    "eslint": "^7.6.0",
-    "eslint-config-prettier": "^6.11.0",
+    "eslint": "^7.15.0",
+    "eslint-config-prettier": "^7.0.0",
     "eslint-plugin-no-only-tests": "^2.4.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.1.4",
+    "eslint-plugin-prettier": "^3.2.0",
     "express": "^4.17.1",
     "jasmine": "^3.6.1",
     "mocha": "^8.1.0",
     "multer": "^1.4.2",
-    "prettier": "^2.0.5",
+    "prettier": "^2.2.1",
     "serve-index": "^1.9.1",
     "sinon": "^7.5.0"
   },
   "scripts": {
-    "lint": "eslint --ignore-pattern node_modules --ignore-pattern generator --ext js \"**/*.js\"",
+    "lint": "eslint --ignore-pattern node_modules --ignore-pattern generator --ext js lib/http.js \"**/*.js\"",
     "test": "npm run lint && mocha -t 600000 --recursive test",
     "test-jasmine": "jasmine JASMINE_CONFIG_PATH=jasmine.json"
   },