@react-native-harness/platform-android 1.1.0-rc.4 → 1.2.0-rc.1

package/dist/adb.js

@@ -1,8 +1,10 @@
-import { spawn, SubprocessError } from '@react-native-harness/tools';
+import { logger, spawn, SubprocessError } from '@react-native-harness/tools';
 import { spawn as nodeSpawn } from 'node:child_process';
 import { access, rm } from 'node:fs/promises';
+import { getAvdConfigPath, getAvdDirectory, readAvdConfig, } from './avd-config.js';
 import { ensureAndroidEmulatorAvailable, ensureAndroidSdkPackages, getAdbBinaryPath, getAndroidSystemImagePackage, getAvdManagerBinaryPath, getEmulatorBinaryPath, getHostAndroidSystemImageArch, getRequiredAndroidSdkPackages, } from './environment.js';
 import { getEmulatorStartupArgs, } from './emulator-startup.js';
+import { AdbAppNotInstalledError, AdbPermissionGrantError, } from './adb-errors.js';
 const wait = async (ms) => {
     await new Promise((resolve) => {
         setTimeout(resolve, ms);
@@ -24,9 +26,9 @@ const waitWithSignal = async (ms, signal) => {
     }
     await Promise.race([wait(ms), waitForAbort(signal)]);
 };
-const getAvdConfigPath = (name) => `${process.env.ANDROID_AVD_HOME ?? `${process.env.HOME}/.android/avd`}/${name}.avd/config.ini`;
 const EMULATOR_STARTUP_OBSERVATION_TIMEOUT_MS = 5000;
 const EMULATOR_OUTPUT_BUFFER_LIMIT = 16 * 1024;
+const androidAdbLogger = logger.child('android-adb');
 export const emulatorProcess = {
     startDetachedProcess: (file, args) => nodeSpawn(file, args, {
         detached: true,
@@ -79,6 +81,43 @@ export const getRequiredEmulatorPackages = (apiLevel) => {
 export const verifyAndroidEmulatorSdk = async (apiLevel) => {
     await ensureAndroidSdkPackages(getRequiredEmulatorPackages(apiLevel));
 };
+const listAvdProfiles = async () => {
+    const { stdout } = await spawn(getAvdManagerBinaryPath(), ['list', 'device']);
+    return stdout
+        .split('\n')
+        .map((line) => line.match(/^id:\s+\d+\s+or\s+"([^"]+)"/i)?.[1]?.trim())
+        .filter((profile) => profile != null && profile !== '');
+};
+const ensureAvdProfileAvailable = async (profile) => {
+    const availableProfiles = await listAvdProfiles();
+    if (availableProfiles.includes(profile)) {
+        return;
+    }
+    const availableProfilesList = availableProfiles.length > 0
+        ? availableProfiles.join(', ')
+        : 'None reported by avdmanager.';
+    throw new Error(`Android AVD profile "${profile}" is not available on this machine. Available profiles: ${availableProfilesList}`);
+};
+const ensureAvdConfigExists = async (name) => {
+    const configPath = getAvdConfigPath(name);
+    if ((await readAvdConfig(name)) == null) {
+        throw new Error(`Android AVD "${name}" was created, but config.ini was not found at ${configPath}.`);
+    }
+    return configPath;
+};
+const getAvdIniPath = (name) => {
+    const avdHome = process.env.ANDROID_AVD_HOME ?? `${process.env.HOME}/.android/avd`;
+    return `${avdHome}/${name}.ini`;
+};
+const ensureAvdIniExists = async ({ name, apiLevel, }) => {
+    const iniPath = getAvdIniPath(name);
+    const avdDirectory = getAvdDirectory(name);
+    await spawn('bash', [
+        '-lc',
+        `printf '%s\n%s\n%s\n%s\n' 'avd.ini.encoding=UTF-8' 'path=${avdDirectory}' 'path.rel=avd/${name}.avd' 'target=android-${apiLevel}' > "${iniPath}"`,
+    ]);
+    return iniPath;
+};
 export const getStartAppArgs = (bundleId, activityName, options) => {
     const args = [
         'shell',
@@ -182,6 +221,61 @@ export const getDeviceInfo = async (adbId) => {
     const model = await getShellProperty(adbId, 'ro.product.model');
     return { manufacturer, model };
 };
+const getRequestedPermissions = async (adbId, bundleId) => {
+    const { stdout } = await spawn(getAdbBinaryPath(), [
+        '-s',
+        adbId,
+        'shell',
+        'dumpsys',
+        'package',
+        bundleId,
+    ]);
+    const requestedPermissions = new Set();
+    const lines = stdout.split('\n');
+    let inRequestedPermissionsSection = false;
+    for (const line of lines) {
+        const trimmedLine = line.trim();
+        if (trimmedLine === 'requested permissions:') {
+            inRequestedPermissionsSection = true;
+            continue;
+        }
+        if (!inRequestedPermissionsSection) {
+            continue;
+        }
+        if (trimmedLine === '') {
+            continue;
+        }
+        if (trimmedLine.endsWith(':')) {
+            break;
+        }
+        if (/^[a-zA-Z0-9_.]+$/.test(trimmedLine)) {
+            requestedPermissions.add(trimmedLine);
+            continue;
+        }
+        break;
+    }
+    return [...requestedPermissions];
+};
+const getDangerousPermissions = async (adbId) => {
+    const { stdout } = await spawn(getAdbBinaryPath(), [
+        '-s',
+        adbId,
+        'shell',
+        'pm',
+        'list',
+        'permissions',
+        '-g',
+        '-d',
+    ]);
+    const dangerousPermissions = new Set();
+    for (const match of stdout.matchAll(/permission:([a-zA-Z0-9_.]+)/g)) {
+        const permission = match[1]?.trim();
+        if (permission) {
+            dangerousPermissions.add(permission);
+        }
+    }
+    return dangerousPermissions;
+};
 export const isBootCompleted = async (adbId) => {
     try {
         const bootCompleted = await getShellProperty(adbId, 'sys.boot_completed');
@@ -200,6 +294,9 @@ export const stopEmulator = async (adbId) => {
 export const installApp = async (adbId, appPath) => {
     await spawn(getAdbBinaryPath(), ['-s', adbId, 'install', '-r', appPath]);
 };
+export const uninstallApp = async (adbId, bundleId) => {
+    await spawn(getAdbBinaryPath(), ['-s', adbId, 'uninstall', bundleId]);
+};
 export const hasAvd = async (name) => {
     const avds = await getAvds();
     return avds.includes(name);
@@ -207,13 +304,16 @@ export const hasAvd = async (name) => {
 export const createAvd = async ({ name, apiLevel, profile, diskSize, heapSize, }) => {
     const systemImagePackage = getAndroidSystemImagePackage(apiLevel, getHostAndroidSystemImageArch());
     await verifyAndroidEmulatorSdk(apiLevel);
+    await ensureAvdProfileAvailable(profile);
     await spawn('bash', [
         '-lc',
-        `printf 'no\n' | "${getAvdManagerBinaryPath()}" create avd --force --name "${name}" --package "${systemImagePackage}" --device "${profile}"`,
+        `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);
     await spawn('bash', [
         '-lc',
-        `printf '%s\n%s\n' 'disk.dataPartition.size=${diskSize}' 'vm.heapSize=${heapSize}' >> "${getAvdConfigPath(name)}"`,
+        `printf '%s\n%s\n' 'disk.dataPartition.size=${diskSize}' 'vm.heapSize=${heapSize}' >> "${configPath}"`,
     ]);
 };
 export const deleteAvd = async (name) => {
@@ -428,3 +528,62 @@ export const getConnectedDevices = async () => {
     }
     return devices;
 };
+export const grantPermissions = async (adbId, bundleId) => {
+    androidAdbLogger.debug('grantPermissions:start %o', {
+        adbId,
+        bundleId,
+    });
+    const isInstalled = await isAppInstalled(adbId, bundleId);
+    if (!isInstalled) {
+        throw new AdbAppNotInstalledError(bundleId, adbId);
+    }
+    const [requestedPermissions, dangerousPermissions] = await Promise.all([
+        getRequestedPermissions(adbId, bundleId),
+        getDangerousPermissions(adbId),
+    ]);
+    const permissions = requestedPermissions.filter((permission) => dangerousPermissions.has(permission));
+    androidAdbLogger.debug('grantPermissions:resolved %o', {
+        adbId,
+        bundleId,
+        requestedPermissions,
+        permissions,
+    });
+    if (permissions.length === 0) {
+        androidAdbLogger.debug('grantPermissions:skip %o', {
+            adbId,
+            bundleId,
+        });
+        return;
+    }
+    const grantCommands = permissions.map((permission) => [
+        '-s',
+        adbId,
+        'shell',
+        'pm',
+        'grant',
+        bundleId,
+        permission,
+    ]);
+    try {
+        androidAdbLogger.debug('grantPermissions:commands %o', {
+            adbId,
+            bundleId,
+            grantCommands,
+        });
+        await Promise.all(grantCommands.map((args) => spawn(getAdbBinaryPath(), args)));
+        androidAdbLogger.debug('grantPermissions:success %o', {
+            adbId,
+            bundleId,
+            permissions,
+        });
+    }
+    catch (error) {
+        androidAdbLogger.debug('grantPermissions:error %o', {
+            adbId,
+            bundleId,
+            permissions,
+            error,
+        });
+        throw new AdbPermissionGrantError(bundleId, permissions, adbId);
+    }
+};

package/dist/config.d.ts

@@ -68,8 +68,8 @@ export declare const AndroidEmulatorSchema: z.ZodObject<{
         } | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     type: "emulator";
+    name: string;
     avd?: {
         apiLevel: number;
         profile: string;
@@ -80,8 +80,8 @@ export declare const AndroidEmulatorSchema: z.ZodObject<{
         } | undefined;
     } | undefined;
 }, {
-    name: string;
     type: "emulator";
+    name: string;
     avd?: {
         apiLevel: number;
         profile: string;
@@ -97,13 +97,13 @@ export declare const PhysicalAndroidDeviceSchema: z.ZodObject<{
     manufacturer: z.ZodString;
     model: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    type: "physical";
     manufacturer: string;
     model: string;
-    type: "physical";
 }, {
+    type: "physical";
     manufacturer: string;
     model: string;
-    type: "physical";
 }>;
 export declare const AndroidDeviceSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"emulator">;
@@ -138,8 +138,8 @@ export declare const AndroidDeviceSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
         } | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     type: "emulator";
+    name: string;
     avd?: {
         apiLevel: number;
         profile: string;
@@ -150,8 +150,8 @@ export declare const AndroidDeviceSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
         } | undefined;
     } | undefined;
 }, {
-    name: string;
     type: "emulator";
+    name: string;
     avd?: {
         apiLevel: number;
         profile: string;
@@ -166,13 +166,13 @@ export declare const AndroidDeviceSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
     manufacturer: z.ZodString;
     model: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    type: "physical";
     manufacturer: string;
     model: string;
-    type: "physical";
 }, {
+    type: "physical";
     manufacturer: string;
     model: string;
-    type: "physical";
 }>]>;
 export declare const AndroidPlatformConfigSchema: z.ZodObject<{
     name: z.ZodString;
@@ -209,8 +209,8 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
             } | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
-        name: string;
         type: "emulator";
+        name: string;
         avd?: {
             apiLevel: number;
             profile: string;
@@ -221,8 +221,8 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     }, {
-        name: string;
         type: "emulator";
+        name: string;
         avd?: {
             apiLevel: number;
             profile: string;
@@ -237,13 +237,13 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
         manufacturer: z.ZodString;
         model: z.ZodString;
     }, "strip", z.ZodTypeAny, {
+        type: "physical";
         manufacturer: string;
         model: string;
-        type: "physical";
     }, {
+        type: "physical";
         manufacturer: string;
         model: string;
-        type: "physical";
     }>]>;
     bundleId: z.ZodString;
     activityName: z.ZodDefault<z.ZodString>;
@@ -257,8 +257,8 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     device: {
-        name: string;
         type: "emulator";
+        name: string;
         avd?: {
             apiLevel: number;
             profile: string;
@@ -269,9 +269,9 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     } | {
+        type: "physical";
         manufacturer: string;
         model: string;
-        type: "physical";
     };
     bundleId: string;
     activityName: string;
@@ -281,8 +281,8 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
 }, {
     name: string;
     device: {
-        name: string;
         type: "emulator";
+        name: string;
         avd?: {
             apiLevel: number;
             profile: string;
@@ -293,9 +293,9 @@ export declare const AndroidPlatformConfigSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     } | {
+        type: "physical";
         manufacturer: string;
         model: string;
-        type: "physical";
     };
     bundleId: string;
     activityName?: string | undefined;

package/dist/emulator-startup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emulator-startup.d.ts","sourceRoot":"","sources":["../src/emulator-startup.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GACxB,cAAc,GACd,2BAA2B,GAC3B,gBAAgB,CAAC;AAYrB,eAAO,MAAM,sBAAsB,GACjC,MAAM,MAAM,EACZ,MAAM,gBAAgB,KACrB,MAAM,EASR,CAAC"}
+{"version":3,"file":"emulator-startup.d.ts","sourceRoot":"","sources":["../src/emulator-startup.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GACxB,cAAc,GACd,2BAA2B,GAC3B,gBAAgB,CAAC;AAUrB,eAAO,MAAM,sBAAsB,GACjC,MAAM,MAAM,EACZ,MAAM,gBAAgB,KACrB,MAAM,EASR,CAAC"}

package/dist/emulator-startup.js

@@ -4,8 +4,6 @@ const COMMON_EMULATOR_ARGS = [
     'swiftshader_indirect',
     '-noaudio',
     '-no-boot-anim',
-    '-camera-back',
-    'none',
 ];
 export const getEmulatorStartupArgs = (name, mode) => {
     const modeArgs = mode === 'clean-snapshot-generation'

package/dist/instance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"instance.d.ts","sourceRoot":"","sources":["../src/instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,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;AAkKrB,eAAO,MAAM,kCAAkC,GAC7C,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,MAAM,0BAA0B,KAC/B,OAAO,CAAC,qBAAqB,CAkI/B,CAAC;AAEF,eAAO,MAAM,wCAAwC,GACnD,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,KAC3B,OAAO,CAAC,qBAAqB,CAiE/B,CAAC"}
+{"version":3,"file":"instance.d.ts","sourceRoot":"","sources":["../src/instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,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;AAgLrB,eAAO,MAAM,kCAAkC,GAC7C,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,EAC5B,MAAM,0BAA0B,KAC/B,OAAO,CAAC,qBAAqB,CA2I/B,CAAC;AAEF,eAAO,MAAM,wCAAwC,GACnD,QAAQ,qBAAqB,EAC7B,eAAe,aAAa,KAC3B,OAAO,CAAC,qBAAqB,CAsE/B,CAAC"}

package/dist/instance.js

@@ -29,6 +29,16 @@ const getHarnessAppPath = () => {
     }
     return appPath;
 };
+const getOptionalHarnessAppPath = () => {
+    const appPath = process.env.HARNESS_APP_PATH;
+    if (!appPath) {
+        return undefined;
+    }
+    if (!fs.existsSync(appPath)) {
+        throw new HarnessAppPathError('invalid', appPath);
+    }
+    return appPath;
+};
 const configureAndroidRuntime = async (adbId, config, harnessConfig) => {
     const metroPort = harnessConfig.metroPort;
     await Promise.all([
@@ -98,6 +108,7 @@ const prepareCachedAvd = async ({ emulatorConfig, signal, }) => {
 export const getAndroidEmulatorPlatformInstance = async (config, harnessConfig, init) => {
     assertAndroidDeviceEmulator(config.device);
     const detectNativeCrashes = harnessConfig.detectNativeCrashes ?? true;
+    const permissionsEnabled = harnessConfig.permissions ?? false;
     const emulatorConfig = config.device;
     const emulatorName = emulatorConfig.name;
     const avdConfig = emulatorConfig.avd;
@@ -141,11 +152,19 @@ export const getAndroidEmulatorPlatformInstance = async (config, harnessConfig,
     }
     androidInstanceLogger.debug('waiting for Android emulator %s to finish booting', adbId);
     const isInstalled = await adb.isAppInstalled(adbId, config.bundleId);
-    if (!isInstalled) {
-        const appPath = getHarnessAppPath();
+    const appPath = getOptionalHarnessAppPath();
+    if (isInstalled && appPath) {
+        await adb.uninstallApp(adbId, config.bundleId);
         await adb.installApp(adbId, appPath);
     }
+    else if (!isInstalled) {
+        const installPath = appPath ?? getHarnessAppPath();
+        await adb.installApp(adbId, installPath);
+    }
     const appUid = await configureAndroidRuntime(adbId, config, harnessConfig);
+    if (permissionsEnabled) {
+        await adb.grantPermissions(adbId, config.bundleId);
+    }
     return {
         startApp: async (options) => {
             await adb.startApp(adbId, config.bundleId, config.activityName, options ??
@@ -187,6 +206,7 @@ export const getAndroidEmulatorPlatformInstance = async (config, harnessConfig,
 export const getAndroidPhysicalDevicePlatformInstance = async (config, harnessConfig) => {
     assertAndroidDevicePhysical(config.device);
     const detectNativeCrashes = harnessConfig.detectNativeCrashes ?? true;
+    const permissionsEnabled = harnessConfig.permissions ?? false;
     const adbId = await getAdbId(config.device);
     if (!adbId) {
         throw new DeviceNotFoundError(getDeviceName(config.device));
@@ -196,6 +216,9 @@ export const getAndroidPhysicalDevicePlatformInstance = async (config, harnessCo
         throw new AppNotInstalledError(config.bundleId, getDeviceName(config.device));
     }
     const appUid = await configureAndroidRuntime(adbId, config, harnessConfig);
+    if (permissionsEnabled) {
+        await adb.grantPermissions(adbId, config.bundleId);
+    }
     return {
         startApp: async (options) => {
             await adb.startApp(adbId, config.bundleId, config.activityName, options ??