selenium-webdriver 4.6.1 → 4.7.1

package/CHANGES.md

@@ -1,3 +1,28 @@
+## v4.7.1
+
+#### :nail_care: Polish
+
+* feat/deprecation message for standalone3x (#11422)
+
+#### :bug: Bug Fix
+
+* feat/fix spawn format for SeleniumServer, issue 11405 (#11412)
+
+#### Committers: 1
+
+- Potapov Dmitriy ([@potapovDim](https://github.com/potapovDim))
+
+## v4.7.0
+
+#### :rocket: New Feature
+
+* Add support for Selenium Manager to work with IE Driver
+
+#### :nail_care: Polish
+
+* Adding CDP files for v108 and removing v105
+* Improve error handling for Selenium Manager
+
 ## v4.6.1
 
 #### :bug: Bug Fix

package/common/seleniumManager.js

@@ -76,12 +76,12 @@ function driverLocation(browser) {
     result = execSync(args.join(' ')).toString()
   } catch (e) {
     throw new Error(
-      `Error executing command with ${args} : Error ${e.stderr.toString()}`
+      `Error executing command with ${args}\n${e.stdout.toString()}${e.stderr.toString()}`
     )
   }
 
   if (!result.startsWith('INFO\t')) {
-    throw new Error(`Unsuccessful command executed ${args}}`)
+    throw new Error(`Unsuccessful command executed: ${args}\n${result}`)
   }
 
   return result.replace('INFO\t', '').trim()

package/ie.js

@@ -35,6 +35,7 @@ const remote = require('./remote')
 const webdriver = require('./lib/webdriver')
 const { Browser, Capabilities } = require('./lib/capabilities')
 const error = require('./lib/error')
+const { driverLocation } = require('./common/seleniumManager')
 
 const IEDRIVER_EXE = 'IEDriverServer.exe'
 const OPTIONS_CAPABILITY_KEY = 'se:ieOptions'
@@ -399,6 +400,18 @@ 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)
+    } catch (err) {
+      console.log(`Unable to obtain driver using Selenium Manager: ${err}`)
+    }
+  }
+
   if (!exe || !fs.existsSync(exe)) {
     throw Error(
       `${IEDRIVER_EXE} could not be found on the current PATH. Please ` +

package/io/zip.js

@@ -68,8 +68,8 @@ class Zip {
    * @param {string} dirPath path to the directory to add.
    * @param {string=} zipPath path to the folder in the archive to add the
    *     directory contents to. Defaults to the root folder.
-   * @return {!Promise<?>} returns a promise that will resolve when the
-   *     the operation is complete.
+   * @return {!Promise<?>} returns a promise that will resolve when
+   * the operation is complete.
    */
   addDir(dirPath, zipPath = '') {
     return io.walkDir(dirPath).then((entries) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.6.1",
+  "version": "4.7.1",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -28,18 +28,18 @@
     "ws": ">=8.7.0"
   },
   "devDependencies": {
-    "eslint": "^8.16.0",
+    "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-no-only-tests": "^2.6.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "express": "^4.17.1",
-    "jasmine": "^3.8.0",
-    "mocha": "^10.0.0",
+    "eslint-plugin-prettier": "^4.2.0",
+    "express": "^4.18.2",
+    "jasmine": "^4.5.0",
+    "mocha": "^10.1.0",
     "multer": "^1.4.5-lts.1",
-    "prettier": "^2.6.1",
+    "prettier": "^2.7.1",
     "serve-index": "^1.9.1",
-    "sinon": "^10.0.0"
+    "sinon": "^14.0.2"
   },
   "scripts": {
     "lint": "eslint --ignore-pattern node_modules --ignore-pattern generator --fix --ext js lib/http.js \"**/*.js\"",

package/remote/index.js

@@ -18,7 +18,6 @@
 'use strict'
 
 const fs = require('fs')
-const path = require('path')
 const url = require('url')
 
 const httpUtil = require('../http/util')
@@ -29,6 +28,9 @@ const cmd = require('../lib/command')
 const input = require('../lib/input')
 const net = require('../net')
 const portprober = require('../net/portprober')
+const logging = require('../lib/logging')
+
+const { getJavaPath, formatSpawnArgs } = require('./util')
 
 /**
  * @typedef {(string|!Array<string|number|!stream.Stream|null|undefined>)}
@@ -118,6 +120,8 @@ class DriverService {
    * @param {!ServiceOptions} options Configuration options for the service.
    */
   constructor(executable, options) {
+    /** @private @const */
+    this.log_ = logging.getLogger('webdriver.DriverService')
     /** @private {string} */
     this.executable_ = executable
 
@@ -236,7 +240,7 @@ class DriverService {
                 net.getLoopbackAddress()
             }
 
-            var serverUrl = url.format({
+            const serverUrl = url.format({
               protocol: 'http',
               hostname: hostname,
               port: port + '',
@@ -479,13 +483,15 @@ class SeleniumServer extends DriverService {
       let port = resolved[0]
       let jvmArgs = resolved[1]
       let args = resolved[2]
-      return jvmArgs.concat('-jar', jar, '-port', port).concat(args)
+
+      const fullArgsList = jvmArgs
+        .concat('-jar', jar, '-port', port)
+        .concat(args)
+
+      return formatSpawnArgs(jar, fullArgsList)
     })
 
-    let java = 'java'
-    if (process.env['JAVA_HOME']) {
-      java = path.join(process.env['JAVA_HOME'], 'bin/java')
-    }
+    const java = getJavaPath()
 
     super(java, {
       loopback: options.loopback,

package/remote/util.js

@@ -0,0 +1,93 @@
+// 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.
+
+'use strict'
+
+const path = require('path')
+const cp = require('child_process')
+
+/**
+ * returns path to java or 'java' string if JAVA_HOME does not exist in env obj
+ * @returns {string}
+ */
+function getJavaPath() {
+  return process.env['JAVA_HOME']
+    ? path.join(process.env['JAVA_HOME'], 'bin/java')
+    : 'java'
+}
+
+/**
+ * @param {string} seleniumStandalonePath path to standalone server
+ * @returns {boolean}
+ */
+function isSelenium3x(seleniumStandalonePath) {
+  const javaPath = getJavaPath()
+
+  const execRes = cp.execSync(
+    `${javaPath} -jar ${seleniumStandalonePath} --version`
+  )
+
+  return execRes.toString().trim().startsWith('Selenium server version: 3')
+}
+
+/**
+ * @param {string} seleniumStandalonePath path to standalone server
+ * @param {Array.<string>} args spawn arguments array
+ * returns formatted args based on selenium standalone server version
+ * @returns {Array.<string>}
+ */
+function formatSpawnArgs(seleniumStandalonePath, args) {
+  if (isSelenium3x(seleniumStandalonePath)) {
+    console.warn('Deprecation: Support for Standalone Server 3.x will be removed soon. Please update to version 4.x')
+    return args
+  }
+
+  const standaloneArg = 'standalone'
+  const port3xArgFormat = '-port'
+  const port4xArgFormat = '--port'
+
+  let formattedArgs = Array.from(args)
+
+  const standaloneArgIndex = formattedArgs.findIndex(
+    (arg) => arg === seleniumStandalonePath
+  )
+  const v3portArgFormat = formattedArgs.findIndex(
+    (arg) => arg === port3xArgFormat
+  )
+
+  // old v3x port arg format was -port, new v4x port arg format is --port
+  if (v3portArgFormat !== -1) {
+    formattedArgs[v3portArgFormat] = port4xArgFormat
+  }
+
+  // 'standalone' arg should be right after jar file path
+  // in case if it is already in place - returns args
+  if (formattedArgs[standaloneArgIndex + 1] === standaloneArg)
+    return formattedArgs
+
+  // insert 'standalone' right after jar file path
+  formattedArgs.splice(standaloneArgIndex + 1, 0, standaloneArg)
+
+  return formattedArgs
+}
+
+// PUBLIC API
+module.exports = {
+  getJavaPath,
+  isSelenium3x,
+  formatSpawnArgs,
+}