ditch lodash

Author: mykola-mokhnach

Scripts/fetch-prebuilt-wda.mjs

@@ -3,7 +3,6 @@ import { fileURLToPath } from 'node:url';
 import { readFileSync } from 'node:fs';
 import axios from 'axios';
 import { logger, fs, mkdirp, net } from '@appium/support';
-import _ from 'lodash';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -53,7 +52,10 @@ async function fetchPrebuiltWebDriverAgentAssets () {
     const url = asset.browser_download_url;
     log.info(`Downloading: ${url}`);
     try {
-      const nameOfAgent = _.last(url.split('/'));
+      const nameOfAgent = url.split('/').at(-1);
+      if (!nameOfAgent) {
+        continue;
+      }
       agentsDownloading.push(downloadAgent(url, path.join(webdriveragentsDir, nameOfAgent)));
     } catch { }
   }

lib/utils.ts

@@ -3,7 +3,6 @@ import {exec, SubProcess} from 'teen_process';
 import path, {dirname} from 'node:path';
 import {fileURLToPath} from 'node:url';
 import {log} from './logger';
-import _ from 'lodash';
 import {PLATFORM_NAME_TVOS} from './constants';
 import _fs from 'node:fs';
 import {waitForCondition} from 'asyncbox';
@@ -18,13 +17,18 @@ const currentFilename =
 
 const currentDirname = dirname(currentFilename);
 
+let moduleRootCache: string | undefined;
+
 /**
  * Calculates the path to the current module's root folder
  *
  * @returns {string} The full path to module root
  * @throws {Error} If the current module root folder cannot be determined
  */
-const getModuleRoot = _.memoize(function getModuleRoot(): string {
+const getModuleRoot = function getModuleRoot(): string {
+  if (moduleRootCache) {
+    return moduleRootCache;
+  }
   let currentDir = currentDirname;
   let isAtFsRoot = false;
   while (!isAtFsRoot) {
@@ -34,14 +38,15 @@ const getModuleRoot = _.memoize(function getModuleRoot(): string {
         _fs.existsSync(manifestPath) &&
         JSON.parse(_fs.readFileSync(manifestPath, 'utf8')).name === 'appium-webdriveragent'
       ) {
+        moduleRootCache = currentDir;
         return currentDir;
       }
     } catch {}
     currentDir = path.dirname(currentDir);
     isAtFsRoot = currentDir.length <= path.dirname(currentDir).length;
   }
   throw new Error('Cannot find the root folder of the appium-webdriveragent Node.js module');
-});
+};
 
 export const BOOTSTRAP_PATH = getModuleRoot();
 
@@ -63,7 +68,7 @@ export async function killAppUsingPattern(pgrepPattern: string): Promise<void> {
   const signals = [2, 15, 9];
   for (const signal of signals) {
     const matchedPids = await getPIDsUsingPattern(pgrepPattern);
-    if (_.isEmpty(matchedPids)) {
+    if (matchedPids.length === 0) {
       return;
     }
     const args = [`-${signal}`, ...matchedPids];
@@ -72,7 +77,7 @@ export async function killAppUsingPattern(pgrepPattern: string): Promise<void> {
     } catch (err: any) {
       log.debug(`kill ${args.join(' ')} -> ${err.message}`);
     }
-    if (signal === _.last(signals)) {
+    if (signal === signals[signals.length - 1]) {
       // there is no need to wait after SIGKILL
       return;
     }
@@ -109,7 +114,7 @@ export async function killAppUsingPattern(pgrepPattern: string): Promise<void> {
  * @returns Return true if the platformName is tvOS
  */
 export function isTvOS(platformName: string): boolean {
-  return _.toLower(platformName) === _.toLower(PLATFORM_NAME_TVOS);
+  return platformName?.toLowerCase() === PLATFORM_NAME_TVOS.toLowerCase();
 }
 
 /**
@@ -148,7 +153,7 @@ export async function setXctestrunFile(args: XctestrunFileArgs): Promise<string>
     wdaRemotePort,
     wdaBindingIP,
   );
-  const newXctestRunContent = _.merge(xctestRunContent, updateWDAPort);
+  const newXctestRunContent = mergeObjects(xctestRunContent, updateWDAPort);
   await plist.updatePlistFile(xctestrunFilePath, newXctestRunContent, true);
 
   return xctestrunFilePath;
@@ -293,6 +298,23 @@ export async function getWDAUpgradeTimestamp(): Promise<number | null> {
   return mtime.getTime();
 }
 
+/**
+ * Escape regular expression metacharacters in a string.
+ */
+export function escapeRegExp(value: string): string {
+  return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+/**
+ * Truncate a string to the given length and append ellipsis if needed.
+ */
+export function truncateString(value: string, length: number): string {
+  if (value.length <= length) {
+    return value;
+  }
+  return `${value.slice(0, Math.max(0, length - 1))}…`;
+}
+
 /**
  * Kills running XCTest processes for the particular device.
  */
@@ -337,7 +359,7 @@ export async function getPIDsListeningOnPort(
     return result;
   }
 
-  if (!_.isFunction(filteringFunc)) {
+  if (typeof filteringFunc !== 'function') {
     return result;
   }
   const filtered = await Promise.all(
@@ -370,7 +392,7 @@ async function getPIDsUsingPattern(pattern: string): Promise<string[]> {
     return stdout
       .split(/\s+/)
       .map((x) => parseInt(x, 10))
-      .filter(_.isInteger)
+      .filter(Number.isInteger)
       .map((x) => `${x}`);
   } catch (err: any) {
     log.debug(
@@ -379,3 +401,30 @@ async function getPIDsUsingPattern(pattern: string): Promise<string[]> {
     return [];
   }
 }
+
+function mergeObjects<T extends Record<string, any>, U extends Record<string, any>>(
+  target: T,
+  source: U,
+): T & U {
+  const output: Record<string, any> = {...target};
+  for (const [key, sourceValue] of Object.entries(source)) {
+    const targetValue = output[key];
+    if (
+      isPlainObject(targetValue) &&
+      isPlainObject(sourceValue)
+    ) {
+      output[key] = mergeObjects(targetValue, sourceValue);
+      continue;
+    }
+    output[key] = sourceValue;
+  }
+  return output as T & U;
+}
+
+function isPlainObject(value: unknown): value is Record<string, any> {
+  if (value == null || typeof value !== 'object' || Array.isArray(value)) {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  return prototype === Object.prototype || prototype === null;
+}

lib/webdriveragent.ts

@@ -1,5 +1,4 @@
 import {waitForCondition} from 'asyncbox';
-import _ from 'lodash';
 import path from 'node:path';
 import {JWProxy} from '@appium/base-driver';
 import {fs, util, plist} from '@appium/support';
@@ -75,7 +74,7 @@ export class WebDriverAgent {
    * @param log - Optional logger instance
    */
   constructor(args: WebDriverAgentArgs, log: AppiumLogger | null = null) {
-    this.args = _.clone(args);
+    this.args = {...args};
     this.log = log ?? defaultLogger;
 
     this.device = args.device;
@@ -252,7 +251,7 @@ export class WebDriverAgent {
         !cmdLine.toLowerCase().includes(this.device.udid.toLowerCase()),
     );
 
-    if (_.isEmpty(obsoletePids)) {
+    if (obsoletePids.length === 0) {
       this.log.debug(
         `No obsolete cached processes from previous WDA sessions ` +
           `listening on port ${this.url.port} have been found`,
@@ -455,7 +454,7 @@ export class WebDriverAgent {
     if (
       actualUpgradeTimestamp &&
       upgradedAt &&
-      _.toLower(`${actualUpgradeTimestamp}`) !== _.toLower(`${upgradedAt}`)
+      `${actualUpgradeTimestamp}`.toLowerCase() !== `${upgradedAt}`.toLowerCase()
     ) {
       this.log.info(
         'Will uninstall running WDA since it has different version in comparison to the one ' +
@@ -499,7 +498,7 @@ export class WebDriverAgent {
     const wdaBundlePaths = await fs.glob(`${this.derivedDataPath}/**/*${WDA_RUNNER_APP}/`, {
       absolute: true,
     });
-    if (_.isEmpty(wdaBundlePaths)) {
+    if (wdaBundlePaths.length === 0) {
       throw new Error(`Could not find the WDA bundle in '${this.derivedDataPath}'`);
     }
     return wdaBundlePaths[0];
@@ -588,7 +587,7 @@ export class WebDriverAgent {
     const sendGetStatus = async () =>
       (await noSessionProxy.command('/status', 'GET')) as StringRecord;
 
-    if (_.isNil(timeoutMs) || timeoutMs <= 0) {
+    if (timeoutMs == null || timeoutMs <= 0) {
       try {
         return await sendGetStatus();
       } catch (err: any) {
@@ -635,7 +634,7 @@ export class WebDriverAgent {
   private async uninstall(): Promise<void> {
     try {
       const bundleIds = await this.device.getUserInstalledBundleIdsByBundleName(WDA_CF_BUNDLE_NAME);
-      if (_.isEmpty(bundleIds)) {
+      if (bundleIds.length === 0) {
         this.log.debug('No WDAs on the device.');
         return;
       }

lib/xcodebuild.ts

@@ -9,8 +9,9 @@ import {
   killProcess,
   getWDAUpgradeTimestamp,
   isTvOS,
+  escapeRegExp,
+  truncateString,
 } from './utils';
-import _ from 'lodash';
 import path from 'node:path';
 import {WDA_RUNNER_BUNDLE_ID} from './constants';
 import type {AppleDevice, XcodeBuildArgs} from './types';
@@ -29,7 +30,7 @@ const IGNORED_ERRORS = [
   'Failed to remove screenshot at path',
 ];
 const IGNORED_ERRORS_PATTERN = new RegExp(
-  '(' + IGNORED_ERRORS.map((errStr) => _.escapeRegExp(errStr)).join('|') + ')',
+  '(' + IGNORED_ERRORS.map((errStr) => escapeRegExp(errStr)).join('|') + ')',
 );
 
 const RUNNER_SCHEME_TV = 'WebDriverAgentRunner_tvOS';
@@ -118,7 +119,7 @@ export class XcodeBuild {
 
     this.mjpegServerPort = args.mjpegServerPort;
 
-    this.prebuildDelay = _.isNumber(args.prebuildDelay) ? args.prebuildDelay : PREBUILD_DELAY;
+    this.prebuildDelay = typeof args.prebuildDelay === 'number' ? args.prebuildDelay : PREBUILD_DELAY;
 
     this.allowProvisioningDeviceRegistration = args.allowProvisioningDeviceRegistration;
 
@@ -182,7 +183,7 @@ export class XcodeBuild {
       const pattern = /^\s*BUILD_DIR\s+=\s+(\/.*)/m;
       const match = pattern.exec(stdout);
       if (!match) {
-        this.log.warn(`Cannot parse WDA build dir from ${_.truncate(stdout, {length: 300})}`);
+        this.log.warn(`Cannot parse WDA build dir from ${truncateString(stdout, 300)}`);
         return;
       }
       this.log.debug(`Parsed BUILD_DIR configuration value: '${match[1]}'`);
@@ -414,7 +415,7 @@ export class XcodeBuild {
     });
 
     let logXcodeOutput = !!this.showXcodeLog;
-    const logMsg = _.isBoolean(this.showXcodeLog)
+    const logMsg = typeof this.showXcodeLog === 'boolean'
       ? `Output from xcodebuild ${this.showXcodeLog ? 'will' : 'will not'} be logged`
       : 'Output from xcodebuild will only be logged if any errors are present there';
     this.log.debug(`${logMsg}. To change this, use 'showXcodeLog' desired capability`);

package.json

@@ -54,7 +54,6 @@
     "@appium/types": "^1.0.0-rc.1",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@types/lodash": "^4.14.196",
     "@types/mocha": "^10.0.1",
     "@types/node": "^25.0.0",
     "appium-xcode": "^6.0.0",
@@ -79,7 +78,6 @@
     "async-lock": "^1.0.0",
     "asyncbox": "^6.1.0",
     "axios": "^1.4.0",
-    "lodash": "^4.17.11",
     "teen_process": "^4.0.7"
   },
   "files": [

test/functional/helpers/simulator.ts

@@ -1,4 +1,3 @@
-import _ from 'lodash';
 import {Simctl} from 'node-simctl';
 import {retryInterval} from 'asyncbox';
 import {killAllSimulators as simKill} from 'appium-ios-simulator';
@@ -7,7 +6,7 @@ import type {AppleDevice} from '../../../lib/types';
 
 export async function killAllSimulators(): Promise<void> {
   const simctl = new Simctl();
-  const allDevices = _.flatMap(_.values(await simctl.getDevices()));
+  const allDevices = Object.values(await simctl.getDevices()).flat();
   const bootedDevices = allDevices.filter((device) => device.state === 'Booted');
 
   for (const {udid} of bootedDevices) {