chore/code style changes, add util (#10975)

potapovDim · web-flow · commit 51095a4612bb · 2022-08-28T13:56:01.000+05:30
diff --git a/javascript/node/selenium-webdriver/lib/by.js b/javascript/node/selenium-webdriver/lib/by.js
@@ -41,9 +41,8 @@
  *     {name: string}|
  *     {partialLinkText: string}|
  *     {tagName: string}|
- *     {xpath: string})}
+ *     {xpath: string})} ByHash
  */
-var ByHash // eslint-disable-line
 
 /**
  * Error thrown if an invalid character is encountered while escaping a CSS
diff --git a/javascript/node/selenium-webdriver/lib/command.js b/javascript/node/selenium-webdriver/lib/command.js
@@ -204,7 +204,7 @@ class Executor {
 // PUBLIC API
 
 module.exports = {
-  Command: Command,
-  Name: Name,
-  Executor: Executor,
+  Command,
+  Name,
+  Executor,
 }
diff --git a/javascript/node/selenium-webdriver/lib/error.js b/javascript/node/selenium-webdriver/lib/error.js
@@ -17,6 +17,8 @@
 
 'use strict'
 
+const { isObject } = require('./util')
+
 /**
  * The base WebDriver error type. This error type is only used directly when a
  * more appropriate category is not defined for the offending error.
@@ -505,7 +507,7 @@ function encodeError(err) {
  * @see https://w3c.github.io/webdriver/webdriver-spec.html#protocol
  */
 function isErrorResponse(data) {
-  return data && typeof data === 'object' && typeof data.error === 'string'
+  return isObject(data) && typeof data.error === 'string'
 }
 
 /**
@@ -540,15 +542,13 @@ function throwDecodedError(data) {
 function checkLegacyResponse(responseObj) {
   // Handle the legacy Selenium error response format.
   if (
-    responseObj &&
-    typeof responseObj === 'object' &&
-    typeof responseObj['status'] === 'number' &&
-    responseObj['status'] !== 0
+    isObject(responseObj) &&
+    typeof responseObj.status === 'number' &&
+    responseObj.status !== 0
   ) {
-    let status = responseObj['status']
-    let ctor = LEGACY_ERROR_CODE_TO_TYPE.get(status) || WebDriverError
+    const { status, value } = responseObj
 
-    let value = responseObj['value']
+    let ctor = LEGACY_ERROR_CODE_TO_TYPE.get(status) || WebDriverError
 
     if (!value || typeof value !== 'object') {
       throw new ctor(value + '')
diff --git a/javascript/node/selenium-webdriver/lib/http.js b/javascript/node/selenium-webdriver/lib/http.js
@@ -32,6 +32,7 @@ const logging = require('./logging')
 const promise = require('./promise')
 const { Session } = require('./session')
 const webElement = require('./webelement')
+const { isObject } = require('./util')
 
 const getAttribute = requireAtom(
   'get-attribute.js',
@@ -572,10 +573,7 @@ function parseHttpResponse(command, httpResponse) {
 
   if (parsed && typeof parsed === 'object') {
     let value = parsed.value
-    let isW3C =
-      value !== null &&
-      typeof value === 'object' &&
-      typeof parsed.status === 'undefined'
+    let isW3C = isObject(value) && typeof parsed.status === 'undefined'
 
     if (!isW3C) {
       error.checkLegacyResponse(parsed)
@@ -645,10 +643,10 @@ function buildPath(path, parameters) {
 // PUBLIC API
 
 module.exports = {
-  Executor: Executor,
-  Client: Client,
-  Request: Request,
-  Response: Response,
+  Executor,
+  Client,
+  Request,
+  Response,
   // Exported for testing.
-  buildPath: buildPath,
+  buildPath,
 }
diff --git a/javascript/node/selenium-webdriver/lib/promise.js b/javascript/node/selenium-webdriver/lib/promise.js
@@ -22,16 +22,7 @@
 
 'use strict'
 
-/**
- * Determines whether a {@code value} should be treated as a promise.
- * Any object whose "then" property is a function will be considered a promise.
- *
- * @param {?} value The value to test.
- * @return {boolean} Whether the value is a promise.
- */
-function isPromise(value) {
-  return Object.prototype.toString.call(value) === '[object Promise]'
-}
+const { isObject, isPromise } = require('./util')
 
 /**
  * Creates a promise that will be resolved at a set time in the future.
@@ -218,7 +209,7 @@ async function fullyResolved(value) {
     return fullyResolveKeys(/** @type {!Array} */ (value))
   }
 
