@appium/support 7.1.0 → 7.2.0

package/lib/mjpeg.ts

@@ -1,4 +1,3 @@
-import _ from 'lodash';
 import log from './logger';
 import B from 'bluebird';
 import {requireSharp} from './image-util';
@@ -18,10 +17,11 @@ async function initMJpegConsumer(): Promise<MJpegConsumerConstructor> {
   if (!MJpegConsumer) {
     try {
       MJpegConsumer = (await requirePackage('mjpeg-consumer')) as MJpegConsumerConstructor;
-    } catch {
+    } catch (e) {
       throw new Error(
         'mjpeg-consumer module is required to use MJPEG-over-HTTP features. ' +
-          'Please install it first (npm i -g mjpeg-consumer) and restart Appium.'
+          'Please install it first (npm i -g mjpeg-consumer) and restart Appium.',
+        {cause: e}
       );
     }
   }
@@ -29,6 +29,7 @@ async function initMJpegConsumer(): Promise<MJpegConsumerConstructor> {
 }
 
 const MJPEG_SERVER_TIMEOUT_MS = 10000;
+const noop = () => {};
 
 /** Class which stores the last bit of data streamed into it */
 export class MJpegStream extends Writable {
@@ -50,7 +51,7 @@ export class MJpegStream extends Writable {
    */
   constructor(
     mJpegUrl: string,
-    errorHandler: (err: Error) => void = _.noop,
+    errorHandler: (err: Error) => void = noop,
     options: WritableOptions = {}
   ) {
     super(options);
@@ -61,7 +62,7 @@ export class MJpegStream extends Writable {
 
   get lastChunkBase64(): string | null {
     const lastChunk = this.lastChunk;
-    if (lastChunk && !_.isEmpty(lastChunk) && _.isBuffer(lastChunk)) {
+    if (lastChunk && lastChunk.length > 0 && Buffer.isBuffer(lastChunk)) {
       return lastChunk.toString('base64');
     }
     return null;
@@ -69,7 +70,7 @@ export class MJpegStream extends Writable {
 
   async lastChunkPNG(): Promise<Buffer | null> {
     const chunk = this.lastChunk;
-    if (!chunk || _.isEmpty(chunk) || !_.isBuffer(chunk)) {
+    if (!chunk || chunk.length === 0 || !Buffer.isBuffer(chunk)) {
       return null;
     }
     try {
@@ -118,7 +119,8 @@ export class MJpegStream extends Writable {
         message = String(e);
       }
       throw new Error(
-        `Cannot connect to the MJPEG stream at ${url}. Original error: ${message}`
+        `Cannot connect to the MJPEG stream at ${url}. Original error: ${message}`,
+        {cause: e}
       );
     }
 

package/lib/net.ts

@@ -1,6 +1,5 @@
-import _ from 'lodash';
 import {fs} from './fs';
-import {toReadableSizeString} from './util';
+import {isPlainObject, toReadableSizeString} from './util';
 import log from './logger';
 import Ftp from 'jsftp';
 import {Timer} from './timing';
@@ -63,6 +62,8 @@ export interface FtpUploadOptions extends NetOptions {}
 /** @deprecated Use {@linkcode FtpUploadOptions} instead. */
 export type NotHttpUploadOptions = FtpUploadOptions;
 
+type AuthLike = AuthCredentials | AxiosBasicCredentials;
+
 /**
  * Uploads the given file to a remote location. HTTP(S) and FTP protocols are supported.
  */
@@ -85,7 +86,7 @@ export async function uploadFile(
   if (isHttpUploadOptions(uploadOptions, url)) {
     if (!uploadOptions.fileFieldName) {
       uploadOptions.headers = {
-        ...(_.isPlainObject(uploadOptions.headers) ? uploadOptions.headers : {}),
+        ...(isPlainObject(uploadOptions.headers) ? uploadOptions.headers : {}),
         'Content-Length': size,
       };
     }
@@ -107,6 +108,8 @@ export async function uploadFile(
   }
 }
 
+// #region Private helpers
+
 /**
  * Downloads the given file via HTTP(S).
  *
@@ -128,7 +131,7 @@ export async function downloadFile(
   if (axiosAuth) {
     requestOpts.auth = axiosAuth;
   }
-  if (_.isPlainObject(headers)) {
+  if (isPlainObject(headers)) {
     requestOpts.headers = headers as RawAxiosRequestConfig['headers'];
   }
 
@@ -150,7 +153,7 @@ export async function downloadFile(
     });
   } catch (err) {
     const message = err instanceof Error ? err.message : String(err);
-    throw new Error(`Cannot download the file from ${remoteUrl}: ${message}`);
+    throw new Error(`Cannot download the file from ${remoteUrl}: ${message}`, {cause: err});
   }
 
   const {size} = await fs.stat(dstPath);
@@ -174,18 +177,17 @@ export async function downloadFile(
   }
 }
 
-// #region Private helpers
-
-type AuthLike = AuthCredentials | AxiosBasicCredentials;
-
 function toAxiosAuth(auth: AuthLike | undefined): AxiosBasicCredentials | null {
-  if (!auth || !_.isPlainObject(auth)) {
+  if (!auth || !isPlainObject(auth)) {
     return null;
   }
 
   const username = 'username' in auth ? auth.username : auth.user;
   const password = 'password' in auth ? auth.password : auth.pass;
-  return username && password ? {username, password} : null;
+  if (typeof username !== 'string' || typeof password !== 'string' || !username || !password) {
+    return null;
+  }
+  return {username, password};
 }
 
 async function uploadFileToHttp(
@@ -218,13 +220,13 @@ async function uploadFileToHttp(
     const form = new FormData();
     if (formFields) {
       let pairs: [string, unknown][] = [];
-      if (_.isArray(formFields)) {
+      if (Array.isArray(formFields)) {
         pairs = formFields as [string, unknown][];
-      } else if (_.isPlainObject(formFields)) {
-        pairs = _.toPairs(formFields);
+      } else if (isPlainObject(formFields)) {
+        pairs = Object.entries(formFields);
       }
       for (const [key, value] of pairs) {
-        if (_.toLower(key) !== _.toLower(fileFieldName)) {
+        if (key.toLowerCase() !== fileFieldName?.toLowerCase()) {
           form.append(key, value as string | Buffer);
         }
       }
@@ -232,19 +234,23 @@ async function uploadFileToHttp(
     // AWS S3 POST upload requires this to be the last field; do not move before formFields.
     form.append(fileFieldName, localFileStream);
     requestOpts.headers = {
-      ...(_.isPlainObject(headers) ? headers : {}),
+      ...(isPlainObject(headers) ? headers : {}),
       ...form.getHeaders(),
     };
     requestOpts.data = form;
   } else {
-    if (_.isPlainObject(headers)) {
+    if (isPlainObject(headers)) {
       requestOpts.headers = headers;
     }
     requestOpts.data = localFileStream;
   }
   log.debug(
     `Performing ${method} to ${href} with options (excluding data): ` +
-      JSON.stringify(_.omit(requestOpts, ['data']))
+      JSON.stringify((() => {
+        const requestOptsWithoutData = {...requestOpts} as Record<string, unknown>;
+        delete requestOptsWithoutData.data;
+        return requestOptsWithoutData;
+      })())
   );
 
   const {status, statusText} = await axios(requestOpts);
@@ -261,7 +267,7 @@ async function uploadFileToFtp(
 
   const ftpOpts: {host: string; port: number; user?: string; pass?: string} = {
     host: hostname ?? '',
-    port: port !== undefined && port !== '' ? _.parseInt(port, 10) : 21,
+    port: port !== undefined && port !== '' ? Number.parseInt(port, 10) : 21,
   };
   if (auth?.user && auth?.pass) {
     ftpOpts.user = auth.user;

package/lib/node.ts

@@ -1,6 +1,5 @@
 import {isWindows} from './system';
 import log from './logger';
-import _ from 'lodash';
 import {exec} from 'teen_process';
 import path from 'node:path';
 import _fs from 'node:fs';
@@ -156,7 +155,7 @@ async function linkGlobalPackage(packageName: string): Promise<void> {
     if (e.stderr) {
       log.debug(e.stderr);
     }
-    throw new Error(msg);
+    throw new Error(msg, {cause: err});
   }
 }
 
@@ -165,14 +164,14 @@ function extractAllProperties(obj: object): (string | symbol)[] {
   for (const prop in obj) {
     stringProperties.push(prop);
   }
-  if (_.isFunction(Object.getOwnPropertySymbols)) {
+  if (typeof Object.getOwnPropertySymbols === 'function') {
     stringProperties.push(...Object.getOwnPropertySymbols(obj));
   }
   return stringProperties;
 }
 
 function _getSizeOfObject(seen: WeakSet<object>, object: object): number {
-  if (_.isNil(object)) {
+  if (object == null) {
     return 0;
   }
 
@@ -181,7 +180,7 @@ function _getSizeOfObject(seen: WeakSet<object>, object: object): number {
   const calc = getCalculator(seen);
   for (const key of properties) {
     const val = (object as Record<string | symbol, unknown>)[key];
-    if (typeof val === 'object' && !_.isNil(val)) {
+    if (typeof val === 'object' && val != null) {
       if (seen.has(val as object)) {
         continue;
       }
@@ -203,7 +202,7 @@ function _getSizeOfObject(seen: WeakSet<object>, object: object): number {
 
 function getCalculator(seen: WeakSet<object>): SizeCalculator {
   return function calculator(obj: unknown): number {
-    if (_.isBuffer(obj)) {
+    if (Buffer.isBuffer(obj)) {
       return (obj as Buffer).length;
     }
 
@@ -215,11 +214,11 @@ function getCalculator(seen: WeakSet<object>): SizeCalculator {
       case 'number':
         return ECMA_SIZES.NUMBER;
       case 'symbol':
-        return _.isFunction(Symbol.keyFor) && Symbol.keyFor(obj)
+        return typeof Symbol.keyFor === 'function' && Symbol.keyFor(obj)
           ? (Symbol.keyFor(obj) as string).length * ECMA_SIZES.STRING
           : (obj.toString().length - 8) * ECMA_SIZES.STRING;
       case 'object':
-        return _.isArray(obj)
+        return Array.isArray(obj)
           ? obj.map(getCalculator(seen)).reduce((acc, curr) => acc + curr, 0)
           : _getSizeOfObject(seen, obj as object);
       default:

package/lib/npm.ts

@@ -104,7 +104,8 @@ export class NPM {
     } catch (e) {
       const {stdout = '', stderr = '', code = null} = e as ExecError;
       throw new Error(
-        `npm command '${argsCopy.join(' ')}' failed with code ${code}.\n\nSTDOUT:\n${stdout.trim()}\n\nSTDERR:\n${stderr.trim()}`
+        `npm command '${argsCopy.join(' ')}' failed with code ${code}.\n\nSTDOUT:\n${stdout.trim()}\n\nSTDERR:\n${stderr.trim()}`,
+        {cause: e}
       );
     }
     return ret;
@@ -245,11 +246,12 @@ export class NPM {
       const pkgJson = await fs.readFile(pkgJsonPath, 'utf8');
       const pkg = JSON.parse(pkgJson) as PackageJson;
       return {installPath: path.dirname(pkgJsonPath), pkg};
-    } catch {
+    } catch (e) {
       throw new Error(
         'The package was not downloaded correctly; its package.json ' +
           'did not exist or was unreadable. We looked for it at ' +
-          pkgJsonPath
+          pkgJsonPath,
+        {cause: e}
       );
     }
   }

package/lib/plist.ts

@@ -1,9 +1,9 @@
-import xmlplist from 'plist';
+import {build as plistBuild, parse as plistParse} from 'plist';
 import bplistCreate from 'bplist-creator';
 import {parseFile, parseBuffer} from 'bplist-parser';
 import {fs} from './fs';
 import log from './logger';
-import _ from 'lodash';
+import {truncateString} from './util';
 
 const BPLIST_IDENTIFIER = {
   BUFFER: Buffer.from('bplist00'),
@@ -37,7 +37,7 @@ export async function parsePlistFile(
     return {};
   }
 
-  let obj: object = {};
+  let obj: object;
   let type = 'binary';
   try {
     const parsed = await parseFile(plist);
@@ -85,8 +85,8 @@ export async function updatePlistFile(
   } catch (err) {
     throw log.errorWithException(`Could not update plist: ${(err as Error).message}`);
   }
-  _.extend(obj, updatedFields);
-  const newPlist = binary ? bplistCreate(obj) : xmlplist.build(obj);
+  Object.assign(obj as Record<string, unknown>, updatedFields);
+  const newPlist = binary ? bplistCreate(obj) : plistBuild(obj);
   try {
     await fs.writeFile(plist, newPlist);
   } catch (err) {
@@ -128,7 +128,7 @@ export function createPlist(object: object, binary = false): Buffer | string {
   if (binary) {
     return createBinaryPlist(object);
   }
-  return xmlplist.build(object);
+  return plistBuild(object);
 }
 
 /**
@@ -141,7 +141,7 @@ export function createPlist(object: object, binary = false): Buffer | string {
 export function parsePlist(data: string | Buffer): object {
   const textPlist = getXmlPlist(data);
   if (textPlist) {
-    return xmlplist.parse(textPlist);
+    return plistParse(textPlist);
   }
 
   const binaryPlist = getBinaryPlist(data);
@@ -150,17 +150,17 @@ export function parsePlist(data: string | Buffer): object {
   }
 
   throw new Error(
-    `Unknown type of plist, data: ${_.truncate(data.toString(), {length: 200})}`
+    `Unknown type of plist, data: ${truncateString(data.toString(), {length: 200})}`
   );
 }
 
 async function parseXmlPlistFile(plistFilename: string): Promise<object> {
   const xmlContent = await fs.readFile(plistFilename, 'utf8');
-  return xmlplist.parse(xmlContent);
+  return plistParse(xmlContent);
 }
 
 function getXmlPlist(data: string | Buffer): string | null {
-  if (_.isString(data) && data.startsWith(PLIST_IDENTIFIER.TEXT)) {
+  if (typeof data === 'string' && data.startsWith(PLIST_IDENTIFIER.TEXT)) {
     return data;
   }
   if (
@@ -173,7 +173,7 @@ function getXmlPlist(data: string | Buffer): string | null {
 }
 
 function getBinaryPlist(data: string | Buffer): Buffer | null {
-  if (_.isString(data) && data.startsWith(BPLIST_IDENTIFIER.TEXT)) {
+  if (typeof data === 'string' && data.startsWith(BPLIST_IDENTIFIER.TEXT)) {
     return Buffer.from(data);
   }
 

package/lib/process.ts

@@ -28,7 +28,10 @@ export async function getProcessIds(appName: string): Promise<number[]> {
   } catch (err) {
     const code = (err as ExecError).code;
     if (code !== 1) {
-      throw new Error(`Error getting process ids for app '${appName}': ${(err as Error).message}`);
+      throw new Error(
+        `Error getting process ids for app '${appName}': ${(err as Error).message}`,
+        {cause: err}
+      );
     }
     pids = [];
   }
@@ -56,7 +59,10 @@ export async function killProcess(appName: string, force = false): Promise<void>
   } catch (err) {
     const code = (err as ExecError).code;
     if (code !== 1) {
-      throw new Error(`Error killing app '${appName}' with pkill: ${(err as Error).message}`);
+      throw new Error(
+        `Error killing app '${appName}' with pkill: ${(err as Error).message}`,
+        {cause: err}
+      );
     }
   }
 }

package/lib/system.ts

@@ -1,5 +1,4 @@
 import {exec} from 'teen_process';
-import _ from 'lodash';
 import os from 'node:os';
 
 const VERSION_PATTERN = /^(\d+\.\d+)/m;
@@ -29,7 +28,7 @@ export function isLinux(): boolean {
  * Whether the current Windows process is 64-bit (or WOW64).
  */
 export function isOSWin64(): boolean {
-  return process.arch === 'x64' || _.has(process.env, 'PROCESSOR_ARCHITEW6432');
+  return process.arch === 'x64' || Object.hasOwn(process.env, 'PROCESSOR_ARCHITEW6432');
 }
 
 /**
@@ -43,7 +42,7 @@ export async function macOsxVersion(): Promise<string> {
   try {
     stdout = (await exec('sw_vers', ['-productVersion'])).stdout.trim();
   } catch (err) {
-    throw new Error(`Could not detect Mac OS X Version: ${err}`);
+    throw new Error(`Could not detect Mac OS X Version: ${err}`, {cause: err});
   }
 
   const versionMatch = VERSION_PATTERN.exec(stdout);

package/lib/tempdir.ts

@@ -2,9 +2,9 @@
 import {fs} from './fs';
 import os from 'node:os';
 import nodePath from 'node:path';
-import _ from 'lodash';
 import {constants} from 'node:fs';
 import log from './logger';
+import {memoize} from './util';
 
 const RDWR_EXCL = constants.O_CREAT | constants.O_TRUNC | constants.O_RDWR | constants.O_EXCL;
 
@@ -61,7 +61,7 @@ export const openDir = tempDir;
  *
  * @returns The same temp directory path on every call.
  */
-export const staticDir = _.memoize(async function staticDir (): Promise<string> {
+export const staticDir = memoize(async function staticDir (): Promise<string> {
   return tempDir();
 });
 

package/lib/timing.ts

@@ -1,5 +1,3 @@
-import _ from 'lodash';
-
 const NS_PER_S = 1e9;
 const NS_PER_MS = 1e6;
 
@@ -65,7 +63,7 @@ export class Timer {
    * @return {Timer} The current instance, for chaining
    */
   start(): this {
-    if (!_.isNull(this._startTime)) {
+    if (this._startTime !== null) {
       throw new Error('Timer has already been started.');
     }
     this._startTime = process.hrtime.bigint();
@@ -78,12 +76,12 @@ export class Timer {
    * @return {Duration} the duration
    */
   getDuration(): Duration {
-    if (_.isNull(this._startTime)) {
+    if (this._startTime === null) {
       throw new Error('Unable to get duration. Timer was not started');
     }
 
     let nanoDuration: number;
-    if (_.isArray(this._startTime)) {
+    if (Array.isArray(this._startTime)) {
       // startTime was created using process.hrtime()
       const [seconds, nanos] = process.hrtime(this._startTime as [number, number]);
       nanoDuration = seconds * NS_PER_S + nanos;