selenium-webdriver 4.28.1 → 4.29.0

package/CHANGES.md

@@ -1,6 +1,13 @@
+## 4.29.0
+
+- Add CDP for Chrome 133 and remove 130
+- [js] Remove Firefox CDP (#15200)
+- [js][bidi] Implement bidi `setCacheBehavior` command (#15136)
+- [js][bidi] Implement bidi getClientWindows command in browser module (#15248)
+
 ## 4.28.1
---> Bumping version for nightly
---> [JS] specify min required node versiton to 18.20.5
+
+- [JS] specify min required node versiton to 18.20.5
 
 ## 4.28.0
 

package/bidi/browser.js

@@ -15,6 +15,8 @@
 // specific language governing permissions and limitations
 // under the License.
 
+const { WindowState, ClientWindowInfo } = require('./clientWindowInfo')
+
 /**
  * Represents the commands and events under Browser Module.
  * Described in https://w3c.github.io/webdriver-bidi/#module-browser
@@ -83,6 +85,20 @@ class Browser {
 
     await this.bidi.send(command)
   }
+
+  /**
+   * Gets information about all client windows.
+   * @returns {Promise<ClientWindowInfo[]>} Array of client window information
+   */
+  async getClientWindows() {
+    const command = {
+      method: 'browser.getClientWindows',
+      params: {},
+    }
+
+    const response = await this.bidi.send(command)
+    return response.result.clientWindows.map((window) => ClientWindowInfo.fromJson(window))
+  }
 }
 
 async function getBrowserInstance(driver) {
@@ -92,3 +108,4 @@ async function getBrowserInstance(driver) {
 }
 
 module.exports = getBrowserInstance
+module.exports.WindowState = WindowState

package/bidi/clientWindowInfo.js

@@ -0,0 +1,54 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const WindowState = Object.freeze({
+  FULLSCREEN: 'fullscreen',
+  MAXIMIZED: 'maximized',
+  MINIMIZED: 'minimized',
+  NORMAL: 'normal',
+})
+
+class ClientWindowInfo {
+  /**
+   * @param {Object} params Window information parameters
+   * @param {string} params.clientWindow Window identifier
+   * @param {string} params.state Window state from WindowState
+   * @param {number} params.width Window width
+   * @param {number} params.height Window height
+   * @param {number} params.x Window x coordinate
+   * @param {number} params.y Window y coordinate
+   * @param {boolean} params.active Whether window is active and can receive keyboard input
+   */
+  constructor({ clientWindow, state, width, height, x, y, active }) {
+    this.clientWindow = clientWindow
+    this.state = state
+    this.width = width
+    this.height = height
+    this.x = x
+    this.y = y
+    this.active = active
+  }
+
+  static fromJson(json) {
+    return new ClientWindowInfo({
+      ...json,
+      state: json.state.toLowerCase(),
+    })
+  }
+}
+
+module.exports = { WindowState, ClientWindowInfo }

package/bidi/network.js

@@ -29,6 +29,11 @@ const NetworkEvent = {
   FETCH_ERROR: 'network.fetchError',
 }
 
+const CacheBehavior = Object.freeze({
+  DEFAULT: 'default',
+  BYPASS: 'bypass',
+})
+
 /**
  * Represents all commands and events of Network module.
  * Described in https://w3c.github.io/webdriver-bidi/#module-network.
@@ -355,6 +360,40 @@ class Network {
     await this.bidi.send(command)
   }
 
+  /**
+   * Sets the cache behavior for network requests.
+   *
+   * @param {string} behavior - The cache behavior ("default" or "bypass")
+   * @param {Array<string>} [contexts] - Optional array of browsing context IDs
+   * @returns {Promise<void>} A promise that resolves when the cache behavior is set
+   * @throws {Error} If behavior is invalid or context IDs are invalid
+   */
+  async setCacheBehavior(behavior, contexts = null) {
+    if (!Object.values(CacheBehavior).includes(behavior)) {
+      throw new Error(`Cache behavior must be either "${CacheBehavior.DEFAULT}" or "${CacheBehavior.BYPASS}"`)
+    }
+
+    const command = {
+      method: 'network.setCacheBehavior',
+      params: {
+        cacheBehavior: behavior,
+      },
+    }
+
+    if (contexts !== null) {
+      if (
+        !Array.isArray(contexts) ||
+        contexts.length === 0 ||
+        contexts.some((c) => typeof c !== 'string' || c.trim() === '')
+      ) {
+        throw new Error('Contexts must be an array of non-empty strings')
+      }
+      command.params.contexts = contexts
+    }
+
+    await this.bidi.send(command)
+  }
+
   /**
    * Unsubscribes from network events for all browsing contexts.
    * @returns {Promise<void>} A promise that resolves when the network connection is closed.
@@ -389,4 +428,4 @@ async function getNetworkInstance(driver, browsingContextIds = null) {
   return instance
 }
 
-module.exports = getNetworkInstance
+module.exports = { Network: getNetworkInstance, CacheBehavior }

package/lib/network.js

@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-const network = require('../bidi/network')
+const { Network: getNetwork } = require('../bidi/network')
 const { InterceptPhase } = require('../bidi/interceptPhase')
 const { AddInterceptParameters } = require('../bidi/addInterceptParameters')
 
@@ -39,7 +39,7 @@ class Network {
     if (this.#network !== undefined) {
       return
     }
-    this.#network = await network(this.#driver)
+    this.#network = await getNetwork(this.#driver)
 
     await this.#network.addIntercept(new AddInterceptParameters(InterceptPhase.AUTH_REQUIRED))
 

package/lib/webdriver.js

@@ -1244,9 +1244,7 @@ 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.',
-      )
+      throw new Error('CDP support for Firefox is removed. Please switch to WebDriver BiDi.')
     }
 
     if (process.env.SELENIUM_REMOTE_URL) {
@@ -1255,11 +1253,7 @@ class WebDriver {
       debuggerUrl = `ws://${host}/session/${sessionId}/se/cdp`
     } else {
       const seCdp = caps['map_'].get('se:cdp')
-      const vendorInfo =
-        caps['map_'].get('goog:chromeOptions') ||
-        caps['map_'].get('ms:edgeOptions') ||
-        caps['map_'].get('moz:debuggerAddress') ||
-        new Map()
+      const vendorInfo = caps['map_'].get('goog:chromeOptions') || caps['map_'].get('ms:edgeOptions') || new Map()
       debuggerUrl = seCdp || vendorInfo['debuggerAddress'] || vendorInfo
     }
     this._wsUrl = await this.getWsUrl(debuggerUrl, target, caps)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.28.1",
+  "version": "4.29.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [