selenium-webdriver 4.8.0 → 4.8.2

package/CHANGES.md

@@ -1,3 +1,29 @@
+## v4.8.2
+
+#### :nail_care: Polish
+
+* Add CDP support for v111 and remove v108
+* Using json output with Selenium Manager
+
+#### :bug: Bug Fix
+
+fix: Using status from response (#11742)
+
+## v4.8.1
+
+#### :rocket: New Feature
+
+* Add script pinning (#11584)
+
+#### :nail_care: Polish
+
+* Add CDP support for v110 and remove v107
+* Updating Selenium Manager binaries for 4.8.1 release
+
+#### :bug: Bug Fix
+
+fix: iedriver download with selenium-manager #11579
+
 ## v4.8.0
 
 #### :rocket: New Feature

package/chrome.js

@@ -160,10 +160,6 @@ class ServiceBuilder extends chromium.ServiceBuilder {
     let exe = opt_exe || locateSynchronously()
 
     if (!exe) {
-      console.log(
-        ` The ChromeDriver could not be found on the current PATH, trying Selenium Manager`
-      )
-
       try {
         exe = driverLocation(Browser.CHROME)
       } catch (err) {
@@ -173,10 +169,9 @@ class ServiceBuilder extends chromium.ServiceBuilder {
 
     if (!exe) {
       throw Error(
-        `The ChromeDriver could not be found on the current PATH.
-      Please download the latest version of the ChromeDriver
-      from http://chromedriver.storage.googleapis.com/index.html
-      and ensure it can be found on your PATH.`
+        `ChromeDriver could not be found on the PATH.
+        For more information on how to install drivers see
+        https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/.`
       )
     }
 

package/common/seleniumManager.js

@@ -30,7 +30,7 @@ const execSync = require('child_process').execSync
  * currently supported browsers for selenium-manager
  * @type {string[]}
  */
-const Browser = ['chrome', 'firefox', 'edge']
+const Browser = ['chrome', 'firefox', 'edge', 'iexplorer']
 
 /**
  * Determines the path of the correct Selenium Manager binary
@@ -69,22 +69,30 @@ function driverLocation(browser) {
     )
   }
 
-  let args = [getBinary(), '--browser', browser]
-  let result
+  let args = [getBinary(), '--browser', browser, '--output', 'json']
+  let output
 
   try {
-    result = execSync(args.join(' ')).toString()
+    output = JSON.parse(execSync(args.join(' ')).toString())
   } catch (e) {
+    let error
+    try {
+      error = JSON.parse(e.stdout.toString()).result.message
+    } catch (e) {
+      error = e.toString()
+    }
     throw new Error(
-      `Error executing command with ${args}\n${e.stdout.toString()}${e.stderr.toString()}`
+      `Error executing command with ${args}: ${error}`
     )
   }
 
-  if (!result.startsWith('INFO\t')) {
-    throw new Error(`Unsuccessful command executed: ${args}\n${result}`)
+  for (const key in output.logs){
+    if (output.logs[key].level === 'WARN') {
+      console.warn(`${output.logs[key].message}`)
+    }
   }
 
-  return result.replace('INFO\t', '').trim()
+  return output.result.message
 }
 
 // PUBLIC API

package/devtools/CDPConnection.js

@@ -15,6 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
+const RESPONSE_TIMEOUT = 1000 * 30
 class CDPConnection {
   constructor(wsConnection) {
     this._wsConnection = wsConnection
@@ -35,6 +36,42 @@ class CDPConnection {
     const mergedMessage = Object.assign({ params: params }, message)
     this._wsConnection.send(JSON.stringify(mergedMessage), callback)
   }
+
+  async send(method, params) {
+    let cdp_id = this.cmd_id++
+    let message = {
+      method,
+      id: cdp_id,
+    }
+    if (this.sessionId) {
+      message['sessionId'] = this.sessionId
+    }
+
+    const mergedMessage = Object.assign({ params: params }, message)
+    this._wsConnection.send(JSON.stringify(mergedMessage))
+
+    return new Promise((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        reject(new Error(`Request with id ${cdp_id} timed out`))
+        handler.off('message', listener)
+      }, RESPONSE_TIMEOUT)
+
+      const listener = (data) => {
+        try {
+          const payload = JSON.parse(data.toString())
+          if (payload.id === cdp_id) {
+            clearTimeout(timeoutId)
+            handler.off('message', listener)
+            resolve(payload)
+          }
+        } catch (err) {
+          console.error(`Failed parse message: ${err.message}`)
+        }
+      }
+
+      const handler = this._wsConnection.on('message', listener)
+    })
+  }
 }
 
 exports.CdpConnection = CDPConnection

package/edge.js

@@ -109,10 +109,6 @@ class ServiceBuilder extends chromium.ServiceBuilder {
     let exe = opt_exe || locateSynchronously()
 
     if (!exe) {
-      console.log(
-        `The WebDriver for Edge could not be found on the current PATH, trying Selenium Manager`
-      )
-
       try {
         exe = driverLocation('edge')
       } catch (err) {
@@ -122,13 +118,11 @@ class ServiceBuilder extends chromium.ServiceBuilder {
 
     if (!exe) {
       throw Error(
-        `The WebDriver for Edge could not be found on the current PATH. Please download the ` +
-          `latest version of ${EDGEDRIVER_CHROMIUM_EXE} from ` +
-          `https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ ` +
-          `and ensure it can be found on your PATH.`
+        `MSEdgeDriver could not be found on the PATH.
+        For more information on how to install drivers see
+        https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/.`
       )
     }
-
     super(exe)
     this.setLoopback(true)
   }

package/firefox.js

@@ -474,10 +474,6 @@ function findGeckoDriver() {
   let exe = locateSynchronously()
 
   if (!exe) {
-    console.log(
-      `The ${GECKO_DRIVER_EXE} executable could not be found on the current PATH, trying Selenium Manager`
-    )
-
     try {
       exe = driverLocation(Browser.FIREFOX)
     } catch (err) {
@@ -487,9 +483,9 @@ function findGeckoDriver() {
 
   if (!exe) {
     throw Error(
-      `The ${GECKO_DRIVER_EXE} executable could not be found on the current PATH.
-      Please download the latest version from https://github.com/mozilla/geckodriver/releases/
-      and ensure it can be found on your PATH.`
+      `GeckoDriver could not be found on the PATH.
+      For more information on how to install drivers see
+      https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/.`
     )
   }
 

package/ie.js

@@ -401,12 +401,8 @@ function createServiceFromCapabilities(capabilities) {
 
   let exe = locateSynchronously()
   if (!exe) {
-    console.log(
-      `The ${IEDRIVER_EXE} executable could not be found on the current PATH, trying Selenium Manager`
-    )
-
     try {
-      exe = driverLocation(Browser.INTERNET_EXPLORER)
+      exe = driverLocation('iexplorer')
     } catch (err) {
       console.log(`Unable to obtain driver using Selenium Manager: ${err}`)
     }
@@ -414,10 +410,9 @@ function createServiceFromCapabilities(capabilities) {
 
   if (!exe || !fs.existsSync(exe)) {
     throw Error(
-      `${IEDRIVER_EXE} could not be found on the current PATH. Please ` +
-        `download the latest version of ${IEDRIVER_EXE} from ` +
-        'https://www.selenium.dev/downloads/ and ' +
-        'ensure it can be found on your system PATH.'
+      `IEDriver could not be found on the PATH.
+      For more information on how to install drivers see
+      https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/.`
     )
   }
 

package/lib/pinnedScript.js

@@ -0,0 +1,59 @@
+// 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 crypto = require('crypto')
+
+class PinnedScript {
+  constructor(script) {
+    this.scriptSource_ = script
+    this.scriptHandle_ = crypto.randomUUID().replace(/-/gi, '')
+  }
+
+  get handle() {
+    return this.scriptHandle_
+  }
+
+  get source() {
+    return this.scriptSource_
+  }
+
+  get scriptId() {
+    return this.scriptId_
+  }
+
+  set scriptId(id) {
+    this.scriptId_ = id
+  }
+
+  creationScript() {
+    return `function __webdriver_${this.scriptHandle_}(arguments) { ${this.scriptSource_} }`
+  }
+
+  executionScript() {
+    return `return __webdriver_${this.scriptHandle_}(arguments)`
+  }
+
+  removalScript() {
+    return `__webdriver_${this.scriptHandle_} = undefined`
+  }
+}
+
+// PUBLIC API
+
+module.exports = {
+  PinnedScript,
+}

package/lib/webdriver.js

@@ -41,6 +41,7 @@ const { Credential } = require('./virtual_authenticator')
 const webElement = require('./webelement')
 const { isObject } = require('./util')
 const BIDI = require('../bidi')
+const { PinnedScript } = require('./pinnedScript')
 
 // Capability names that are defined in the W3C spec.
 const W3C_CAPABILITY_NAMES = new Set([
@@ -686,6 +687,8 @@ class WebDriver {
 
     /** @private {./virtual_authenticator}*/
     this.authenticatorId_ = null
+
+    this.pinnedScripts_ = {}
   }
 
   /**
@@ -795,6 +798,15 @@ class WebDriver {
     if (typeof script === 'function') {
       script = 'return (' + script + ').apply(null, arguments);'
     }
+
+    if (script && script instanceof PinnedScript) {
+      return this.execute(
+        new command.Command(command.Name.EXECUTE_SCRIPT)
+          .setParameter('script', script.executionScript())
+          .setParameter('args', args)
+      )
+    }
+
     return this.execute(
       new command.Command(command.Name.EXECUTE_SCRIPT)
         .setParameter('script', script)
@@ -807,6 +819,15 @@ class WebDriver {
     if (typeof script === 'function') {
       script = 'return (' + script + ').apply(null, arguments);'
     }
+
+    if (script && script instanceof PinnedScript) {
+      return this.execute(
+        new command.Command(command.Name.EXECUTE_ASYNC_SCRIPT)
+          .setParameter('script', script.executionScript())
+          .setParameter('args', args)
+      )
+    }
+
     return this.execute(
       new command.Command(command.Name.EXECUTE_ASYNC_SCRIPT)
         .setParameter('script', script)
@@ -1226,7 +1247,9 @@ class WebDriver {
     this._wsUrl = await this.getWsUrl(debuggerUrl, target, caps)
     return new Promise((resolve, reject) => {
       try {
-        this._wsConnection = new WebSocket(this._wsUrl.replace('localhost', '127.0.0.1'))
+        this._wsConnection = new WebSocket(
+          this._wsUrl.replace('localhost', '127.0.0.1')
+        )
         this._cdpConnection = new cdp.CdpConnection(this._wsConnection)
       } catch (err) {
         reject(err)
@@ -1382,7 +1405,7 @@ class WebDriver {
         if (requestPausedParams.request.url == httpResponse.urlToIntercept) {
           connection.execute('Fetch.fulfillRequest', {
             requestId: requestPausedParams['requestId'],
-            responseCode: 200,
+            responseCode: httpResponse.status,
             responseHeaders: httpResponse.headers,
             body: httpResponse.body,
           })
@@ -1532,6 +1555,74 @@ class WebDriver {
     })
   }
 
+  async pinScript(script) {
+    let pinnedScript = new PinnedScript(script)
+    let connection
+    if (Object.is(this._cdpConnection, undefined)) {
+      connection = await this.createCDPConnection('page')
+    } else {
+      connection = this._cdpConnection
+    }
+
+    await connection.execute('Page.enable', {}, null)
+
+    await connection.execute(
+      'Runtime.evaluate',
+      {
+        expression: pinnedScript.creationScript(),
+      },
+      null
+    )
+
+    let result = await connection.send(
+      'Page.addScriptToEvaluateOnNewDocument',
+      {
+        source: pinnedScript.creationScript(),
+      }
+    )
+
+    pinnedScript.scriptId = result['result']['identifier']
+
+    this.pinnedScripts_[pinnedScript.handle] = pinnedScript
+
+    return pinnedScript
+  }
+
+  async unpinScript(script) {
+    if (script && !(script instanceof PinnedScript)) {
+      throw Error(`Pass valid PinnedScript object. Received: ${script}`)
+    }
+
+    if (script.handle in this.pinnedScripts_) {
+      let connection
+      if (Object.is(this._cdpConnection, undefined)) {
+        connection = this.createCDPConnection('page')
+      } else {
+        connection = this._cdpConnection
+      }
+
+      await connection.execute('Page.enable', {}, null)
+
+      await connection.execute(
+        'Runtime.evaluate',
+        {
+          expression: script.removalScript(),
+        },
+        null
+      )
+
+      await connection.execute(
+        'Page.removeScriptToEvaluateOnLoad',
+        {
+          identifier: script.scriptId,
+        },
+        null
+      )
+
+      delete this.pinnedScripts_[script.handle]
+    }
+  }
+
   /**
    *
    * @returns The value of authenticator ID added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.8.0",
+  "version": "4.8.2",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [