appium-ios-simulator 8.1.3 → 8.2.0

package/lib/utils/lifecycle.ts

@@ -0,0 +1,78 @@
+import {log} from '../logger';
+import {exec, type ExecError} from 'teen_process';
+import {waitForCondition} from 'asyncbox';
+import {getVersion} from 'appium-xcode';
+import {
+  DEVICE_HUB_UI_CLIENT_BUNDLE_ID,
+  MIN_DEVICE_HUB_XCODE_VERSION,
+  SIMULATOR_UI_CLIENT_BUNDLE_ID,
+} from './constants';
+import {getDevices} from './get-devices';
+import {getMacAppPidByBundleId, killMacAppByBundleId} from './process';
+
+const DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS = 60000;
+
+/**
+ * @param timeout - Timeout in milliseconds (default: DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS).
+ * @returns Promise that resolves when all simulators are killed.
+ */
+export async function killAllSimulators(
+  timeout: number = DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS,
+): Promise<void> {
+  log.debug('Killing all iOS Simulators');
+  const xcodeVersion = await getVersion(true);
+  const uiClientBundleId =
+    xcodeVersion.major >= MIN_DEVICE_HUB_XCODE_VERSION
+      ? DEVICE_HUB_UI_CLIENT_BUNDLE_ID
+      : SIMULATOR_UI_CLIENT_BUNDLE_ID;
+
+  const startedMs = performance.now();
+  try {
+    await exec('xcrun', ['simctl', 'shutdown', 'all'], {timeout});
+  } catch (err: unknown) {
+    log.debug(
+      `Failed to shutdown all simulators: ${(err as ExecError).stderr || (err as Error).message}`,
+    );
+  }
+
+  const uiClientPid = await getMacAppPidByBundleId(uiClientBundleId);
+  if (uiClientPid) {
+    log.debug(`Killing UI client '${uiClientBundleId}' (pid ${uiClientPid})`);
+    await killMacAppByBundleId(uiClientBundleId);
+  } else {
+    log.debug(`UI client '${uiClientBundleId}' is not running`);
+  }
+
+  try {
+    await waitForCondition(allSimsAreDown, {
+      waitMs: Math.max(1000, startedMs + timeout - performance.now()),
+      intervalMs: 200,
+    });
+  } catch (err) {
+    const remainingDevices = await getNonShutdownDeviceDescriptions();
+    const message =
+      remainingDevices.length > 0
+        ? `The following devices are still not in the correct state after ${timeout} ms:\n` +
+          remainingDevices.map((device) => `    ${device}`).join('\n')
+        : `Timed out after ${timeout} ms waiting for all simulators to shut down`;
+    throw new Error(message, {cause: err});
+  }
+}
+
+async function allSimsAreDown(): Promise<boolean> {
+  try {
+    return (await getNonShutdownDeviceDescriptions()).length === 0;
+  } catch {
+    return false;
+  }
+}
+
+async function getNonShutdownDeviceDescriptions(): Promise<string[]> {
+  const devices = Object.values(await getDevices()).flat();
+  return devices
+    .filter((sim) => !['shutdown', 'unavailable', 'disconnected'].includes(sim.state.toLowerCase()))
+    .map(
+      (sim) =>
+        `${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${sim.state.toLowerCase()}'`,
+    );
+}

package/lib/utils/process.ts

@@ -0,0 +1,31 @@
+import {log} from '../logger';
+import {exec} from 'teen_process';
+
+/**
+ * @param bundleId - The bundle identifier of a running macOS application.
+ * @returns The process ID or null if the application is not running.
+ */
+export async function getMacAppPidByBundleId(bundleId: string): Promise<string | null> {
+  let stdout: string;
+  try {
+    ({stdout} = await exec('lsappinfo', ['info', '-only', 'pid', bundleId]));
+  } catch {
+    return null;
+  }
+  const match = stdout.trim().match(/"pid"=(\d+)/);
+  return match?.[1] ?? null;
+}
+
+/**
+ * @param bundleId - The bundle identifier of a running macOS application.
+ * @returns True if the kill command succeeded.
+ */
+export async function killMacAppByBundleId(bundleId: string): Promise<boolean> {
+  try {
+    await exec('lsappinfo', ['kill', '-hard', bundleId]);
+    return true;
+  } catch (e: any) {
+    log.debug(`Could not kill '${bundleId}' via lsappinfo: ${e.stderr || e.message}`);
+    return false;
+  }
+}

