selenium-webdriver 4.25.0 → 4.27.0

package/CHANGES.md

@@ -1,3 +1,19 @@
+## 4.27.0
+
+- Add CDP for Chrome 131 and remove 128
+- Add Firefox CDP deprecation warnings
+- Update supported versions for Chrome DevTools
+- [bidi] Allow passing in uri for authentication handlers (#14386)
+- [bidi] Enable locate node tests for Chrome and Edge
+- [bidi] Ensure start nodes are serialized
+
+## 4.26.0
+
+- Add CDP for Chrome 130 and remove 127
+- Fix sendKeys command fail on FileDetector.handleFile error (#14663)
+- Update dependencies to latest versions to resolve security alerts
+- Close BiDi websocket connection (#14507)
+
 ## 4.25.0
 
 - Add CDP for Chrome 129 and remove 126

package/bidi/browsingContext.js

@@ -156,8 +156,7 @@ class BrowsingContext {
       method: 'browsingContext.create',
       params: Object.fromEntries(parameters),
     }
-    const res = await this.bidi.send(params)
-    return res
+    return await this.bidi.send(params)
   }
 
   /**
@@ -528,10 +527,15 @@ class BrowsingContext {
       throw Error(`Pass in an array of ReferenceValue objects. Received: ${startNodes}`)
     }
 
+    let startNodesSerialized = undefined
+
     if (startNodes !== undefined && Array.isArray(startNodes)) {
+      startNodesSerialized = []
       startNodes.forEach((node) => {
         if (!(node instanceof ReferenceValue)) {
           throw Error(`Pass in a ReferenceValue object. Received: ${node}`)
+        } else {
+          startNodesSerialized.push(node.asMap())
         }
       })
     }
@@ -544,7 +548,7 @@ class BrowsingContext {
         maxNodeCount: maxNodeCount,
         sandbox: sandbox,
         serializationOptions: serializationOptions,
-        startNodes: startNodes,
+        startNodes: startNodesSerialized,
       },
     }
 

package/bidi/continueRequestParameters.js

@@ -47,7 +47,7 @@ class ContinueRequestParameters {
    * Sets the cookies for the request.
    *
    * @param {Header[]} cookieHeaders - An array of cookie headers.
-   * @returns {continueRequestParameters} - The current instance of the ContinueRequestParameters for chaining.
+   * @returns {ContinueRequestParameters} - The current instance of the ContinueRequestParameters for chaining.
    * @throws {Error} - If a cookie header is not an instance of Header.
    */
   cookies(cookieHeaders) {

package/bidi/filterBy.js

@@ -21,7 +21,7 @@ class FilterBy {
   }
 
   static logLevel(level) {
-    if (level === undefined || (level != undefined && !['debug', 'error', 'info', 'warning'].includes(level))) {
+    if (level === undefined || (level !== undefined && !['debug', 'error', 'info', 'warning'].includes(level))) {
       throw Error(
         `Please pass valid log level. Valid log levels are 'debug', 'error', 'info' and 'warning'. Received: ${level}`,
       )

package/bidi/logEntries.js

@@ -21,12 +21,13 @@ const { Source } = require('./scriptTypes')
 
 /**
  * Represents a base log entry.
- * Desribed in https://w3c.github.io/webdriver-bidi/#types-log-logentry.
+ * Described in https://w3c.github.io/webdriver-bidi/#types-log-logentry.
  */
 class BaseLogEntry {
   /**
    * Creates a new instance of BaseLogEntry.
    * @param {string} level - The log level.
+   * @param {source} source - Script Source
    * @param {string} text - The log source.
    * @param {string} text - The log text.
    * @param {number} timeStamp - The log timestamp.
@@ -86,6 +87,7 @@ class GenericLogEntry extends BaseLogEntry {
   /**
    * Creates an instance of GenericLogEntry.
    * @param {string} level - The log level.
+   * @param {source} source - Script Source
    * @param {string} text - The log text.
    * @param {Date} timeStamp - The log timestamp.
    * @param {string} type - The log type.

package/bidi/protocolValue.js

@@ -145,7 +145,7 @@ class LocalValue {
   /**
    * Creates a new LocalValue object from the passed object.
    *
-   * @param {Object} map - The object.
+   * @param {Object} object - The object.
    * @returns {LocalValue} - The created LocalValue object.
    */
   static createObjectValue(object) {
@@ -431,7 +431,7 @@ class ChannelValue {
       }
     }
 
-    if (resultOwnership != undefined) {
+    if (resultOwnership !== undefined) {
       if (['root', 'none'].includes(resultOwnership)) {
         this.resultOwnership = resultOwnership
       } else {

package/bidi/storage.js

@@ -138,11 +138,7 @@ class Storage {
         Object.prototype.hasOwnProperty.call(response.result.partitionKey, 'userContext') &&
         Object.prototype.hasOwnProperty.call(response.result.partitionKey, 'sourceOrigin')
       ) {
-        let partitionKey = new PartitionKey(
-          response.result.partitionKey.userContext,
-          response.result.partitionKey.sourceOrigin,
-        )
-        return partitionKey
+        return new PartitionKey(response.result.partitionKey.userContext, response.result.partitionKey.sourceOrigin)
       }
     }
   }
@@ -182,11 +178,7 @@ class Storage {
         Object.prototype.hasOwnProperty.call(response.result.partitionKey, 'userContext') &&
         Object.prototype.hasOwnProperty.call(response.result.partitionKey, 'sourceOrigin')
       ) {
-        let partitionKey = new PartitionKey(
-          response.result.partitionKey.userContext,
-          response.result.partitionKey.sourceOrigin,
-        )
-        return partitionKey
+        return new PartitionKey(response.result.partitionKey.userContext, response.result.partitionKey.sourceOrigin)
       }
     }
   }

package/lib/network.js

@@ -20,9 +20,10 @@ const { InterceptPhase } = require('../bidi/interceptPhase')
 const { AddInterceptParameters } = require('../bidi/addInterceptParameters')
 
 class Network {
+  #callbackId = 0
   #driver
   #network
-  #callBackInterceptIdMap = new Map()
+  #authHandlers = new Map()
 
   constructor(driver) {
     this.#driver = driver
@@ -30,7 +31,7 @@ class Network {
 
   // This should be done in the constructor.
   // But since it needs to call async methods we cannot do that in the constructor.
-  // We can have a separate async method that initialises the Script instance.
+  // We can have a separate async method that initialises the Network instance.
   // However, that pattern does not allow chaining the methods as we would like the user to use it.
   // Since it involves awaiting to get the instance and then another await to call the method.
   // Using this allows the user to do this "await driver.network.addAuthenticationHandler(callback)"
@@ -39,39 +40,51 @@ class Network {
       return
     }
     this.#network = await network(this.#driver)
-  }
 
-  async addAuthenticationHandler(username, password) {
-    await this.#init()
+    await this.#network.addIntercept(new AddInterceptParameters(InterceptPhase.AUTH_REQUIRED))
 
-    const interceptId = await this.#network.addIntercept(new AddInterceptParameters(InterceptPhase.AUTH_REQUIRED))
+    await this.#network.authRequired(async (event) => {
+      const requestId = event.request.request
+      const uri = event.request.url
+      const credentials = this.getAuthCredentials(uri)
+      if (credentials !== null) {
+        await this.#network.continueWithAuth(requestId, credentials.username, credentials.password)
+        return
+      }
 
-    const id = await this.#network.authRequired(async (event) => {
-      await this.#network.continueWithAuth(event.request.request, username, password)
+      await this.#network.continueWithAuthNoCredentials(requestId)
     })
+  }
+
+  getAuthCredentials(uri) {
+    for (let [, value] of this.#authHandlers) {
+      if (uri.match(value.uri)) {
+        return value
+      }
+    }
+    return null
+  }
+  async addAuthenticationHandler(username, password, uri = '//') {
+    await this.#init()
 
-    this.#callBackInterceptIdMap.set(id, interceptId)
+    const id = this.#callbackId++
+
+    this.#authHandlers.set(id, { username, password, uri })
     return id
   }
 
   async removeAuthenticationHandler(id) {
     await this.#init()
 
-    const interceptId = this.#callBackInterceptIdMap.get(id)
-
-    await this.#network.removeIntercept(interceptId)
-    await this.#network.removeCallback(id)
-
-    this.#callBackInterceptIdMap.delete(id)
+    if (this.#authHandlers.has(id)) {
+      this.#authHandlers.delete(id)
+    } else {
+      throw Error(`Callback with id ${id} not found`)
+    }
   }
 
   async clearAuthenticationHandlers() {
-    for (const [key, value] of this.#callBackInterceptIdMap.entries()) {
-      await this.#network.removeIntercept(value)
-      await this.#network.removeCallback(key)
-    }
-
-    this.#callBackInterceptIdMap.clear()
+    this.#authHandlers.clear()
   }
 }
 

package/lib/webdriver.js

@@ -789,8 +789,13 @@ class WebDriver {
       // If the websocket connection is not closed,
       // and we are running CDP sessions against the Selenium Grid,
       // the node process never exits since the websocket connection is open until the Grid is shutdown.
-      if (this._wsConnection !== undefined) {
-        this._wsConnection.close()
+      if (this._cdpWsConnection !== undefined) {
+        this._cdpWsConnection.close()
+      }
+
+      // Close the BiDi websocket connection
+      if (this._bidiConnection !== undefined) {
+        this._bidiConnection.close()
       }
     })
   }
@@ -1225,6 +1230,12 @@ class WebDriver {
 
     const caps = await this.getCapabilities()
 
+    if (caps['map_'].get('browserName') === 'firefox') {
+      console.warn(
+        'CDP support for Firefox is deprecated and will be removed in future versions. Please switch to WebDriver BiDi.',
+      )
+    }
+
     if (process.env.SELENIUM_REMOTE_URL) {
       const host = new URL(process.env.SELENIUM_REMOTE_URL).host
       const sessionId = await this.getSession().then((session) => session.getId())
@@ -1241,18 +1252,18 @@ class WebDriver {
     this._wsUrl = await this.getWsUrl(debuggerUrl, target, caps)
     return new Promise((resolve, reject) => {
       try {
-        this._wsConnection = new WebSocket(this._wsUrl.replace('localhost', '127.0.0.1'))
-        this._cdpConnection = new cdp.CdpConnection(this._wsConnection)
+        this._cdpWsConnection = new WebSocket(this._wsUrl.replace('localhost', '127.0.0.1'))
+        this._cdpConnection = new cdp.CdpConnection(this._cdpWsConnection)
       } catch (err) {
         reject(err)
         return
       }
 
-      this._wsConnection.on('open', async () => {
+      this._cdpWsConnection.on('open', async () => {
         await this.getCdpTargets()
       })
 
-      this._wsConnection.on('message', async (message) => {
+      this._cdpWsConnection.on('message', async (message) => {
         const params = JSON.parse(message)
         if (params.result) {
           if (params.result.targetInfos) {
@@ -1273,7 +1284,7 @@ class WebDriver {
         }
       })
 
-      this._wsConnection.on('error', (error) => {
+      this._cdpWsConnection.on('error', (error) => {
         reject(error)
       })
     })
@@ -1288,9 +1299,12 @@ class WebDriver {
    * @returns {BIDI}
    */
   async getBidi() {
-    const caps = await this.getCapabilities()
-    let WebSocketUrl = caps['map_'].get('webSocketUrl')
-    return new BIDI(WebSocketUrl.replace('localhost', '127.0.0.1'))
+    if (this._bidiConnection === undefined) {
+      const caps = await this.getCapabilities()
+      let WebSocketUrl = caps['map_'].get('webSocketUrl')
+      this._bidiConnection = new BIDI(WebSocketUrl.replace('localhost', '127.0.0.1'))
+    }
+    return this._bidiConnection
   }
 
   /**
@@ -1338,7 +1352,7 @@ class WebDriver {
    * @param connection CDP Connection
    */
   async register(username, password, connection) {
-    this._wsConnection.on('message', (message) => {
+    this._cdpWsConnection.on('message', (message) => {
       const params = JSON.parse(message)
 
       if (params.method === 'Fetch.authRequired') {
@@ -1383,7 +1397,7 @@ class WebDriver {
    * @param callback callback called when we intercept requests.
    */
   async onIntercept(connection, httpResponse, callback) {
-    this._wsConnection.on('message', (message) => {
+    this._cdpWsConnection.on('message', (message) => {
       const params = JSON.parse(message)
       if (params.method === 'Fetch.requestPaused') {
         const requestPausedParams = params['params']
@@ -1420,7 +1434,7 @@ class WebDriver {
    * @returns {Promise<void>}
    */
   async onLogEvent(connection, callback) {
-    this._wsConnection.on('message', (message) => {
+    this._cdpWsConnection.on('message', (message) => {
       const params = JSON.parse(message)
       if (params.method === 'Runtime.consoleAPICalled') {
         const consoleEventParams = params['params']
@@ -1457,7 +1471,7 @@ class WebDriver {
   async onLogException(connection, callback) {
     await connection.execute('Runtime.enable', {}, null)
 
-    this._wsConnection.on('message', (message) => {
+    this._cdpWsConnection.on('message', (message) => {
       const params = JSON.parse(message)
 
       if (params.method === 'Runtime.exceptionThrown') {
@@ -1510,7 +1524,7 @@ class WebDriver {
       null,
     )
 
-    this._wsConnection.on('message', async (message) => {
+    this._cdpWsConnection.on('message', async (message) => {
       const params = JSON.parse(message)
       if (params.method === 'Runtime.bindingCalled') {
         let payload = JSON.parse(params['params']['payload'])
@@ -2744,6 +2758,7 @@ class WebElement {
       keys = await this.driver_.fileDetector_.handleFile(this.driver_, keys.join(''))
     } catch (ex) {
       this.log_.severe('Error trying parse string as a file with file detector; sending keys instead' + ex)
+      keys = keys.join('')
     }
 
     return this.execute_(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.25.0",
+  "version": "4.27.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -23,30 +23,30 @@
     "node": ">= 14.21.0"
   },
   "dependencies": {
-    "@bazel/runfiles": "^5.8.1",
+    "@bazel/runfiles": "^6.3.1",
     "jszip": "^3.10.1",
     "tmp": "^0.2.3",
     "ws": "^8.18.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.8.0",
+    "@eslint/js": "^9.14.0",
     "clean-jsdoc-theme": "^4.3.0",
-    "eslint": "^9.8.0",
+    "eslint": "^9.14.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-mocha": "^10.5.0",
-    "eslint-plugin-n": "^17.10.1",
-    "eslint-plugin-no-only-tests": "^3.1.0",
+    "eslint-plugin-n": "^17.13.1",
+    "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-prettier": "^5.2.1",
-    "express": "^4.19.2",
-    "globals": "^15.9.0",
+    "express": "^4.21.1",
+    "globals": "^15.12.0",
     "has-flag": "^5.0.1",
-    "jsdoc": "^4.0.3",
-    "mocha": "^10.7.0",
+    "jsdoc": "^4.0.4",
+    "mocha": "^10.8.2",
     "mocha-junit-reporter": "^2.2.1",
     "multer": "1.4.5-lts.1",
     "prettier": "^3.3.3",
     "serve-index": "^1.9.1",
-    "sinon": "^18.0.0",
+    "sinon": "^19.0.2",
     "supports-color": "^9.4.0"
   },
   "scripts": {
@@ -61,5 +61,15 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
-  }
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/SeleniumHQ"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/selenium"
+    }
+  ]
 }