appium-ios-simulator 8.0.13 → 8.1.0

package/lib/defaults-utils.ts

@@ -1,8 +1,64 @@
-import _ from 'lodash';
 import {DOMParser, XMLSerializer, type Document, type Element} from '@xmldom/xmldom';
 import {exec} from 'teen_process';
-import B from 'bluebird';
 import {log} from './logger';
+import {isPlainObject} from './utils';
+
+export class NSUserDefaults {
+  plist: string;
+
+  constructor(plist: string) {
+    this.plist = plist;
+  }
+
+  /**
+   * Reads the content of the given plist file using plutil command line tool
+   * and serializes it to a JSON representation
+   *
+   * @returns The serialized plist content
+   * @throws {Error} If there was an error during serialization
+   */
+  async asJson(): Promise<Record<string, any>> {
+    try {
+      const {stdout} = await exec('plutil', ['-convert', 'json', '-o', '-', this.plist]);
+      return JSON.parse(stdout);
+    } catch (e: any) {
+      throw new Error(
+        `'${this.plist}' cannot be converted to JSON. Original error: ${e.stderr || e.message}`,
+      );
+    }
+  }
+
+  /**
+   * Updates the content of the given plist file.
+   * If the plist does not exist yet then it is going to be created.
+   *
+   * @param valuesMap Mapping of preference values to update.
+   * If any of item values are of dictionary type then only the first level dictionary gets
+   * updated. Everything below this level will be replaced. This is the known limitation
+   * of the `defaults` command line tool. A workaround for it would be to read the current
+   * preferences mapping first and merge it with this value.
+   * @throws {Error} If there was an error while updating the plist
+   */
+  async update(valuesMap: Record<string, any>): Promise<void> {
+    if (!isPlainObject(valuesMap)) {
+      throw new TypeError(`plist values must be a map. '${valuesMap}' is given instead`);
+    }
+    if (Object.keys(valuesMap).length === 0) {
+      return;
+    }
+
+    const commandArgs = generateDefaultsCommandArgs(valuesMap);
+    try {
+      await Promise.all(
+        commandArgs.map((args) => exec('defaults', ['write', this.plist, ...args])),
+      );
+    } catch (e: any) {
+      throw new Error(
+        `Could not write defaults into '${this.plist}'. Original error: ${e.stderr || e.message}`,
+      );
+    }
+  }
+}
 
 /**
  * Serializes the given value to plist-compatible
@@ -19,10 +75,10 @@ import {log} from './logger';
 export function toXmlArg(value: any, serialize: boolean = true): string | Element {
   let xmlDoc: Document | null = null;
 
-  if (_.isPlainObject(value)) {
+  if (isPlainObject(value)) {
     xmlDoc = new DOMParser().parseFromString('<dict></dict>', 'text/xml');
     const documentElement = requireDocumentElement(xmlDoc);
-    for (const [subKey, subValue] of _.toPairs(value)) {
+    for (const [subKey, subValue] of Object.entries(value)) {
       const keyEl = xmlDoc.createElement('key');
       const keyTextEl = xmlDoc.createTextNode(subKey);
       keyEl.appendChild(keyTextEl);
@@ -30,20 +86,20 @@ export function toXmlArg(value: any, serialize: boolean = true): string | Elemen
       const subValueEl = xmlDoc.importNode(toXmlArg(subValue, false) as Element, true);
       documentElement.appendChild(subValueEl);
     }
-  } else if (_.isArray(value)) {
+  } else if (Array.isArray(value)) {
     xmlDoc = new DOMParser().parseFromString('<array></array>', 'text/xml');
     const documentElement = requireDocumentElement(xmlDoc);
     for (const subValue of value) {
       const subValueEl = xmlDoc.importNode(toXmlArg(subValue, false) as Element, true);
       documentElement.appendChild(subValueEl);
     }
-  } else if (_.isBoolean(value)) {
+  } else if (typeof value === 'boolean') {
     xmlDoc = new DOMParser().parseFromString(value ? '<true/>' : '<false/>', 'text/xml');
-  } else if (_.isInteger(value)) {
+  } else if (Number.isInteger(value)) {
     xmlDoc = new DOMParser().parseFromString(`<integer>${value}</integer>`, 'text/xml');
-  } else if (_.isNumber(value)) {
+  } else if (typeof value === 'number') {
     xmlDoc = new DOMParser().parseFromString(`<real>${value}</real>`, 'text/xml');
-  } else if (_.isString(value)) {
+  } else if (typeof value === 'string') {
     xmlDoc = new DOMParser().parseFromString(`<string></string>`, 'text/xml');
     const valueTextEl = xmlDoc.createTextNode(value);
     requireDocumentElement(xmlDoc).appendChild(valueTextEl);
@@ -78,15 +134,15 @@ export function generateDefaultsCommandArgs(
   replace: boolean = false,
 ): string[][] {
   const resultArgs: string[][] = [];
-  for (const [key, value] of _.toPairs(valuesMap)) {
+  for (const [key, value] of Object.entries(valuesMap)) {
     try {
-      if (!replace && _.isPlainObject(value)) {
+      if (!replace && isPlainObject(value)) {
         const dictArgs = [key, '-dict-add'];
-        for (const [subKey, subValue] of _.toPairs(value)) {
+        for (const [subKey, subValue] of Object.entries(value)) {
           dictArgs.push(subKey, toXmlArg(subValue) as string);
         }
         resultArgs.push(dictArgs);
-      } else if (!replace && _.isArray(value)) {
+      } else if (!replace && Array.isArray(value)) {
         const arrayArgs = [key, '-array-add'];
         for (const subValue of value) {
           arrayArgs.push(toXmlArg(subValue) as string);
@@ -106,61 +162,6 @@ export function generateDefaultsCommandArgs(
   return resultArgs;
 }
 
-export class NSUserDefaults {
-  plist: string;
-
-  constructor(plist: string) {
-    this.plist = plist;
-  }
-
-  /**
-   * Reads the content of the given plist file using plutil command line tool
-   * and serializes it to a JSON representation
-   *
-   * @returns The serialized plist content
-   * @throws {Error} If there was an error during serialization
-   */
-  async asJson(): Promise<Record<string, any>> {
-    try {
-      const {stdout} = await exec('plutil', ['-convert', 'json', '-o', '-', this.plist]);
-      return JSON.parse(stdout);
-    } catch (e: any) {
-      throw new Error(
-        `'${this.plist}' cannot be converted to JSON. Original error: ${e.stderr || e.message}`,
-      );
-    }
-  }
-
-  /**
-   * Updates the content of the given plist file.
-   * If the plist does not exist yet then it is going to be created.
-   *
-   * @param valuesMap Mapping of preference values to update.
-   * If any of item values are of dictionary type then only the first level dictionary gets
-   * updated. Everything below this level will be replaced. This is the known limitation
-   * of the `defaults` command line tool. A workaround for it would be to read the current
-   * preferences mapping first and merge it with this value.
-   * @throws {Error} If there was an error while updating the plist
-   */
-  async update(valuesMap: Record<string, any>): Promise<void> {
-    if (!_.isPlainObject(valuesMap)) {
-      throw new TypeError(`plist values must be a map. '${valuesMap}' is given instead`);
-    }
-    if (_.isEmpty(valuesMap)) {
-      return;
-    }
-
-    const commandArgs = generateDefaultsCommandArgs(valuesMap);
-    try {
-      await B.all(commandArgs.map((args) => exec('defaults', ['write', this.plist, ...args])));
-    } catch (e: any) {
-      throw new Error(
-        `Could not write defaults into '${this.plist}'. Original error: ${e.stderr || e.message}`,
-      );
-    }
-  }
-}
-
 function requireDocumentElement(xmlDoc: Document): Element {
   const {documentElement} = xmlDoc;
   if (!documentElement) {

package/lib/extensions/applications.ts

@@ -1,8 +1,7 @@
-import _ from 'lodash';
 import path from 'node:path';
 import {fs, plist, util} from '@appium/support';
-import B from 'bluebird';
 import {waitForCondition} from 'asyncbox';
+import {isPlainObject} from '../utils';
 import type {CoreSimulator, InteractsWithApps, LaunchAppOptions} from '../types';
 
 type CoreSimulatorWithApps = CoreSimulator & InteractsWithApps;
@@ -32,7 +31,7 @@ export async function getUserInstalledBundleIdsByBundleName(
     cwd: appsRoot,
     absolute: true,
   });
-  if (_.isEmpty(infoPlists)) {
+  if (infoPlists.length === 0) {
     return [];
   }
 
@@ -48,11 +47,11 @@ export async function getUserInstalledBundleIdsByBundleName(
       })(),
     );
   }
-  const bundleInfos = (await B.all(bundleInfoPromises)).filter(_.isPlainObject);
+  const bundleInfos = (await Promise.all(bundleInfoPromises)).filter(isPlainObject);
   const bundleIds = bundleInfos
     .filter(({CFBundleName}) => CFBundleName === bundleName)
     .map(({CFBundleIdentifier}) => CFBundleIdentifier);
-  if (_.isEmpty(bundleIds)) {
+  if (bundleIds.length === 0) {
     return [];
   }
 
@@ -166,12 +165,12 @@ export async function scrubApp(this: CoreSimulatorWithApps, bundleId: string): P
   this.log.info(
     `Found ${appFiles.length} ${bundleId} app ${util.pluralize('file', appFiles.length, false)} to scrub`,
   );
-  if (_.isEmpty(appFiles)) {
+  if (appFiles.length === 0) {
     return;
   }
 
   try {
     await this.terminateApp(bundleId);
   } catch {}
-  await B.all(appFiles.map((p) => fs.rimraf(p)));
+  await Promise.all(appFiles.map((p) => fs.rimraf(p)));
 }

package/lib/extensions/biometric.ts

@@ -1,5 +1,5 @@
-import _ from 'lodash';
 import type {CoreSimulator, SupportsBiometric} from '../types';
+import {escapeRegExp} from '../utils';
 
 type CoreSimulatorWithBiometric = CoreSimulator & SupportsBiometric;
 
@@ -18,7 +18,7 @@ export async function isBiometricEnrolled(this: CoreSimulatorWithBiometric): Pro
     '-g',
     ENROLLMENT_NOTIFICATION_RECEIVER,
   ]);
