selenium-webdriver 4.10.0 → 4.11.0

package/common/seleniumManager.js

@@ -26,11 +26,7 @@ const path = require('path')
 const fs = require('fs')
 const spawnSync = require('child_process').spawnSync
 
-/**
- * currently supported browsers for selenium-manager
- * @type {string[]}
- */
-const Browser = ['chrome', 'firefox', 'edge', 'MicrosoftEdge', 'iexplorer']
+let debugMessagePrinted = false;
 
 /**
  * Determines the path of the correct Selenium Manager binary
@@ -55,26 +51,22 @@ function getBinary() {
     throw new Error(`Unable to obtain Selenium Manager`)
   }
 
+  if (!debugMessagePrinted) {
+    console.debug(`Selenium Manager binary found at ${filePath}`)
+    debugMessagePrinted = true; // Set the flag to true after printing the debug message
+  }
+
   return filePath
 }
 
 /**
  * Determines the path of the correct driver
  * @param {Capabilities} options browser options to fetch the driver
- * @returns {string} path of the driver location
+ * @returns {{browserPath: string, driverPath: string}} path of the driver and
+ * browser location
  */
 
 function driverLocation(options) {
-  if (!Browser.includes(options.getBrowserName().toLocaleString())) {
-    throw new Error(
-      `Unable to locate driver associated with browser name: ${options.getBrowserName()}`
-    )
-  }
-
-  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() !== '') {
@@ -116,6 +108,7 @@ function driverLocation(options) {
     if (spawnResult.stdout.toString()) {
       try {
         output = JSON.parse(spawnResult.stdout.toString())
+        logOutput(output)
         errorMessage = output.result.message
       } catch (e) {
         errorMessage = e.toString()
@@ -133,13 +126,22 @@ function driverLocation(options) {
     )
   }
 
+  logOutput(output)
+  return {
+    driverPath: output.result.driver_path,
+    browserPath: output.result.browser_path,
+  }
+}
+
+function logOutput (output) {
   for (const key in output.logs) {
     if (output.logs[key].level === 'WARN') {
       console.warn(`${output.logs[key].message}`)
     }
+    if (['DEBUG', 'INFO'].includes(output.logs[key].level)) {
+      console.debug(`${output.logs[key].message}`)
+    }
   }
-
-  return output.result.message
 }
 
 // PUBLIC API

package/edge.js

@@ -78,16 +78,8 @@
 'use strict'
 
 const { Browser } = require('./lib/capabilities')
-const io = require('./io')
 const chromium = require('./chromium')
-
-/**
- * Name of the EdgeDriver executable.
- * @type {string}
- * @const
- */
-const EDGEDRIVER_CHROMIUM_EXE =
-  process.platform === 'win32' ? 'msedgedriver.exe' : 'msedgedriver'
+const EDGE_CAPABILITY_KEY = 'ms:edgeOptions'
 
 /** @type {remote.DriverService} */
 
@@ -105,8 +97,7 @@ class ServiceBuilder extends chromium.ServiceBuilder {
    *     cannot be found on the PATH.
    */
   constructor(opt_exe) {
-    let exe = opt_exe || locateSynchronously()
-    super(exe)
+    super(opt_exe)
     this.setLoopback(true)
   }
 }
@@ -157,7 +148,7 @@ 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)
+      super.createSession(caps, opt_serviceExecutor, 'ms', EDGE_CAPABILITY_KEY)
     )
   }
 
@@ -177,19 +168,8 @@ class Driver extends chromium.Driver {
   setFileDetector() {}
 }
 
-/**
- * _Synchronously_ attempts to locate the chromedriver executable on the current
- * system.
- *
- * @return {?string} the located executable, or `null`.
- */
-function locateSynchronously() {
-  return io.findInPath(EDGEDRIVER_CHROMIUM_EXE, true)
-}
-
 Options.prototype.BROWSER_NAME_VALUE = Browser.EDGE
-Options.prototype.CAPABILITY_KEY = 'ms:edgeOptions'
-Driver.prototype.VENDOR_CAPABILITY_PREFIX = 'ms'
+Options.prototype.CAPABILITY_KEY = EDGE_CAPABILITY_KEY
 
 // PUBLIC API
 
