Skip to content

Android driver: emulator.ts starts, readies and stops an emulator #1269

Closed

Description

@V3RON

Part of #1259.

Scope

After this PR, emulator.ts is a part of the Android driver (ADR 0063 §4). It owns the adb registrar (#registrar), and does starting an emulator (flags, emulator.log, crash database), waiting until it is ready (re-announcing a silent serial), shutting it down, waiting for it to exit, the tail of its log, and stopping an emulator this process did not start, only when it answers this device's own folder (it refuses one that gives no answer). AndroidDriver builds it in its constructor, passes it the options it needs, and delegates to it. Behaviour, messages, timeouts and files on disk do not change. makeReady, shutdown and destroy stay in the root: their bodies span several parts. start returns the process handle and the root stores it in the device state, so the part writes no state it does not own.

In short

About 269 lines of code move out of the 3,573-line driver into a file an agent reads whole. Nothing a user or a caller sees changes. A part is a file that owns its own state and takes its collaborators in an options object; it never imports index.ts.

flowchart LR
  R["index.ts: AndroidDriver"] --> P["emulator.ts (new part)"]
  R --> O[parts moved earlier]
  P --> O
Loading

What a user would notice if this goes wrong: an emulator fails to boot or hangs, or is not stopped.

Technical spec

Facts

Commit 059a270. Line numbers are on that commit; earlier tasks of #1259 move code, so the implementer finds each name by search.

# Fact Source
F1 every name this task moves, at its line on 059a270 (the exact assignment of every name of the file, made from its syntax tree) COLD_BOOT_ESTIMATE_MS at src/drivers/android/index.ts:97; PORT_POLL_INTERVAL_MS at src/drivers/android/index.ts:114; REGISTRATION_RETRY_AFTER_MS at src/drivers/android/index.ts:127; SIGKILL_REAP_TIMEOUT_MS at src/drivers/android/index.ts:136; EMULATOR_LOG_TAIL_BYTES at src/drivers/android/index.ts:137; EMULATOR_LOG_TAIL_LINES at src/drivers/android/index.ts:138; SNAPSHOT_BOOT_ESTIMATE_MS at src/drivers/android/index.ts:145; AndroidEmulatorLaunchOptions at src/drivers/android/index.ts:181; DEFAULT_EMULATOR_LAUNCH at src/drivers/android/index.ts:188; #registrar at src/drivers/android/index.ts:633; #emulatorEnv at src/drivers/android/index.ts:1041; #register at src/drivers/android/index.ts:1082; #stopUnownedEmulator at src/drivers/android/index.ts:1847; #emulatorLogPath at src/drivers/android/index.ts:2654; #emulatorLogTail at src/drivers/android/index.ts:2659; #waitForReadiness at src/drivers/android/index.ts:2754; #bootSettled at src/drivers/android/index.ts:2799; #startEmulator at src/drivers/android/index.ts:2887; #bootEstimate at src/drivers/android/index.ts:2960; #shutdown at src/drivers/android/index.ts:2971; #waitForExit at src/drivers/android/index.ts:2991; emulatorLaunchFlags at src/drivers/android/index.ts:3443
F2 a part in this folder takes an options object and is built by the driver src/drivers/android/adb-registrar.ts:22-25, src/drivers/android/index.ts:675
F3 such a part has its own test file that builds it directly src/drivers/android/adb-registrar.test.ts:9
F4 the folder's testing.ts is imported by index.test.ts, and the test file's shared helpers sit outside any describe src/drivers/android/index.test.ts:46, src/drivers/android/index.test.ts:5117-5410, src/drivers/android/index.test.ts:7306-8212
F5 Fallow fails CI on an import loop between files (circular-dependencies, default error) and on any dead-code finding node_modules/fallow/schema.json RulesConfig at pnpm-lock.yaml:2180; docs/internal/agent-rules/toolchain.md:51-53
F6 test-lint flags an added sibling import in a test unless a why: sits above the first describe .agents/scripts/test-lint.mjs:141-148
F7 the module manual is 141 lines, and manuals may have at most 150 src/drivers/android/AGENTS.md:1-141, src/docs-manuals.test.ts:9
F8 the root tests that prove the root still reaches this part src/drivers/android/index.test.ts:815 "launches with the same arguments as before these options existed under the default config"; src/drivers/android/index.test.ts:528 "starts the seed's boots and the copy's boot with -crash-report-mode never"
F9 the process handle is set at start and cleared at shutdown, and the root reads it in makeReady and destroy src/drivers/android/index.ts:2921, src/drivers/android/index.ts:2988, src/drivers/android/index.ts:1729, src/drivers/android/index.ts:1824

Modules touched

Searches: grep -rn of each F1 name under src/ (hits only in src/drivers/android/index.ts, src/drivers/android/index.test.ts and, for the exports index.ts keeps, their importers); ls src/drivers/android/emulator.ts (absent on 059a270).

flowchart LR
  R["index.ts (changed)"] --> P["emulator.ts (new)"]
  P --> E["earlier parts, data.ts"]
Loading
  • src/drivers/android/emulator.ts: new; the part. It imports only data.ts, files that exist on 059a270 and the parts of earlier tasks; anything else reaches it as an option or a callback.
  • src/drivers/android/index.ts: builds the part, delegates, and loses the F1 names.
  • src/drivers/android/index.test.ts: unchanged, except helpers moved to testing.ts.
  • no new test file.
  • src/drivers/android/data.ts: takes a type two parts share, when this task moves one.
  • src/drivers/android/testing.ts: takes any helper two test files now use.
  • src/drivers/android/AGENTS.md: the one Files row for the parts (ADR 0063), which Android driver: adb-tools.ts, the leaf part for env, commands and device folders #1264 adds, gains emulator.ts and a few words; no new row (F7).
  • src/source-hygiene.test.ts: the two Android entries of the shrink-only list take their new lengths; an entry whose file is now within its limit is removed.

Contract and event changes

none: the task moves code inside the Android driver; no file under src/contract/ and no event changes (search: git grep -n "drivers/android" src/contract gives 0 hits).

Other code on the same state

The state this part owns: the adb registrar (#registrar). Searches: grep -n of each owned name in src/drivers/android/index.ts and under src/ outside the Android folder (0 hits outside). After this task the root and later tasks (#1270, #1273, #1271, #1272) reach that state only through this part's interface; none keeps a copy.

Failure modes

none: the task crosses no new boundary and writes no new state. Every call to adb, emulator, avdmanager or sdkmanager it moves keeps its arguments, environment and time limit (F1).

Rules in play

  • ADR 0063 §1, "A part never calls the root": the part takes collaborators and callbacks in its options and imports no index.ts (F5 fails a loop).
  • ADR 0063 §2, tests sit with the part: a test moves only when everything it asserts is made by this part; a test across parts stays in the root's tests. A part test file has one why: above its first describe naming "a part of a decomposed module" (F6).
  • ADR 0063 §3: a listed file that is now within its limit leaves the shrink-only list in this PR.
  • Architecture rule 14, "nothing outside the directory imports a file inside it": only files in src/drivers/android/ import the part.
  • Architecture rule 17, "A comment starts with why:": a moved comment that is not a why:, or that no longer holds, is deleted.
  • Documentation rule 7 and src/docs-manuals.test.ts: the manual stays within 150 lines (F7).

Tests

No test of src/drivers/android/index.test.ts asserts only this part's code: each drives it through a verb that spans parts, so they stay where they are (ADR 0063 §2). The seam is src/drivers/android/index.test.ts (F8).

  • The driver boots and stops emulators through emulator.ts, and the whole-driver tests see the same launches, readiness and shutdowns as before; cases: "launches with the same arguments as before these options existed under the default config"; "starts the seed's boots and the copy's boot with -crash-report-mode never".

Done when

  • pnpm exec vitest run --project unit src/drivers/android passes, and its number of tests is the base's plus the tests this task adds.
  • src/drivers/android/emulator.ts exists, and only files in src/drivers/android/ import it: dependency-cruiser's past-index rule (.dependency-cruiser.mjs:36-37), run by pnpm check, fails any import of it from outside the folder.
  • src/drivers/android/index.ts defines none of the F1 names, except each Driver method (and other AndroidDriver member the core or the daemon calls), which stays and delegates; the root's field that holds the part takes a name that is not an F1 name; an F1 constant the root still uses is imported from the part.
  • In src/source-hygiene.test.ts, each Android entry equals its file's new line count, or is gone when the file is within its limit.
  • pnpm check passes.

Out of scope

Depends on

Written by an agent.

Metadata

Metadata

Assignees

Labels

task:readySpec checked. An agent may implement it once its Depends on allow.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions