Files
amethyst/tools/ime-test/README.md
T
Claude 1de9c242e9 fix(embed): don't let a readonly field's mirror be typed into
Audit of the branch, two findings.

`readonly` stops the *user* editing a field, not scripts: the shim writes
through the native value setter, so any text that reaches the host mirror is
applied to the page and fires an `input` event no native browser would. Cut and
Paste were refused at their call sites, but that misses a hardware keyboard
(tablets, DeX, Chromebooks) — whose Ctrl+V goes straight to
`onTextContextMenuItem`, bypassing the wrapper — and autofill. Configure the
mirror as TYPE_NULL for a readonly field instead: `onCheckIsTextEditor()` is
then false, so there is no InputConnection to type through at all, while
selection and Copy — the half native does offer on a readonly field — keep
working.

The selection toolbar's item list was rebuilt on every recomposition of the tab
layer, which recomposes on every IME inset change, bounds report and console
line, for a toolbar only shown during a selection. Remembered on the readonly
flag, so it allocates once and keeps a stable identity the overlay can skip on.

Adds tools/ime-test/shim-events.mjs, a regression test that drives the shipped
shim in headless Chromium and asserts the page→host envelopes. It fails on main
(7 cases, including "no ime.wantkb — the keyboard could never come back") and
passes here. A JVM unit test cannot cover this: the host parser runs on Android's
org.json, which the unit tests stub out, so it would pass without parsing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AC3ambee9KFcvHCS6HRqhS
2026-08-11 15:21:10 +00:00

124 lines
6.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# IME / text-selection test harness
A single-file web page (`index.html`) for exercising and profiling the embedded
WebView IME + text-selection relay (see
`amethyst/plans/2026-06-25-embed-text-selection-native-parity.md`). It has a
plain `<input>` and a `<textarea>` plus an on-page green log that records, with
millisecond timestamps:
- focus/blur, `selectionchange`, `keydown`/`beforeinput`/`input`, composition
events, and the resulting `value`/selection — to catch erase, caret-jump, and
focus-transfer regressions;
- **paint latency** (`requestAnimationFrame` after each DOM change) — the metric
that exposed the first-letter freeze;
- **long-task** + **main-thread-block** detectors and a focus/selection
**heartbeat** — to catch anything stalling the WebView main thread or
spontaneously moving focus/selection.
The log lines are tagged `[ImeDiag]` and also go to `console.log`, so they show
up in `adb logcat` (the `:napplet` process owns the WebView console). Nothing
here ships in the app — it's a dev tool, which is why the `[ImeDiag]` strings
live only under `tools/`.
## Run it
1. Serve this directory over HTTP from your dev machine:
```bash
cd tools/ime-test && python3 -m http.server 8765
```
2. Reach it from the device/emulator:
- **Emulator:** the page is at `http://10.0.2.2:8765` (`10.0.2.2` is the
emulator's alias for the host loopback).
- **Physical device (USB):** `adb reverse tcp:8765 tcp:8765`, then the page is
at `http://localhost:8765`.
3. Open that URL as an **embedded** tab (this is the path that uses the relay —
*not* a full-screen activity):
- Open the in-app browser (`BrowserScreen`) and type the URL into its address
bar. The embedded browser handles `http`/`https`, so it loads into the
`:napplet` SurfaceControlViewHost surface.
To compare against native behavior, open the same URL in a full-screen
activity (where the WebView renders in-window with the native keyboard) — that
is also how you reproduce the **full-screen round-trip highlight bug** (open
full-screen, `back`, then selection highlight is dead across all embeds).
## Reading the log
- `INPUT … val=… sel=…` right after a keystroke with the right value = no erase.
- `PAINT-LATENCY Nms` spiking to ~1000ms = the first-letter freeze (should stay
low now that the surface no longer resizes on IME show).
- `MAINTHREAD BLOCKED` / `LONGTASK` = something is stalling the WebView thread.
- `HEARTBEAT` lines changing while idle = spontaneous focus/selection drift.
## `shim-events.mjs` — automated regression test for the IME protocol
`index.html` and `perf.html` are manual probes; this one is a real test. It loads
the shipped shim (`commons/.../napplet/shim.js`) into headless Chromium with the
embedded-surface flags set, drives genuine focus/tap/blur gestures, and asserts
the `ime.*` envelopes it emits — the doorbell fires on a tap in an
already-focused field, the doorbell stays payload-free, a host `ime.resync` is
answered with the field state and no geometry, `readonly` survives the round
trip, and a tap inside a `contenteditable` counts.
```bash
cd tools/ime-test
npm i playwright-core # once; the browser itself is already on the box
node shim-events.mjs # exits 0 on success, 1 with a per-case report
node shim-events.mjs /path/to/other/shim.js # diff a candidate against it
```
Set `CHROMIUM_PATH` if your Chromium lives somewhere other than
`/opt/pw-browsers/chromium-1194/chrome-linux/chrome`.
**Why this and not a JVM unit test.** The host-side parser
(`parseImeEvent`) runs on Android's `org.json`, which the unit tests stub out
(`unitTests.isReturnDefaultValues = true` in `amethyst/build.gradle.kts`, and
there is no Robolectric); a Kotlin test would "pass" without parsing anything.
The half worth protecting is the page↔host contract, and that only exists in a
browser.
## `perf.html` — why does the embed feel slower than the full-screen browser?
`index.html` profiles the IME relay. `perf.html` answers a different question:
the embedded tab and the full-screen browser are the **same WebView in the same
`:napplet` process** with byte-identical `WebSettings`, so when a site's JS feels
slower in the embed, the cause is host-induced — and this page measures which
host effect it is.
Serve the directory (above) and open **the same URL in both hosts**, then compare
the summary line at the bottom of the page:
- **`vis=hidden`** — decisive. Chromium considers the embedded page hidden, so it
clamps timers to ~1Hz and suspends `requestAnimationFrame`. Everything the site
schedules lands late; it reads as "the JS got slow". Confirmed by
`timer50` (a 50ms interval firing at 500-1000ms) and `raf` (0 fps).
- **`vis=visible` but `cpu` is 2-4× the full-screen number** — the process is
running on the little cores. The site's JS runs in the WebView *renderer*
process, whose scheduling class is inherited from its host: `:napplet` is
`top-app` when it fronts the full-screen activity, but only a bound service
(`BIND_AUTO_CREATE`, no `BIND_IMPORTANT`) when it serves the embed. Cross-check
off-device with:
```bash
adb shell dumpsys activity processes | grep -E 'napplet|sandboxed'
adb shell "cat /proc/$(adb shell pidof com.vitorpamplona.amethyst:napplet)/cgroup"
```
Expect `/top-app` with the full-screen browser open and `/foreground` (or lower)
with an embed tab open.
- **`cpu` matches but `inputDelivery` is much higher** — the gap is input routing
into the embedded window, not compute. `inputDelivery` is the time between the
platform stamping the touch and JS receiving it.
- **`layout` much higher in the embed** — layout/paint is the bottleneck (check
logcat for WebView software-rendering warnings; a non-hardware-accelerated
`SurfaceControlViewHost` window would put Chromium on the software path).
- **`focus=false` in the embed is expected** and is not itself a throttle: the
host window owns the keyboard, which is the whole reason `RemoteImeView` exists.
`longtasks` counts main-thread blocks over 50ms while the page was measuring —
high counts in the embed with a matching `cpu` number point at something else in
the process competing (e.g. parked warm tabs that are never paused).