selenium-webdriver 4.28.1 → 4.30.0

package/CHANGES.md

@@ -1,6 +1,20 @@
+## 4.30.0
+
+- [bidi] fix chrome and firefox test for CI RBE (#15405)
+- [cdp] add support for 134 and remove 131
+- [cdp] remove support for v85 since no longer required by Firefox
+- [bidi] implement permissions module commands in JS (#15304)
+
+## 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/external/permissions.js

@@ -0,0 +1,73 @@
+// 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 PermissionState = Object.freeze({
+  GRANTED: 'granted',
+  DENIED: 'denied',
+  PROMPT: 'prompt',
+})
+
+class Permission {
+  constructor(driver) {
+    this._driver = driver
+  }
+
+  async init() {
+    if (!(await this._driver.getCapabilities()).get('webSocketUrl')) {
+      throw Error('WebDriver instance must support BiDi protocol')
+    }
+
+    this.bidi = await this._driver.getBidi()
+  }
+
+  /**
+   * Sets a permission state for a given permission descriptor.
+   * @param {Object} permissionDescriptor The permission descriptor.
+   * @param {string} state The permission state (granted, denied, prompt).
+   * @param {string} origin The origin for which the permission is set.
+   * @param {string} [userContext] The user context id (optional).
+   * @returns {Promise<void>}
+   */
+  async setPermission(permissionDescriptor, state, origin, userContext = null) {
+    if (!Object.values(PermissionState).includes(state)) {
+      throw new Error(`Invalid permission state. Must be one of: ${Object.values(PermissionState).join(', ')}`)
+    }
+
+    const command = {
+      method: 'permissions.setPermission',
+      params: {
+        descriptor: permissionDescriptor,
+        state: state,
+        origin: origin,
+      },
+    }
+
+    if (userContext) {
+      command.params.userContext = userContext
+    }
+
+    await this.bidi.send(command)
+  }
+}
+
+async function getPermissionInstance(driver) {
+  let instance = new Permission(driver)
+  await instance.init()
+  return instance
+}
+
+module.exports = { getPermissionInstance, PermissionState }

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/atoms/find-elements.js

@@ -122,4 +122,4 @@ Z.u=function(a,b,c){var d=A(a);if(!d.documentElement)return null;(t||Hc)&&Ac(d?d
 null}}try{return d.evaluate(b,a,e,c,null)}catch(n){if("TypeError"===n.name)return e=d.createNSResolver?d.createNSResolver(d.documentElement):Z.I,d.evaluate(b,a,e,c,null);throw n;}}catch(n){if(!Na||"NS_ERROR_ILLEGAL_VALUE"!=n.name)throw new P(32,"Unable to locate an element with the xpath expression "+b+" because of the following error:\n"+n);}};Z.J=function(a,b){if(!a||1!=a.nodeType)throw new P(32,'The result of the xpath expression "'+b+'" is: '+a+". It should be an element.");};
 Z.s=function(a,b){var c=function(){var d=Z.u(b,a,9);return d?d.singleNodeValue||null:b.selectSingleNode?(d=A(b),d.setProperty&&d.setProperty("SelectionLanguage","XPath"),b.selectSingleNode(a)):null}();null===c||Z.J(c,a);return c};
 Z.j=function(a,b){var c=function(){var d=Z.u(b,a,7);if(d){for(var e=d.snapshotLength,f=[],g=0;g<e;++g)f.push(d.snapshotItem(g));return f}return b.selectNodes?(d=A(b),d.setProperty&&d.setProperty("SelectionLanguage","XPath"),b.selectNodes(a)):[]}();l(c,function(d){Z.J(d,a)});return c};var td={className:Dc,"class name":Dc,css:Nc,"css selector":Nc,relative:Y,id:qd,linkText:X,"link text":X,name:{s:function(a,b){b=mb(eb(b),"*",null,b);return ua(b,function(c){return Uc(c,"name")==a})},j:function(a,b){b=mb(eb(b),"*",null,b);return pa(b,function(c){return Uc(c,"name")==a})}},partialLinkText:rd,"partial link text":rd,tagName:vd,"tag name":vd,xpath:Z};function sd(a){for(var b in a)if(a.hasOwnProperty(b))return b;return null}
