@react-native-harness/platform-android 1.4.0-rc.1 → 1.4.0

package/dist/emulator-startup.js

@@ -1,9 +1,24 @@
+import { getDeviceCoreBudget, logger, spawn, SubprocessError, } from '@react-native-harness/tools';
+import os from 'node:os';
+import { getEmulatorBinaryPath } from './environment.js';
+const emulatorStartupLogger = logger.child('android-emulator-startup');
+/**
+ * Returns the vCPU count baked into an AVD for this runner.
+ *
+ * AVD snapshots require an identical hardware configuration to load, so all
+ * AVD creation, compatibility, and cache-key callers must use this value on
+ * the same host.
+ */
+export const getEmulatorCpuCores = () => {
+    return getDeviceCoreBudget(os.availableParallelism());
+};
 const COMMON_EMULATOR_ARGS = [
     '-no-window',
     '-gpu',
     'swiftshader_indirect',
     '-noaudio',
     '-no-boot-anim',
+    '-no-metrics',
 ];
 export const getEmulatorStartupArgs = (name, mode) => {
     const modeArgs = mode === 'clean-snapshot-generation'
@@ -13,3 +28,46 @@ export const getEmulatorStartupArgs = (name, mode) => {
             : ['-no-snapshot-load', '-no-snapshot-save'];
     return [`@${name}`, ...modeArgs, ...COMMON_EMULATOR_ARGS];
 };
+/**
+ * Parses the output of `emulator -accel-check` to determine whether
+ * hardware acceleration (KVM on Linux, HVF on macOS) is usable. The
+ * emulator prints a message containing "is installed and usable" when
+ * acceleration is available.
+ */
+export const isAccelerationUsable = (accelCheckOutput) => {
+    return accelCheckOutput.includes('is installed and usable');
+};
+/**
+ * Runs `emulator -accel-check` and logs a non-fatal warning when hardware
+ * acceleration (KVM/HVF) appears unavailable, in which case the emulator
+ * falls back to very slow software emulation. This check must never fail or
+ * block emulator startup - any error running it is swallowed and only
+ * debug-logged.
+ */
+export const warnIfEmulatorAccelerationUnavailable = async () => {
+    let combinedOutput;
+    try {
+        const emulatorBinaryPath = getEmulatorBinaryPath();
+        const { stdout, stderr } = await spawn(emulatorBinaryPath, [
+            '-accel-check',
+        ]);
+        combinedOutput = `${stdout}\n${stderr}`;
+    }
+    catch (error) {
+        if (error instanceof SubprocessError) {
+            // The check itself ran but exited non-zero - this is how
+            // `-accel-check` reports that acceleration is unavailable, so treat
+            // its output as a normal (non-fatal) result rather than swallowing it.
+            combinedOutput = `${error.stdout}\n${error.stderr}`;
+        }
+        else {
+            // Failed to even run the check (e.g. binary missing). This must never
+            // fail or block emulator startup.
+            emulatorStartupLogger.debug('Failed to run "emulator -accel-check": %o', error);
+            return;
+        }
+    }
+    if (!isAccelerationUsable(combinedOutput)) {
+        logger.warn('Hardware acceleration (KVM/HVF) appears unavailable for the Android emulator. It will fall back to very slow software emulation.');
+    }
+};

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { androidEmulator, physicalAndroidDevice, androidPlatform, } from './fact
 export type { AndroidPlatformConfig } from './config.js';
 export { getNormalizedAvdCacheConfig, resolveAvdCachingEnabled, } from './avd-config.js';
 export { getHostAndroidSystemImageArch } from './environment.js';
+export { getEmulatorCpuCores } from './emulator-startup.js';
 export { HarnessAppPathError, HarnessEmulatorConfigError } from './errors.js';
 export { getRunTargets } from './targets.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,GACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,GACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 export { androidEmulator, physicalAndroidDevice, androidPlatform, } from './factory.js';
 export { getNormalizedAvdCacheConfig, resolveAvdCachingEnabled, } from './avd-config.js';
 export { getHostAndroidSystemImageArch } from './environment.js';
+export { getEmulatorCpuCores } from './emulator-startup.js';
 export { HarnessAppPathError, HarnessEmulatorConfigError } from './errors.js';
 export { getRunTargets } from './targets.js';

package/dist/instance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"instance.d.ts","sourceRoot":"","sources":["../src/instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,0BAA0B,EAC/B,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE5E,OAAO,EACL,qBAAqB,EAGtB,MAAM,aAAa,CAAC;AAuKrB,eAAO,MAAM,kCAAkC,GAC7C,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,MAAM,0BAA0B,KAC/B,OAAO,CAAC,qBAAqB,CA8H/B,CAAC;AAEF,eAAO,MAAM,wCAAwC,GACnD,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,OAAO,0BAA0B,KAChC,OAAO,CAAC,qBAAqB,CAyD/B,CAAC"}
+{"version":3,"file":"instance.d.ts","sourceRoot":"","sources":["../src/instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,0BAA0B,EAC/B,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE5E,OAAO,EACL,qBAAqB,EAGtB,MAAM,aAAa,CAAC;AAyKrB,eAAO,MAAM,kCAAkC,GAC7C,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,MAAM,0BAA0B,KAC/B,OAAO,CAAC,qBAAqB,CAoI/B,CAAC;AAEF,eAAO,MAAM,wCAAwC,GACnD,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,OAAO,0BAA0B,KAChC,OAAO,CAAC,qBAAqB,CA+D/B,CAAC"}

package/dist/instance.js

@@ -1,13 +1,14 @@
 import { AppNotInstalledError, DeviceNotFoundError, } from '@react-native-harness/platforms';
-import { logger } from '@react-native-harness/tools';
+import { instrumented, logger, noopDiagnostics } from '@react-native-harness/tools';
 import { assertAndroidDeviceEmulator, assertAndroidDevicePhysical, } from './config.js';
 import { isAvdCompatible, readAvdConfig, resolveAvdCachingEnabled, } from './avd-config.js';
 import { getAdbId } from './adb-id.js';
-import * as adb from './adb.js';
+import * as adbModule from './adb.js';
 import { applyHarnessDebugHttpHost, clearHarnessDebugHttpHost, } from './shared-prefs.js';
 import { getDeviceName } from './utils.js';
 import { HarnessAppPathError, HarnessEmulatorConfigError } from './errors.js';
 import { ensureAndroidEmulatorAvailable, ensureAndroidEmulatorEnvironment, getHostAndroidSystemImageArch, } from './environment.js';
+import { warnIfEmulatorAccelerationUnavailable } from './emulator-startup.js';
 import { isInteractive } from '@react-native-harness/tools';
 import fs from 'node:fs';
 import { createAndroidAppSession } from './app-session.js';
@@ -35,23 +36,24 @@ const getOptionalHarnessAppPath = () => {
 const configureAndroidRuntime = async (adbId, config, harnessConfig) => {
     const metroPort = harnessConfig.metroPort;
     await Promise.all([
-        adb.reversePort(adbId, metroPort),
-        adb.reversePort(adbId, 8080),
-        adb.setHideErrorDialogs(adbId, true),
+        adbModule.reversePort(adbId, metroPort),
+        adbModule.reversePort(adbId, 8080),
+        adbModule.setHideErrorDialogs(adbId, true),
         applyHarnessDebugHttpHost(adbId, config.bundleId, `localhost:${metroPort}`),
     ]);
-    return adb.getAppUid(adbId, config.bundleId);
+    return adbModule.getAppUid(adbId, config.bundleId);
 };
 const startAndWaitForBoot = async ({ emulatorName, signal, mode, }) => {
     await ensureAndroidEmulatorAvailable();
-    await adb.startEmulator(emulatorName, mode);
-    return adb.waitForBoot(emulatorName, signal);
+    await warnIfEmulatorAccelerationUnavailable();
+    await adbModule.startEmulator(emulatorName, mode);
+    return adbModule.waitForBoot(emulatorName, signal);
 };
 const recreateAvd = async ({ emulatorConfig, }) => {
     if (!emulatorConfig.avd) {
         throw new HarnessEmulatorConfigError(emulatorConfig.name);
     }
-    await adb.createAvd({
+    await adbModule.createAvd({
         name: emulatorConfig.name,
         apiLevel: emulatorConfig.avd.apiLevel,
         profile: emulatorConfig.avd.profile,
@@ -62,7 +64,7 @@ const recreateAvd = async ({ emulatorConfig, }) => {
 const prepareCachedAvd = async ({ emulatorConfig, signal, }) => {
     const emulatorName = emulatorConfig.name;
     const hostArch = getHostAndroidSystemImageArch();
-    const hasExistingAvd = await adb.hasAvd(emulatorName);
+    const hasExistingAvd = await adbModule.hasAvd(emulatorName);
     const avdConfig = hasExistingAvd ? await readAvdConfig(emulatorName) : null;
     const compatibility = avdConfig == null
         ? { compatible: false, reason: 'Missing AVD config.ini.' }
@@ -77,7 +79,7 @@ const prepareCachedAvd = async ({ emulatorConfig, signal, }) => {
             : 'Creating Android emulator %s...', emulatorName);
         if (hasExistingAvd && !compatibility.compatible) {
             androidInstanceLogger.debug('Android AVD %s is not reusable: %s', emulatorName, compatibility.reason);
-            await adb.deleteAvd(emulatorName);
+            await adbModule.deleteAvd(emulatorName);
         }
         await recreateAvd({ emulatorConfig });
         const generationAdbId = await startAndWaitForBoot({
@@ -86,8 +88,8 @@ const prepareCachedAvd = async ({ emulatorConfig, signal, }) => {
             mode: 'clean-snapshot-generation',
         });
         logger.info('Saving Android emulator snapshot for %s...', emulatorName);
-        await adb.stopEmulator(generationAdbId);
-        await adb.waitForEmulatorDisconnect(generationAdbId, signal);
+        await adbModule.stopEmulator(generationAdbId);
+        await adbModule.waitForEmulatorDisconnect(generationAdbId, signal);
     }
     else {
         logger.info('Using cached Android emulator %s...', emulatorName);
@@ -100,6 +102,7 @@ const prepareCachedAvd = async ({ emulatorConfig, signal, }) => {
 };
 export const getAndroidEmulatorPlatformInstance = async (config, harnessConfig, init) => {
     assertAndroidDeviceEmulator(config.device);
+    const adb = instrumented(adbModule, 'platform.android.adb', init.diagnostics ?? noopDiagnostics);
     const permissionsEnabled = harnessConfig.permissions ?? false;
     const emulatorConfig = config.device;
     const emulatorName = emulatorConfig.name;
@@ -169,10 +172,11 @@ export const getAndroidEmulatorPlatformInstance = async (config, harnessConfig,
                 stopApp: () => adb.stopApp(adbId, config.bundleId),
                 getAppPid: () => adb.getAppPid(adbId, config.bundleId),
                 getLogcatTimestamp: () => adb.getLogcatTimestamp(adbId),
-                startLogcat: (args) => adb.startLogcat(adbId, args),
+                startLogcat: (args, options) => adb.startLogcat(adbId, args, options),
                 getDropboxOutput: () => adb.getDropboxPrint(adbId),
                 getExitInfo: () => adb.getActivityExitInfo(adbId, config.bundleId),
                 crashArtifactWriter: init.crashArtifactWriter,
+                signal: init.signal,
             });
         },
         dispose: async () => {
@@ -188,6 +192,7 @@ export const getAndroidEmulatorPlatformInstance = async (config, harnessConfig,
 };
 export const getAndroidPhysicalDevicePlatformInstance = async (config, harnessConfig, init) => {
     assertAndroidDevicePhysical(config.device);
+    const adb = instrumented(adbModule, 'platform.android.adb', init?.diagnostics ?? noopDiagnostics);
     const permissionsEnabled = harnessConfig.permissions ?? false;
     const adbId = await getAdbId(config.device);
     if (!adbId) {
@@ -213,10 +218,11 @@ export const getAndroidPhysicalDevicePlatformInstance = async (config, harnessCo
                 stopApp: () => adb.stopApp(adbId, config.bundleId),
                 getAppPid: () => adb.getAppPid(adbId, config.bundleId),
                 getLogcatTimestamp: () => adb.getLogcatTimestamp(adbId),
-                startLogcat: (args) => adb.startLogcat(adbId, args),
+                startLogcat: (args, options) => adb.startLogcat(adbId, args, options),
                 getDropboxOutput: () => adb.getDropboxPrint(adbId),
                 getExitInfo: () => adb.getActivityExitInfo(adbId, config.bundleId),
                 crashArtifactWriter: init?.crashArtifactWriter,
+                signal: init?.signal,
             });
         },
         dispose: async () => {

package/dist/runner.d.ts

@@ -1,6 +1,6 @@
-import { HarnessPlatformRunner, type HarnessPlatformInitOptions } from '@react-native-harness/platforms';
+import { type HarnessPlatformRunnerFactory } from '@react-native-harness/platforms';
 import type { Config as HarnessConfig } from '@react-native-harness/config';
 import { type AndroidPlatformConfig } from './config.js';
-declare const getAndroidRunner: (config: AndroidPlatformConfig, harnessConfig: HarnessConfig, init: HarnessPlatformInitOptions) => Promise<HarnessPlatformRunner>;
+declare const getAndroidRunner: HarnessPlatformRunnerFactory<AndroidPlatformConfig, HarnessConfig>;
 export default getAndroidRunner;
 //# sourceMappingURL=runner.d.ts.map

package/dist/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,0BAA0B,EAChC,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAEL,KAAK,qBAAqB,EAE3B,MAAM,aAAa,CAAC;AAUrB,QAAA,MAAM,gBAAgB,GACpB,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,MAAM,0BAA0B,KAC/B,OAAO,CAAC,qBAAqB,CAoB/B,CAAC;AAEF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAEL,KAAK,qBAAqB,EAE3B,MAAM,aAAa,CAAC;AAUrB,QAAA,MAAM,gBAAgB,EAAE,4BAA4B,CAClD,qBAAqB,EACrB,aAAa,CAqBd,CAAC;AAEF,eAAe,gBAAgB,CAAC"}