agent-device 0.4.2 → 0.5.0

package/src/platforms/android/__tests__/index.test.ts

@@ -1,274 +0,0 @@
-import test from 'node:test';
-import assert from 'node:assert/strict';
-import { promises as fs } from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
-import { inferAndroidAppName, listAndroidApps, openAndroidApp, parseAndroidLaunchComponent, swipeAndroid } from '../index.ts';
-import type { DeviceInfo } from '../../../utils/device.ts';
-import { AppError } from '../../../utils/errors.ts';
-import { findBounds, parseUiHierarchy } from '../ui-hierarchy.ts';
-
-test('parseUiHierarchy reads double-quoted Android node attributes', () => {
-  const xml =
-    '<hierarchy><node class="android.widget.TextView" text="Hello" content-desc="Greeting" resource-id="com.demo:id/title" bounds="[10,20][110,60]" clickable="true" enabled="true"/></hierarchy>';
-
-  const result = parseUiHierarchy(xml, 800, { raw: true });
-  assert.equal(result.nodes.length, 1);
-  assert.equal(result.nodes[0].value, 'Hello');
-  assert.equal(result.nodes[0].label, 'Hello');
-  assert.equal(result.nodes[0].identifier, 'com.demo:id/title');
-  assert.deepEqual(result.nodes[0].rect, { x: 10, y: 20, width: 100, height: 40 });
-  assert.equal(result.nodes[0].hittable, true);
-  assert.equal(result.nodes[0].enabled, true);
-});
-
-test('parseUiHierarchy reads single-quoted Android node attributes', () => {
-  const xml =
-    "<hierarchy><node class='android.widget.TextView' text='Hello' content-desc='Greeting' resource-id='com.demo:id/title' bounds='[10,20][110,60]' clickable='true' enabled='true'/></hierarchy>";
-
-  const result = parseUiHierarchy(xml, 800, { raw: true });
-  assert.equal(result.nodes.length, 1);
-  assert.equal(result.nodes[0].value, 'Hello');
-  assert.equal(result.nodes[0].label, 'Hello');
-  assert.equal(result.nodes[0].identifier, 'com.demo:id/title');
-  assert.deepEqual(result.nodes[0].rect, { x: 10, y: 20, width: 100, height: 40 });
-  assert.equal(result.nodes[0].hittable, true);
-  assert.equal(result.nodes[0].enabled, true);
-});
-
-test('parseUiHierarchy supports mixed quote styles in one node', () => {
-  const xml =
-    '<hierarchy><node class="android.widget.TextView" text=\'Hello\' content-desc="Greeting" resource-id=\'com.demo:id/title\' bounds="[10,20][110,60]"/></hierarchy>';
-
-  const result = parseUiHierarchy(xml, 800, { raw: true });
-  assert.equal(result.nodes.length, 1);
-  assert.equal(result.nodes[0].value, 'Hello');
-  assert.equal(result.nodes[0].label, 'Hello');
-  assert.equal(result.nodes[0].identifier, 'com.demo:id/title');
-});
-
-test('findBounds supports single and double quoted attributes', () => {
-  const xml = [
-    '<hierarchy>',
-    '<node text="Nothing" content-desc="Irrelevant" bounds="[0,0][10,10]"/>',
-    "<node text='Target from single quote' content-desc='Alt single' bounds='[100,200][300,500]'/>",
-    '<node text="Target from double quote" content-desc="Alt double" bounds="[50,50][150,250]"/>',
-    '</hierarchy>',
-  ].join('');
-
-  assert.deepEqual(findBounds(xml, 'single quote'), { x: 200, y: 350 });
-  assert.deepEqual(findBounds(xml, 'alt double'), { x: 100, y: 150 });
-});
-
-test('parseUiHierarchy ignores attribute-name prefix spoofing', () => {
-  const xml =
-    "<hierarchy><node class='android.widget.TextView' hint-text='Spoofed' text='Actual' bounds='[10,20][110,60]'/></hierarchy>";
-
-  const result = parseUiHierarchy(xml, 800, { raw: true });
-  assert.equal(result.nodes.length, 1);
-  assert.equal(result.nodes[0].value, 'Actual');
-});
-
-test('findBounds ignores bounds-like fragments inside other attribute values', () => {
-  const xml = [
-    '<hierarchy>',
-    "<node text='Target' content-desc=\"metadata bounds='[900,900][1000,1000]'\" bounds='[100,200][300,500]'/>",
-    '</hierarchy>',
-  ].join('');
-
-  assert.deepEqual(findBounds(xml, 'target'), { x: 200, y: 350 });
-});
-
-test('parseAndroidLaunchComponent extracts final resolved component', () => {
-  const stdout = [
-    'priority=0 preferredOrder=0 match=0x108000 specificIndex=-1 isDefault=true',
-    'com.boatsgroup.boattrader/com.boatsgroup.boattrader.MainActivity',
-  ].join('\n');
-  assert.equal(
-    parseAndroidLaunchComponent(stdout),
-    'com.boatsgroup.boattrader/com.boatsgroup.boattrader.MainActivity',
-  );
-});
-
-test('parseAndroidLaunchComponent returns null when no component is present', () => {
-  const stdout = 'No activity found';
-  assert.equal(parseAndroidLaunchComponent(stdout), null);
-});
-
-test('inferAndroidAppName derives readable names from package ids', () => {
-  assert.equal(inferAndroidAppName('com.android.settings'), 'Settings');
-  assert.equal(inferAndroidAppName('com.google.android.apps.maps'), 'Maps');
-  assert.equal(inferAndroidAppName('org.mozilla.firefox'), 'Firefox');
-  assert.equal(inferAndroidAppName('com.facebook.katana'), 'Katana');
-  assert.equal(inferAndroidAppName('single'), 'Single');
-  assert.equal(inferAndroidAppName('com.android.app.services'), 'Services');
-});
-
-test('listAndroidApps returns launchable apps with inferred names', async () => {
-  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'agent-device-android-apps-all-'));
-  const adbPath = path.join(tmpDir, 'adb');
-  await fs.writeFile(
-    adbPath,
-    [
-      '#!/bin/sh',
-      'if [ "$1" = "-s" ]; then',
-      '  shift',
-      '  shift',
-      'fi',
-      'if [ "$1" = "shell" ] && [ "$2" = "cmd" ] && [ "$3" = "package" ] && [ "$4" = "query-activities" ]; then',
-      '  echo "com.google.android.apps.maps/.MainActivity"',
-      '  echo "org.mozilla.firefox/.App"',
-      '  echo "com.android.settings/.Settings"',
-      '  exit 0',
-      'fi',
-      'if [ "$1" = "shell" ] && [ "$2" = "pm" ] && [ "$3" = "list" ] && [ "$4" = "packages" ] && [ "$5" = "-3" ]; then',
-      '  echo "package:com.google.android.apps.maps"',
-      '  echo "package:com.example.serviceonly"',
-      '  echo "package:org.mozilla.firefox"',
-      '  exit 0',
-      'fi',
-      'echo "unexpected args: $@" >&2',
-      'exit 1',
-      '',
-    ].join('\n'),
-    'utf8',
-  );
-  await fs.chmod(adbPath, 0o755);
-
-  const previousPath = process.env.PATH;
-  process.env.PATH = `${tmpDir}${path.delimiter}${previousPath ?? ''}`;
-
-  const device: DeviceInfo = {
-    platform: 'android',
-    id: 'emulator-5554',
-    name: 'Pixel',
-    kind: 'emulator',
-    booted: true,
-  };
-
-  try {
-    const apps = await listAndroidApps(device, 'all');
-    assert.deepEqual(apps, [
-      { package: 'com.android.settings', name: 'Settings' },
-      { package: 'com.google.android.apps.maps', name: 'Maps' },
-      { package: 'org.mozilla.firefox', name: 'Firefox' },
-    ]);
-  } finally {
-    process.env.PATH = previousPath;
-    await fs.rm(tmpDir, { recursive: true, force: true });
-  }
-});
-
-test('listAndroidApps user-installed excludes non-launchable packages', async () => {
-  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'agent-device-android-apps-user-'));
-  const adbPath = path.join(tmpDir, 'adb');
-  await fs.writeFile(
-    adbPath,
-    [
-      '#!/bin/sh',
-      'if [ "$1" = "-s" ]; then',
-      '  shift',
-      '  shift',
-      'fi',
-      'if [ "$1" = "shell" ] && [ "$2" = "cmd" ] && [ "$3" = "package" ] && [ "$4" = "query-activities" ]; then',
-      '  echo "com.google.android.apps.maps/.MainActivity"',
-      '  echo "org.mozilla.firefox/.App"',
-      '  exit 0',
-      'fi',
-      'if [ "$1" = "shell" ] && [ "$2" = "pm" ] && [ "$3" = "list" ] && [ "$4" = "packages" ] && [ "$5" = "-3" ]; then',
-      '  echo "package:com.google.android.apps.maps"',
-      '  echo "package:com.example.serviceonly"',
-      '  echo "package:org.mozilla.firefox"',
-      '  exit 0',
-      'fi',
-      'echo "unexpected args: $@" >&2',
-      'exit 1',
-      '',
-    ].join('\n'),
-    'utf8',
-  );
-  await fs.chmod(adbPath, 0o755);
-
-  const previousPath = process.env.PATH;
-  process.env.PATH = `${tmpDir}${path.delimiter}${previousPath ?? ''}`;
-
-  const device: DeviceInfo = {
-    platform: 'android',
-    id: 'emulator-5554',
-    name: 'Pixel',
-    kind: 'emulator',
-    booted: true,
-  };
-
-  try {
-    const apps = await listAndroidApps(device, 'user-installed');
-    assert.deepEqual(apps, [
-      { package: 'com.google.android.apps.maps', name: 'Maps' },
-      { package: 'org.mozilla.firefox', name: 'Firefox' },
-    ]);
-  } finally {
-    process.env.PATH = previousPath;
-    await fs.rm(tmpDir, { recursive: true, force: true });
-  }
-});
-
-test('openAndroidApp rejects activity override for deep link URLs', async () => {
-  const device: DeviceInfo = {
-    platform: 'android',
-    id: 'emulator-5554',
-    name: 'Pixel',
-    kind: 'emulator',
-    booted: true,
-  };
-
-  await assert.rejects(
-    () => openAndroidApp(device, '  https://example.com/path  ', '.MainActivity'),
-    (error: unknown) => {
-      assert.equal(error instanceof AppError, true);
-      assert.equal((error as AppError).code, 'INVALID_ARGS');
-      return true;
-    },
-  );
-});
-
-test('swipeAndroid invokes adb input swipe with duration', async () => {
-  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'agent-device-swipe-test-'));
-  const adbPath = path.join(tmpDir, 'adb');
-  const argsLogPath = path.join(tmpDir, 'args.log');
-  await fs.writeFile(
-    adbPath,
-    '#!/bin/sh\nprintf "%s\\n" "$@" > "$AGENT_DEVICE_TEST_ARGS_FILE"\nexit 0\n',
-    'utf8',
-  );
-  await fs.chmod(adbPath, 0o755);
-
-  const previousPath = process.env.PATH;
-  const previousArgsFile = process.env.AGENT_DEVICE_TEST_ARGS_FILE;
-  process.env.PATH = `${tmpDir}${path.delimiter}${previousPath ?? ''}`;
-  process.env.AGENT_DEVICE_TEST_ARGS_FILE = argsLogPath;
-
-  const device: DeviceInfo = {
-    platform: 'android',
-    id: 'emulator-5554',
-    name: 'Pixel',
-    kind: 'emulator',
-    booted: true,
-  };
-
-  try {
-    await swipeAndroid(device, 10, 20, 30, 40, 250);
-    const args = (await fs.readFile(argsLogPath, 'utf8'))
-      .trim()
-      .split('\n')
-      .filter(Boolean);
-    assert.deepEqual(args, ['-s', 'emulator-5554', 'shell', 'input', 'swipe', '10', '20', '30', '40', '250']);
-  } finally {
-    process.env.PATH = previousPath;
-    if (previousArgsFile === undefined) {
-      delete process.env.AGENT_DEVICE_TEST_ARGS_FILE;
-    } else {
-      process.env.AGENT_DEVICE_TEST_ARGS_FILE = previousArgsFile;
-    }
-    await fs.rm(tmpDir, { recursive: true, force: true });
-  }
-});