package/lib/utils/types.ts

@@ -0,0 +1,3 @@
+export interface SimulatorInfoOptions {
+  devicesSetPath?: string | null;
+}

package/lib/utils/xcode.ts

@@ -0,0 +1,86 @@
+import {fs} from '@appium/support';
+import {exec} from 'teen_process';
+import path from 'node:path';
+import type {XcodeVersion} from 'appium-xcode';
+import {MIN_DEVICE_HUB_XCODE_VERSION, MIN_SUPPORTED_XCODE_VERSION} from './constants';
+
+/**
+ * @returns Promise that resolves to the developer root path.
+ */
+export async function getDeveloperRoot(): Promise<string> {
+  const {stdout} = await exec('xcode-select', ['-p']);
+  return stdout.trim();
+}
+
+/**
+ * @param bundleId - The bundle identifier of the Simulator UI client.
+ * @param xcodeVersion - The active Xcode version.
+ * @returns The full path to the UI client app in the active Xcode installation.
+ * @throws {Error} If no matching app is found in the active Xcode folder.
+ */
+export async function getUiClientAppPath(
+  bundleId: string,
+  xcodeVersion: XcodeVersion,
+): Promise<string> {
+  const devRoot = await getDeveloperRoot();
+  const applicationsDir =
+    xcodeVersion.major >= MIN_DEVICE_HUB_XCODE_VERSION
+      ? path.resolve(devRoot, '..', 'Applications')
+      : path.resolve(devRoot, 'Applications');
+
+  if (await fs.exists(applicationsDir)) {
+    const appPaths = (await fs.readdir(applicationsDir))
+      .filter((entry) => entry.endsWith('.app'))
+      .map((entry) => path.resolve(applicationsDir, entry));
+    const apps = await Promise.all(
+      appPaths.map(async (appPath) => ({
+        appPath,
+        bundleId: await readBundleIdFromPlist(path.resolve(appPath, 'Contents', 'Info.plist')),
+      })),
+    );
+    const match = apps.find((app) => app.bundleId === bundleId);
+    if (match) {
+      return match.appPath;
+    }
+  }
+
+  throw new Error(
+    `Could not find UI client app with bundle id '${bundleId}' under '${applicationsDir}' ` +
+      `(active Xcode developer root: ${devRoot})`,
+  );
+}
+
+/**
+ * Asserts that the Xcode version meets the minimum supported version requirement.
+ *
+ * @template V - The Xcode version type.
+ * @param xcodeVersion - The Xcode version to check.
+ * @returns The same Xcode version if it meets the requirement.
+ * @throws {Error} If the Xcode version is below the minimum supported version.
+ */
+export function assertXcodeVersion<V extends XcodeVersion>(xcodeVersion: V): V {
+  if (xcodeVersion.major < MIN_SUPPORTED_XCODE_VERSION) {
+    throw new Error(
+      `Tried to use an iOS simulator with xcode version ${xcodeVersion.versionString} but only Xcode version ` +
+        `${MIN_SUPPORTED_XCODE_VERSION} and up are supported`,
+    );
+  }
+  return xcodeVersion;
+}
+
+/**
+ * @param infoPlistPath - The full path to an Info.plist file.
+ * @returns The bundle identifier or null if it cannot be read.
+ */
+export async function readBundleIdFromPlist(infoPlistPath: string): Promise<string | null> {
+  try {
+    const {stdout} = await exec('/usr/libexec/PlistBuddy', [
+      '-c',
+      'print CFBundleIdentifier',
+      infoPlistPath,
+    ]);
+    return stdout.trim() || null;
+  } catch {
+    return null;
+  }
+}

package/package.json

@@ -7,7 +7,7 @@
     "ios",
     "simctl"
   ],
-  "version": "8.1.3",
+  "version": "8.2.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

package/build/lib/defaults-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaults-utils.d.ts","sourceRoot":"","sources":["../../lib/defaults-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,KAAK,OAAO,EAAC,MAAM,gBAAgB,CAAC;AAKrF,qBAAa,cAAc;IACzB,KAAK,EAAE,MAAM,CAAC;gBAEF,KAAK,EAAE,MAAM;IAIzB;;;;;;OAMG;IACG,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAY5C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB5D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,GAAE,OAAc,GAAG,MAAM,GAAG,OAAO,CA0ChF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,OAAO,GAAE,OAAe,GACvB,MAAM,EAAE,EAAE,CA4BZ"}