@@ -197,5 +177,4 @@ module.exports = {
   Driver,
   Options,
   ServiceBuilder,
-  locateSynchronously,
 }

package/firefox.js

@@ -128,6 +128,7 @@ const zip = require('./io/zip')
 const { Browser, Capabilities } = require('./lib/capabilities')
 const { Zip } = require('./io/zip')
 const { getPath } = require('./common/driverFinder')
+const FIREFOX_CAPABILITY_KEY = 'moz:firefoxOptions'
 
 /**
  * Thrown when there an add-on is malformed.
@@ -263,10 +264,10 @@ class Options extends Capabilities {
    * @private
    */
   firefoxOptions_() {
-    let options = this.get('moz:firefoxOptions')
+    let options = this.get(FIREFOX_CAPABILITY_KEY)
     if (!options) {
       options = {}
-      this.set('moz:firefoxOptions', options)
+      this.set(FIREFOX_CAPABILITY_KEY, options)
     }
     return options
   }
@@ -453,27 +454,6 @@ const Context = {
   CHROME: 'chrome',
 }
 
-const GECKO_DRIVER_EXE =
-  process.platform === 'win32' ? 'geckodriver.exe' : 'geckodriver'
-
-/**
- * _Synchronously_ attempts to locate the geckodriver executable on the current
- * system.
- *
- * @return {?string} the located executable, or `null`.
- */
-function locateSynchronously() {
-  return io.findInPath(GECKO_DRIVER_EXE, true)
-}
-
-/**
- * @return {string} .
- * @throws {Error}
- */
-function findGeckoDriver() {
-  return locateSynchronously()
-}
-
 /**
  * @param {string} file Path to the file to find, relative to the program files
  *     root.
@@ -555,7 +535,7 @@ class ServiceBuilder extends remote.DriverService.Builder {
    *     the builder will attempt to locate the geckodriver on the system PATH.
    */
   constructor(opt_exe) {
-    super(opt_exe || findGeckoDriver())
+    super(opt_exe)
     this.setLoopback(true) // Required.
   }
 
@@ -601,6 +581,8 @@ class Driver extends webdriver.WebDriver {
     let caps =
       opt_config instanceof Capabilities ? opt_config : new Options(opt_config)
 
+    let firefoxBrowserPath = null
+
     let executor
     let onQuit
 
@@ -609,19 +591,33 @@ class Driver extends webdriver.WebDriver {
       configureExecutor(executor)
     } else if (opt_executor instanceof remote.DriverService) {
       if (!opt_executor.getExecutable()) {
-        opt_executor.setExecutable(getPath(opt_executor, opt_config))
+        const {driverPath, browserPath} = getPath(caps)
+        opt_executor.setExecutable(driverPath)
+        firefoxBrowserPath = browserPath
       }
       executor = createExecutor(opt_executor.start())
       onQuit = () => opt_executor.kill()
     } else {
       let service = new ServiceBuilder().build()
       if (!service.getExecutable()) {
-        service.setExecutable(getPath(service, opt_config))
+        const {driverPath, browserPath} = getPath(caps)
+        service.setExecutable(driverPath)
+        firefoxBrowserPath = browserPath
       }
       executor = createExecutor(service.start())
       onQuit = () => service.kill()
     }
 
+    if (firefoxBrowserPath) {
+      const vendorOptions = caps.get(FIREFOX_CAPABILITY_KEY)
+      if (vendorOptions) {
+        vendorOptions['binary'] = firefoxBrowserPath
+        caps.set(FIREFOX_CAPABILITY_KEY, vendorOptions)
+      } else {
+        caps.set(FIREFOX_CAPABILITY_KEY, {binary: firefoxBrowserPath})
+      }
+    }
+
     return /** @type {!Driver} */ (super.createSession(executor, caps, onQuit))
   }
 
@@ -832,5 +828,4 @@ module.exports = {
   Driver,
   Options,
   ServiceBuilder,
-  locateSynchronously,
 }

package/ie.js

@@ -27,9 +27,7 @@
 
 'use strict'
 