package/src/platforms/android/devices.ts

@@ -1,196 +0,0 @@
-import { runCmd, whichCmd } from '../../utils/exec.ts';
-import type { ExecResult } from '../../utils/exec.ts';
-import { AppError, asAppError } from '../../utils/errors.ts';
-import type { DeviceInfo } from '../../utils/device.ts';
-import { Deadline, isEnvTruthy, retryWithPolicy, TIMEOUT_PROFILES, type RetryTelemetryEvent } from '../../utils/retry.ts';
-import { bootFailureHint, classifyBootFailure } from '../boot-diagnostics.ts';
-
-const EMULATOR_SERIAL_PREFIX = 'emulator-';
-const ANDROID_BOOT_POLL_MS = 1000;
-const RETRY_LOGS_ENABLED = isEnvTruthy(process.env.AGENT_DEVICE_RETRY_LOGS);
-
-function adbArgs(serial: string, args: string[]): string[] {
-  return ['-s', serial, ...args];
-}
-
-function isEmulatorSerial(serial: string): boolean {
-  return serial.startsWith(EMULATOR_SERIAL_PREFIX);
-}
-
-async function readAndroidBootProp(
-  serial: string,
-  timeoutMs = TIMEOUT_PROFILES.android_boot.operationMs,
-): Promise<ExecResult> {
-  return runCmd('adb', adbArgs(serial, ['shell', 'getprop', 'sys.boot_completed']), {
-    allowFailure: true,
-    timeoutMs,
-  });
-}
-
-async function resolveAndroidDeviceName(serial: string, rawModel: string): Promise<string> {
-  const modelName = rawModel.replace(/_/g, ' ').trim();
-  if (!isEmulatorSerial(serial)) return modelName || serial;
-  const avd = await runCmd('adb', adbArgs(serial, ['emu', 'avd', 'name']), {
-    allowFailure: true,
-    timeoutMs: TIMEOUT_PROFILES.android_boot.operationMs,
-  });
-  const avdName = avd.stdout.trim();
-  if (avd.exitCode === 0 && avdName) {
-    return avdName.replace(/_/g, ' ');
-  }
-  return modelName || serial;
-}
-
-export async function listAndroidDevices(): Promise<DeviceInfo[]> {
-  const adbAvailable = await whichCmd('adb');
-  if (!adbAvailable) {
-    throw new AppError('TOOL_MISSING', 'adb not found in PATH');
-  }
-
-  const result = await runCmd('adb', ['devices', '-l'], {
-    timeoutMs: TIMEOUT_PROFILES.android_boot.operationMs,
-  });
-  const lines = result.stdout.split('\n').map((l: string) => l.trim());
-  const entries = lines
-    .filter((line) => line.length > 0 && !line.startsWith('List of devices'))
-    .map((line) => line.split(/\s+/))
-    .filter((parts) => parts[1] === 'device')
-    .map((parts) => ({
-      serial: parts[0],
-      rawModel: (parts.find((p: string) => p.startsWith('model:')) ?? '').replace('model:', ''),
-    }));
-
-  const devices = await Promise.all(entries.map(async ({ serial, rawModel }) => {
-    const [name, booted] = await Promise.all([
-      resolveAndroidDeviceName(serial, rawModel),
-      isAndroidBooted(serial),
-    ]);
-    return {
-      platform: 'android',
-      id: serial,
-      name,
-      kind: isEmulatorSerial(serial) ? 'emulator' : 'device',
-      booted,
-    } satisfies DeviceInfo;
-  }));
-
-  return devices;
-}
-
-export async function isAndroidBooted(serial: string): Promise<boolean> {
-  try {
-    const result = await readAndroidBootProp(serial);
-    return result.stdout.trim() === '1';
-  } catch {
-    return false;
-  }
-}
-
-export async function waitForAndroidBoot(serial: string, timeoutMs = 60000): Promise<void> {
-  const timeoutBudget = timeoutMs;
-  const deadline = Deadline.fromTimeoutMs(timeoutBudget);
-  const maxAttempts = Math.max(1, Math.ceil(timeoutBudget / ANDROID_BOOT_POLL_MS));
-  let lastBootResult: ExecResult | undefined;
-  let timedOut = false;
-  try {
-    await retryWithPolicy(
-      async ({ deadline: attemptDeadline }) => {
-        if (attemptDeadline?.isExpired()) {
-          timedOut = true;
-          throw new AppError('COMMAND_FAILED', 'Android boot deadline exceeded', {
-            serial,
-            timeoutMs,
-            elapsedMs: deadline.elapsedMs(),
-            message: 'timeout',
-          });
-        }
-        const remainingMs = Math.max(1_000, attemptDeadline?.remainingMs() ?? timeoutBudget);
-        const result = await readAndroidBootProp(
-          serial,
-          Math.min(remainingMs, TIMEOUT_PROFILES.android_boot.operationMs),
-        );
-        lastBootResult = result;
-        if (result.stdout.trim() === '1') return;
-        throw new AppError('COMMAND_FAILED', 'Android device is still booting', {
-          serial,
-          stdout: result.stdout,
-          stderr: result.stderr,
-          exitCode: result.exitCode,
-        });
-      },
-      {
-        maxAttempts,
-        baseDelayMs: ANDROID_BOOT_POLL_MS,
-        maxDelayMs: ANDROID_BOOT_POLL_MS,
-        jitter: 0,
-        shouldRetry: (error) => {
-          const reason = classifyBootFailure({
-            error,
-            stdout: lastBootResult?.stdout,
-            stderr: lastBootResult?.stderr,
-            context: { platform: 'android', phase: 'boot' },
-          });
-          return reason !== 'ADB_TRANSPORT_UNAVAILABLE' && reason !== 'ANDROID_BOOT_TIMEOUT';
-        },
-      },
-      {
-        deadline,
-        phase: 'boot',
-        classifyReason: (error) =>
-          classifyBootFailure({
-            error,
-            stdout: lastBootResult?.stdout,
-            stderr: lastBootResult?.stderr,
-            context: { platform: 'android', phase: 'boot' },
-          }),
-        onEvent: (event: RetryTelemetryEvent) => {
-          if (!RETRY_LOGS_ENABLED) return;
-          process.stderr.write(`[agent-device][retry] ${JSON.stringify(event)}\n`);
-        },
-      },
-    );
-  } catch (error) {
-    const appErr = asAppError(error);
-    const stdout = lastBootResult?.stdout;
-    const stderr = lastBootResult?.stderr;
-    const exitCode = lastBootResult?.exitCode;
-    let reason = classifyBootFailure({
-      error,
-      stdout,
-      stderr,
-      context: { platform: 'android', phase: 'boot' },
-    });
-    if (reason === 'BOOT_COMMAND_FAILED' && appErr.message === 'Android device is still booting') {
-      reason = 'ANDROID_BOOT_TIMEOUT';
-    }
-    const baseDetails = {
-      serial,
-      timeoutMs: timeoutBudget,
-      elapsedMs: deadline.elapsedMs(),
-      reason,
-      hint: bootFailureHint(reason),
-      stdout,
-      stderr,
-      exitCode,
-    };
-    if (timedOut || reason === 'ANDROID_BOOT_TIMEOUT') {
-      throw new AppError('COMMAND_FAILED', 'Android device did not finish booting in time', baseDetails);
-    }
-    if (appErr.code === 'TOOL_MISSING') {
-      throw new AppError('TOOL_MISSING', appErr.message, {
-        ...baseDetails,
-        ...(appErr.details ?? {}),
-      });
-    }
-    if (reason === 'ADB_TRANSPORT_UNAVAILABLE') {
-      throw new AppError('COMMAND_FAILED', appErr.message, {
-        ...baseDetails,
-        ...(appErr.details ?? {}),
-      });
-    }
-    throw new AppError(appErr.code, appErr.message, {
-      ...baseDetails,
-      ...(appErr.details ?? {}),
-    }, appErr.cause);
-  }
-}