-  const match = new RegExp(`${_.escapeRegExp(ENROLLMENT_NOTIFICATION_RECEIVER)}\\s+([01])`).exec(
+  const match = new RegExp(`${escapeRegExp(ENROLLMENT_NOTIFICATION_RECEIVER)}\\s+([01])`).exec(
     stdout,
   );
   if (!match) {
@@ -80,7 +80,7 @@ export async function sendBiometricMatch(
 export function toBiometricDomainComponent(name: string): string {
   if (!BIOMETRICS[name]) {
     throw new Error(
-      `'${name}' is not a valid biometric. Use one of: ${JSON.stringify(_.keys(BIOMETRICS))}`,
+      `'${name}' is not a valid biometric. Use one of: ${JSON.stringify(Object.keys(BIOMETRICS))}`,
     );
   }
   return BIOMETRICS[name];

package/lib/extensions/keychain.ts

@@ -1,4 +1,3 @@
-import _ from 'lodash';
 import path from 'node:path';
 import {fs, mkdirp, tempDir, util} from '@appium/support';
 import {exec} from 'teen_process';
@@ -16,13 +15,16 @@ type CoreSimulatorWithKeychain = CoreSimulator & InteractsWithKeychain;
  */
 export async function backupKeychains(this: CoreSimulatorWithKeychain): Promise<boolean> {
   const resetBackupPath = async (newPath: string | null | undefined) => {
-    if (_.isString(this._keychainsBackupPath) && (await fs.exists(this._keychainsBackupPath))) {
+    if (
+      typeof this._keychainsBackupPath === 'string' &&
+      (await fs.exists(this._keychainsBackupPath))
+    ) {
       await fs.unlink(this._keychainsBackupPath);
     }
     this._keychainsBackupPath = newPath;
   };
 
-  if (!(await fs.exists(this.keychainPath)) || _.isEmpty(await fs.readdir(this.keychainPath))) {
+  if (!(await fs.exists(this.keychainPath)) || (await fs.readdir(this.keychainPath)).length === 0) {
     this.log.info(`There is nothing to backup from '${this.keychainPath}'`);
     await resetBackupPath(null);
     return false;
@@ -64,14 +66,17 @@ export async function restoreKeychains(
   this: CoreSimulatorWithKeychain,
   excludePatterns: string[] | string = [],
 ): Promise<boolean> {
-  if (!_.isString(this._keychainsBackupPath) || !(await fs.exists(this._keychainsBackupPath))) {
+  if (
+    typeof this._keychainsBackupPath !== 'string' ||
+    !(await fs.exists(this._keychainsBackupPath))
+  ) {
     throw new Error(
       `The keychains backup archive does not exist. ` + `Are you sure it was created before?`,
     );
   }
 
   let patterns: string[] = [];
-  if (_.isString(excludePatterns)) {
+  if (typeof excludePatterns === 'string') {
     patterns = excludePatterns.split(',').map((x) => x.trim());
   } else {
     patterns = excludePatterns;
@@ -95,7 +100,7 @@ export async function restoreKeychains(
     const unzipArgs = [
       '-o',
       backupPath,
-      ..._.flatMap(patterns.map((x) => ['-x', x])),
+      ...patterns.flatMap((x) => ['-x', x]),
       '-d',
       path.dirname(this.keychainPath),
     ];

package/lib/extensions/permissions.ts

@@ -1,8 +1,6 @@
-import _ from 'lodash';
 import {fs, timing, util} from '@appium/support';
 import {exec} from 'teen_process';
 import path from 'node:path';
-import B from 'bluebird';
 import {waitForCondition} from 'asyncbox';
 import type {CoreSimulator, SupportsAppPermissions} from '../types';
 import type {StringRecord} from '@appium/types';
@@ -99,17 +97,17 @@ export async function getPermission(
 }
 
 function toInternalServiceName(serviceName: string): string {
-  const lowerName = _.toLower(serviceName);
-  if (_.has(SERVICES, lowerName)) {
+  const lowerName = serviceName.toLowerCase();
+  if (lowerName in SERVICES) {
     return SERVICES[lowerName as keyof typeof SERVICES] as string;
   }
   throw new Error(
-    `'${serviceName}' is unknown. Only the following service names are supported: ${JSON.stringify(_.keys(SERVICES))}`,
+    `'${serviceName}' is unknown. Only the following service names are supported: ${JSON.stringify(Object.keys(SERVICES))}`,
   );
 }
 
 function formatStatus(status: string): string {
-  return status === STATUS.UNSET || status === STATUS.NO ? _.toUpper(status) : status;
+  return status === STATUS.UNSET || status === STATUS.NO ? status.toUpperCase() : status;
 }
 
 /**
@@ -190,7 +188,7 @@ async function setAccess(
     } else {
       // xcrun simctl privacy expects to be lower case while AppleSimulatorUtils is upper case.
       // To keep the compatibility,  we should convert here to lower case explicitly.
-      switch (_.toLower(permissionsMapping[serviceName])) {
+      switch (permissionsMapping[serviceName]?.toLowerCase()) {
         case STATUS.YES:
           grantPermissions.push(serviceName);
           break;
@@ -210,7 +208,7 @@ async function setAccess(
 
   const permissionPromises: Promise<any>[] = [];
 
-  if (!_.isEmpty(grantPermissions)) {
+  if (grantPermissions.length > 0) {
     this.log.debug(
       `Granting ${util.pluralize('permission', grantPermissions.length, false)} for ${bundleId}: ${grantPermissions}`,
     );
@@ -219,7 +217,7 @@ async function setAccess(
     }
   }
 
-  if (!_.isEmpty(revokePermissions)) {
+  if (revokePermissions.length > 0) {
     this.log.debug(
       `Revoking ${util.pluralize('permission', revokePermissions.length, false)} for ${bundleId}: ${revokePermissions}`,
     );
@@ -228,7 +226,7 @@ async function setAccess(
     }
   }
 
-  if (!_.isEmpty(resetPermissions)) {
+  if (resetPermissions.length > 0) {
     this.log.debug(
       `Resetting ${util.pluralize('permission', resetPermissions.length, false)} for ${bundleId}: ${resetPermissions}`,
     );
@@ -237,16 +235,16 @@ async function setAccess(
     }
   }
 
-  if (!_.isEmpty(permissionPromises)) {
-    await B.all(permissionPromises);
+  if (permissionPromises.length > 0) {
+    await Promise.all(permissionPromises);
   }
 
-  if (!_.isEmpty(wixPermissions)) {
+  if (Object.keys(wixPermissions).length > 0) {
     this.log.debug(
       `Setting permissions for ${bundleId} wit ${WIX_SIM_UTILS} as ${JSON.stringify(wixPermissions)}`,
     );
-    const permissionsArg = _.toPairs(wixPermissions)
-      .map((x) => `${x[0]}=${formatStatus(x[1])}`)
+    const permissionsArg = Object.entries(wixPermissions)
+      .map(([name, status]) => `${name}=${formatStatus(status)}`)
       .join(',');
     const execWixFn = async () =>
       await execWix.bind(this)([
@@ -257,8 +255,8 @@ async function setAccess(
         '--setPermissions',
         permissionsArg,
       ]);
-    const shouldWaitForSystemReadiness = !_.isEmpty(
-      _.intersection(SERVICES_NEED_SPRINGBOARD_RESTART, _.keys(wixPermissions)),
+    const shouldWaitForSystemReadiness = SERVICES_NEED_SPRINGBOARD_RESTART.some(
+      (service) => service in wixPermissions,
     );
     if (shouldWaitForSystemReadiness) {
       const [didTimeout] = await runAndWaitForSystemReadiness.bind(this)(
@@ -302,7 +300,7 @@ async function runAndWaitForSystemReadiness<T>(
       async () => {
         try {
           const pid = (await this.ps()).find(({name}) => bundleId === name)?.pid;
-          return _.isInteger(pid) && initialPid !== pid;
+          return Number.isInteger(pid) && initialPid !== pid;
         } catch {
           return false;
         }
@@ -322,7 +320,7 @@ async function runAndWaitForSystemReadiness<T>(
   ].map((bundleId) => initialProcesses.find(({name}) => bundleId === name)?.pid);
 
   const result = await fn();
-  if (!_.isInteger(initialSpringboardPid) || !_.isInteger(initialSpotlightPid)) {
+  if (!Number.isInteger(initialSpringboardPid) || !Number.isInteger(initialSpotlightPid)) {
     // there is no point to wait if relevant processes were not running before
     return [false, result];
   }

package/lib/extensions/safari.ts

@@ -1,7 +1,5 @@
-import _ from 'lodash';
 import path from 'node:path';
 import {fs, timing} from '@appium/support';
-import B from 'bluebird';
 import {MOBILE_SAFARI_BUNDLE_ID, SAFARI_STARTUP_TIMEOUT_MS} from '../utils';
 import {waitForCondition} from 'asyncbox';
 import {exec} from 'teen_process';
@@ -103,7 +101,7 @@ export async function scrubSafari(
   if (!keepPrefs) {
     deletePromises.push(fs.rimraf(path.join(libraryDir, 'Preferences', '*.plist')));
   }
-  await B.all(deletePromises);
+  await Promise.all(deletePromises);
 }
 
 /**
@@ -126,7 +124,7 @@ export async function updateSafariSettings(
   this: CoreSimulatorWithSafariBrowser,
   updates: StringRecord,
 ): Promise<boolean> {
-  if (_.isEmpty(updates)) {
+  if (Object.keys(updates).length === 0) {
     return false;
   }