-function ud(a,b){var c=sd(a);if(c){var d=td[c];if(d&&ea(d.j))return d.j(a[c],b||Bc.document)}throw new P(61,"Unsupported locator strategy: "+c);};ca("_",ud);; return this._.apply(null,arguments);}).apply({navigator:typeof window!='undefined'?window.navigator:null,document:typeof window!='undefined'?window.document:null}, arguments);};
+function ud(a,b){var c=sd(a);if(c){var d=td[c];if(d&&ea(d.j))return d.j(a[c],b||Bc.document)}throw new P(61,"Unsupported locator strategy: "+c);};ca("se_exportedFunctionSymbol",ud);; return this.se_exportedFunctionSymbol.apply(null,arguments);}).apply(window, arguments);};

package/lib/atoms/get-attribute.js

@@ -4,4 +4,4 @@ m[51]="invalid selector";m[52]="invalid selector";m[17]="javascript error";m[405
 a:{var F="",G=function(){var a=p;if(B)return/rv:([^\);]+)(\)|;)/.exec(a);if(A)return/Edge\/([\d\.]+)/.exec(a);if(z)return/\b(?:MSIE|rv)[: ]([^\);]+)(\)|;)/.exec(a);if(C)return/WebKit\/(\S+)/.exec(a);if(y)return/(?:Version)[ \/]?(\S+)/.exec(a)}();G&&(F=G?G[1]:"");if(z){var H=D();if(null!=H&&H>parseFloat(F)){E=String(H);break a}}E=F}var I;I=d.document&&z?D():void 0;var J=u(),K=w()||t("iPod"),L=t("iPad"),M=t("Android")&&!(v()||u()||t("Opera")||t("Silk")),N=v(),aa=t("Safari")&&!(v()||t("Coast")||t("Opera")||t("Edge")||t("Edg/")||t("OPR")||u()||t("Silk")||t("Android"))&&!(w()||t("iPad")||t("iPod"));function O(a){return(a=a.exec(p))?a[1]:""}(function(){if(J)return O(/Firefox\/([0-9.]+)/);if(z||A||y)return E;if(N)return w()||t("iPad")||t("iPod")?O(/CriOS\/([0-9.]+)/):O(/Chrome\/([0-9.]+)/);if(aa&&!(w()||t("iPad")||t("iPod")))return O(/Version\/([0-9.]+)/);if(K||L){var a=/Version\/(\S+).*Mobile\/(\S+)/.exec(p);if(a)return a[1]+"."+a[2]}else if(M)return(a=O(/Android\s+([0-9.]+)/))?a:O(/Version\/([0-9.]+)/);return""})();var P=z&&!(8<=Number(I)),ba=z&&!(9<=Number(I));var ca={SCRIPT:1,STYLE:1,HEAD:1,IFRAME:1,OBJECT:1},Q={IMG:" ",BR:"\n"};function R(a,b,c){if(!(a.nodeName in ca))if(3==a.nodeType)c?b.push(String(a.nodeValue).replace(/(\r\n|\r|\n)/g,"")):b.push(a.nodeValue);else if(a.nodeName in Q)b.push(Q[a.nodeName]);else for(a=a.firstChild;a;)R(a,b,c),a=a.nextSibling};function S(a,b){b=b.toLowerCase();return"style"==b?da(a.style.cssText):P&&"value"==b&&T(a,"INPUT")?a.value:ba&&!0===a[b]?String(a.getAttribute(b)):(a=a.getAttributeNode(b))&&a.specified?a.value:null}var ea=/[;]+(?=(?:(?:[^"]*"){2})*[^"]*$)(?=(?:(?:[^']*'){2})*[^']*$)(?=(?:[^()]*\([^()]*\))*[^()]*$)/;
 function da(a){var b=[];k(a.split(ea),function(c){var e=c.indexOf(":");0<e&&(c=[c.slice(0,e),c.slice(e+1)],2==c.length&&b.push(c[0].toLowerCase(),":",c[1],";"))});b=b.join("");return b=";"==b.charAt(b.length-1)?b:b+";"}function U(a,b){P&&"value"==b&&T(a,"OPTION")&&null===S(a,"value")?(b=[],R(a,b,!1),a=b.join("")):a=a[b];return a}
 function T(a,b){b&&"string"!==typeof b&&(b=b.toString());return a instanceof HTMLFormElement?!!a&&1==a.nodeType&&(!b||"FORM"==b):!!a&&1==a.nodeType&&(!b||a.tagName.toUpperCase()==b)}function V(a){return T(a,"OPTION")?!0:T(a,"INPUT")?(a=a.type.toLowerCase(),"checkbox"==a||"radio"==a):!1};var fa={"class":"className",readonly:"readOnly"},ha="allowfullscreen allowpaymentrequest allowusermedia async autofocus autoplay checked compact complete controls declare default defaultchecked defaultselected defer disabled ended formnovalidate hidden indeterminate iscontenteditable ismap itemscope loop multiple muted nohref nomodule noresize noshade novalidate nowrap open paused playsinline pubdate readonly required reversed scoped seamless seeking selected truespeed typemustmatch willvalidate".split(" ");function W(a,b){var c=null,e=b.toLowerCase();if("style"==e)return(c=a.style)&&"string"!=typeof c&&(c=c.cssText),c;if(("selected"==e||"checked"==e)&&V(a)){if(!V(a))throw new l(15,"Element is not selectable");b="selected";c=a.type&&a.type.toLowerCase();if("checkbox"==c||"radio"==c)b="checked";return U(a,b)?"true":null}var g=T(a,"A");if(T(a,"IMG")&&"src"==e||g&&"href"==e)return(c=S(a,e))&&(c=U(a,e)),c;if("spellcheck"==e){c=S(a,e);if(null!==c){if("false"==c.toLowerCase())return"false";if("true"==c.toLowerCase())return"true"}return U(a,
-e)+""}g=fa[b]||b;if(0<=h(ha,e))return(c=null!==S(a,b)||U(a,g))?"true":null;try{var x=U(a,g)}catch(ia){}(e=null==x)||(e=typeof x,e="object"==e&&null!=x||"function"==e);e?c=S(a,b):c=x;return null!=c?c.toString():null}var X=["_"],Y=d;X[0]in Y||"undefined"==typeof Y.execScript||Y.execScript("var "+X[0]);for(var Z;X.length&&(Z=X.shift());)X.length||void 0===W?Y[Z]&&Y[Z]!==Object.prototype[Z]?Y=Y[Z]:Y=Y[Z]={}:Y[Z]=W;; return this._.apply(null,arguments);}).apply({navigator:typeof window!='undefined'?window.navigator:null,document:typeof window!='undefined'?window.document:null}, arguments);};
+e)+""}g=fa[b]||b;if(0<=h(ha,e))return(c=null!==S(a,b)||U(a,g))?"true":null;try{var x=U(a,g)}catch(ia){}(e=null==x)||(e=typeof x,e="object"==e&&null!=x||"function"==e);e?c=S(a,b):c=x;return null!=c?c.toString():null}var X=["se_exportedFunctionSymbol"],Y=d;X[0]in Y||"undefined"==typeof Y.execScript||Y.execScript("var "+X[0]);for(var Z;X.length&&(Z=X.shift());)X.length||void 0===W?Y[Z]&&Y[Z]!==Object.prototype[Z]?Y=Y[Z]:Y=Y[Z]={}:Y[Z]=W;; return this.se_exportedFunctionSymbol.apply(null,arguments);}).apply(window, arguments);};

