selenium-webdriver 4.7.0 → 4.7.1

package/CHANGES.md

@@ -1,3 +1,17 @@
+## 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

package/package.json

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

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,
+}