appium-xcuitest-driver/lib/commands/memory.ts

Appium driver for iOS using XCUITest for backend

import _ from 'lodash';
import { errors } from 'appium/driver';
import type {XCUITestDriver} from '../driver';
import type {RealDevice} from '../device/real-device-management';

/**
 * Simulates Low Memory warning on the given application
 *
 * @since Xcode 15
 * @param bundleId - The bundle identifier of the target app. The app must be running
 * @throws If the app is not running or is not installed
 */
export async function mobileSendMemoryWarning(
  this: XCUITestDriver,
  bundleId: string,
): Promise<void> {
  if (!this.isRealDevice()) {
    throw new Error('Memory warning simulation is only supported on real devices');
  }

  const device = this.device as RealDevice;

  const appInfos = await device.devicectl.listApps(bundleId);
  if (_.isEmpty(appInfos)) {
    throw new errors.InvalidArgumentError(
      `The application identified by ${bundleId} cannot be found on the device. Is it installed?`
    );
  }

  // This regexp tries to match the process name of the main bundle executable.
  // For example, if 'url' contains something like
  // `file:///private/var/containers/Bundle/Application/093ACA6D-8F0B-4601-87B9-4099E43A1A20/Target.app/`
  // and the following processes might be running:
  // `file:///private/var/containers/Bundle/Application/093ACA6D-8F0B-4601-87B9-4099E43A1A20/Target.app/Target`
  // `file:///private/var/containers/Bundle/Application/093ACA6D-8F0B-4601-87B9-4099E43A1A20/Target.app/PlugIns/WidgetExtension.appex/WidgetExtension`
  // then we only want to match the first one.
  // Unfortunately devicectl does not provide more info which would
  // allow to connect a bundle id to a process id.
  const pattern = new RegExp(`^${_.escapeRegExp(appInfos[0].url)}[^/]+$`);
  const pids = (await device.devicectl.listProcesses())
    .filter(({executable}) => pattern.test(executable))
    .map(({processIdentifier}) => processIdentifier);
  if (_.isEmpty(pids)) {
    throw new errors.InvalidArgumentError(
      `The application identified by ${bundleId} must be running in order to simulate the Low Memory warning`
    );
  }
  this.log.info(`Emulating Low Memory warning for the process id ${pids[0]}, bundle id ${bundleId}`);
  await device.devicectl.sendMemoryWarning(pids[0]);
}