-  if (value && typeof value === 'object') {
+  if (isObject(value)) {
     return fullyResolveKeys(/** @type {!Object} */ (value))
   }
 
diff --git a/javascript/node/selenium-webdriver/lib/util.js b/javascript/node/selenium-webdriver/lib/util.js
@@ -0,0 +1,43 @@
+// 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'
+
+/**
+ * Determines whether a {@code value} should be treated as an object.
+ * @param {?} value The value to test.
+ * @returns {boolean} Whether the value is an object.
+ */
+function isObject(value) {
+  return Object.prototype.toString.call(value) === '[object Object]'
+}
+
+/**
+ * Determines whether a {@code value} should be treated as a promise.
+ * Any object whose "then" property is a function will be considered a promise.
+ *
+ * @param {?} value The value to test.
+ * @return {boolean} Whether the value is a promise.
+ */
+function isPromise(value) {
+  return Object.prototype.toString.call(value) === '[object Promise]'
+}
+
+module.exports = {
+  isObject,
+  isPromise,
+}
diff --git a/javascript/node/selenium-webdriver/lib/virtual_authenticator.js b/javascript/node/selenium-webdriver/lib/virtual_authenticator.js
@@ -234,7 +234,11 @@ class Credential {
   }
 }
 
-module.exports.Credential = Credential
-module.exports.VirtualAuthenticatorOptions = VirtualAuthenticatorOptions
-module.exports.Transport = Transport
-module.exports.Protocol = Protocol
+// PUBLIC API
+
+module.exports = {
+  Credential,
+  VirtualAuthenticatorOptions,
+  Transport,
+  Protocol,
+}
diff --git a/javascript/node/selenium-webdriver/lib/webdriver.js b/javascript/node/selenium-webdriver/lib/webdriver.js
@@ -37,8 +37,9 @@ const { Capabilities } = require('./capabilities')
 const path = require('path')
 const { NoSuchElementError } = require('./error')
 const cdpTargets = ['page', 'browser']
-const Credential = require('./virtual_authenticator').Credential
+const { Credential } = require('./virtual_authenticator')
 const webElement = require('./webelement')
+const { isObject } = require('./util')
 
 // Capability names that are defined in the W3C spec.
 const W3C_CAPABILITY_NAMES = new Set([
@@ -214,7 +215,7 @@ function fromWireValue(driver, value) {
   } else if (ShadowRoot.isId(value)) {
     let id = ShadowRoot.extractId(value)
     value = new ShadowRoot(driver, id)
-  } else if (value && typeof value === 'object') {
+  } else if (isObject(value)) {
     let result = {}
     for (let key in value) {
       if (Object.prototype.hasOwnProperty.call(value, key)) {
diff --git a/javascript/node/selenium-webdriver/lib/webelement.js b/javascript/node/selenium-webdriver/lib/webelement.js
@@ -16,6 +16,7 @@
 // under the License.
 
 'use strict'
+const { isObject } = require('./util')
 
 /**
  * @fileoverview Defines some common methods used for WebElements.
@@ -33,8 +34,7 @@ const ELEMENT_ID_KEY = 'element-6066-11e4-a52e-4f735466cecf'
  */
 function isId(obj) {
   return (
-    obj &&
-    typeof obj === 'object' &&
+    isObject(obj) &&
     (typeof obj[ELEMENT_ID_KEY] === 'string' ||
       typeof obj[LEGACY_ELEMENT_ID_KEY] === 'string')
   )
@@ -48,7 +48,7 @@ function isId(obj) {
  * @throws {TypeError} if the object is not a valid encoded ID.
  */
 function extractId(obj) {
-  if (obj && typeof obj === 'object') {
+  if (isObject(obj)) {
     if (typeof obj[ELEMENT_ID_KEY] === 'string') {
       return obj[ELEMENT_ID_KEY]
     } else if (typeof obj[LEGACY_ELEMENT_ID_KEY] === 'string') {
