selenium-webdriver 4.16.0 → 4.18.0

package/chromium.js

@@ -36,17 +36,12 @@
  *     a unique browser session with a clean user profile (unless otherwise
  *     configured through the {@link Options} class).
  *
- * __Headless Chromium__ <a id="headless"></a>
- *
- * To start the browser in headless mode, simply call
- * {@linkplain Options#headless Options.headless()}.
- *
  *     let chrome = require('selenium-webdriver/chrome');
  *     let {Builder} = require('selenium-webdriver');
  *
  *     let driver = new Builder()
  *         .forBrowser('chrome')
- *         .setChromeOptions(new chrome.Options().headless())
+ *         .setChromeOptions(new chrome.Options())
  *         .build();
  *
  * __Customizing the Chromium WebDriver Server__ <a id="custom-server"></a>
@@ -124,71 +119,39 @@ function createExecutor(url, vendorPrefix) {
  * @param {!http.Executor} executor the executor to configure.
  */
 function configureExecutor(executor, vendorPrefix) {
-  executor.defineCommand(
-    Command.LAUNCH_APP,
-    'POST',
-    '/session/:sessionId/chromium/launch_app'
-  )
-  executor.defineCommand(
-    Command.GET_NETWORK_CONDITIONS,
-    'GET',
-    '/session/:sessionId/chromium/network_conditions'
-  )
-  executor.defineCommand(
-    Command.SET_NETWORK_CONDITIONS,
-    'POST',
-    '/session/:sessionId/chromium/network_conditions'
-  )
-  executor.defineCommand(
-    Command.DELETE_NETWORK_CONDITIONS,
-    'DELETE',
-    '/session/:sessionId/chromium/network_conditions'
-  )
-  executor.defineCommand(
-    Command.SEND_DEVTOOLS_COMMAND,
-    'POST',
-    '/session/:sessionId/chromium/send_command'
-  )
+  executor.defineCommand(Command.LAUNCH_APP, 'POST', '/session/:sessionId/chromium/launch_app')
+  executor.defineCommand(Command.GET_NETWORK_CONDITIONS, 'GET', '/session/:sessionId/chromium/network_conditions')
+  executor.defineCommand(Command.SET_NETWORK_CONDITIONS, 'POST', '/session/:sessionId/chromium/network_conditions')
+  executor.defineCommand(Command.DELETE_NETWORK_CONDITIONS, 'DELETE', '/session/:sessionId/chromium/network_conditions')
+  executor.defineCommand(Command.SEND_DEVTOOLS_COMMAND, 'POST', '/session/:sessionId/chromium/send_command')
   executor.defineCommand(
     Command.SEND_AND_GET_DEVTOOLS_COMMAND,
     'POST',
-    '/session/:sessionId/chromium/send_command_and_get_result'
-  )
-  executor.defineCommand(
-    Command.SET_PERMISSION,
-    'POST',
-    '/session/:sessionId/permissions'
-  )
-  executor.defineCommand(
-    Command.GET_CAST_SINKS,
-    'GET',
-    `/session/:sessionId/${vendorPrefix}/cast/get_sinks`
+    '/session/:sessionId/chromium/send_command_and_get_result',
   )
+  executor.defineCommand(Command.SET_PERMISSION, 'POST', '/session/:sessionId/permissions')
+  executor.defineCommand(Command.GET_CAST_SINKS, 'GET', `/session/:sessionId/${vendorPrefix}/cast/get_sinks`)
   executor.defineCommand(
     Command.SET_CAST_SINK_TO_USE,
     'POST',
-    `/session/:sessionId/${vendorPrefix}/cast/set_sink_to_use`
+    `/session/:sessionId/${vendorPrefix}/cast/set_sink_to_use`,
   )
   executor.defineCommand(
     Command.START_CAST_DESKTOP_MIRRORING,
     'POST',
-    `/session/:sessionId/${vendorPrefix}/cast/start_desktop_mirroring`
+    `/session/:sessionId/${vendorPrefix}/cast/start_desktop_mirroring`,
   )
   executor.defineCommand(
     Command.START_CAST_TAB_MIRRORING,
     'POST',
-    `/session/:sessionId/${vendorPrefix}/cast/start_tab_mirroring`
+    `/session/:sessionId/${vendorPrefix}/cast/start_tab_mirroring`,
   )
   executor.defineCommand(
     Command.GET_CAST_ISSUE_MESSAGE,
     'GET',
-    `/session/:sessionId/${vendorPrefix}/cast/get_issue_message`
-  )
-  executor.defineCommand(
-    Command.STOP_CASTING,
-    'POST',
-    `/session/:sessionId/${vendorPrefix}/cast/stop_casting`
+    `/session/:sessionId/${vendorPrefix}/cast/get_issue_message`,
   )
+  executor.defineCommand(Command.STOP_CASTING, 'POST', `/session/:sessionId/${vendorPrefix}/cast/stop_casting`)
 }
 
 /**
@@ -310,34 +273,6 @@ class Options extends Capabilities {
     return this
   }
 
-  /**
-   * @deprecated Use {@link Options#addArguments} instead.
-   * @example
-   * options.addArguments('--headless=chrome'); (or)
-   * options.addArguments('--headless');
-   * @example
-   *
-   * Recommended to use '--headless=chrome' as argument for browsers v94-108.
-   * Recommended to use '--headless=new' as argument for browsers v109+.
-   *
-   * Configures the driver to start the browser in headless mode.
-   *
-   * > __NOTE:__ Resizing the browser window in headless mode is only supported
-   * > in Chromium 60+. Users are encouraged to set an initial window size with
-   * > the {@link #windowSize windowSize({width, height})} option.
-   *
-   * > __NOTE__: For security, Chromium disables downloads by default when
-   * > in headless mode (to prevent sites from silently downloading files to
-   * > your machine). After creating a session, you may call
-   * > {@link ./chrome.Driver#setDownloadPath setDownloadPath} to re-enable
-   * > downloads, saving files in the specified directory.
-   *
-   * @return {!Options} A self reference.
-   */
-  headless() {
-    return this.addArguments('headless')
-  }
-
   /**
    * Sets the initial window size.
    *
@@ -655,9 +590,7 @@ class Extensions {
       if (Buffer.isBuffer(extension)) {
         return extension.toString('base64')
       }
-      return io
-        .read(/** @type {string} */ (extension))
-        .then((buffer) => buffer.toString('base64'))
+      return io.read(/** @type {string} */ (extension)).then((buffer) => buffer.toString('base64'))
     })
   }
 }
