@react-native-harness/platform-android 1.3.0 → 1.4.0

package/src/adb.ts

@@ -1,8 +1,10 @@
 import { type AndroidAppLaunchOptions } from '@react-native-harness/platforms';
 import {
+  delay,
   logger,
   spawn,
   SubprocessError,
+  waitForAbort,
   type Subprocess,
 } from '@react-native-harness/tools';
 import { spawn as nodeSpawn } from 'node:child_process';
@@ -25,6 +27,7 @@ import {
   getRequiredAndroidSdkPackages,
 } from './environment.js';
 import {
+  getEmulatorCpuCores,
   getEmulatorStartupArgs,
   type EmulatorBootMode,
 } from './emulator-startup.js';
@@ -33,37 +36,26 @@ import {
   AdbPermissionGrantError,
 } from './adb-errors.js';
 
-const wait = async (ms: number): Promise<void> => {
-  await new Promise((resolve) => {
-    setTimeout(resolve, ms);
-  });
-};
-
-const waitForAbort = (signal: AbortSignal): Promise<never> => {
-  if (signal.aborted) {
-    return Promise.reject(signal.reason);
-  }
-
-  return new Promise((_, reject) => {
-    signal.addEventListener(
-      'abort',
-      () => {
-        reject(signal.reason);
-      },
-      { once: true },
-    );
-  });
-};
-
 const waitWithSignal = async (
   ms: number,
-  signal: AbortSignal,
+  signal: AbortSignal
 ): Promise<void> => {
   if (signal.aborted) {
     throw signal.reason;
   }
 
-  await Promise.race([wait(ms), waitForAbort(signal)]);
+  // Both sides of this race must be torn down explicitly when they lose:
+  // an uncancelled timer keeps a ref'd Timeout alive, and an uncancelled
+  // abort wait leaks a listener on `signal`, which is a session-lifetime
+  // signal here and gets polled against once per second.
+  const timer = delay(ms);
+  const abort = waitForAbort(signal);
+  try {
+    await Promise.race([timer.promise, abort.promise]);
+  } finally {
+    timer.cancel();
+    abort.cancel();
+  }
 };
 
 const EMULATOR_STARTUP_OBSERVATION_TIMEOUT_MS = 5000;
@@ -73,7 +65,7 @@ const androidAdbLogger = logger.child('android-adb');
 export const emulatorProcess = {
   startDetachedProcess: (
     file: string,
-    args: readonly string[],
+    args: readonly string[]
   ): ChildProcessByStdio<null, Readable, Readable> =>
     nodeSpawn(file, args, {
       detached: true,
@@ -84,7 +76,7 @@ export const emulatorProcess = {
 const appendBoundedOutput = (
   output: string,
   chunk: string,
-  limit: number = EMULATOR_OUTPUT_BUFFER_LIMIT,
+  limit: number = EMULATOR_OUTPUT_BUFFER_LIMIT
 ): string => {
   const nextOutput = output + chunk;
 
@@ -165,7 +157,7 @@ export const getRequiredEmulatorPackages = (apiLevel: number): string[] => {
 };
 
 export const verifyAndroidEmulatorSdk = async (
-  apiLevel: number,
+  apiLevel: number
 ): Promise<void> => {
   await ensureAndroidSdkPackages(getRequiredEmulatorPackages(apiLevel));
 };
@@ -192,7 +184,7 @@ const ensureAvdProfileAvailable = async (profile: string): Promise<void> => {
       : 'None reported by avdmanager.';
 
   throw new Error(
-    `Android AVD profile "${profile}" is not available on this machine. Available profiles: ${availableProfilesList}`,
+    `Android AVD profile "${profile}" is not available on this machine. Available profiles: ${availableProfilesList}`
   );
 };
 
@@ -201,7 +193,7 @@ const ensureAvdConfigExists = async (name: string): Promise<string> => {
 
   if ((await readAvdConfig(name)) == null) {
     throw new Error(
-      `Android AVD "${name}" was created, but config.ini was not found at ${configPath}.`,
+      `Android AVD "${name}" was created, but config.ini was not found at ${configPath}.`
     );
   }
 
@@ -235,7 +227,7 @@ const ensureAvdIniExists = async ({
 export const getStartAppArgs = (
   bundleId: string,
   activityName: string,
-  options?: AndroidAppLaunchOptions,
+  options?: AndroidAppLaunchOptions
 ): string[] => {
   const args = [
     'shell',
@@ -264,7 +256,7 @@ export const getStartAppArgs = (
 
     if (!Number.isSafeInteger(value)) {
       throw new Error(
-        `Android app launch option "${key}" must be a safe integer.`,
+        `Android app launch option "${key}" must be a safe integer.`
       );
     }
 
@@ -276,7 +268,7 @@ export const getStartAppArgs = (
 
 export const isAppInstalled = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<boolean> => {
   const { stdout } = await spawn(getAdbBinaryPath(), [
     '-s',
@@ -293,7 +285,7 @@ export const isAppInstalled = async (
 export const reversePort = async (
   adbId: string,
   port: number,
-  hostPort: number = port,
+  hostPort: number = port
 ): Promise<void> => {
   await spawn(getAdbBinaryPath(), [
     '-s',
@@ -306,7 +298,7 @@ export const reversePort = async (
 
 export const stopApp = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<void> => {
   await spawn(getAdbBinaryPath(), [
     '-s',
@@ -322,7 +314,7 @@ export const startApp = async (
   adbId: string,
   bundleId: string,
   activityName: string,
-  options?: AndroidAppLaunchOptions,
+  options?: AndroidAppLaunchOptions
 ): Promise<void> => {
   await spawn(getAdbBinaryPath(), [
     '-s',
@@ -341,7 +333,7 @@ export const getDeviceIds = async (): Promise<string[]> => {
 };
 
 export const getEmulatorName = async (
-  adbId: string,
+  adbId: string
 ): Promise<string | null> => {
   const { stdout } = await spawn(getAdbBinaryPath(), [
     '-s',
@@ -355,7 +347,7 @@ export const getEmulatorName = async (
 
 export const getShellProperty = async (
   adbId: string,
-  property: string,
+  property: string
 ): Promise<string | null> => {
   const { stdout } = await spawn(getAdbBinaryPath(), [
     '-s',
@@ -377,7 +369,7 @@ export type DeviceInfo = {
 };
 
 export const getDeviceInfo = async (
-  adbId: string,
+  adbId: string
 ): Promise<DeviceInfo | null> => {
   const manufacturer = await getShellProperty(adbId, 'ro.product.manufacturer');
   const model = await getShellProperty(adbId, 'ro.product.model');
@@ -386,7 +378,7 @@ export const getDeviceInfo = async (
 
 const getRequestedPermissions = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<string[]> => {
   const { stdout } = await spawn(getAdbBinaryPath(), [
     '-s',
@@ -476,14 +468,14 @@ export const stopEmulator = async (adbId: string): Promise<void> => {
 
 export const installApp = async (
   adbId: string,
-  appPath: string,
+  appPath: string
 ): Promise<void> => {
   await spawn(getAdbBinaryPath(), ['-s', adbId, 'install', '-r', appPath]);
 };
 
 export const uninstallApp = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<void> => {
   await spawn(getAdbBinaryPath(), ['-s', adbId, 'uninstall', bundleId]);
 };
@@ -502,20 +494,27 @@ export const createAvd = async ({
 }: CreateAvdOptions): Promise<void> => {
   const systemImagePackage = getAndroidSystemImagePackage(
     apiLevel,
-    getHostAndroidSystemImageArch(),
+    getHostAndroidSystemImageArch()
   );
 
   await verifyAndroidEmulatorSdk(apiLevel);
   await ensureAvdProfileAvailable(profile);
   await spawn('bash', [
     '-lc',
-    `printf 'no\n' | "${getAvdManagerBinaryPath()}" create avd --force --name "${name}" --package "${systemImagePackage}" --device "${profile}" -p "${getAvdDirectory(name)}"`,
+    `printf 'no\n' | "${getAvdManagerBinaryPath()}" create avd --force --name "${name}" --package "${systemImagePackage}" --device "${profile}" -p "${getAvdDirectory(
+      name
+    )}"`,
   ]);
   await ensureAvdIniExists({ name, apiLevel });
   const configPath = await ensureAvdConfigExists(name);
+  // hw.cpu.ncore is baked into config.ini (rather than passed as a `-cores`
+  // boot flag) so it's part of the AVD's persisted hardware profile: boot
+  // snapshots require an identical hardware config to load, so the vCPU
+  // count must be fixed at AVD-creation time and stay consistent across
+  // boots.
   await spawn('bash', [
     '-lc',
-    `printf '%s\n%s\n' 'disk.dataPartition.size=${diskSize}' 'vm.heapSize=${heapSize}' >> "${configPath}"`,
+    `printf '%s\n%s\n%s\n' 'disk.dataPartition.size=${diskSize}' 'vm.heapSize=${heapSize}' 'hw.cpu.ncore=${getEmulatorCpuCores()}' >> "${configPath}"`,
   ]);
 };
 
@@ -527,7 +526,7 @@ export const deleteAvd = async (name: string): Promise<void> => {
     {
       force: true,
       recursive: true,
-    },
+    }
   );
   await rm(
     `${
@@ -535,18 +534,18 @@ export const deleteAvd = async (name: string): Promise<void> => {
     }/${name}.ini`,
     {
       force: true,
-    },
+    }
   );
 };
 
 export const startEmulator = async (
   name: string,
-  mode: EmulatorBootMode = 'default-boot',
+  mode: EmulatorBootMode = 'default-boot'
 ): Promise<void> => {
   const emulatorBinaryPath = await ensureEmulatorInstalled();
   const childProcess = emulatorProcess.startDetachedProcess(
     emulatorBinaryPath,
-    getEmulatorStartupArgs(name, mode),
+    getEmulatorStartupArgs(name, mode)
   );
 
   let stdout = '';
@@ -582,7 +581,7 @@ export const startEmulator = async (
           stdout,
           stderr,
           error,
-        }),
+        })
       );
     });
 
@@ -594,7 +593,7 @@ export const startEmulator = async (
           stderr,
           exitCode,
           signal,
-        }),
+        })
       );
     });
   });
@@ -609,13 +608,19 @@ export const startEmulator = async (
       throw error;
     });
 
-  const observationTimeout = wait(EMULATOR_STARTUP_OBSERVATION_TIMEOUT_MS).then(
-    () => 'timeout' as const,
+  const observationTimer = delay(EMULATOR_STARTUP_OBSERVATION_TIMEOUT_MS);
+  const observationTimeout = observationTimer.promise.then(
+    () => 'timeout' as const
   );
 
   try {
     await Promise.race([earlyExit, observedBoot, observationTimeout]);
   } finally {
+    // If `earlyExit` or `observedBoot` won the race, this timer would
+    // otherwise sit ref'd in the event loop for the rest of its 5s;
+    // cancelling here is a no-op on the happy "proceed detached" path
+    // where the timer itself won.
+    observationTimer.cancel();
     cleanup();
   }
 
@@ -626,7 +631,7 @@ export const startEmulator = async (
 
 export const waitForEmulator = async (
   name: string,
-  signal: AbortSignal,
+  signal: AbortSignal
 ): Promise<string> => {
   while (!signal.aborted) {
     const adbIds = await getDeviceIds();
@@ -651,7 +656,7 @@ export const waitForEmulator = async (
 
 export const waitForEmulatorDisconnect = async (
   adbId: string,
-  signal: AbortSignal,
+  signal: AbortSignal
 ): Promise<void> => {
   while (!signal.aborted) {
     const adbIds = await getDeviceIds();
@@ -668,7 +673,7 @@ export const waitForEmulatorDisconnect = async (
 
 export const waitForBoot = async (
   name: string,
-  signal: AbortSignal,
+  signal: AbortSignal
 ): Promise<string> => {
   while (!signal.aborted) {
     const adbIds = await getDeviceIds();
@@ -697,8 +702,15 @@ export const waitForBoot = async (
 
 export const isAppRunning = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<boolean> => {
+  return (await getAppPid(adbId, bundleId)) != null;
+};
+
+export const getAppPid = async (
+  adbId: string,
+  bundleId: string
+): Promise<number | null> => {
   try {
     const { stdout } = await spawn(getAdbBinaryPath(), [
       '-s',
@@ -707,10 +719,15 @@ export const isAppRunning = async (
       'pidof',
       bundleId,
     ]);
-    return stdout.trim() !== '';
+    const pid = stdout
+      .trim()
+      .split(/\s+/)
+      .find((value) => value !== '');
+
+    return pid ? Number(pid) : null;
   } catch (error) {
     if (error instanceof SubprocessError && error.exitCode === 1) {
-      return false;
+      return null;
     }
 
     throw error;
@@ -719,7 +736,7 @@ export const isAppRunning = async (
 
 export const getAppUid = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<number> => {
   const { stdout } = await spawn(getAdbBinaryPath(), [
     '-s',
@@ -744,7 +761,7 @@ export const getAppUid = async (
 
 export const setHideErrorDialogs = async (
   adbId: string,
-  hide: boolean,
+  hide: boolean
 ): Promise<void> => {
   await spawn(getAdbBinaryPath(), [
     '-s',
@@ -773,12 +790,61 @@ export const getLogcatTimestamp = async (adbId: string): Promise<string> => {
 export const startLogcat = (
   adbId: string,
   args: readonly string[],
+  options?: { signal?: AbortSignal }
 ): Subprocess =>
   spawn(getAdbBinaryPath(), ['-s', adbId, ...args], {
     stdout: 'pipe',
     stderr: 'pipe',
+    signal: options?.signal,
   });
 
+export const DROPBOX_CRASH_TAGS = [
+  'data_app_crash',
+  'data_app_native_crash',
+] as const;
+
+export const getDropboxPrint = async (
+  adbId: string,
+  tags: readonly string[] = DROPBOX_CRASH_TAGS
+): Promise<string> => {
+  // Android treats multiple args after --print as one search string, so each
+  // tag must be queried separately and merged on the host.
+  const outputs = await Promise.all(
+    tags.map(async (tag) => {
+      const { stdout } = await spawn(getAdbBinaryPath(), [
+        '-s',
+        adbId,
+        'shell',
+        'dumpsys',
+        'dropbox',
+        '--print',
+        tag,
+      ]);
+
+      return stdout;
+    })
+  );
+
+  return outputs.join('\n');
+};
+
+export const getActivityExitInfo = async (
+  adbId: string,
+  bundleId: string
+): Promise<string> => {
+  const { stdout } = await spawn(getAdbBinaryPath(), [
+    '-s',
+    adbId,
+    'shell',
+    'dumpsys',
+    'activity',
+    'exit-info',
+    bundleId,
+  ]);
+
+  return stdout;
+};
+
 export const getAvds = async (): Promise<string[]> => {
   try {
     const emulatorBinaryPath = await ensureEmulatorInstalled();
@@ -832,7 +898,7 @@ export const getConnectedDevices = async (): Promise<AdbDevice[]> => {
 
 export const grantPermissions = async (
   adbId: string,
-  bundleId: string,
+  bundleId: string
 ): Promise<void> => {
   androidAdbLogger.debug('grantPermissions:start %o', {
     adbId,
@@ -849,7 +915,7 @@ export const grantPermissions = async (
     getDangerousPermissions(adbId),
   ]);
   const permissions = requestedPermissions.filter((permission) =>
-    dangerousPermissions.has(permission),
+    dangerousPermissions.has(permission)
   );
 
   androidAdbLogger.debug('grantPermissions:resolved %o', {
@@ -885,7 +951,7 @@ export const grantPermissions = async (
     });
 
     await Promise.all(
-      grantCommands.map((args) => spawn(getAdbBinaryPath(), args as string[])),
+      grantCommands.map((args) => spawn(getAdbBinaryPath(), args as string[]))
     );
 
     androidAdbLogger.debug('grantPermissions:success %o', {