selenium-webdriver 4.0.0 → 4.1.0

package/lib/webdriver.js

@@ -50,7 +50,7 @@ const W3C_CAPABILITY_NAMES = new Set([
   'strictFileInteractability',
   'timeouts',
   'unhandledPromptBehavior',
-  'webSocketUrl'
+  'webSocketUrl',
 ])
 
 /**
@@ -209,6 +209,9 @@ function fromWireValue(driver, value) {
   } else if (WebElement.isId(value)) {
     let id = WebElement.extractId(value)
     value = new WebElement(driver, id)
+  } else if (ShadowRoot.isId(value)) {
+    let id = ShadowRoot.extractId(value)
+    value = new ShadowRoot(driver, id)
   } else if (value && typeof value === 'object') {
     let result = {}
     for (let key in value) {
@@ -1203,14 +1206,39 @@ class WebDriver {
     return new Promise((resolve, reject) => {
       try {
         this._wsConnection = new WebSocket(this._wsUrl)
+        this._cdpConnection = new cdp.CdpConnection(this._wsConnection)
       } catch (err) {
         reject(err)
         return
       }
 
-      this._wsConnection.on('open', () => {
-        this._cdpConnection = new cdp.CdpConnection(this._wsConnection)
-        resolve(this._cdpConnection)
+      this._wsConnection.on('open', async () => {
+        await this.getCdpTargets()
+      })
+
+      this._wsConnection.on('message', async (message) => {
+        const params = JSON.parse(message)
+        if (params.result) {
+          if (params.result.targetInfos) {
+            const targets = params.result.targetInfos
+            const page = targets.find((info) => info.type === 'page')
+            if (page) {
+              this.targetID = page.targetId
+              this._cdpConnection.execute(
+                'Target.attachToTarget',
+                { targetId: this.targetID, flatten: true },
+                null
+              )
+            } else {
+              reject('Unable to find Page target.')
+            }
+          }
+          if (params.result.sessionId) {
+            this.sessionId = params.result.sessionId
+            this._cdpConnection.sessionId = this.sessionId
+            resolve(this._cdpConnection)
+          }
+        }
       })
 
       this._wsConnection.on('error', (error) => {
@@ -1219,6 +1247,10 @@ class WebDriver {
     })
   }
 
+  async getCdpTargets() {
+    this._cdpConnection.execute('Target.getTargets')
+  }
+
   /**
    * Retrieves 'webSocketDebuggerUrl' by sending a http request using debugger address
    * @param {string} debuggerAddress
@@ -1232,16 +1264,18 @@ class WebDriver {
     }
 
     if (debuggerAddress.match(/\/se\/cdp/)) {
-      return debuggerAddress;
+      return debuggerAddress
     }
 
     let path
-    if (target === 'page' && caps['map_'].get('browserName')!=='firefox' ){
+    if (target === 'page' && caps['map_'].get('browserName') !== 'firefox') {
       path = '/json'
-    } else if(target === 'page' && caps['map_'].get('browserName')==='firefox'){
+    } else if (
+      target === 'page' &&
+      caps['map_'].get('browserName') === 'firefox'
+    ) {
       path = '/json/list'
-    }
-    else {
+    } else {
       path = '/json/version'
     }
 
@@ -1265,39 +1299,29 @@ class WebDriver {
    * @param connection CDP Connection
    */
   async register(username, password, connection) {
-
     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,
-            },
-          }
-        )
+        connection.execute('Fetch.continueWithAuth', {
+          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'],
-          }
-        )
+        connection.execute('Fetch.continueRequest', {
+          requestId: requestPausedParams['requestId'],
+        })
       }
     })
 
     await connection.execute(
       'Fetch.enable',
-      1,
       {
         handleAuthRequests: true,
       },
@@ -1305,7 +1329,6 @@ class WebDriver {
     )
     await connection.execute(
       'Network.setCacheDisabled',
-      this.getRandomNumber(1, 10),
       {
         cacheDisabled: true,
       },
@@ -1321,45 +1344,30 @@ class WebDriver {
    * @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
-            }
-          )
+          connection.execute('Fetch.continueRequest', {
+            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'],
-            }
-          )
+          connection.execute('Fetch.continueRequest', {
+            requestId: requestPausedParams['requestId'],
+          })
         }
       }
     })
 
