selenium-webdriver 4.5.0 → 4.6.1

package/CHANGES.md

@@ -1,3 +1,31 @@
+## v4.6.1
+
+#### :bug: Bug Fix
+
+* Support Node 17 and above (#11262)
+
+#### :nail_care: Polish
+
+* Fix typos (#11258) 
+
+## v4.6.0
+
+#### :rocket: New Feature
+
+* [grid] Add ability to use Enter key to confirm (#11178)
+* [grid][ui] Add search field for running sessions (#11197)
+* Add support for selenium manager (#11189)
+
+#### :bug: Bug Fix
+
+* isPromise() thenable fix (#11048)
+* Fix: making methods static (#11182)
+
+#### :nail_care: Polish
+
+* fix a tiny typo in chromium.js (#11073)
+* Adding CDP files for v107 and removing v104
+
 ## v4.5.0
 
 #### :rocket: New Feature

package/chrome.js

@@ -130,6 +130,7 @@
 const io = require('./io')
 const { Browser } = require('./lib/capabilities')
 const chromium = require('./chromium')
+const { driverLocation } = require('./common/seleniumManager')
 
 /**
  * Name of the ChromeDriver executable.
@@ -150,20 +151,35 @@ class ServiceBuilder extends chromium.ServiceBuilder {
   /**
    * @param {string=} opt_exe Path to the server executable to use. If omitted,
    *     the builder will attempt to locate the chromedriver on the current
-   *     PATH.
+   *     PATH. If the chromedriver is not available in path, selenium-manager will
+   *     download the chromedriver
    * @throws {Error} If provided executable does not exist, or the chromedriver
    *     cannot be found on the PATH.
    */
   constructor(opt_exe) {
     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) {
+        console.log(`Unable to obtain driver using Selenium Manager: ${err}`)
+      }
+    }
+
     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.`
+        `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.`
       )
     }
+
     super(exe)
   }
 }

package/chromium.js

@@ -706,7 +706,7 @@ class Driver extends webdriver.WebDriver {
   /**
    * Schedules a command to get Chromium network emulation settings.
    * @return {!Promise} A promise that will be resolved when network
-   *     emulation settings are retrievied.
+   *     emulation settings are retrieved.
    */
   getNetworkConditions() {
     return this.execute(new command.Command(Command.GET_NETWORK_CONDITIONS))

package/common/seleniumManager.js

@@ -0,0 +1,91 @@
+// 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.
+
+/**
+ *  This implementation is still in beta, and may change.
+ *
+ *  Wrapper for getting information from the Selenium Manager binaries
+ */
+
+const { platform } = require('process')
+const path = require('path')
+const fs = require('fs')
+const execSync = require('child_process').execSync
+
+/**
+ * currently supported browsers for selenium-manager
+ * @type {string[]}
+ */
+const Browser = ['chrome', 'firefox', 'edge']
+
+/**
+ * Determines the path of the correct Selenium Manager binary
+ * @returns {string}
+ */
+function getBinary() {
+  const directory = {
+    darwin: 'macos',
+    win32: 'windows',
+    cygwin: 'windows',
+    linux: 'linux',
+  }[platform]
+
+  const file =
+    directory === 'windows' ? 'selenium-manager.exe' : 'selenium-manager'
+
+  const filePath = path.join(__dirname, '..', '/bin', directory, file)
+
+  if (!fs.existsSync(filePath)) {
+    throw new Error(`Unable to obtain Selenium Manager`)
+  }
+
+  return filePath
+}
+
+/**
+ * Determines the path of the correct driver
+ * @param {Browser|string} browser name to fetch the driver
+ * @returns {string} path of the driver location
+ */
+
+function driverLocation(browser) {
+  if (!Browser.includes(browser.toLocaleString())) {
+    throw new Error(
+      `Unable to locate driver associated with browser name: ${browser}`
+    )
+  }
+
+  let args = [getBinary(), '--browser', browser]
+  let result
+
+  try {
+    result = execSync(args.join(' ')).toString()
+  } catch (e) {
+    throw new Error(
+      `Error executing command with ${args} : Error ${e.stderr.toString()}`
+    )
+  }
+
+  if (!result.startsWith('INFO\t')) {
+    throw new Error(`Unsuccessful command executed ${args}}`)
+  }
+
+  return result.replace('INFO\t', '').trim()
+}
+
+// PUBLIC API
+module.exports = { driverLocation }

package/edge.js

@@ -80,6 +80,7 @@
 const { Browser } = require('./lib/capabilities')
 const io = require('./io')
 const chromium = require('./chromium')
+const { driverLocation } = require('./common/seleniumManager')
 
 /**
  * Name of the EdgeDriver executable.
@@ -106,6 +107,19 @@ class ServiceBuilder extends chromium.ServiceBuilder {
    */
   constructor(opt_exe) {
     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) {
+        console.log(`Unable to obtain driver using Selenium Manager: ${err}`)
+      }
+    }
+
     if (!exe) {
       throw Error(
         `The WebDriver for Edge could not be found on the current PATH. Please download the ` +
@@ -114,6 +128,7 @@ class ServiceBuilder extends chromium.ServiceBuilder {
           `and ensure it can be found on your PATH.`
       )
     }
+
     super(exe)
     this.setLoopback(true)
   }

package/firefox.js

@@ -127,6 +127,7 @@ const webdriver = require('./lib/webdriver')
 const zip = require('./io/zip')
 const { Browser, Capabilities } = require('./lib/capabilities')
 const { Zip } = require('./io/zip')
+const { driverLocation } = require('./common/seleniumManager')
 
 /**
  * Thrown when there an add-on is malformed.
@@ -459,16 +460,27 @@ function locateSynchronously() {
  */
 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) {
+      console.log(`Unable to obtain driver using Selenium Manager: ${err}`)
+    }
+  }
+
   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.'
+      `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.`
     )
   }
+
   return exe
 }
 

package/http/index.js

@@ -54,6 +54,7 @@ function getRequestOptions(aUrl) {
   options.search = null
   options.hash = null
   options.path = options.pathname
+  options.hostname = options.hostname === 'localhost' ? '127.0.0.1' : options.hostname // To support Node 17 and above. Refer https://github.com/nodejs/node/issues/40702 for details.
   return options
 }
 

package/lib/select.js

@@ -291,7 +291,7 @@ class Select {
   }
 
   /**
-   * Retruns a boolean value if the select tag is multiple
+   * Returns a boolean value if the select tag is multiple
    * @returns {Promise<boolean>}
    */
   async isMultiple() {

package/lib/util.js

@@ -34,7 +34,16 @@ function isObject(value) {
  * @return {boolean} Whether the value is a promise.
  */
 function isPromise(value) {
-  return Object.prototype.toString.call(value) === '[object Promise]'
+  try {
+    // Use array notation so the Closure compiler does not obfuscate away our
+    // contract.
+    return (
+      (typeof value === 'object' || typeof value === 'function') &&
+      typeof value['then'] === 'function'
+    )
+  } catch (ex) {
+    return false
+  }
 }
 
 module.exports = {

package/lib/virtual_authenticator.js

@@ -169,24 +169,34 @@ class Credential {
    * @param userHandle userHandle associated to the credential. Must be Base64 encoded string.
    * @param privateKey Base64 encoded PKCS
    * @param signCount initial value for a signature counter.
+   * @deprecated This method has been made static. Call it with class name. Example, Credential.createResidentCredential()
    * @returns A resident credential
    */
   createResidentCredential(id, rpId, userHandle, privateKey, signCount) {
     return new Credential(id, true, rpId, userHandle, privateKey, signCount)
   }
 
+  static createResidentCredential(id, rpId, userHandle, privateKey, signCount) {
+    return new Credential(id, true, rpId, userHandle, privateKey, signCount)
+  }
+
   /**
    * Creates a non-resident (i.e. stateless) credential.
    * @param id Unique base64 encoded string.
    * @param rpId Relying party identifier.
    * @param privateKey Base64 encoded PKCS
    * @param signCount initial value for a signature counter.
+   * @deprecated This method has been made static. Call it with class name. Example, Credential.createNonResidentCredential()
    * @returns A non-resident credential
    */
   createNonResidentCredential(id, rpId, privateKey, signCount) {
     return new Credential(id, false, rpId, null, privateKey, signCount)
   }
 
+  static createNonResidentCredential(id, rpId, privateKey, signCount) {
+    return new Credential(id, false, rpId, null, privateKey, signCount)
+  }
+
   toDict() {
     let credentialData = {
       credentialId: Buffer.from(this._id).toString('base64url'),

package/package.json

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