selenium-webdriver 4.11.1 → 4.13.0

package/CHANGES.md

@@ -1,3 +1,27 @@
+## 4.13.0
+
+#### :nail_care: Polish
+
+* Adding CDP v117 and removing v114
+* Added file location to exception message for Selenium Manager 
+
+#### :rocket: New Feature
+
+* Allow users to set Selenium Manager path by environment variable (#12752)
+
+## 4.12.0
+
+#### :bug: Bug fix
+
+* Adding browsers when they are present on the host (#12456)
+* Create absolute path for browser binary (#12479)
+* Fix how browsers and drivers are discovered (#12456)
+
+#### :nail_care: Polish
+
+* Add support for Chrome 116 and remove support for Chrome 113
+* Remove browserVersion from options in Selenium Manager (#12641)
+
 ## 4.11.1
 
 #### :bug: Bug fix

package/chrome.js

@@ -127,7 +127,6 @@
 
 'use strict'
 
-const io = require('./io')
 const { Browser } = require('./lib/capabilities')
 const chromium = require('./chromium')
 const CHROME_CAPABILITY_KEY = 'goog:chromeOptions'
@@ -221,7 +220,12 @@ class Driver extends chromium.Driver {
   static createSession(opt_config, opt_serviceExecutor) {
     let caps = opt_config || new Options()
     return /** @type {!Driver} */ (
-      super.createSession(caps, opt_serviceExecutor, 'goog', CHROME_CAPABILITY_KEY)
+      super.createSession(
+        caps,
+        opt_serviceExecutor,
+        'goog',
+        CHROME_CAPABILITY_KEY
+      )
     )
   }
 

package/chromium.js

@@ -679,8 +679,12 @@ class Driver extends webdriver.WebDriver {
    * @param vendorCapabilityKey Either 'goog:chromeOptions' or 'ms:edgeOptions'
    * @return {!Driver} A new driver instance.
    */
-  static createSession(caps, opt_serviceExecutor,
-    vendorPrefix = '', vendorCapabilityKey = '') {
+  static createSession(
+    caps,
+    opt_serviceExecutor,
+    vendorPrefix = '',
+    vendorCapabilityKey = ''
+  ) {
     let executor
     let onQuit
     if (opt_serviceExecutor instanceof http.Executor) {
@@ -689,14 +693,14 @@ class Driver extends webdriver.WebDriver {
     } else {
       let service = opt_serviceExecutor || this.getDefaultService()
       if (!service.getExecutable()) {
-        const {driverPath, browserPath} = getPath(caps)
+        const { driverPath, browserPath } = getPath(caps)
         service.setExecutable(driverPath)
         const vendorOptions = caps.get(vendorCapabilityKey)
         if (vendorOptions) {
           vendorOptions['binary'] = browserPath
           caps.set(vendorCapabilityKey, vendorOptions)
         } else {
-          caps.set(vendorCapabilityKey, {binary: browserPath})
+          caps.set(vendorCapabilityKey, { binary: browserPath })
         }
       }
       onQuit = () => service.kill()

package/common/seleniumManager.js

@@ -25,8 +25,9 @@ const { platform } = require('process')
 const path = require('path')
 const fs = require('fs')
 const spawnSync = require('child_process').spawnSync
+const { Capability } = require('../lib/capabilities')
 
-let debugMessagePrinted = false;
+let debugMessagePrinted = false
 
 /**
  * Determines the path of the correct Selenium Manager binary
@@ -45,15 +46,15 @@ function getBinary() {
 
   let seleniumManagerBasePath = path.join(__dirname, '..', '/bin')
 
-  const filePath = path.join(seleniumManagerBasePath, directory, file)
+  const filePath = process.env.SE_MANAGER_PATH || path.join(seleniumManagerBasePath, directory, file)
 
   if (!fs.existsSync(filePath)) {
-    throw new Error(`Unable to obtain Selenium Manager`)
+    throw new Error(`Unable to obtain Selenium Manager at ${filePath}`)
   }
 
   if (!debugMessagePrinted) {
     console.debug(`Selenium Manager binary found at ${filePath}`)
-    debugMessagePrinted = true; // Set the flag to true after printing the debug message
+    debugMessagePrinted = true // Set the flag to true after printing the debug message
   }
 
   return filePath
@@ -78,22 +79,20 @@ function driverLocation(options) {
     options.get('ms:edgeOptions') ||
     options.get('moz:firefoxOptions')
   if (vendorOptions && vendorOptions.binary && vendorOptions.binary !== '') {
-    args.push('--browser-path', '"' + vendorOptions.binary + '"')
+    args.push('--browser-path', path.resolve(vendorOptions.binary))
   }
 
-  const proxyOptions = options.getProxy();
+  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'];
+    const httpProxy = proxyOptions['httpProxy']
+    const sslProxy = proxyOptions['sslProxy']
 
     if (httpProxy !== undefined) {
-      args.push('--proxy', httpProxy);
-    }
-
-    else if (sslProxy !== undefined) {
-      args.push('--proxy', sslProxy);
+      args.push('--proxy', httpProxy)
+    } else if (sslProxy !== undefined) {
+      args.push('--proxy', sslProxy)
     }
   }
 
@@ -126,6 +125,11 @@ function driverLocation(options) {
     )
   }
 
+  // Once driverPath is available, delete browserVersion from payload
+  if (output.result.driver_path) {
+    options.delete(Capability.BROWSER_VERSION)
+  }
+
   logOutput(output)
   return {
     driverPath: output.result.driver_path,
@@ -133,7 +137,7 @@ function driverLocation(options) {
   }
 }
 
-function logOutput (output) {
+function logOutput(output) {
   for (const key in output.logs) {
     if (output.logs[key].level === 'WARN') {
       console.warn(`${output.logs[key].message}`)

package/firefox.js

@@ -591,7 +591,7 @@ class Driver extends webdriver.WebDriver {
       configureExecutor(executor)
     } else if (opt_executor instanceof remote.DriverService) {
       if (!opt_executor.getExecutable()) {
-        const {driverPath, browserPath} = getPath(caps)
+        const { driverPath, browserPath } = getPath(caps)
         opt_executor.setExecutable(driverPath)
         firefoxBrowserPath = browserPath
       }
@@ -600,7 +600,7 @@ class Driver extends webdriver.WebDriver {
     } else {
       let service = new ServiceBuilder().build()
       if (!service.getExecutable()) {
-        const {driverPath, browserPath} = getPath(caps)
+        const { driverPath, browserPath } = getPath(caps)
         service.setExecutable(driverPath)
         firefoxBrowserPath = browserPath
       }
@@ -614,7 +614,7 @@ class Driver extends webdriver.WebDriver {
         vendorOptions['binary'] = firefoxBrowserPath
         caps.set(FIREFOX_CAPABILITY_KEY, vendorOptions)
       } else {
-        caps.set(FIREFOX_CAPABILITY_KEY, {binary: firefoxBrowserPath})
+        caps.set(FIREFOX_CAPABILITY_KEY, { binary: firefoxBrowserPath })
       }
     }
 

package/lib/by.js

@@ -396,7 +396,11 @@ class RelativeBy {
  *     strategy.
  */
 function check(locator) {
-  if (locator instanceof By || locator instanceof RelativeBy || typeof locator === 'function') {
+  if (
+    locator instanceof By ||
+    locator instanceof RelativeBy ||
+    typeof locator === 'function'
+  ) {
     return locator
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.11.1",
+  "version": "4.13.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -28,15 +28,15 @@
     "ws": ">=8.13.0"
   },
   "devDependencies": {
-    "eslint": "^8.44.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^5.0.0",
     "express": "^4.18.2",
     "mocha": "^10.2.0",
     "multer": "^1.4.5-lts.1",
-    "prettier": "^3.0.0",
+    "prettier": "^3.0.1",
     "serve-index": "^1.9.1",
     "sinon": "^15.2.0"
   },

package/remote/index.js

@@ -17,7 +17,6 @@
 
 'use strict'
 
-const fs = require('fs')
 const url = require('url')
 
 const httpUtil = require('../http/util')

package/remote/util.js

@@ -37,7 +37,11 @@ function getJavaPath() {
 function isSelenium3x(seleniumStandalonePath) {
   const javaPath = getJavaPath()
 
-  const execRes = cp.execFileSync(javaPath, ['-jar', seleniumStandalonePath, '--version'])
+  const execRes = cp.execFileSync(javaPath, [
+    '-jar',
+    seleniumStandalonePath,
+    '--version',
+  ])
 
   return execRes.toString().trim().startsWith('Selenium server version: 3')
 }

package/testing/index.js

@@ -118,19 +118,24 @@ function getAvailableBrowsers() {
   info(`Searching for WebDriver executables installed on the current system...`)
 
   let targets = [
-    [getPath(new chrome.Options()).driverPath, Browser.CHROME],
-    [getPath(new edge.Options()).driverPath, Browser.EDGE],
-    [getPath(new firefox.Options()).driverPath, Browser.FIREFOX],
-    [getPath(new ie.Options()).driverPath, Browser.INTERNET_EXPLORER],
-    [getPath(new safari.Options()).driverPath, Browser.SAFARI],
+    [getPath(new chrome.Options()), Browser.CHROME],
+    [getPath(new edge.Options()), Browser.EDGE],
+    [getPath(new firefox.Options()), Browser.FIREFOX],
   ]
+  if (process.platform === 'win32') {
+    targets.push([getPath(new ie.Options()), Browser.INTERNET_EXPLORER])
+  }
+  if (process.platform === 'darwin') {
+    targets.push([getPath(new safari.Options()), Browser.SAFARI])
+  }
 
   let availableBrowsers = []
   for (let pair of targets) {
-    const driverPath = pair[0]
+    const driverPath = pair[0].driverPath
+    const browserPath = pair[0].browserPath
     const name = pair[1]
     const capabilities = pair[2]
-    if (driverPath.length > 0) {
+    if (driverPath.length > 0 && browserPath && browserPath.length > 0) {
       info(`... located ${name}`)
       availableBrowsers.push({ name, capabilities })
     }