package/build/lib/defaults-utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaults-utils.js","sourceRoot":"","sources":["../../lib/defaults-utils.ts"],"names":[],"mappings":";;;AA4EA,4BA0CC;AAeD,kEA+BC;AApKD,2CAAqF;AACrF,+CAAkC;AAClC,qCAA6B;AAC7B,6CAAqC;AAErC,MAAa,cAAc;IACzB,KAAK,CAAS;IAEd,YAAY,KAAa;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,CAAC;YACH,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACnF,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,IAAI,IAAI,CAAC,KAAK,kDAAkD,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,EACvF,EAAC,KAAK,EAAE,CAAC,EAAC,CACX,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,SAA8B;QACzC,IAAI,CAAC,cAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,SAAS,CAAC,gCAAgC,SAAS,oBAAoB,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CACf,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAI,EAAC,UAAU,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAC5E,CAAC;QACJ,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,kCAAkC,IAAI,CAAC,KAAK,sBAAsB,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,EACzF,EAAC,KAAK,EAAE,CAAC,EAAC,CACX,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAzDD,wCAyDC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,QAAQ,CAAC,KAAU,EAAE,YAAqB,IAAI;IAC5D,IAAI,MAAM,GAAoB,IAAI,CAAC;IAEnC,IAAI,cAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACvD,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAChD,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YAC7B,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACnC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAY,EAAE,IAAI,CAAC,CAAC;YACjF,eAAe,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;QACxE,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACvD,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC7B,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAY,EAAE,IAAI,CAAC,CAAC;YACjF,eAAe,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QACtC,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACvF,CAAC;SAAM,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,YAAY,KAAK,YAAY,EAAE,UAAU,CAAC,CAAC;IACtF,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,SAAS,KAAK,SAAS,EAAE,UAAU,CAAC,CAAC;IAChF,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACjD,sBAAsB,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,SAAS,CACjB,sBAAsB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,sBAAsB;YAC/D,gDAAgD,CACnD,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,sBAAa,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;AAC9F,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,2BAA2B,CACzC,SAA8B,EAC9B,UAAmB,KAAK;IAExB,MAAM,UAAU,GAAe,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACrD,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,IAAI,cAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBACpC,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvD,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAW,CAAC,CAAC;gBACtD,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5B,CAAC;iBAAM,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;gBACtC,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;oBAC7B,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAW,CAAC,CAAC;gBAC/C,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAW,CAAC,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;gBAC3B,YAAG,CAAC,IAAI,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAgB;IAC9C,MAAM,EAAC,eAAe,EAAC,GAAG,MAAM,CAAC;IACjC,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/build/lib/utils.d.ts

@@ -1,44 +0,0 @@
-import type { XcodeVersion } from 'appium-xcode';
-import type { StringRecord } from '@appium/types';
-export declare const SAFARI_STARTUP_TIMEOUT_MS: number;
-export declare const MOBILE_SAFARI_BUNDLE_ID = "com.apple.mobilesafari";
-export declare const SIMULATOR_APP_NAME = "Simulator.app";
-export declare const MIN_SUPPORTED_XCODE_VERSION = 14;
-export interface SimulatorInfoOptions {
-    devicesSetPath?: string | null;
-}
-/**
- * @param timeout - Timeout in milliseconds (default: DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS).
- * @returns Promise that resolves when all simulators are killed.
- */
-export declare function killAllSimulators(timeout?: number): Promise<void>;
-/**
- * @param udid - The simulator UDID.
- * @param opts - Options including devicesSetPath.
- * @returns Promise that resolves to simulator info or undefined if not found.
- */
-export declare function getSimulatorInfo(udid: string, opts?: SimulatorInfoOptions): Promise<any>;
-/**
- * @param udid - The simulator UDID.
- * @returns Promise that resolves to true if simulator exists, false otherwise.
- */
-export declare function simExists(udid: string): Promise<boolean>;
-/**
- * @returns Promise that resolves to the developer root path.
- */
-export declare function getDeveloperRoot(): Promise<string>;
-/**
- * Asserts that the Xcode version meets the minimum supported version requirement.
- *
- * @template V - The Xcode version type.
- * @param xcodeVersion - The Xcode version to check.
- * @returns The same Xcode version if it meets the requirement.
- * @throws {Error} If the Xcode version is below the minimum supported version.
- */
-export declare function assertXcodeVersion<V extends XcodeVersion>(xcodeVersion: V): V;
-/**
- * @param simctlOpts - Optional simctl options
- * @returns Promise that resolves to a record of devices grouped by SDK version
- */
-export declare function getDevices(simctlOpts?: StringRecord): Promise<Record<string, any[]>>;
-//# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAG/C,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAC;AAKhD,eAAO,MAAM,yBAAyB,QAAY,CAAC;AACnD,eAAO,MAAM,uBAAuB,2BAA2B,CAAC;AAChE,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,GAAE,MAAwC,GAChD,OAAO,CAAC,IAAI,CAAC,CA6Ef;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,oBAAyB,GAC9B,OAAO,CAAC,GAAG,CAAC,CAKd;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAE9D;AAED;;GAEG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,CAGxD;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAQ7E;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,UAAU,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAE1F"}

package/build/lib/utils.js

@@ -1,211 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIN_SUPPORTED_XCODE_VERSION = exports.SIMULATOR_APP_NAME = exports.MOBILE_SAFARI_BUNDLE_ID = exports.SAFARI_STARTUP_TIMEOUT_MS = void 0;
-exports.killAllSimulators = killAllSimulators;
-exports.getSimulatorInfo = getSimulatorInfo;
-exports.simExists = simExists;
-exports.getDeveloperRoot = getDeveloperRoot;
-exports.assertXcodeVersion = assertXcodeVersion;
-exports.getDevices = getDevices;
-const logger_1 = require("./logger");
-const teen_process_1 = require("teen_process");
-const asyncbox_1 = require("asyncbox");
-const appium_xcode_1 = require("appium-xcode");
-const node_path_1 = __importDefault(require("node:path"));
-const node_simctl_1 = require("node-simctl");
-// it's a hack needed to stub getDevices in tests
-const utilsModule = __importStar(require("./utils"));
-const DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS = 30000;
-exports.SAFARI_STARTUP_TIMEOUT_MS = 25 * 1000;
-exports.MOBILE_SAFARI_BUNDLE_ID = 'com.apple.mobilesafari';
-exports.SIMULATOR_APP_NAME = 'Simulator.app';
-exports.MIN_SUPPORTED_XCODE_VERSION = 14;
-/**
- * @param timeout - Timeout in milliseconds (default: DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS).
- * @returns Promise that resolves when all simulators are killed.
- */
-async function killAllSimulators(timeout = DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS) {
-    logger_1.log.debug('Killing all iOS Simulators');
-    const xcodeVersion = await (0, appium_xcode_1.getVersion)(true);
-    if (typeof xcodeVersion === 'string') {
-        return;
-    }
-    const appName = node_path_1.default.parse(exports.SIMULATOR_APP_NAME).name;
-    const version = xcodeVersion;
-    // later versions are slower to close
-    timeout = timeout * (version.major >= 8 ? 2 : 1);
-    try {
-        await (0, teen_process_1.exec)('xcrun', ['simctl', 'shutdown', version.major > 8 ? 'all' : 'booted'], { timeout });
-    }
-    catch { }
-    const pids = [];
-    try {
-        const { stdout } = await (0, teen_process_1.exec)('pgrep', ['-f', `${appName}.app/Contents/MacOS/`]);
-        if (stdout.trim()) {
-            pids.push(...stdout.trim().split(/\s+/));
-        }
-    }
-    catch (e) {
-        if (e.code === 1) {
-            logger_1.log.debug(`${appName} is not running. Continuing...`);
-            return;
-        }
-        if (pids.length === 0) {
-            logger_1.log.warn(`pgrep error ${e.code} while detecting whether ${appName} is running. Trying to kill anyway.`);
-        }
-    }
-    if (pids.length > 0) {
-        logger_1.log.debug(`Killing processes: ${pids.join(', ')}`);
-        try {
-            await (0, teen_process_1.exec)('kill', ['-9', ...pids.map((pid) => `${pid}`)]);
-        }
-        catch { }
-    }
-    logger_1.log.debug(`Using pkill to kill application: ${appName}`);
-    try {
-        await pkill(appName, true);
-    }
-    catch { }
-    // wait for all the devices to be shutdown before Continuing
-    // but only print out the failed ones when they are actually fully failed
-    let remainingDevices = [];
-    async function allSimsAreDown() {
-        remainingDevices = [];
-        const devicesRecord = await utilsModule.getDevices();
-        const devices = Object.values(devicesRecord).flat();
-        return devices.every((sim) => {
-            const state = sim.state.toLowerCase();
-            const done = ['shutdown', 'unavailable', 'disconnected'].includes(state);
-            if (!done) {
-                remainingDevices.push(`${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${state}'`);
-            }
-            return done;
-        });
-    }
-    try {
-        await (0, asyncbox_1.waitForCondition)(allSimsAreDown, {
-            waitMs: timeout,
-            intervalMs: 200,
-        });
-    }
-    catch (err) {
-        if (remainingDevices.length > 0) {
-            logger_1.log.warn(`The following devices are still not in the correct state after ${timeout} ms:`);
-            for (const device of remainingDevices) {
-                logger_1.log.warn(`    ${device}`);
-            }
-        }
-        throw err;
-    }
-}
-/**
- * @param udid - The simulator UDID.
- * @param opts - Options including devicesSetPath.
- * @returns Promise that resolves to simulator info or undefined if not found.
- */
-async function getSimulatorInfo(udid, opts = {}) {
-    const { devicesSetPath } = opts;
-    // see the README for github.com/appium/node-simctl for example output of getDevices()
-    const devices = Object.values(await utilsModule.getDevices({ devicesSetPath })).flat();
-    return devices.find((sim) => sim.udid === udid);
-}
-/**
- * @param udid - The simulator UDID.
- * @returns Promise that resolves to true if simulator exists, false otherwise.
- */
-async function simExists(udid) {
-    return !!(await getSimulatorInfo(udid));
-}
-/**
- * @returns Promise that resolves to the developer root path.
- */
-async function getDeveloperRoot() {
-    const { stdout } = await (0, teen_process_1.exec)('xcode-select', ['-p']);
-    return stdout.trim();
-}
-/**
- * Asserts that the Xcode version meets the minimum supported version requirement.
- *
- * @template V - The Xcode version type.
- * @param xcodeVersion - The Xcode version to check.
- * @returns The same Xcode version if it meets the requirement.
- * @throws {Error} If the Xcode version is below the minimum supported version.
- */
-function assertXcodeVersion(xcodeVersion) {
-    if (xcodeVersion.major < exports.MIN_SUPPORTED_XCODE_VERSION) {
-        throw new Error(`Tried to use an iOS simulator with xcode version ${xcodeVersion.versionString} but only Xcode version ` +
-            `${exports.MIN_SUPPORTED_XCODE_VERSION} and up are supported`);
-    }
-    return xcodeVersion;
-}
-/**
- * @param simctlOpts - Optional simctl options
- * @returns Promise that resolves to a record of devices grouped by SDK version
- */
-async function getDevices(simctlOpts) {
-    return await new node_simctl_1.Simctl(simctlOpts).getDevices();
-}
-/**
- * @param appName - The application name to kill.
- * @param forceKill - Whether to force kill the process.
- * @returns Promise that resolves to 0 on success.
- */
-async function pkill(appName, forceKill = false) {
-    const args = forceKill ? ['-9'] : [];
-    args.push('-x', appName);
-    try {
-        await (0, teen_process_1.exec)('pkill', args);
-        return 0;
-    }
-    catch (err) {
-        // pgrep/pkill exit codes:
-        // 0       One or more processes were matched.
-        // 1       No processes were matched.
-        // 2       Invalid options were specified on the command line.
-        // 3       An internal error occurred.
-        if (err.code !== undefined) {
-            throw new Error(`Cannot forcefully terminate ${appName}. pkill error code: ${err.code}`, {
-                cause: err,
-            });
-        }
-        logger_1.log.error(`Received unexpected error while trying to kill ${appName}: ${err.message}`);
-        throw err;
-    }
-}
-//# sourceMappingURL=utils.js.map

package/build/lib/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,8CA+EC;AAOD,4CAQC;AAMD,8BAEC;AAKD,4CAGC;AAUD,gDAQC;AAMD,gCAEC;AAjKD,qCAA6B;AAC7B,+CAAkC;AAClC,uCAA0C;AAC1C,+CAAwC;AAExC,0DAA6B;AAC7B,6CAAmC;AAEnC,iDAAiD;AACjD,qDAAuC;AAEvC,MAAM,+BAA+B,GAAG,KAAK,CAAC;AACjC,QAAA,yBAAyB,GAAG,EAAE,GAAG,IAAI,CAAC;AACtC,QAAA,uBAAuB,GAAG,wBAAwB,CAAC;AACnD,QAAA,kBAAkB,GAAG,eAAe,CAAC;AACrC,QAAA,2BAA2B,GAAG,EAAE,CAAC;AAM9C;;;GAGG;AACI,KAAK,UAAU,iBAAiB,CACrC,UAAkB,+BAA+B;IAEjD,YAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACxC,MAAM,YAAY,GAAG,MAAM,IAAA,yBAAU,EAAC,IAAI,CAAC,CAAC;IAC5C,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IACD,MAAM,OAAO,GAAG,mBAAI,CAAC,KAAK,CAAC,0BAAkB,CAAC,CAAC,IAAI,CAAC;IACpD,MAAM,OAAO,GAAG,YAA4B,CAAC;IAE7C,qCAAqC;IACrC,OAAO,GAAG,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjD,IAAI,CAAC;QACH,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAC/F,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;IAEV,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,OAAO,sBAAsB,CAAC,CAAC,CAAC;QAC/E,IAAI,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACjB,YAAG,CAAC,KAAK,CAAC,GAAG,OAAO,gCAAgC,CAAC,CAAC;YACtD,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,YAAG,CAAC,IAAI,CACN,eAAe,CAAC,CAAC,IAAI,4BAA4B,OAAO,qCAAqC,CAC9F,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,YAAG,CAAC,KAAK,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC;YACH,MAAM,IAAA,mBAAI,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IAED,YAAG,CAAC,KAAK,CAAC,oCAAoC,OAAO,EAAE,CAAC,CAAC;IACzD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;IAEV,4DAA4D;IAC5D,yEAAyE;IACzE,IAAI,gBAAgB,GAAa,EAAE,CAAC;IACpC,KAAK,UAAU,cAAc;QAC3B,gBAAgB,GAAG,EAAE,CAAC;QACtB,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,UAAU,EAAE,CAAC;QACrD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC;QACpD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;YAChC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACzE,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,gBAAgB,CAAC,IAAI,CACnB,GAAG,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,GAAG,WAAW,GAAG,CAAC,IAAI,wBAAwB,KAAK,GAAG,CAC3E,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAA,2BAAgB,EAAC,cAAc,EAAE;YACrC,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,YAAG,CAAC,IAAI,CAAC,kEAAkE,OAAO,MAAM,CAAC,CAAC;YAC1F,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;gBACtC,YAAG,CAAC,IAAI,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CACpC,IAAY,EACZ,OAA6B,EAAE;IAE/B,MAAM,EAAC,cAAc,EAAC,GAAG,IAAI,CAAC;IAC9B,sFAAsF;IACtF,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,WAAW,CAAC,UAAU,CAAC,EAAC,cAAc,EAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACrF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACvD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS,CAAC,IAAY;IAC1C,OAAO,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB;IACpC,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAyB,YAAe;IACxE,IAAI,YAAY,CAAC,KAAK,GAAG,mCAA2B,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACb,oDAAoD,YAAY,CAAC,aAAa,0BAA0B;YACtG,GAAG,mCAA2B,uBAAuB,CACxD,CAAC;IACJ,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,UAAyB;IACxD,OAAO,MAAM,IAAI,oBAAM,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;AACnD,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,KAAK,CAAC,OAAe,EAAE,YAAqB,KAAK;IAC9D,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACzB,IAAI,CAAC;QACH,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1B,OAAO,CAAC,CAAC;IACX,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,0BAA0B;QAC1B,8CAA8C;QAC9C,qCAAqC;QACrC,8DAA8D;QAC9D,sCAAsC;QACtC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,uBAAuB,GAAG,CAAC,IAAI,EAAE,EAAE;gBACvF,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;QACL,CAAC;QACD,YAAG,CAAC,KAAK,CAAC,kDAAkD,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACvF,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC"}