Files
software-mansion__argent/packages/tool-server/test/adb-binary-failure-buffer.test.ts
Mateusz Ścianek b8afbed183 feat(tv): Apple TV (tvOS) and Android TV support (#374)
Adds end-to-end support for driving **Apple TV (tvOS)** and **Android TV
(leanback)** targets through argent, using a focus-driven interaction
model (TVs have no touchscreen — interaction is moving a focus highlight
with the remote).

This PR was reworked after review to **reuse the existing cross-platform
tool surface and the `tv-remote` tool from the Vega/Fire TV work
(#366)** rather than ship a separate family of `tv-*` tools.

## What this delivers

TV targets are driven by the **same cross-platform tools as every other
platform**, routed through the existing `dispatchByPlatform` fork
mechanism — there are no dedicated
`tv-describe`/`tv-navigate`/`tv-type`/`tv-set-focus` tools:

- **`describe`** — on a `runtimeKind: "tv"` target, returns the
focus-driven view (focused + focusable elements) instead of a tap tree.
On Android TV it auto-falls-back to the full `uiautomator` tree when the
RN focus engine exposes nothing.
- **`tv-remote`** — the cross-platform remote/D-pad tool from #366, now
extended with `ios` (Apple TV HID daemon) and `android` (Android TV adb
keyevents) branches alongside the existing `vega` branch. Single button,
a `repeat`, or a whole path (`["up","right","select"]`) in one call.
- **`keyboard`** — types into the focused field on a TV target (named
keys are rejected there — they're navigation, which belongs to
`tv-remote`).
- **`button`** stays hardware-only (phones/tablets); it is not a TV
tool.

**Apple TV** runs two native daemons (in-sim AX service + host-side HID
daemon), shipped via the `argent-private` submodule. **Android TV**
reuses the same tool surface, adb-backed (`input keyevent`, `uiautomator
dump`, `input text`).

## Remote vocabulary parity

`tv-remote` exposes the full 16-button vocabulary
(`up`/`down`/`left`/`right`/`select`/`back`/`home`/`menu`/`playPause`/`rewind`/`fastForward`/`next`/`previous`/`volumeUp`/`volumeDown`/`mute`):

| | Apple TV | Android TV | Vega |
|---|---|---|---|
| D-pad / select / back / menu / home / playPause | ✅ | ✅ | ✅ |
| media-transport + volume/mute | ❌ rejected | ✅ | ✅ |

Media-transport/volume keys **genuinely work on Android TV** (real
keycodes — verified live: `volumeUp` moved `STREAM_MUSIC`, `mute`
toggled per `dumpsys audio`). On the **Apple TV simulator** they are
**rejected with a clear error**: on-device testing confirmed the tvOS
sim's HID stack silently drops Consumer-Control events, so returning
success would be a lie.

## Key design points
- **tvOS UDIDs are UUID-shaped and indistinguishable from iOS by
shape.** Handled with `runtimeKind` detection (tvOS runtime string for
Apple TV; `pm list features` leanback/television for Android TV — *not*
`ro.build.characteristics`, which lies on TV emulators).
- Converted launch-app / restart-app / screenshot / screenshot-diff /
run-sequence from **eager** to **lazy** service resolution, so a tvOS
target never spins up (and hangs on) the iOS-only simulator-server /
native-devtools blueprints.
- Native injection selects the platform-matched (TVOSSIMULATOR) dylib
slice; daemons recycle across sim reboots and app relaunches so
injection and focus survive.
- SKILL.md footprint minimized per review: the two TV skills were
collapsed into a single lean **`argent-tv-interact`** (~40 lines).

## Verification
- `npm run build`, ESLint, Prettier, and the full tool-server suite
(**1565 tests**) all pass; CI green (incl. the Apple TV / Android TV /
Vega e2e jobs).
- Core flows verified live against real apps on both an Apple TV 4K
simulator and a Google ATV emulator.

## Dependency / merge order
Pins the `argent-private` submodule to the tip of its `feat/tv-support`
branch (software-mansion/argent-private#20). **Merge that PR to `main`
first, then bump the submodule pointer here to the merged SHA before
merging this PR.**

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 14:59:37 +02:00

79 lines
2.9 KiB
TypeScript

import { describe, it, expect, vi, beforeEach } from "vitest";
const execFileMock = vi.fn();
// Binary execs run with encoding:"buffer", so on failure Node attaches
// Buffer stderr/stdout to the rejected error (not strings). This mock mirrors
// that contract so describeAdbFailure is exercised against Buffer fields.
vi.mock("node:child_process", async () => {
const actual = await vi.importActual<typeof import("node:child_process")>("node:child_process");
return {
...actual,
execFile: (
cmd: string,
args: readonly string[],
opts: unknown,
cb?: (err: Error | null, out: { stdout: unknown; stderr: unknown }) => void
) => {
const callback = typeof opts === "function" ? opts : cb!;
const result = execFileMock(cmd, args);
if (result instanceof Error) {
const e = result as Error & { stderr?: unknown; stdout?: unknown };
callback(e, { stdout: e.stdout ?? Buffer.alloc(0), stderr: e.stderr ?? Buffer.alloc(0) });
} else callback(null, result ?? { stdout: Buffer.alloc(0), stderr: Buffer.alloc(0) });
},
};
});
vi.mock("../src/utils/android-binary", () => ({
resolveAndroidBinary: vi.fn(async (name: "adb" | "emulator") => name),
__resetAndroidBinaryCacheForTesting: () => {},
}));
import { adbExecOutBinary } from "../src/utils/adb";
beforeEach(() => {
execFileMock.mockReset();
});
// Regression (Bug-ATV4): describeAdbFailure called `(e.stderr ?? "").trim()`
// but binary execs reject with a Buffer stderr — Buffer has no `.trim`, so the
// handler itself threw `(e.stderr ?? "").trim is not a function`, masking adb's
// real diagnostic. The handler must coerce Buffer→string first.
describe("describeAdbFailure handles Buffer stderr/stdout from binary execs", () => {
async function expectRejection(): Promise<string> {
try {
await adbExecOutBinary("emulator-5554", "uiautomator dump");
throw new Error("expected rejection");
} catch (err) {
return (err as Error).message;
}
}
it("surfaces the adb diagnostic from a Buffer stderr instead of crashing", async () => {
execFileMock.mockImplementation(() =>
Object.assign(new Error("Command failed: adb -s emulator-5554 exec-out uiautomator dump"), {
code: 1,
stdout: Buffer.alloc(0),
stderr: Buffer.from("error: device 'emulator-5554' offline"),
})
);
const msg = await expectRejection();
expect(msg).not.toMatch(/is not a function/);
expect(msg).toContain("error: device 'emulator-5554' offline");
});
it("falls back to a Buffer stdout when stderr is empty", async () => {
execFileMock.mockImplementation(() =>
Object.assign(new Error("Command failed"), {
code: 1,
stdout: Buffer.from("junk output, no <hierarchy>"),
stderr: Buffer.alloc(0),
})
);
const msg = await expectRejection();
expect(msg).not.toMatch(/is not a function/);
expect(msg).toContain("junk output, no <hierarchy>");
});
});