@@ -679,12 +612,7 @@ 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) {
@@ -734,9 +662,7 @@ class Driver extends webdriver.WebDriver {
    *     when app is launched.
    */
   launchApp(id) {
-    return this.execute(
-      new command.Command(Command.LAUNCH_APP).setParameter('id', id)
-    )
+    return this.execute(new command.Command(Command.LAUNCH_APP).setParameter('id', id))
   }
 
   /**
@@ -775,16 +701,9 @@ class Driver extends webdriver.WebDriver {
    */
   setNetworkConditions(spec) {
     if (!spec || typeof spec !== 'object') {
-      throw TypeError(
-        'setNetworkConditions called with non-network-conditions parameter'
-      )
+      throw TypeError('setNetworkConditions called with non-network-conditions parameter')
     }
-    return this.execute(
-      new command.Command(Command.SET_NETWORK_CONDITIONS).setParameter(
-        'network_conditions',
-        spec
-      )
-    )
+    return this.execute(new command.Command(Command.SET_NETWORK_CONDITIONS).setParameter('network_conditions', spec))
   }
 
   /**
@@ -798,9 +717,7 @@ class Driver extends webdriver.WebDriver {
    */
   sendDevToolsCommand(cmd, params = {}) {
     return this.execute(
-      new command.Command(Command.SEND_DEVTOOLS_COMMAND)
-        .setParameter('cmd', cmd)
-        .setParameter('params', params)
+      new command.Command(Command.SEND_DEVTOOLS_COMMAND).setParameter('cmd', cmd).setParameter('params', params),
     )
   }
 
@@ -817,7 +734,7 @@ class Driver extends webdriver.WebDriver {
     return this.execute(
       new command.Command(Command.SEND_AND_GET_DEVTOOLS_COMMAND)
         .setParameter('cmd', cmd)
-        .setParameter('params', params)
+        .setParameter('params', params),
     )
   }
 
@@ -833,9 +750,7 @@ class Driver extends webdriver.WebDriver {
    */
   setPermission(name, state) {
     return this.execute(
-      new command.Command(Command.SET_PERMISSION)
-        .setParameter('descriptor', { name })
-        .setParameter('state', state)
+      new command.Command(Command.SET_PERMISSION).setParameter('descriptor', { name }).setParameter('state', state),
     )
   }
 
@@ -868,10 +783,7 @@ class Driver extends webdriver.WebDriver {
    *   containing the friendly device names of available cast sink targets.
    */
   getCastSinks() {
-    return this.schedule(
-      new command.Command(Command.GET_CAST_SINKS),
-      'Driver.getCastSinks()'
-    )
+    return this.execute(new command.Command(Command.GET_CAST_SINKS))
   }
 
   /**
@@ -882,13 +794,7 @@ class Driver extends webdriver.WebDriver {
    *     when the target device has been selected to respond further webdriver commands.
    */
   setCastSinkToUse(deviceName) {
-    return this.schedule(
-      new command.Command(Command.SET_CAST_SINK_TO_USE).setParameter(
-        'sinkName',
-        deviceName
-      ),
-      'Driver.setCastSinkToUse(' + deviceName + ')'
-    )
+    return this.execute(new command.Command(Command.SET_CAST_SINK_TO_USE).setParameter('sinkName', deviceName))
   }
 
   /**
@@ -899,13 +805,7 @@ class Driver extends webdriver.WebDriver {
    *     when the mirror command has been issued to the device.
    */
   startDesktopMirroring(deviceName) {
-    return this.schedule(
-      new command.Command(Command.START_CAST_DESKTOP_MIRRORING).setParameter(
-        'sinkName',
-        deviceName
-      ),
-      'Driver.startDesktopMirroring(' + deviceName + ')'
-    )
+    return this.execute(new command.Command(Command.START_CAST_DESKTOP_MIRRORING).setParameter('sinkName', deviceName))
   }
 
   /**
@@ -916,13 +816,7 @@ class Driver extends webdriver.WebDriver {
    *     when the mirror command has been issued to the device.
    */
   startCastTabMirroring(deviceName) {
-    return this.schedule(
-      new command.Command(Command.START_CAST_TAB_MIRRORING).setParameter(
-        'sinkName',
-        deviceName
-      ),
-      'Driver.startCastTabMirroring(' + deviceName + ')'
-    )
+    return this.execute(new command.Command(Command.START_CAST_TAB_MIRRORING).setParameter('sinkName', deviceName))
   }
 
   /**
@@ -931,10 +825,7 @@ class Driver extends webdriver.WebDriver {
    *     when the mirror command has been issued to the device.
    */
   getCastIssueMessage() {
-    return this.schedule(
-      new command.Command(Command.GET_CAST_ISSUE_MESSAGE),
-      'Driver.getCastIssueMessage()'
-    )
+    return this.execute(new command.Command(Command.GET_CAST_ISSUE_MESSAGE))
   }
 
   /**
@@ -945,13 +836,7 @@ class Driver extends webdriver.WebDriver {
    *     when the stop command has been issued to the device.
    */
   stopCasting(deviceName) {
-    return this.schedule(
-      new command.Command(Command.STOP_CASTING).setParameter(
-        'sinkName',
-        deviceName
-      ),
-      'Driver.stopCasting(' + deviceName + ')'
-    )
+    return this.execute(new command.Command(Command.STOP_CASTING).setParameter('sinkName', deviceName))
   }
 }
 

package/common/driverFinder.js

@@ -35,7 +35,7 @@ function getPath(capabilities) {
     throw Error(
       `Unable to obtain browser driver.
         For more information on how to install drivers see
-        https://www.selenium.dev/documentation/webdriver/troubleshooting/errors/driver_location/. ${e}`
+        https://www.selenium.dev/documentation/webdriver/troubleshooting/errors/driver_location/. ${e}`,
     )
   }
 }

package/common/seleniumManager.js

@@ -43,8 +43,7 @@ function getBinary() {
     linux: 'linux',
   }[platform]
 
-  const file =
-    directory === 'windows' ? 'selenium-manager.exe' : 'selenium-manager'
+  const file = directory === 'windows' ? 'selenium-manager.exe' : 'selenium-manager'
 
   let seleniumManagerBasePath = path.join(__dirname, '..', '/bin')
 
@@ -70,16 +69,14 @@ function getBinary() {
  */
 
 function driverLocation(options) {
-  let args = ['--browser', options.getBrowserName(), '--output', 'json']
+  let args = ['--browser', options.getBrowserName(), '--language-binding', 'javascript', '--output', 'json']
 
   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')
+    options.get('goog:chromeOptions') || options.get('ms:edgeOptions') || options.get('moz:firefoxOptions')
   if (vendorOptions && vendorOptions.binary && vendorOptions.binary !== '') {
     args.push('--browser-path', path.resolve(vendorOptions.binary))
   }
@@ -115,16 +112,12 @@ 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()}`)
   }
 
   // Once driverPath is available, delete browserVersion from payload

package/devtools/CDPConnection.js

@@ -67,9 +67,7 @@ class CDPConnection {
             resolve(payload)
           }
         } catch (err) {
-          logging
-            .getLogger(logging.Type.BROWSER)
-            .severe(`Failed parse message: ${err.message}`)
+          logging.getLogger(logging.Type.BROWSER).severe(`Failed parse message: ${err.message}`)
         }
       }
 

package/edge.js

@@ -147,9 +147,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, 'ms', EDGE_CAPABILITY_KEY)
-    )
+    return /** @type {!Driver} */ (super.createSession(caps, opt_serviceExecutor, 'ms', EDGE_CAPABILITY_KEY))
   }
 
   /**

package/example/chrome_android.js

@@ -29,10 +29,7 @@ const { Options } = require('../chrome')
 ;(async function () {
   let driver
   try {
-    driver = await new Builder()
-      .forBrowser('chrome')
-      .setChromeOptions(new Options().androidChrome())
-      .build()
+    driver = await new Builder().forBrowser('chrome').setChromeOptions(new Options().androidChrome()).build()
     await driver.get('http://www.google.com/ncr')
     await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
     await driver.wait(until.titleIs('webdriver - Google Search'), 1000)
@@ -41,5 +38,5 @@ const { Options } = require('../chrome')
   }
 })().then(
   (_) => console.log('SUCCESS'),
-  (err) => console.error('ERROR: ' + err)
+  (err) => console.error('ERROR: ' + err),
 )

package/example/chrome_mobile_emulation.js

@@ -30,9 +30,7 @@ const { Options } = require('../chrome')
   try {
     driver = await new Builder()
       .forBrowser('chrome')
-      .setChromeOptions(
-        new Options().setMobileEmulation({ deviceName: 'Nexus 5X' })
-      )
+      .setChromeOptions(new Options().setMobileEmulation({ deviceName: 'Nexus 5X' }))
       .build()
     await driver.get('http://www.google.com/ncr')
     await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
@@ -42,5 +40,5 @@ const { Options } = require('../chrome')
   }
 })().then(
   (_) => console.log('SUCCESS'),
-  (err) => console.error('ERROR: ' + err)
+  (err) => console.error('ERROR: ' + err),
 )

package/example/google_search.js

@@ -43,8 +43,6 @@ const driver = new Builder().forBrowser('firefox').build()
 
 driver
   .get('http://www.google.com/ncr')
-  .then((_) =>
-    driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
-  )
+  .then((_) => driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
   .then((_) => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
   .then((_) => driver.quit())

package/example/headless.js

@@ -40,24 +40,18 @@ const height = 480
 
 let driver = new Builder()
   .forBrowser('chrome')
-  .setChromeOptions(
-    new chrome.Options().headless().windowSize({ width, height })
-  )
-  .setFirefoxOptions(
-    new firefox.Options().headless().windowSize({ width, height })
-  )
+  .setChromeOptions(new chrome.Options().addArguments('-headless').windowSize({ width, height }))
+  .setFirefoxOptions(new firefox.Options().addArguments('-headless').windowSize({ width, height }))
   .build()
 
 driver
   .get('http://www.google.com/ncr')
-  .then((_) =>
-    driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN)
-  )
+  .then((_) => driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
   .then((_) => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
   .then(
     (_) => driver.quit(),
     (e) =>
       driver.quit().then(() => {
         throw e
-      })
+      }),
   )

package/example/logging.js

@@ -40,17 +40,11 @@ logging.getLogger(`${logging.Type.DRIVER}.http`).setLevel(logging.Level.ALL)
       // Configure the service for each browser to enable verbose logging and
       // to inherit the stdio settings from the current process. The builder
       // will only start the service if needed for the selected browser.
-      .setChromeService(
-        new chrome.ServiceBuilder().enableVerboseLogging().setStdio('inherit')
-      )
+      .setChromeService(new chrome.ServiceBuilder().enableVerboseLogging().setStdio('inherit'))
       .setEdgeService(
-        process.platform === 'win32'
-          ? new edge.ServiceBuilder().enableVerboseLogging().setStdio('inherit')
-          : null
-      )
-      .setFirefoxService(
-        new firefox.ServiceBuilder().enableVerboseLogging().setStdio('inherit')
+        process.platform === 'win32' ? new edge.ServiceBuilder().enableVerboseLogging().setStdio('inherit') : null,
       )
+      .setFirefoxService(new firefox.ServiceBuilder().enableVerboseLogging().setStdio('inherit'))
       .build()
 
     await driver.get('http://www.google.com/ncr')