-    await connection.execute(
-      'Fetch.enable',
-      1,
-      {},
-      null
-    )
+    await connection.execute('Fetch.enable', {}, null)
     await connection.execute(
       'Network.setCacheDisabled',
-      this.getRandomNumber(1, 10),
       {
         cacheDisabled: true,
       },
@@ -1373,11 +1381,8 @@ class WebDriver {
    * @returns {Promise<void>}
    */
   async onLogEvent(connection, callback) {
-
-
     this._wsConnection.on('message', (message) => {
       const params = JSON.parse(message)
-
       if (params.method === 'Runtime.consoleAPICalled') {
         const consoleEventParams = params['params']
         let event = {
@@ -1388,13 +1393,21 @@ class WebDriver {
 
         callback(event)
       }
+      
+      if (params.method === 'Log.entryAdded') {
+        const logEventParams = params['params']
+        const logEntry = logEventParams['entry']
+        let event = {
+          level: logEntry['level'],
+          timestamp: new Date(logEntry['timestamp']),
+          message: logEntry['text'],
+        }
+
+        callback(event)
+      }
+
     })
-    await connection.execute(
-      'Runtime.enable',
-      this.getRandomNumber(1, 10),
-      {},
-      null
-    )
+    await connection.execute('Runtime.enable', {}, null)
   }
 
   /**
@@ -1404,12 +1417,7 @@ class WebDriver {
    * @returns {Promise<void>}
    */
   async onLogException(connection, callback) {
-    await connection.execute(
-      'Runtime.enable',
-      this.getRandomNumber(1, 10),
-      {},
-      null
-    )
+    await connection.execute('Runtime.enable', {}, null)
 
     this._wsConnection.on('message', (message) => {
       const params = JSON.parse(message)
@@ -1432,22 +1440,11 @@ class WebDriver {
    * @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.enable', {}, null)
+    await connection.execute('Page.enable', {}, null)
 
     await connection.execute(
       'Runtime.addBinding',
-      this.getRandomNumber(1, 10),
       {
         name: '__webdriver_attribute',
       },
@@ -1477,7 +1474,6 @@ class WebDriver {
 
     await connection.execute(
       'Page.addScriptToEvaluateOnNewDocument',
-      this.getRandomNumber(1, 10),
       {
         source: mutationListener,
       },
@@ -1489,7 +1485,7 @@ class WebDriver {
       if (params.method === 'Runtime.bindingCalled') {
         let payload = JSON.parse(params['params']['payload'])
         let elements = await this.findElements({
-          css: '*[data-__webdriver_id=' + payload['target'],
+          css: '*[data-__webdriver_id=' + by.escapeCss(payload['target']) + ']',
         })
 
         if (elements.length === 0) {
@@ -1506,10 +1502,6 @@ class WebDriver {
       }
     })
   }
-
-  getRandomNumber(min, max) {
-    return Math.floor(Math.random() * (max - min + 1) + min)
-  }
 }
 
 /**
@@ -2167,7 +2159,7 @@ class TargetLocator {
    * @return {!WebElementPromise} The active element.
    */
   activeElement() {
-    var id = this.driver_.execute(
+    const id = this.driver_.execute(
       new command.Command(command.Name.GET_ACTIVE_ELEMENT)
     )
     return new WebElementPromise(this.driver_, id)
@@ -2259,7 +2251,7 @@ class TargetLocator {
    *     when the driver has changed focus to the new window.
    */
   newWindow(typeHint) {
-    var driver = this.driver_
+    const driver = this.driver_
     return this.driver_
       .execute(
         new command.Command(command.Name.SWITCH_TO_NEW_WINDOW).setParameter(
@@ -2281,10 +2273,10 @@ class TargetLocator {
    * @return {!AlertPromise} The open alert.
    */
   alert() {
-    var text = this.driver_.execute(
+    const text = this.driver_.execute(
       new command.Command(command.Name.GET_ALERT_TEXT)
     )
-    var driver = this.driver_
+    const driver = this.driver_
     return new AlertPromise(
       driver,
       text.then(function (text) {
@@ -2302,6 +2294,7 @@ class TargetLocator {
 
 const LEGACY_ELEMENT_ID_KEY = 'ELEMENT'
 const ELEMENT_ID_KEY = 'element-6066-11e4-a52e-4f735466cecf'
+const SHADOWROOT_ID_KEY = 'shadow-6066-11e4-a52e-4f735466cecf'
 
 /**
  * Represents a DOM element. WebElements can be found by searching from the
@@ -2614,7 +2607,7 @@ class WebElement {
    *     requested CSS value.
    */
   getCssValue(cssStyleProperty) {
-    var name = command.Name.GET_ELEMENT_VALUE_OF_CSS_PROPERTY
+    const name = command.Name.GET_ELEMENT_VALUE_OF_CSS_PROPERTY
     return this.execute_(
       new command.Command(name).setParameter('propertyName', cssStyleProperty)
     )
@@ -2673,6 +2666,16 @@ class WebElement {
     )
   }
 
+  /**
+   * Get the shadow root of the current web element.
+   * @returns {!Promise<ShadowRoot>} A promise that will be
+   *      resolved with the elements shadow root or rejected
+   *      with {@link NoSuchShadowRootError}
+   */
+  getShadowRoot() {
+    return this.execute_(new command.Command(command.Name.GET_SHADOW_ROOT))
+  }
+
   /**
    * Get the visible (i.e. not hidden by CSS) innerText of this element,
    * including sub-elements, without any leading or trailing whitespace.
@@ -2758,7 +2761,13 @@ class WebElement {
    *     when the form has been submitted.
    */
   submit() {
-    return this.execute_(new command.Command(command.Name.SUBMIT_ELEMENT))
+    const form = this.findElement({ xpath: './ancestor-or-self::form' })
+    this.driver_.executeScript(
+      "var e = arguments[0].ownerDocument.createEvent('Event');" +
+      "e.initEvent('submit', true, true);" +
+      'if (arguments[0].dispatchEvent(e)) { arguments[0].submit() }',
+      form
+    )
   }
 
   /**
@@ -2841,6 +2850,186 @@ class WebElementPromise extends WebElement {
   }
 }
 
+//////////////////////////////////////////////////////////////////////////////
+//
+//  ShadowRoot
+//
+//////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Represents a ShadowRoot of a {@link WebElement}. Provides functions to
+ * retrieve elements that live in the DOM below the ShadowRoot.
+ */
+class ShadowRoot {
+
+  constructor(driver, id) {
+    this.driver_ = driver
+    this.id_ = id
+  }
+
+  /**
+   * Extracts the encoded ShadowRoot ID from the object.
+   *
+   * @param {?} obj The object to extract the ID from.
+   * @return {string} the extracted ID.
+   * @throws {TypeError} if the object is not a valid encoded ID.
+   */
+  static extractId(obj) {
+    if (obj && typeof obj === 'object') {
+      if (typeof obj[SHADOWROOT_ID_KEY] === 'string') {
+        return obj[SHADOWROOT_ID_KEY]
+      }
+    }
+    throw new TypeError('object is not a ShadowRoot ID')
+  }
+
+  /**
+   * @param {?} obj the object to test.
+   * @return {boolean} whether the object is a valid encoded WebElement ID.
+   */
+  static isId(obj) {
+    return (
+      obj &&
+      typeof obj === 'object' &&
+      typeof obj[SHADOWROOT_ID_KEY] === 'string')
+  }
+
+  /**
+   * @return {!Object} Returns the serialized representation of this ShadowRoot.
+   */
+  [Symbols.serialize]() {
+    return this.getId()
+  }
+
+  /**
+   * Schedules a command that targets this element with the parent WebDriver
+   * instance. Will ensure this element's ID is included in the command
+   * parameters under the "id" key.
+   *
+   * @param {!command.Command} command The command to schedule.
+   * @return {!Promise<T>} A promise that will be resolved with the result.
+   * @template T
+   * @see WebDriver#schedule
+   * @private
+   */
+  execute_(command) {
+    command.setParameter('id', this)
+    return this.driver_.execute(command)
+  }
+
+  /**
+   * Schedule a command to find a descendant of this ShadowROot. If the element
+   * cannot be found, the returned promise will be rejected with a
+   * {@linkplain error.NoSuchElementError NoSuchElementError}.
+   *
+   * The search criteria for an element may be defined using one of the static
+   * factories on the {@link by.By} class, or as a short-hand
+   * {@link ./by.ByHash} object. For example, the following two statements
+   * are equivalent:
+   *
+   *     var e1 = shadowroot.findElement(By.id('foo'));
+   *     var e2 = shadowroot.findElement({id:'foo'});
+   *
+   * You may also provide a custom locator function, which takes as input this
+   * instance and returns a {@link WebElement}, or a promise that will resolve
+   * to a WebElement. If the returned promise resolves to an array of
+   * WebElements, WebDriver will use the first element. For example, to find the
+   * first visible link on a page, you could write:
+   *
+   *     var link = element.findElement(firstVisibleLink);
+   *
+   *     function firstVisibleLink(shadowRoot) {
+   *       var links = shadowRoot.findElements(By.tagName('a'));
+   *       return promise.filter(links, function(link) {
+   *         return link.isDisplayed();
+   *       });
+   *     }
+   *
+   * @param {!(by.By|Function)} locator The locator strategy to use when
+   *     searching for the element.
+   * @return {!WebElementPromise} A WebElement that can be used to issue
+   *     commands against the located element. If the element is not found, the
+   *     element will be invalidated and all scheduled commands aborted.
+   */
+  findElement(locator) {
+    locator = by.checkedLocator(locator)
+    let id
+    if (typeof locator === 'function') {
+      id = this.driver_.findElementInternal_(locator, this)
+    } else {
+      let cmd = new command.Command(command.Name.FIND_ELEMENT_FROM_SHADOWROOT)
+        .setParameter('using', locator.using)
+        .setParameter('value', locator.value)
+      id = this.execute_(cmd)
+    }
+    return new ShadowRootPromise(this.driver_, id)
+  }
+
+  /**
+   * Locates all of the descendants of this element that match the given search
+   * criteria.
+   *
+   * @param {!(by.By|Function)} locator The locator strategy to use when
+   *     searching for the element.
+   * @return {!Promise<!Array<!WebElement>>} A promise that will resolve to an
+   *     array of WebElements.
+   */
+  async findElements(locator) {
+    locator = by.checkedLocator(locator)
+    if (typeof locator === 'function') {
+      return this.driver_.findElementsInternal_(locator, this)
+    } else {
+      let cmd = new command.Command(command.Name.FIND_ELEMENTS_FROM_SHADOWROOT)
+        .setParameter('using', locator.using)
+        .setParameter('value', locator.value)
+      let result = await this.execute_(cmd)
+      return Array.isArray(result) ? result : []
+    }
+  }
+
+  getId() {
+    return this.id_
+  }
+}
+
+/**
+ * ShadowRootPromise is a promise that will be fulfilled with a WebElement.
+ * This serves as a forward proxy on ShadowRoot, allowing calls to be
+ * scheduled without directly on this instance before the underlying
+ * ShadowRoot has been fulfilled.
+ *
+ * @implements { IThenable<!ShadowRoot>}
+ * @final
+ */
+class ShadowRootPromise extends ShadowRoot {
+  /**
+   * @param {!WebDriver} driver The parent WebDriver instance for this
+   *     element.
+   * @param {!Promise<!ShadowRoot>} el A promise
+   *     that will resolve to the promised element.
+   */
+  constructor(driver, shadow) {
+    super(driver, 'unused')
+
+    /** @override */
+    this.then = shadow.then.bind(shadow)
+
+    /** @override */
+    this.catch = shadow.catch.bind(shadow)
+
+    /**
+     * Defers returning the ShadowRoot ID until the wrapped WebElement has been
+     * resolved.
+     * @override
+     */
+    this.getId = function () {
+      return shadow.then(function (shadow) {
+        return shadow.getId()
+      })
+    }
+  }
+}
+
 //////////////////////////////////////////////////////////////////////////////
 //
 //  Alert
@@ -2998,6 +3187,7 @@ module.exports = {
   Logs,
   Navigation,
   Options,
+  ShadowRoot,
   TargetLocator,
   IWebDriver,
   WebDriver,

package/net/portprober.js

@@ -29,7 +29,7 @@ const net = require('net')
  */
 function isFree(port, opt_host) {
   return new Promise((resolve, reject) => {
-    let server = net.createServer().on('error', function (e) {
+    const server = net.createServer().on('error', function (e) {
       if (e.code === 'EADDRINUSE' || e.code === 'EACCES') {
         resolve(false)
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -24,7 +24,6 @@
   },
   "dependencies": {
     "jszip": "^3.6.0",
-    "rimraf": "^3.0.2",
     "tmp": "^0.2.1",
     "ws": ">=7.4.6"
   },

package/remote/index.js

@@ -464,7 +464,7 @@ class SeleniumServer extends DriverService {
       throw Error('Path to the Selenium jar not specified')
     }
 
-    var options = opt_options || {}
+    const options = opt_options || {}
 
     if (options.port < 0) {
       throw Error('Port must be >= 0: ' + options.port)

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()
+    ))
   }
 }