selenium-webdriver 4.17.0 → 4.18.1

package/bidi/scriptManager.js

@@ -55,11 +55,7 @@ class ScriptManager {
     await this.bidi.send(params)
   }
 
-  async disownBrowsingContextScript(
-    browsingContextId,
-    handles,
-    sandbox = null
-  ) {
+  async disownBrowsingContextScript(browsingContextId, handles, sandbox = null) {
     const params = {
       method: 'script.disown',
       params: {
@@ -83,7 +79,7 @@ class ScriptManager {
     awaitPromise,
     argumentValueList = null,
     thisParameter = null,
-    resultOwnership = null
+    resultOwnership = null,
   ) {
     const params = this.getCallFunctionParams(
       'realm',
@@ -93,7 +89,7 @@ class ScriptManager {
       awaitPromise,
       argumentValueList,
       thisParameter,
-      resultOwnership
+      resultOwnership,
     )
 
     const command = {
@@ -112,7 +108,7 @@ class ScriptManager {
     argumentValueList = null,
     thisParameter = null,
     resultOwnership = null,
-    sandbox = null
+    sandbox = null,
   ) {
     const params = this.getCallFunctionParams(
       'contextTarget',
@@ -122,7 +118,7 @@ class ScriptManager {
       awaitPromise,
       argumentValueList,
       thisParameter,
-      resultOwnership
+      resultOwnership,
     )
 
     const command = {
@@ -133,20 +129,8 @@ class ScriptManager {
     return this.createEvaluateResult(response)
   }
 
-  async evaluateFunctionInRealm(
-    realmId,
-    expression,
-    awaitPromise,
-    resultOwnership = null
-  ) {
-    const params = this.getEvaluateParams(
-      'realm',
-      realmId,
-      null,
-      expression,
-      awaitPromise,
-      resultOwnership
-    )
+  async evaluateFunctionInRealm(realmId, expression, awaitPromise, resultOwnership = null) {
+    const params = this.getEvaluateParams('realm', realmId, null, expression, awaitPromise, resultOwnership)
 
     const command = {
       method: 'script.evaluate',
@@ -162,7 +146,7 @@ class ScriptManager {
     expression,
     awaitPromise,
     resultOwnership = null,
-    sandbox = null
+    sandbox = null,
   ) {
     const params = this.getEvaluateParams(
       'contextTarget',
@@ -170,7 +154,7 @@ class ScriptManager {
       sandbox,
       expression,
       awaitPromise,
-      resultOwnership
+      resultOwnership,
     )
 
     const command = {
@@ -182,11 +166,7 @@ class ScriptManager {
     return this.createEvaluateResult(response)
   }
 
-  async addPreloadScript(
-    functionDeclaration,
-    argumentValueList = [],
-    sandbox = null
-  ) {
+  async addPreloadScript(functionDeclaration, argumentValueList = [], sandbox = null) {
     const params = {
       functionDeclaration: functionDeclaration,
       arguments: argumentValueList,
@@ -223,7 +203,7 @@ class ScriptManager {
     awaitPromise,
     argumentValueList = null,
     thisParameter = null,
-    resultOwnership = null
+    resultOwnership = null,
   ) {
     const params = {
       functionDeclaration: functionDeclaration,
@@ -258,14 +238,7 @@ class ScriptManager {
     return params
   }
 
-  getEvaluateParams(
-    targetType,
-    id,
-    sandbox,
-    expression,
-    awaitPromise,
-    resultOwnership = null
-  ) {
+  getEvaluateParams(targetType, id, sandbox, expression, awaitPromise, resultOwnership = null) {
     const params = {
       expression: expression,
       awaitPromise: awaitPromise,
@@ -293,16 +266,10 @@ class ScriptManager {
 
     if (type === EvaluateResultType.SUCCESS) {
       const result = response.result.result
-      evaluateResult = new EvaluateResultSuccess(
-        realmId,
-        new RemoteValue(result)
-      )
+      evaluateResult = new EvaluateResultSuccess(realmId, new RemoteValue(result))
     } else {
       const exceptionDetails = response.result.exceptionDetails
-      evaluateResult = new EvaluateResultException(
-        realmId,
-        new ExceptionDetails(exceptionDetails)
-      )
+      evaluateResult = new EvaluateResultException(realmId, new ExceptionDetails(exceptionDetails))
     }
     return evaluateResult
   }
@@ -359,6 +326,10 @@ class ScriptManager {
     await this.subscribeAndHandleEvent('script.realmCreated', callback)
   }
 
+  async onRealmDestroyed(callback) {
+    await this.subscribeAndHandleEvent('script.realmDestroyed', callback)
+  }
+
   async subscribeAndHandleEvent(eventType, callback) {
     if (this._browsingContextIds != null) {
       await this.bidi.subscribe(eventType, this._browsingContextIds)
@@ -375,20 +346,10 @@ class ScriptManager {
       if (params) {
         let response = null
         if ('channel' in params) {
-          response = new Message(
-            params.channel,
-            new RemoteValue(params.data),
-            new Source(params.source)
-          )
+          response = new Message(params.channel, new RemoteValue(params.data), new Source(params.source))
         } else if ('realm' in params) {
           if (params.type === RealmType.WINDOW) {
-            response = new WindowRealmInfo(
-              params.realm,
-              params.origin,
-              params.type,
-              params.context,
-              params.sandbox
-            )
+            response = new WindowRealmInfo(params.realm, params.origin, params.type, params.context, params.sandbox)
           } else if (params.realm !== null && params.type !== null) {
             response = new RealmInfo(params.realm, params.origin, params.type)
           } else if (params.realm !== null) {

package/bidi/urlPattern.js

@@ -0,0 +1,58 @@
+// 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 {LocalValue} = require('./protocolValue')
+
+class UrlPattern {
+  #map = new Map()
+
+  protocol(protocol) {
+    this.#map.set('protocol', protocol)
+    return this
+  }
+
+  hostname(hostname) {
+    this.#map.set('hostname', hostname)
+    return this
+  }
+
+  port(port) {
+    if (typeof port === 'number') {
+      this.#map.set('port', port.toString())
+    } else {
+      throw new Error(`Port must be a number. Received:'${port}'`)
+    }
+    return this
+  }
+
+  pathname(pathname) {
+    this.#map.set('pathname', pathname)
+    return this
+  }
+
+  search(search) {
+    this.#map.set('search', search)
+    return this
+  }
+
+  asMap() {
+    this.#map.set('type', 'pattern')
+    return this.#map
+  }
+}
+
+module.exports = {UrlPattern}

package/chrome.js

@@ -214,14 +214,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,
-        'goog',
-        CHROME_CAPABILITY_KEY
-      )
-    )
+    return /** @type {!Driver} */ (super.createSession(caps, opt_serviceExecutor, 'goog', CHROME_CAPABILITY_KEY))
   }
 
   /**

package/chromium.js

@@ -119,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`)
 }
 
 /**
@@ -622,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'))
     })
   }
 }
@@ -646,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) {
@@ -701,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))
   }
 
   /**
@@ -742,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))
   }
 
   /**
@@ -765,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),
     )
   }
 
@@ -784,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),
     )
   }
 
@@ -800,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),
     )
   }
 
@@ -835,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))
   }
 
   /**
@@ -849,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))
   }
 
   /**
@@ -866,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))
   }
 
   /**
@@ -883,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))
   }
 
   /**
@@ -898,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))
   }
 
   /**
@@ -912,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

@@ -35,7 +35,7 @@ let debugMessagePrinted = false
  * Determines the path of the correct Selenium Manager binary
  * @returns {string}
  */
-function getBinary () {
+function getBinary() {
   const directory = {
     darwin: 'macos',
     win32: 'windows',
@@ -43,13 +43,11 @@ 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')
 
-  const filePath = process.env.SE_MANAGER_PATH || 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 at ${filePath}`)
@@ -70,18 +68,15 @@ function getBinary () {
  * browser location
  */
 
-function driverLocation (options) {
-  let args = ['--browser', options.getBrowserName(), '--language-binding',
-    'javascript', '--output', 'json']
+function driverLocation(options) {
+  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))
   }
@@ -117,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
@@ -141,7 +132,7 @@ function driverLocation (options) {
   }
 }
 
-function logOutput (output) {
+function logOutput(output) {
   for (const key in output.logs) {
     if (output.logs[key].level === 'WARN') {
       log_.warning(`${output.logs[key].message}`)

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())