package/lib/atoms/is-displayed.js

@@ -26,4 +26,4 @@ function Oa(a){var b=P(a,"MAP");if(!b&&!P(a,"AREA"))return null;var c=b?a:P(a.pa
 n&&1==n.nodeType?n:null)d=V(e),b||"default"==a.shape.toLowerCase()||(a=Ra(a),b=Math.min(Math.max(a.a,0),d.width),n=Math.min(Math.max(a.b,0),d.height),d=new R(b+d.a,n+d.b,Math.min(a.width,d.width-b),Math.min(a.height,d.height-n)))}return{image:e,rect:d||new R(0,0,0,0)}}
 function Ra(a){var b=a.shape.toLowerCase();a=a.coords.split(",");if("rect"==b&&4==a.length){b=a[0];var c=a[1];return new R(b,c,a[2]-b,a[3]-c)}if("circle"==b&&3==a.length)return b=a[2],new R(a[0]-b,a[1]-b,2*b,2*b);if("poly"==b&&2<a.length){b=a[0];c=a[1];for(var e=b,d=c,f=2;f+1<a.length;f+=2)b=Math.min(b,a[f]),e=Math.max(e,a[f]),c=Math.min(c,a[f+1]),d=Math.max(d,a[f+1]);return new R(b,c,e-b,d-c)}return new R(0,0,0,0)}function Qa(a){a=V(a);return new Q(a.b,a.a+a.width,a.b+a.height,a.a)}
 function Pa(a){if(Ia){if("relative"==T(a,"position"))return 1;a=T(a,"filter");return(a=a.match(/^alpha\(opacity=(\d*)\)/)||a.match(/^progid:DXImageTransform.Microsoft.Alpha\(Opacity=(\d*)\)/))?Number(a[1])/100:1}return Sa(a)}function Sa(a){var b=1,c=T(a,"opacity");c&&(b=Number(c));(a=S(a))&&(b*=Sa(a));return b};function Ta(a,b){function c(e){if(P(e)&&"none"==T(e,"display"))return!1;var d;if((d=e.parentNode)&&d.shadowRoot&&void 0!==e.assignedSlot)d=e.assignedSlot?e.assignedSlot.parentNode:null;else if(e.getDestinationInsertionPoints){var f=e.getDestinationInsertionPoints();0<f.length&&(d=f[f.length-1])}if(La&&d instanceof ShadowRoot){if(d.host.shadowRoot&&d.host.shadowRoot!==d)return!1;d=d.host}return!d||9!=d.nodeType&&11!=d.nodeType?d&&P(d,"DETAILS")&&!d.open&&!P(e,"SUMMARY")?!1:!!d&&c(d):!0}return U(a,
-!!b,c)}var X=["_"],Y=g;X[0]in Y||"undefined"==typeof Y.execScript||Y.execScript("var "+X[0]);for(var Z;X.length&&(Z=X.shift());)X.length||void 0===Ta?Y[Z]&&Y[Z]!==Object.prototype[Z]?Y=Y[Z]:Y=Y[Z]={}:Y[Z]=Ta;; return this._.apply(null,arguments);}).apply({navigator:typeof window!='undefined'?window.navigator:null,document:typeof window!='undefined'?window.document:null}, arguments);};
+!!b,c)}var X=["se_exportedFunctionSymbol"],Y=g;X[0]in Y||"undefined"==typeof Y.execScript||Y.execScript("var "+X[0]);for(var Z;X.length&&(Z=X.shift());)X.length||void 0===Ta?Y[Z]&&Y[Z]!==Object.prototype[Z]?Y=Y[Z]:Y=Y[Z]={}:Y[Z]=Ta;; return this.se_exportedFunctionSymbol.apply(null,arguments);}).apply(window, arguments);};

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.30.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [