@appium/base-driver 10.5.2 → 10.7.0

package/lib/protocol/errors.ts

@@ -1,4 +1,3 @@
-import _ from 'lodash';
 import {util, logger} from '@appium/support';
 import {StatusCodes as HTTPStatusCodes} from 'http-status-codes';
 import type {ErrorBiDiCommandResponse, Class} from '@appium/types';
@@ -22,13 +21,13 @@ class BaseError extends Error {
 
   private _formatStack(): void {
     // eslint-disable-next-line no-prototype-builtins
-    if (Error.hasOwnProperty('captureStackTrace') && _.isEmpty(this.stack)) {
+    if (Error.hasOwnProperty('captureStackTrace') && util.isEmpty(this.stack)) {
       Error.captureStackTrace(this, this.constructor);
     }
-    if (!_.isString(this.cause?.stack)) {
+    if (typeof this.cause?.stack !== 'string') {
       return;
     }
-    if (_.isEmpty(this.stack)) {
+    if (util.isEmpty(this.stack)) {
       this.stack = this.cause.stack;
       return;
     }
@@ -77,7 +76,7 @@ export class ProtocolError extends BaseError {
   bidiErrObject(id: string | number): ErrorBiDiCommandResponse {
     // if we don't have an id, the client didn't send one, so we have nothing to send back.
     // send back zero rather than making something up
-    const intId = (_.isInteger(id) ? id : (parseInt(`${id}`, 10) || 0)) as number;
+    const intId = (Number.isInteger(id) ? id : parseInt(`${id}`, 10) || 0) as number;
     return {
       id: intId,
       type: 'error',
@@ -113,7 +112,6 @@ export class NoSuchDriverError extends ProtocolError {
   static error() {
     return 'invalid session id';
   }
-
 }
 
 export class NoSuchElementError extends ProtocolError {
@@ -137,7 +135,6 @@ export class NoSuchElementError extends ProtocolError {
   static error() {
     return 'no such element';
   }
-
 }
 
 /**
@@ -149,8 +146,7 @@ export class NoSuchElementError extends ProtocolError {
 export class NoSuchShadowRootError extends ProtocolError {
   constructor(message: string = '', cause?: Error) {
     super(
-      message ||
-        'The element does not have a shadow root attached.',
+      message || 'The element does not have a shadow root attached.',
       NoSuchShadowRootError.code(),
       NoSuchShadowRootError.w3cStatus(),
       NoSuchShadowRootError.error(),
@@ -170,7 +166,6 @@ export class NoSuchShadowRootError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.NOT_FOUND;
   }
-
 }
 
 export class NoSuchFrameError extends ProtocolError {
@@ -195,7 +190,6 @@ export class NoSuchFrameError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.NOT_FOUND;
   }
-
 }
 
 export class UnknownCommandError extends ProtocolError {
@@ -221,7 +215,6 @@ export class UnknownCommandError extends ProtocolError {
   static error() {
     return 'unknown command';
   }
-
 }
 
 export class StaleElementReferenceError extends ProtocolError {
@@ -246,7 +239,6 @@ export class StaleElementReferenceError extends ProtocolError {
   static error() {
     return 'stale element reference';
   }
-
 }
 
 export class ElementNotVisibleError extends ProtocolError {
@@ -271,7 +263,6 @@ export class ElementNotVisibleError extends ProtocolError {
   static error() {
     return 'element not visible';
   }
-
 }
 
 export class InvalidElementStateError extends ProtocolError {
@@ -296,7 +287,6 @@ export class InvalidElementStateError extends ProtocolError {
   static error() {
     return 'invalid element state';
   }
-
 }
 
 export class UnknownError extends ProtocolError {
@@ -319,7 +309,6 @@ export class UnknownError extends ProtocolError {
   static error() {
     return 'unknown error';
   }
-
 }
 
 export class UnknownMethodError extends ProtocolError {
@@ -343,7 +332,6 @@ export class UnknownMethodError extends ProtocolError {
   static error() {
     return 'unknown method';
   }
-
 }
 
 export class UnsupportedOperationError extends ProtocolError {
@@ -366,7 +354,6 @@ export class UnsupportedOperationError extends ProtocolError {
   static error() {
     return 'unsupported operation';
   }
-
 }
 
 export class ElementIsNotSelectableError extends ProtocolError {
@@ -389,7 +376,6 @@ export class ElementIsNotSelectableError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.BAD_REQUEST;
   }
-
 }
 
 export class ElementClickInterceptedError extends ProtocolError {
@@ -414,7 +400,6 @@ export class ElementClickInterceptedError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.BAD_REQUEST;
   }
-
 }
 
 export class ElementNotInteractableError extends ProtocolError {
@@ -438,7 +423,6 @@ export class ElementNotInteractableError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.BAD_REQUEST;
   }
-
 }
 
 export class InsecureCertificateError extends ProtocolError {
@@ -459,7 +443,6 @@ export class InsecureCertificateError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.BAD_REQUEST;
   }
-
 }
 
 export class JavaScriptError extends ProtocolError {
@@ -482,7 +465,6 @@ export class JavaScriptError extends ProtocolError {
   static error() {
     return 'javascript error';
   }
-
 }
 
 export class XPathLookupError extends ProtocolError {
@@ -505,7 +487,6 @@ export class XPathLookupError extends ProtocolError {
   static error() {
     return 'invalid selector';
   }
-
 }
 
 export class TimeoutError extends ProtocolError {
@@ -528,7 +509,6 @@ export class TimeoutError extends ProtocolError {
   static error() {
     return 'timeout';
   }
-
 }
 
 export class NoSuchWindowError extends ProtocolError {
@@ -553,7 +533,6 @@ export class NoSuchWindowError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.NOT_FOUND;
   }
-
 }
 
 export class InvalidArgumentError extends ProtocolError {
@@ -576,7 +555,6 @@ export class InvalidArgumentError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.BAD_REQUEST;
   }
-
 }
 
 export class InvalidCookieDomainError extends ProtocolError {
@@ -601,7 +579,6 @@ export class InvalidCookieDomainError extends ProtocolError {
   static w3cStatus() {
     return HTTPStatusCodes.BAD_REQUEST;
   }
-
 }
 
 export class NoSuchCookieError extends ProtocolError {
@@ -625,7 +602,6 @@ export class NoSuchCookieError extends ProtocolError {
   static error() {
     return 'no such cookie';
   }
-
 }
 
 export class UnableToSetCookieError extends ProtocolError {
@@ -648,7 +624,6 @@ export class UnableToSetCookieError extends ProtocolError {
   static error() {
     return 'unable to set cookie';
   }
-
 }
 
 export class UnexpectedAlertOpenError extends ProtocolError {
@@ -671,7 +646,6 @@ export class UnexpectedAlertOpenError extends ProtocolError {
   static error() {
     return 'unexpected alert open';
   }
-
 }
 
 export class NoAlertOpenError extends ProtocolError {
@@ -694,7 +668,6 @@ export class NoAlertOpenError extends ProtocolError {
   static error() {
     return 'no such alert';
   }
-
 }
 
 export class NoSuchAlertError extends NoAlertOpenError {}
@@ -719,7 +692,6 @@ export class ScriptTimeoutError extends ProtocolError {
   static error() {
     return 'script timeout';
   }
-
 }
 
 export class InvalidElementCoordinatesError extends ProtocolError {
@@ -742,7 +714,6 @@ export class InvalidElementCoordinatesError extends ProtocolError {
   static error() {
     return 'invalid coordinates';
   }
-
 }
 
 export class InvalidCoordinatesError extends InvalidElementCoordinatesError {}
@@ -767,7 +738,6 @@ export class IMENotAvailableError extends ProtocolError {
   static error() {
     return 'unsupported operation';
   }
-
 }
 
 export class IMEEngineActivationFailedError extends ProtocolError {
@@ -790,7 +760,6 @@ export class IMEEngineActivationFailedError extends ProtocolError {
   static error() {
     return 'unsupported operation';
   }
-
 }
 
 export class InvalidSelectorError extends ProtocolError {
@@ -813,13 +782,12 @@ export class InvalidSelectorError extends ProtocolError {
   static error() {
     return 'invalid selector';
   }
-
 }
 
 export class SessionNotCreatedError extends ProtocolError {
   constructor(message: string = '', cause?: Error) {
     super(
-      `A new session could not be created.${message ? (' Details: ' + message) : ''}`,
+      `A new session could not be created.${message ? ' Details: ' + message : ''}`,
       SessionNotCreatedError.code(),
       SessionNotCreatedError.w3cStatus(),
       SessionNotCreatedError.error(),
@@ -836,7 +804,6 @@ export class SessionNotCreatedError extends ProtocolError {
   static error() {
     return 'session not created';
   }
-
 }
 
 export class MoveTargetOutOfBoundsError extends ProtocolError {
@@ -859,7 +826,6 @@ export class MoveTargetOutOfBoundsError extends ProtocolError {
   static error() {
     return 'move target out of bounds';
   }
-
 }
 
 export class NoSuchContextError extends ProtocolError {
@@ -876,7 +842,6 @@ export class NoSuchContextError extends ProtocolError {
   static code() {
     return 35;
   }
-
 }
 
 export class InvalidContextError extends ProtocolError {
@@ -893,7 +858,6 @@ export class InvalidContextError extends ProtocolError {
   static code() {
     return 36;
   }
-
 }
 
 // Aliases to UnknownMethodError
@@ -928,7 +892,6 @@ export class UnableToCaptureScreen extends ProtocolError {
   static error() {
     return 'unable to capture screen';
   }
-
 }
 
 // Equivalent to W3C InvalidArgumentError
@@ -949,38 +912,37 @@ export class ProxyRequestError extends BaseError {
   private readonly _w3cErrorStatus?: number;
   private readonly _jwpError?: MJSONWPError;
 
-  constructor(
-    message: string,
-    httpResponseData: any,
-    httpStatus?: number,
-    cause?: Error,
-  ) {
-    const [responseErrorObj, originalMessage] = ProxyRequestError._parseHttpResponse(httpResponseData);
+  constructor(message: string, httpResponseData: any, httpStatus?: number, cause?: Error) {
+    const [responseErrorObj, originalMessage] =
+      ProxyRequestError._parseHttpResponse(httpResponseData);
     super(
-      _.isEmpty(message)
-        ? `Proxy request unsuccessful.${originalMessage ? (' ' + originalMessage) : ''}`
+      util.isEmpty(message)
+        ? `Proxy request unsuccessful.${originalMessage ? ' ' + originalMessage : ''}`
         : message,
       cause,
     );
 
     // If the response error is an object and value is an object, it's a W3C error (for JSONWP value is a string)
-    if (_.isPlainObject(responseErrorObj.value) && _.has(responseErrorObj.value, 'error')) {
-      this._w3cError = responseErrorObj.value;
+    if (
+      util.isPlainObject(responseErrorObj.value) &&
+      Object.hasOwn(responseErrorObj.value, 'error')
+    ) {
+      this._w3cError = responseErrorObj.value as unknown as typeof this._w3cError;
       this._w3cErrorStatus = httpStatus;
-    } else if (_.has(responseErrorObj, 'status')) {
-      this._jwpError = responseErrorObj;
+    } else if (Object.hasOwn(responseErrorObj, 'status')) {
+      this._jwpError = responseErrorObj as typeof this._jwpError;
     }
   }
 
   private static _parseHttpResponse(data: any): [Record<string, any>, string] {
     let responseErrorObj: Record<string, any> = util.safeJsonParse(data);
-    if (!_.isPlainObject(responseErrorObj)) {
+    if (!util.isPlainObject(responseErrorObj)) {
       responseErrorObj = {};
     }
-    let errorMessage: string = _.isString(data) ? data : '';
-    if (_.isString(responseErrorObj.value)) {
+    let errorMessage: string = typeof data === 'string' ? data : '';
+    if (typeof responseErrorObj.value === 'string') {
       errorMessage = responseErrorObj.value;
-    } else if (_.isString(responseErrorObj.value?.message)) {
+    } else if (typeof responseErrorObj.value?.message === 'string') {
       errorMessage = responseErrorObj.value.message;
     }
     return [responseErrorObj, errorMessage];
@@ -991,7 +953,11 @@ export class ProxyRequestError extends BaseError {
       // If it's MJSONWP error, returns actual error cause for request failure based on `jsonwp.status`
       return errorFromMJSONWPStatusCode(this._jwpError.status, this._jwpError.value);
     }
-    if (util.hasValue(this._w3cError) && _.isNumber(this._w3cErrorStatus) && this._w3cErrorStatus >= 300) {
+    if (
+      util.hasValue(this._w3cError) &&
+      typeof this._w3cErrorStatus === 'number' &&
+      this._w3cErrorStatus >= 300
+    ) {
       return errorFromW3CJsonCode(
         this._w3cError.error,
         this._w3cError.message || this.message,
@@ -1004,13 +970,13 @@ export class ProxyRequestError extends BaseError {
 
 function generateBadParametersMessage(
   paramRequirements: ParameterRequirements,
-  paramNames: string[]
+  paramNames: string[],
 ): string {
-  const toArray = function <T> (x: T | T[]): T[] {
-    if (_.isUndefined(x)) {
+  const toArray = function <T>(x: T | T[]): T[] {
+    if (x === undefined) {
       return [];
     }
-    if (_.isArray(x)) {
+    if (Array.isArray(x)) {
       return x;
     }
     return [x];
@@ -1018,26 +984,30 @@ function generateBadParametersMessage(
 
   const requiredParamNames = toArray(paramRequirements.required);
   const actualParamNames = toArray(paramNames);
-  const missingRequiredParamNames = _.difference(requiredParamNames, actualParamNames);
+  const missingRequiredParamNames = requiredParamNames.filter(
+    (name) => !actualParamNames.includes(name),
+  );
   const resultLines: string[] = [];
   resultLines.push(
-    _.isEmpty(missingRequiredParamNames)
+    util.isEmpty(missingRequiredParamNames)
       ? // This should not happen
         'Some of the provided parameters are not known'
       : `The following required parameter${
           missingRequiredParamNames.length === 1 ? ' is' : 's are'
         } missing: ${JSON.stringify(missingRequiredParamNames)}`,
   );
-  if (!_.isEmpty(requiredParamNames)) {
+  if (!util.isEmpty(requiredParamNames)) {
     resultLines.push(`Known required parameters are: ${JSON.stringify(requiredParamNames)}`);
   }
-  const optionalParamNames = _.difference(toArray(paramRequirements.optional), ['sessionId', 'id']);
-  if (!_.isEmpty(optionalParamNames)) {
+  const optionalParamNames = toArray(paramRequirements.optional).filter(
+    (name): name is string => typeof name === 'string' && !['sessionId', 'id'].includes(name),
+  );
+  if (!util.isEmpty(optionalParamNames)) {
     resultLines.push(`Known optional parameters are: ${JSON.stringify(optionalParamNames)}`);
   }
   resultLines.push(
     `You have provided${
-      _.isEmpty(actualParamNames) ? ' none' : ': ' + JSON.stringify(paramNames)
+      util.isEmpty(actualParamNames) ? ' none' : ': ' + JSON.stringify(paramNames)
     }`,
   );
   return resultLines.join('\n');
@@ -1087,22 +1057,25 @@ export const errors = {
   ProxyRequestError,
 } as const;
 
-const jsonwpErrorCodeMap: Record<string, Class<ProtocolError>> = _.values(errors)
-  .reduce((acc: Record<string, Class<ProtocolError>>, ErrorClass: any) => {
+const jsonwpErrorCodeMap: Record<string, Class<ProtocolError>> = Object.values(errors).reduce(
+  (acc: Record<string, Class<ProtocolError>>, ErrorClass: any) => {
     if ('code' in ErrorClass) {
       acc[ErrorClass.code()] = ErrorClass;
     }
     return acc;
-  }, {});
+  },
+  {},
+);
 
-const w3cErrorCodeMap: Record<string, Class<ProtocolError>> = _.values(errors)
-  .reduce((acc: Record<string, Class<ProtocolError>>, ErrorClass: any) => {
+const w3cErrorCodeMap: Record<string, Class<ProtocolError>> = Object.values(errors).reduce(
+  (acc: Record<string, Class<ProtocolError>>, ErrorClass: any) => {
     if ('error' in ErrorClass) {
       acc[ErrorClass.error()] = ErrorClass;
     }
     return acc;
-  }, {});
-
+  },
+  {},
+);
 
 interface MJSONWPError {
   status: number;
@@ -1134,7 +1107,10 @@ export function isErrorType<T>(err: any, type: Class<T>): err is T {
  * @param value The error message, or an object with a `message` property
  * @return The error that is associated with provided JSONWP status code
  */
-export function errorFromMJSONWPStatusCode(code: number, value: string | {message: string} = ''): ProtocolError {
+export function errorFromMJSONWPStatusCode(
+  code: number,
+  value: string | {message: string} = '',
+): ProtocolError {
   const ErrorClass = jsonwpErrorCodeMap[code] ?? UnknownError;
   mjsonwpLog.debug(`Matched JSONWP error code ${code} to ${ErrorClass.name}`);
   // if `value` is an object, pull message from it, otherwise use the plain
@@ -1150,8 +1126,12 @@ export function errorFromMJSONWPStatusCode(code: number, value: string | {messag
  * @param stacktrace an optional error stacktrace
  * @return The error that is associated with the W3C error string
  */
-export function errorFromW3CJsonCode(signature: string, message: string, stacktrace?: string): ProtocolError {
-  const ErrorClass = w3cErrorCodeMap[_.toLower(signature)] ?? UnknownError;
+export function errorFromW3CJsonCode(
+  signature: string,
+  message: string,
+  stacktrace?: string,
+): ProtocolError {
+  const ErrorClass = w3cErrorCodeMap[signature.toLowerCase()] ?? UnknownError;
   w3cLog.debug(`Matched W3C error code '${signature}' to ${ErrorClass.name}`);
   const resultError = new ErrorClass(message);
   resultError.stacktrace = stacktrace;
@@ -1163,26 +1143,27 @@ export function errorFromW3CJsonCode(signature: string, message: string, stacktr
  *
  * @param err The error that needs to be translated
  */
-export function getResponseForW3CError(err: any): [number, { value: W3CError }] {
-  const protocolErrorToResponse: (e: ProtocolError) => [number, { value: W3CError }] =
-  (e: ProtocolError) => [
+export function getResponseForW3CError(err: any): [number, {value: W3CError}] {
+  const protocolErrorToResponse: (e: ProtocolError) => [number, {value: W3CError}] = (
+    e: ProtocolError,
+  ) => [
     e.w3cStatus,
     {
       value: {
         error: e.error,
         message: e.message,
         stacktrace: e.stacktrace || e.stack,
-      }
-    }
+      },
+    },
   ];
 
   // err is ProtocolError
-  if (['error', 'w3cStatus'].every((prop) => _.has(err, prop))) {
+  if (['error', 'w3cStatus'].every((prop) => Object.hasOwn(err, prop))) {
     return protocolErrorToResponse(err);
   }
 
   // err is ProxyRequestError
-  if (_.has(err, 'getActualError') && _.isFunction(err.getActualError)) {
+  if (Object.hasOwn(err, 'getActualError') && typeof err.getActualError === 'function') {
     return protocolErrorToResponse(err.getActualError());
   }
 

package/lib/protocol/helpers.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash';
+import {util} from '@appium/support';
 import {duplicateKeys} from '../basedriver/helpers';
 import {MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY} from '../constants';
 
@@ -11,7 +11,7 @@ import {MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY} from '../constants';
  * @returns Either modified value or the same one if nothing has been modified
  */
 export function formatResponseValue(resValue: object | undefined): object | null {
-  if (_.isUndefined(resValue)) {
+  if (resValue === undefined) {
     // convert undefined to null
     return null;
   }
@@ -30,7 +30,11 @@ export function formatResponseValue(resValue: object | undefined): object | null
  * @returns The fixed response body
  */
 export function ensureW3cResponse(responseBody: Record<string, unknown>): Record<string, unknown> {
-  return _.isPlainObject(responseBody)
-    ? (_.omit(responseBody, ['status', 'sessionId']) as Record<string, unknown>)
-    : responseBody;
+  if (!util.isPlainObject(responseBody)) {
+    return responseBody;
+  }
+  const result = {...responseBody};
+  delete result.status;
+  delete result.sessionId;
+  return result;
 }