-const fs = require('fs')
 const http = require('./http')
-const io = require('./io')
 const portprober = require('./net/portprober')
 const remote = require('./remote')
 const webdriver = require('./lib/webdriver')
@@ -37,7 +35,6 @@ const { Browser, Capabilities } = require('./lib/capabilities')
 const error = require('./lib/error')
 const { getPath } = require('./common/driverFinder')
 
-const IEDRIVER_EXE = 'IEDriverServer.exe'
 const OPTIONS_CAPABILITY_KEY = 'se:ieOptions'
 const SCROLL_BEHAVIOUR = {
   BOTTOM: 1,
@@ -83,6 +80,7 @@ const Key = {
   FILE_UPLOAD_DIALOG_TIMEOUT: 'ie.fileUploadDialogTimeout',
   ATTACH_TO_EDGE_CHROMIUM: 'ie.edgechromium',
   EDGE_EXECUTABLE_PATH: 'ie.edgepath',
+  IGNORE_PROCESS_MATCH: 'ie.ignoreprocessmatch',
 }
 
 /**
@@ -379,16 +377,6 @@ class Options extends Capabilities {
   }
 }
 
-/**
- * _Synchronously_ attempts to locate the IE driver executable on the current
- * system.
- *
- * @return {?string} the located executable, or `null`.
- */
-function locateSynchronously() {
-  return process.platform === 'win32' ? io.findInPath(IEDRIVER_EXE, true) : null
-}
-
 function createServiceFromCapabilities(capabilities) {
   if (process.platform !== 'win32') {
     throw Error(
@@ -399,7 +387,7 @@ function createServiceFromCapabilities(capabilities) {
     )
   }
 
-  let exe = locateSynchronously()
+  let exe = null // Let Selenium Manager find it
   var args = []
   if (capabilities.has(Key.HOST)) {
     args.push('--host=' + capabilities.get(Key.HOST))
@@ -439,7 +427,7 @@ class ServiceBuilder extends remote.DriverService.Builder {
    *     the builder will attempt to locate the IEDriverServer on the system PATH.
    */
   constructor(opt_exe) {
-    super(opt_exe || IEDRIVER_EXE)
+    super(opt_exe)
     this.setLoopback(true) // Required.
   }
 }
@@ -467,7 +455,7 @@ class Driver extends webdriver.WebDriver {
       service = createServiceFromCapabilities(options)
     }
     if (!service.getExecutable()) {
-      service.setExecutable(getPath(service, options))
+      service.setExecutable(getPath(options).driverPath)
     }
 
     let client = service.start().then((url) => new http.HttpClient(url))
@@ -495,4 +483,3 @@ exports.ServiceBuilder = ServiceBuilder
 exports.Key = Key
 exports.VENDOR_COMMAND_PREFIX = OPTIONS_CAPABILITY_KEY
 exports.Behavior = SCROLL_BEHAVIOUR
-exports.locateSynchronously = locateSynchronously

package/index.js

@@ -43,6 +43,7 @@ const LogInspector = require('./bidi/logInspector')
 const BrowsingContext = require('./bidi/browsingContext')
 const BrowsingConextInspector = require('./bidi/browsingContextInspector')
 const ScriptManager = require('./bidi/scriptManager')
+const NetworkInspector = require('./bidi/networkInspector')
 
 const Browser = capabilities.Browser
 const Capabilities = capabilities.Capabilities
@@ -803,3 +804,4 @@ exports.LogInspector = LogInspector
 exports.BrowsingContext = BrowsingContext
 exports.BrowsingConextInspector = BrowsingConextInspector
 exports.ScriptManager = ScriptManager
+exports.NetworkInspector = NetworkInspector

package/lib/by.js

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

package/lib/webdriver.js

@@ -1238,8 +1238,8 @@ class WebDriver {
     } else {
       const seCdp = caps['map_'].get('se:cdp')
       const vendorInfo =
-        caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
-        caps['map_'].get(this.VENDOR_CAPABILITY_PREFIX + ':edgeOptions') ||
+        caps['map_'].get('goog:chromeOptions') ||
+        caps['map_'].get('ms:edgeOptions') ||
         caps['map_'].get('moz:debuggerAddress') ||
         new Map()
       debuggerUrl = seCdp || vendorInfo['debuggerAddress'] || vendorInfo

package/package.json

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

package/remote/util.js

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

package/safari.js

@@ -22,37 +22,10 @@
 'use strict'
 
 const http = require('./http')
-const io = require('./io')
 const remote = require('./remote')
 const webdriver = require('./lib/webdriver')
 const { Browser, Capabilities } = require('./lib/capabilities')
-
-/**
- * _Synchronously_ attempts to locate the IE driver executable on the current
- * system.
- *
- * @return {?string} the located executable, or `null`.
- */
-function locateSynchronously() {
-  return process.platform === 'darwin'
-    ? io.findInPath('safaridriver', true)
-    : null
-}
-
-/**
- * @return {string} .
- * @throws {Error}
- */
-function findSafariDriver() {
-  let exe = locateSynchronously()
-  if (!exe) {
-    throw Error(
-      `The safaridriver executable could not be found on the current PATH.
-      Please ensure you are using Safari 10.0 or above.`
-    )
-  }
-  return exe
-}
+const { getPath } = require('./common/driverFinder')
 
 /**
  * Creates {@link selenium-webdriver/remote.DriverService} instances that manage
@@ -66,12 +39,12 @@ class ServiceBuilder extends remote.DriverService.Builder {
    *     the builder will attempt to locate the safaridriver on the system PATH.
    */
   constructor(opt_exe) {
-    super(opt_exe || findSafariDriver())
+    super(opt_exe)
     this.setLoopback(true) // Required.
   }
 }
 
-const OPTIONS_CAPABILITY_KEY = 'safari.options'
+const OPTIONS_CAPABILITY_KEY = 'safari:options'
 const TECHNOLOGY_PREVIEW_OPTIONS_KEY = 'technologyPreview'
 
 /**
@@ -150,6 +123,9 @@ class Driver extends webdriver.WebDriver {
     }
 
     let service = new ServiceBuilder(exe).build()
+    if (!service.getExecutable()) {
+      service.setExecutable(getPath(caps).driverPath)
+    }
     let executor = new http.Executor(
       service.start().then((url) => new http.HttpClient(url))
     )
@@ -165,4 +141,3 @@ class Driver extends webdriver.WebDriver {
 exports.Driver = Driver
 exports.Options = Options
 exports.ServiceBuilder = ServiceBuilder
-exports.locateSynchronously = locateSynchronously

package/testing/index.js

@@ -41,6 +41,7 @@ const remote = require('../remote')
 const safari = require('../safari')
 const { Browser } = require('../lib/capabilities')
 const { Builder } = require('../index')
+const { getPath } = require('../common/driverFinder')
 
 /**
  * Describes a browser targeted by a {@linkplain suite test suite}.
@@ -117,19 +118,19 @@ function getAvailableBrowsers() {
   info(`Searching for WebDriver executables installed on the current system...`)
 
   let targets = [
-    [chrome.locateSynchronously, Browser.CHROME],
-    [edge.locateSynchronously, Browser.EDGE],
-    [firefox.locateSynchronously, Browser.FIREFOX],
-    [ie.locateSynchronously, Browser.INTERNET_EXPLORER],
-    [safari.locateSynchronously, Browser.SAFARI],
+    [getPath(chrome.Options).driverPath, Browser.CHROME],
+    [getPath(edge.Options).driverPath, Browser.EDGE],
+    [getPath(firefox.Options).driverPath, Browser.FIREFOX],
+    [getPath(ie.Options).driverPath, Browser.INTERNET_EXPLORER],
+    [getPath(safari.Options).driverPath, Browser.SAFARI],
   ]
 
   let availableBrowsers = []
   for (let pair of targets) {
-    const fn = pair[0]
+    const driverPath = pair[0]
     const name = pair[1]
     const capabilities = pair[2]
-    if (fn()) {
+    if (driverPath.length > 0) {
       info(`... located ${name}`)
       availableBrowsers.push({ name, capabilities })
     }