selenium-webdriver 4.9.2 → 4.10.0

package/CHANGES.md

@@ -1,3 +1,16 @@
+## v4.10.0
+
+#### :nail_care: Polish
+
+* Adding CDP v114 and removing v111
+
+#### :rocket: New Feature
+
+* [Edge] Support webview2 (#11978)
+* [BiDi] Add Script module commands to add/remove preloaded scripts (#11847)
+* [BiDi] Add printPage command (#12124)
+* Add support for proxies with Selenium Manager
+
 ## v4.9.2
 
 #### :nail_care: Polish

package/bidi/browsingContext.js

@@ -129,6 +129,42 @@ class BrowsingContext {
     }
     await this.bidi.send(params)
   }
+
+  /**
+   * Prints PDF of the webpage
+   * @param options print options given by the user
+   * @returns PrintResult object
+   */
+  async printPage(options = {}) {
+    let params = {
+      method: 'browsingContext.print',
+      // Setting default values for parameters
+      params: {
+        context: this._id,
+        background: false,
+        margin: {
+          bottom: 1.0,
+          left: 1.0,
+          right: 1.0,
+          top: 1.0,
+        },
+        orientation: 'portrait',
+        page: {
+          height: 27.94,
+          width: 21.59,
+        },
+        pageRanges: [],
+        scale: 1.0,
+        shrinkToFit: true,
+      },
+    }
+
+    // Updating parameter values based on the options passed
+    params.params = this._driver.validatePrintPageParams(options, params.params)
+
+    const response = await this.bidi.send(params)
+    return new PrintResult(response.result.data)
+  }
 }
 
 class NavigateResult {
@@ -146,6 +182,16 @@ class NavigateResult {
   }
 }
 
+class PrintResult {
+  constructor(data) {
+    this._data = data
+  }
+
+  get data() {
+    return this._data
+  }
+}
+
 /**
  * initiate browsing context instance and return
  * @param driver

package/bidi/scriptManager.js

@@ -23,6 +23,7 @@ const {
 } = require('./evaluateResult')
 const { RealmInfo } = require('./realmInfo')
 const { RemoteValue } = require('./protocolValue')
+const { WebDriverError } = require('../lib/error')
 
 class ScriptManager {
   constructor(driver) {
@@ -179,6 +180,39 @@ class ScriptManager {
     return this.createEvaluateResult(response)
   }
 
+  async addPreloadScript(
+    functionDeclaration,
+    argumentValueList = null,
+    sandbox = null
+  ) {
+    const params = {
+      functionDeclaration: functionDeclaration,
+      arguments: argumentValueList,
+      sandbox: sandbox,
+    }
+
+    const command = {
+      method: 'script.addPreloadScript',
+      params,
+    }
+
+    let response = await this.bidi.send(command)
+    return response.result.script
+  }
+
+  async removePreloadScript(script) {
+    const params = { script: script }
+    const command = {
+      method: 'script.removePreloadScript',
+      params,
+    }
+    let response = await this.bidi.send(command)
+    if ('error' in response) {
+      throw new WebDriverError(response.error)
+    }
+    return response.result
+  }
+
   getCallFunctionParams(
     targetType,
     id,

package/common/driverFinder.js

@@ -32,11 +32,11 @@ function getPath(service, capabilities) {
   try {
     return pathExists(service.getExecutable()) || driverLocation(capabilities)
   } catch (e) {
-      throw Error(
-        `Unable to obtain browser driver.
+    throw Error(
+      `Unable to obtain browser driver.
         For more information on how to install drivers see
         https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/. ${e}`
-      )
+    )
   }
 }
 

package/common/seleniumManager.js

@@ -47,12 +47,7 @@ function getBinary() {
   const file =
     directory === 'windows' ? 'selenium-manager.exe' : 'selenium-manager'
 
-  let seleniumManagerBasePath
-  if (process.env.SELENIUM_MANAGER_BASE_PATH) {
-    seleniumManagerBasePath = process.env.SELENIUM_MANAGER_BASE_PATH
-  } else {
-    seleniumManagerBasePath = path.join(__dirname, '..', '/bin')
-  }
+  let seleniumManagerBasePath = path.join(__dirname, '..', '/bin')
 
   const filePath = path.join(seleniumManagerBasePath, directory, file)
 
@@ -76,16 +71,38 @@ function driverLocation(options) {
     )
   }
 
+  console.debug(
+    'Applicable driver not found; attempting to install with Selenium Manager (Beta)'
+  )
+
   let args = ['--browser', options.getBrowserName(), '--output', 'json']
 
-  if (options.getBrowserVersion() && options.getBrowserVersion() !== "") {
-    args.push("--browser-version", options.getBrowserVersion())
+  if (options.getBrowserVersion() && options.getBrowserVersion() !== '') {
+    args.push('--browser-version', options.getBrowserVersion())
+  }
+
+  const vendorOptions =
+    options.get('goog:chromeOptions') ||
+    options.get('ms:edgeOptions') ||
+    options.get('moz:firefoxOptions')
+  if (vendorOptions && vendorOptions.binary && vendorOptions.binary !== '') {
+    args.push('--browser-path', '"' + vendorOptions.binary + '"')
   }
 
-  const vendorOptions = options.get('goog:chromeOptions') || options.get('ms:edgeOptions')
-                        || options.get('moz:firefoxOptions')
-  if (vendorOptions && vendorOptions.binary && vendorOptions.binary !== "") {
-    args.push("--browser-path", '"' + vendorOptions.binary + '"')
+  const proxyOptions = options.getProxy();
+
+  // Check if proxyOptions exists and has properties
+  if (proxyOptions && Object.keys(proxyOptions).length > 0) {
+    const httpProxy = proxyOptions['httpProxy'];
+    const sslProxy = proxyOptions['sslProxy'];
+
+    if (httpProxy !== undefined) {
+      args.push('--proxy', httpProxy);
+    }
+
+    else if (sslProxy !== undefined) {
+      args.push('--proxy', sslProxy);
+    }
   }
 
   const smBinary = getBinary()
@@ -104,15 +121,18 @@ function driverLocation(options) {
         errorMessage = e.toString()
       }
     }
-    throw new Error(`Error executing command for ${smBinary} with ${args}: ${errorMessage}`)
+    throw new Error(
+      `Error executing command for ${smBinary} with ${args}: ${errorMessage}`
+    )
   }
   try {
     output = JSON.parse(spawnResult.stdout.toString())
   } catch (e) {
-    throw new Error(`Error executing command for ${smBinary} with ${args}: ${e.toString()}`)
+    throw new Error(
+      `Error executing command for ${smBinary} with ${args}: ${e.toString()}`
+    )
   }
 
-
   for (const key in output.logs) {
     if (output.logs[key].level === 'WARN') {
       console.warn(`${output.logs[key].message}`)

package/edge.js

@@ -127,6 +127,19 @@ class Options extends chromium.Options {
   setEdgeChromiumBinaryPath(path) {
     return this.setBinaryPath(path)
   }
+
+  /**
+   * Changes the browser name to 'webview2' to enable
+   * <a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/how-to/webdriver">
+   *   test automation of WebView2 apps with Microsoft Edge WebDriver
+   * </a>
+   *
+   * @param {boolean} enable  flag to enable or disable the 'webview2' usage
+   */
+  useWebView(enable) {
+    const browserName = enable ? 'webview2' : Browser.EDGE
+    return this.setBrowserName(browserName)
+  }
 }
 
 /**

package/io/exec.js

@@ -141,8 +141,8 @@ function exec(command, opt_options) {
       resolve(new Result(code, signal))
     })
 
-    proc.once('error', err => {
-      reject(err);
+    proc.once('error', (err) => {
+      reject(err)
     })
   })
   return new Command(result, killCommand)

package/lib/atoms/find-elements.js

@@ -114,10 +114,9 @@ function nd(a,b,c,d){a=a.nodeValue.replace(/[\u200b\u200e\u200f]/g,"");a=a.repla
 function pd(a,b,c,d,e){if(3==a.nodeType&&c)nd(a,b,d,e);else if(S(a))if(S(a,"CONTENT")||S(a,"SLOT")){for(var f=a;f.parentNode;)f=f.parentNode;f instanceof ShadowRoot?(a=S(a,"CONTENT")?a.getDistributedNodes():a.assignedNodes(),l(a,function(g){pd(g,b,c,d,e)})):jd(a,b)}else if(S(a,"SHADOW")){for(f=a;f.parentNode;)f=f.parentNode;if(f instanceof ShadowRoot&&(a=f))for(a=a.olderShadowRoot;a;)l(a.childNodes,function(g){pd(g,b,c,d,e)}),a=a.olderShadowRoot}else jd(a,b)}
 function jd(a,b){a.shadowRoot&&l(a.shadowRoot.childNodes,function(c){pd(c,b,!0,null,null)});ld(a,b,function(c,d,e,f,g){var h=null;1==c.nodeType?h=c:3==c.nodeType&&(h=c);null!=h&&(null!=h.assignedSlot||h.getDestinationInsertionPoints&&0<h.getDestinationInsertionPoints().length)||pd(c,d,e,f,g)})};var qd={C:function(a,b){return!(!a.querySelectorAll||!a.querySelector)&&!/^\d.*/.test(b)},o:function(a,b){var c=eb(b),d="string"===typeof a?c.a.getElementById(a):a;return d?Uc(d,"id")==a&&b!=d&&hb(b,d)?d:ua(mb(c,"*"),function(e){return Uc(e,"id")==a&&b!=e&&hb(b,e)}):null},j:function(a,b){if(!a)return[];if(qd.C(b,a))try{return b.querySelectorAll("#"+qd.T(a))}catch(c){return[]}b=mb(eb(b),"*",null,b);return pa(b,function(c){return Uc(c,"id")==a})},T:function(a){return a.replace(/([\s'"\\#.:;,!?+<>=~*^$|%&@`{}\-\/\[\]\(\)])/g,
 "\\$1")}};var Y={},rd={};Y.N=function(a,b,c){try{var d=Nc.j("a",b)}catch(e){d=mb(eb(b),"A",null,b)}return ua(d,function(e){e=id(e);e=e.replace(/^[\s]+|[\s]+$/g,"");return c&&-1!=e.indexOf(a)||e==a})};Y.K=function(a,b,c){try{var d=Nc.j("a",b)}catch(e){d=mb(eb(b),"A",null,b)}return pa(d,function(e){e=id(e);e=e.replace(/^[\s]+|[\s]+$/g,"");return c&&-1!=e.indexOf(a)||e==a})};Y.o=function(a,b){return Y.N(a,b,!1)};Y.j=function(a,b){return Y.K(a,b,!1)};rd.o=function(a,b){return Y.N(a,b,!0)};
-rd.j=function(a,b){return Y.K(a,b,!0)};var Z={F:function(a,b){return function(c){var d=Z.u(a);d=W(d);c=W(c);return b.call(null,d,c)}},R:function(a){return Z.F(a,function(b,c){return c.b+c.height<b.b})},S:function(a){return Z.F(a,function(b,c){return b.b+b.height<c.b})},V:function(a){return Z.F(a,function(b,c){return c.a+c.width<b.a})},aa:function(a){return Z.F(a,function(b,c){return b.a+b.width<c.a})},W:function(a,b){var c;b?c=b:"number"==typeof a.distance&&(c=a.distance);c||(c=100);return function(d){var e=Z.u(a);if(e===d)return!1;e=
-W(e);d=W(d);var f=Math.abs(e.a+e.width-d.a),g=Math.abs(e.b+e.height-d.b);g=Math.abs(e.b-(d.b+d.height))<=c||g<=c;return(Math.abs(e.a-(d.a+d.width))<=c||f<=c)&&g?!0:Math.sqrt(Math.pow(Math.abs(e.a+e.width/2-(d.a+d.width/2)),2)+Math.pow(Math.abs(e.b+e.height/2-(d.b+d.height/2)),2))<=c}},u:function(a){if(ha(a)&&1==a.nodeType)return a;if(ea(a))return Z.u(a.call(null));if(ha(a)){var b;a:{if(b=sd(a)){var c=td[b];if(c&&ea(c.o)){b=c.o(a[b],Bc.document);break a}}throw new P(61,"Unsupported locator strategy: "+
-b);}if(!b)throw new P(7,"No element has been found by "+JSON.stringify(a));return b}throw new P(61,"Selector is of wrong type: "+JSON.stringify(a));}};Z.P={left:Z.V,right:Z.aa,above:Z.R,below:Z.S,near:Z.W};Z.O={left:Z.u,right:Z.u,above:Z.u,below:Z.u,near:Z.u};
-Z.U=function(a,b){var c=[];l(a,function(e){e&&ta(b,function(f){var g=f.kind,h=Z.P[g];if(!h)throw new P(61,"Cannot find filter suitable for "+g);return h.apply(null,f.args)(e)},null)&&c.push(e)},null);a=b[b.length-1];var d=Z.O[a?a.kind:"unknown"];return d?(a=d.apply(null,a.args))?Z.ba(a,c):c:c};
+rd.j=function(a,b){return Y.K(a,b,!0)};var Z={F:function(a,b){return function(c){var d=Z.u(a);d=W(d);c=W(c);return b.call(null,d,c)}},R:function(a){return Z.F(a,function(b,c){return c.b+c.height<b.b})},S:function(a){return Z.F(a,function(b,c){return b.b+b.height<c.b})},V:function(a){return Z.F(a,function(b,c){return c.a+c.width<b.a})},aa:function(a){return Z.F(a,function(b,c){return b.a+b.width<c.a})},W:function(a,b){var c;b?c=b:"number"==typeof a.distance&&(c=a.distance);c||(c=50);return function(d){var e=Z.u(a);if(e===d)return!1;e=W(e);
+d=W(d);e=new U(e.a-c,e.b-c,e.width+2*c,e.height+2*c);return e.a<=d.a+d.width&&d.a<=e.a+e.width&&e.b<=d.b+d.height&&d.b<=e.b+e.height}},u:function(a){if(ha(a)&&1==a.nodeType)return a;if(ea(a))return Z.u(a.call(null));if(ha(a)){var b;a:{if(b=sd(a)){var c=td[b];if(c&&ea(c.o)){b=c.o(a[b],Bc.document);break a}}throw new P(61,"Unsupported locator strategy: "+b);}if(!b)throw new P(7,"No element has been found by "+JSON.stringify(a));return b}throw new P(61,"Selector is of wrong type: "+JSON.stringify(a));
+}};Z.P={left:Z.V,right:Z.aa,above:Z.R,below:Z.S,near:Z.W};Z.O={left:Z.u,right:Z.u,above:Z.u,below:Z.u,near:Z.u};Z.U=function(a,b){var c=[];l(a,function(e){e&&ta(b,function(f){var g=f.kind,h=Z.P[g];if(!h)throw new P(61,"Cannot find filter suitable for "+g);return h.apply(null,f.args)(e)},null)&&c.push(e)},null);a=b[b.length-1];var d=Z.O[a?a.kind:"unknown"];return d?(a=d.apply(null,a.args))?Z.ba(a,c):c:c};
 Z.ba=function(a,b){function c(f){f=W(f);return Math.sqrt(Math.pow(d-(f.a+Math.max(1,f.width)/2),2)+Math.pow(e-(f.b+Math.max(1,f.height)/2),2))}a=W(a);var d=a.a+Math.max(1,a.width)/2,e=a.b+Math.max(1,a.height)/2;xa(b,function(f,g){return c(f)-c(g)});return b};Z.o=function(a,b){a=Z.j(a,b);return 0==a.length?null:a[0]};
 Z.j=function(a,b){if(!a.hasOwnProperty("root")||!a.hasOwnProperty("filters"))throw new P(61,"Locator not suitable for relative locators: "+JSON.stringify(a));var c=a.filters,d=da(c);if("array"!=d&&("object"!=d||"number"!=typeof c.length))throw new P(61,"Targets should be an array: "+JSON.stringify(a));var e;S(a.root)?e=[a.root]:e=ud(a.root,b);return 0==e.length?[]:Z.U(e,a.filters)};var vd={o:function(a,b){if(""===a)throw new P(32,'Unable to locate an element with the tagName ""');return b.getElementsByTagName(a)[0]||null},j:function(a,b){if(""===a)throw new P(32,'Unable to locate an element with the tagName ""');return b.getElementsByTagName(a)}};var td={className:Dc,"class name":Dc,css:Nc,"css selector":Nc,relative:Z,id:qd,linkText:Y,"link text":Y,name:{o: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:T};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);};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.9.2",
+  "version": "4.10.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -28,7 +28,7 @@
     "ws": ">=8.13.0"
   },
   "devDependencies": {
-    "eslint": "^8.37.0",
+    "eslint": "^8.41.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
@@ -36,9 +36,9 @@
     "express": "^4.18.2",
     "mocha": "^10.2.0",
     "multer": "^1.4.5-lts.1",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "serve-index": "^1.9.1",
-    "sinon": "^15.0.3"
+    "sinon": "^15.1.0"
   },
   "scripts": {
     "lint": "eslint --ignore-pattern node_modules --ignore-pattern generator --ext js lib/http.js \"**/*.js\"",