Files
sanderling/pkg/spec/test/web-runtime.test.ts
T
pj b1e95739ad feat(hierarchy): an element reports whether it masks what is typed into it
ios reads it off SecureTextField, which the companion already sent and
nothing read; web reads input[type=password]. Android cannot: the native
tree mapper drops the password attribute before the sidecar sees it, so
the fact is three-valued and null there rather than a false that would
read as "not secure".
2026-08-18 17:16:55 +05:30

1132 lines
47 KiB
TypeScript

import assert from "node:assert/strict";
import { test } from "node:test";
// The web runtime is the WEB Host: it parses the injected seed, reports its
// platform, and delegates action generation to the shared picker. These tests
// guard the Host surface and the seed-precision contract. DOM candidate
// enumeration is exercised against a minimal querySelectorAll stub.
// A 64-bit seed that loses precision as a JS Number must survive as a BigInt.
process.env.SANDERLING_SEED = "9007199254740993";
// cssEscape delegates to the browser's CSS.escape, absent in node. Install the
// WHATWG CSSOM escape algorithm so selector-builder tests exercise the real
// escaping production relies on, not a stub.
if (!(globalThis as { CSS?: unknown }).CSS) {
(globalThis as { CSS?: { escape(v: string): string } }).CSS = {
escape(value: string): string {
let out = "";
for (let i = 0; i < value.length; i++) {
const c = value.charCodeAt(i);
if (c === 0) {
out += "�";
} else if (
(c >= 0x1 && c <= 0x1f) ||
c === 0x7f ||
(i === 0 && c >= 0x30 && c <= 0x39) ||
(i === 1 && c >= 0x30 && c <= 0x39 && value.charCodeAt(0) === 0x2d)
) {
out += "\\" + c.toString(16) + " ";
} else if (i === 0 && c === 0x2d && value.length === 1) {
out += "\\" + value[i];
} else if (
c >= 0x80 ||
c === 0x2d ||
c === 0x5f ||
(c >= 0x30 && c <= 0x39) ||
(c >= 0x41 && c <= 0x5a) ||
(c >= 0x61 && c <= 0x7a)
) {
out += value[i];
} else {
out += "\\" + value[i];
}
}
return out;
},
};
}
const { __testing__ } = await import("../src/web-runtime.ts");
const { host } = __testing__;
test("platform is web", () => {
assert.equal(host.platform(), "web");
});
test("seedHi parses the injected 64-bit seed without Number precision loss", () => {
assert.equal(host.seedHi(), 9007199254740993n);
});
test("seedLo is 0 to match goja rand.NewPCG(seed, 0)", () => {
assert.equal(host.seedLo(), 0n);
});
test("reportUnsupported warns once via console.warn", () => {
const original = console.warn;
const messages: string[] = [];
console.warn = (m: string) => messages.push(m);
try {
host.reportUnsupported("swipes");
} finally {
console.warn = original;
}
assert.equal(messages.length, 1);
assert.match(messages[0]!, /swipes/);
});
// installRuntime locked the next-action and extractor globals at import.
test("installRuntime defined the host-invoked globals", () => {
const g = globalThis as Record<string, unknown>;
assert.equal(typeof g.__sanderlingNextAction__, "function");
assert.equal(typeof g.__sanderlingExtractors__, "function");
assert.equal(typeof g.__sanderling__, "object");
});
const { fakeElement, withFakeDocument } = await import("./web-dom-harness.ts");
type FakeElementSpec = Parameters<typeof fakeElement>[0];
// The host reports facts and never routes verbs: which of these a verb may act
// on is decided by the shared rule in src/targets.ts, exercised across both
// engines by host-parity.test.ts.
test("queryTargets reports the tappable selector set as clickable", () => {
const button = fakeElement({ tag: "button", x: 10, y: 20, width: 40, height: 8, clickable: true });
const plain = fakeElement({ tag: "div", x: 0, y: 0, width: 100, height: 100 });
withFakeDocument([button, plain], () => {
const targets = host.queryTargets();
assert.equal(targets.length, 2);
assert.equal(targets[0]!.clickable, true);
assert.deepEqual({ x: targets[0]!.x, y: targets[0]!.y }, { x: 30, y: 24 });
assert.equal(targets[1]!.clickable, false);
});
});
test("queryTargets reports only real text inputs as editable", () => {
const input = fakeElement({ tag: "input", x: 0, y: 0, width: 100, height: 20, editable: true });
const checkbox = fakeElement({ tag: "input", x: 0, y: 40, width: 20, height: 20, editable: true });
checkbox.type = "checkbox";
withFakeDocument([input, checkbox], () => {
const targets = host.queryTargets();
assert.equal(targets[0]!.editable, true);
assert.deepEqual({ x: targets[0]!.x, y: targets[0]!.y }, { x: 50, y: 10 });
assert.equal(targets[1]!.editable, false);
});
});
// A disabled control used to be dropped from every verb's candidates, because
// the web host folded `disabled` into its visibility check. It is a fact of its
// own now, so `taps` still skips it while `swipes` can still start on it, which
// is what the native host has always done.
test("queryTargets reports a disabled control rather than dropping it", () => {
const disabled = fakeElement({
tag: "button", x: 0, y: 0, width: 40, height: 20, clickable: true, disabled: true,
});
withFakeDocument([disabled], () => {
const targets = host.queryTargets();
assert.equal(targets.length, 1);
assert.equal(targets[0]!.clickable, true);
assert.equal(targets[0]!.enabled, false);
});
});
// A target with no selector is a target no property can name. The action the
// picker builds from it carries coordinates only, so `lastAction.on` is empty
// and any property matching on WHICH control was acted upon cannot fire.
test("queryTargets names a uniquely identified target", () => {
const submit = fakeElement({
tag: "button", x: 0, y: 0, width: 40, height: 20, clickable: true, id: "TxnSubmit",
});
const byTestid = fakeElement({
tag: "button", x: 0, y: 40, width: 40, height: 20, clickable: true, testid: "cancel",
});
const byLabel = fakeElement({
tag: "button", x: 0, y: 80, width: 40, height: 20, clickable: true, label: "Close",
});
// alt and title are the fallbacks the hierarchy dump folds into content-desc,
// so the host has to fall back to them in the same order or a name it calls
// unique resolves to a different element on the Go side.
const byAlt = fakeElement({ tag: "img", x: 0, y: 120, width: 40, height: 20, alt: "Logo" });
const byTitle = fakeElement({ tag: "div", x: 0, y: 160, width: 40, height: 20, title: "Help" });
const anonymous = fakeElement({ tag: "div", x: 0, y: 200, width: 10, height: 10 });
withFakeDocument([submit, byTestid, byLabel, byAlt, byTitle, anonymous], () => {
const targets = host.queryTargets();
assert.equal(targets[0]!.selector, "id:TxnSubmit");
assert.equal(targets[1]!.selector, "data-testid:cancel");
assert.equal(targets[2]!.selector, "desc:Close");
assert.equal(targets[3]!.selector, "desc:Logo");
assert.equal(targets[4]!.selector, "desc:Help");
assert.equal(targets[5]!.selector, undefined);
});
});
// A repeated id (folio's Home screen renders one AccountCard testTag per
// account) names no single element, so the runner would re-resolve the action
// onto whichever sibling it found first. Better unnamed than mis-aimed.
test("queryTargets leaves duplicated identities unnamed", () => {
const first = fakeElement({
tag: "div", x: 0, y: 0, width: 40, height: 20, clickable: true, id: "AccountCard",
});
const second = fakeElement({
tag: "div", x: 0, y: 40, width: 40, height: 20, clickable: true, id: "AccountCard",
});
withFakeDocument([first, second], () => {
const targets = host.queryTargets();
assert.equal(targets[0]!.selector, undefined);
assert.equal(targets[1]!.selector, undefined);
});
});
// The enumeration ORDER is the parity contract. buildTree in
// internal/driver/chrome/driver.go emits a host's shadow children before its
// light ones, and TestHierarchy_DerivesTheSameFactsAsTheWebRuntime compares the
// two enumerations position by position.
test("queryTargets splices shadow content in before the host's light children", () => {
const page = fakeElement({
tag: "div", x: 0, y: 0, width: 400, height: 800, id: "page",
children: [
{
tag: "div", x: 0, y: 0, width: 400, height: 100, id: "mount",
shadow: [
{ tag: "button", x: 0, y: 0, width: 40, height: 20, id: "shadow-save", clickable: true },
],
children: [{ tag: "div", x: 0, y: 20, width: 40, height: 20, id: "mount-light-child" }],
},
{ tag: "div", x: 0, y: 100, width: 400, height: 100, id: "after" },
],
});
withFakeDocument([page], () => {
assert.deepEqual(
host.queryTargets().map((target) => target.selector),
["id:page", "id:mount", "id:shadow-save", "id:mount-light-child", "id:after"],
);
});
});
// The tappable set is resolved by selector, and querySelectorAll stops dead at
// a shadow boundary, so a control inside a shadow root carries the clickable
// fact only if the selector sweep descends. A Compose for Web app keeps every
// control it has on the far side of one boundary.
test("queryTargets reports a shadow-hosted control as clickable", () => {
const mount = fakeElement({
tag: "div", x: 0, y: 0, width: 400, height: 100, id: "mount",
shadow: [
{ tag: "button", x: 0, y: 0, width: 40, height: 20, id: "shadow-save", clickable: true },
{ tag: "input", x: 0, y: 20, width: 40, height: 20, id: "shadow-amount", editable: true },
],
});
withFakeDocument([mount], () => {
const targets = host.queryTargets();
assert.deepEqual(
targets.map((target) => target.selector),
["id:mount", "id:shadow-save", "id:shadow-amount"],
);
assert.equal(targets[1]!.clickable, true);
assert.equal(targets[2]!.editable, true);
});
});
test("queryTargets caches within a tick until reset", () => {
const button = fakeElement({ tag: "button", x: 0, y: 0, width: 10, height: 10, clickable: true });
withFakeDocument([button], () => {
const first = host.queryTargets();
const second = host.queryTargets();
assert.equal(first, second);
__testing__.resetTargetCache();
assert.notEqual(host.queryTargets(), first);
});
});
// evaluateExtractors builds State, which references document and window.
const emptyDocument = {
querySelector: () => null,
querySelectorAll: () => [],
};
function withState(run: () => void) {
const g = globalThis as Record<string, unknown>;
const originalDocument = g.document;
const originalWindow = g.window;
g.document = emptyDocument;
g.window = {};
try {
run();
} finally {
g.document = originalDocument;
g.window = originalWindow;
}
}
// Every reading leaves the runtime inside a {value} envelope, so an extractor
// whose getter returned undefined keeps its index instead of being dropped by
// JSON.stringify.
function readingOf(values: Record<number, { value?: unknown }>, index: number): unknown {
return values[index]!.value;
}
test("named() sets the extractor's display name", () => {
const handle = __testing__.runtime.extract(() => "home").named("route");
const entry = __testing__.extractors.find((e) => e.handle === handle);
assert.equal(entry?.name, "route");
});
test("reading another extractor's current inside a getter throws", () => {
const first = __testing__.runtime.extract(() => 1);
let caught: Error | undefined;
__testing__.runtime.extract(() => {
try {
return first.current;
} catch (error) {
caught = error as Error;
return undefined;
}
});
withState(() => __testing__.evaluateExtractors());
assert.match(
caught?.message ?? "",
/inside another extractor is not allowed/,
);
});
// An uncaught cross-extractor read must abort evaluateExtractors loudly, exactly
// like goja's PushSnapshot. If the getter throw were swallowed, web would
// silently yield undefined and the guard would be a no-op for real authors.
test("an uncaught cross-extractor read aborts evaluateExtractors", () => {
__testing__.extractors.length = 0;
const first = __testing__.runtime.extract(() => 1);
__testing__.runtime.extract(() => first.previous);
let thrown: Error | undefined;
withState(() => {
try {
__testing__.evaluateExtractors();
} catch (error) {
thrown = error as Error;
}
});
assert.match(
thrown?.message ?? "",
/inside another extractor is not allowed/,
);
});
// JSON.stringify drops an undefined-valued key, so a reading written straight
// into the table took the extractor's whole INDEX with it when the getter
// returned undefined - folio's on(route, tag) off its own screen, which is most
// of its extractors on most steps. The host then kept goja's dump-derived value
// for those and the page's for the rest, and a property comparing previous to
// current across that split convicts an app that did nothing wrong.
test("an extractor that returned undefined keeps its index through JSON", () => {
__testing__.extractors.length = 0;
__testing__.runtime.extract(() => undefined);
__testing__.runtime.extract(() => null);
__testing__.runtime.extract(() => 5);
let table: Record<number, { value?: unknown }> = {};
withState(() => {
table = __testing__.evaluateExtractors();
});
const overTheWire = JSON.parse(JSON.stringify(table)) as Record<string, { value?: unknown }>;
assert.deepEqual(Object.keys(overTheWire), ["0", "1", "2"]);
// undefined and null have to stay distinguishable across the wire: the goja
// host records undefined for a getter that returned undefined, so reporting
// null instead would make `x.current === undefined` answer one thing on
// native and another on web.
assert.equal("value" in overTheWire["0"]!, false);
assert.equal(overTheWire["1"]!.value, null);
assert.equal(overTheWire["2"]!.value, 5);
});
// state.lastAction is the one piece of state the page cannot observe for
// itself: only the runner knows which action it actually applied. While the web
// runtime hardcoded null there, a spec property gated on the last action (e.g.
// folio's submitMovesBalanceByAtMostTypedAmount, which only looks at taps on
// TxnSubmit) was vacuously true on web forever, and the run went green having
// checked nothing.
function lastActionSeenByASpec(pushed: unknown): unknown {
const setLastAction = (globalThis as Record<string, unknown>)
.__sanderlingSetLastAction__ as (value: unknown) => void;
__testing__.extractors.length = 0;
__testing__.runtime.extract((state) => (state as { lastAction: unknown }).lastAction);
let out: Record<number, { value?: unknown }> = {};
withState(() => {
setLastAction(pushed);
out = __testing__.evaluateExtractors();
});
return readingOf(out, 0);
}
test("state.lastAction carries the action the host pushed", () => {
const action = { kind: "Tap", on: "id:TxnSubmit" };
assert.deepEqual(lastActionSeenByASpec(action), action);
});
test("state.lastAction is null when the host pushed nothing", () => {
// The first step of a run, and any step whose action was never applied: the
// goja host reports null there, so the web host must too.
assert.equal(lastActionSeenByASpec(null), null);
});
// state.logs is the same kind of hole. Console output reaches the runner over
// CDP, so the page cannot read it back, and while the web runtime hardcoded []
// there the default noLogcatErrors counted an empty array on every web run: a
// page whose console was full of errors went green having checked nothing.
function logsSeenByASpec(pushed: unknown): unknown {
const setLogs = (globalThis as Record<string, unknown>).__sanderlingSetLogs__ as (
value: unknown,
) => void;
__testing__.extractors.length = 0;
__testing__.runtime.extract((state) => (state as { logs: unknown }).logs);
let out: Record<number, { value?: unknown }> = {};
withState(() => {
setLogs(pushed);
out = __testing__.evaluateExtractors();
});
return readingOf(out, 0);
}
test("state.logs carries the entries the host pushed", () => {
const entries = [
{ unixMillis: 1700000000123, level: "E", tag: "console", message: "boom from the page" },
];
assert.deepEqual(logsSeenByASpec(entries), entries);
});
test("state.logs is empty when the host pushed no entries", () => {
assert.deepEqual(logsSeenByASpec([]), []);
});
// sanitize runs over every extractor's return value before it leaves the
// runtime. A user extractor that returns a page object reachable from
// document/window can be self-referential, carry functions, or nest deeply;
// without cycle, function, and depth guards extraction overflows the stack or
// emits non-serializable values. These exercise sanitize via the real path.
function sanitizeViaExtract(value: unknown): unknown {
__testing__.extractors.length = 0;
__testing__.runtime.extract(() => value);
let out: Record<number, { value?: unknown }> = {};
withState(() => {
out = __testing__.evaluateExtractors();
});
return readingOf(out, 0);
}
test("sanitize breaks a self-referential cycle instead of overflowing", () => {
const cyclic: Record<string, unknown> = { name: "root" };
cyclic.self = cyclic;
const result = sanitizeViaExtract(cyclic) as Record<string, unknown>;
assert.equal(result.name, "root");
assert.equal(result.self, null);
});
test("sanitize drops function-valued properties", () => {
const result = sanitizeViaExtract({ keep: 1, fn: () => 7 }) as Record<string, unknown>;
assert.deepEqual(result, { keep: 1 });
});
test("sanitize drops a top-level function to undefined", () => {
assert.equal(sanitizeViaExtract(() => 7), undefined);
});
test("sanitize bounds recursion past its depth limit", () => {
let deep: Record<string, unknown> = { leaf: true };
for (let i = 0; i < 40; i++) deep = { next: deep };
// Walk to the depth cap; beyond it sanitize must yield null, not recurse on.
let node: unknown = sanitizeViaExtract(deep);
for (let i = 0; i < 32 && node && typeof node === "object"; i++) {
node = (node as Record<string, unknown>).next;
}
assert.equal(node, null);
});
test("sanitize preserves arrays and nested plain values", () => {
const result = sanitizeViaExtract({ items: [1, "two", { ok: true }] });
assert.deepEqual(result, { items: [1, "two", { ok: true }] });
});
// xpathStringLiteral builds XPath 1.0 string literals by hand (no escape
// syntax in XPath 1.0). A value carrying a quote that isn't wrapped or
// concat()-composed produces a malformed expression, so document.evaluate
// throws or, worse, matches the wrong node by truncating at the quote.
const { xpathStringLiteral } = __testing__;
test("xpathStringLiteral table: quote handling stays well-formed", () => {
const cases: Array<[string, string]> = [
["plain", '"plain"'],
['has"double', `'has"double'`],
["has'single", `"has'single"`],
[`both"and'`, `concat("both", '"', "and'")`],
[`"`, `'"'`],
];
for (const [input, want] of cases) {
assert.equal(xpathStringLiteral(input), want, input);
}
});
// selectorFromString routes a "kind:value" prefix; text becomes an XPath
// substring test, everything else a CSS attribute selector. A value containing a
// colon must not be re-split, and a quote in a text value must reach the
// well-formed XPath literal rather than corrupting the predicate.
const { selectorFromString, selectorFromObject } = __testing__;
test("selectorFromString routes text to a substring XPath", () => {
assert.deepEqual(selectorFromString("text:Hello"), {
xpath:
`.//*[contains(normalize-space(.), "Hello") ` +
`and not(.//*[contains(normalize-space(.), "Hello")])]`,
});
});
test("selectorFromString keeps colons in the value intact", () => {
// Only the first colon splits kind from value; the rest is the value.
assert.deepEqual(selectorFromString("text:a:b:c"), {
xpath:
`.//*[contains(normalize-space(.), "a:b:c") ` +
`and not(.//*[contains(normalize-space(.), "a:b:c")])]`,
});
});
test("selectorFromString text value with both quote kinds uses concat", () => {
assert.deepEqual(selectorFromString(`text:say "hi" o'clock`), {
xpath:
`.//*[contains(normalize-space(.), concat("say ", '"', "hi", '"', " o'clock")) ` +
`and not(.//*[contains(normalize-space(.), concat("say ", '"', "hi", '"', " o'clock"))])]`,
});
});
test("selectorFromObject escapes attribute values to prevent injection", () => {
// A quote in an id value, left unescaped, would close the attribute selector
// early and match a different element.
assert.deepEqual(selectorFromObject({ id: 'a"]' }), {
css: `[id="a\\"\\]"]`,
});
});
test("selectorFromObject maps known keys to their canonical attribute", () => {
assert.deepEqual(selectorFromObject({ testID: "submit" }), {
css: `[data-testid="submit"]`,
});
});
// Compose Multiplatform emits its testTag into `id`, which the native table
// already accepts via the resource-id alias. The web table must not be the one
// place that rejects it.
test("selectorFromObject resolves testTag through data-testid or id", () => {
assert.deepEqual(selectorFromObject({ testTag: "LoginSubmit" }), {
css: `:is([data-testid="LoginSubmit"], [id="LoginSubmit"])`,
});
});
// Multi-key selectors concatenate their parts into one compound, so the
// two-attribute testTag match has to stay a single compound piece.
test("selectorFromObject composes testTag with a second key", () => {
assert.deepEqual(selectorFromObject({ testTag: "Row", "aria-label": "first" }), {
css: `:is([data-testid="Row"], [id="Row"])[aria-label="first"]`,
});
});
// A list whose rows are named <role>_<record id> is only reachable by the role
// half. internal/driver/chrome/translate.go builds the same CSS for the same
// selector, and internal/hierarchy resolves it against the dump of this page.
test("selectorFromString routes idPrefix to a starts-with id match", () => {
assert.deepEqual(selectorFromString("idPrefix:customer_row_"), {
css: `[id^="customer_row_"]`,
});
});
test("selectorFromObject routes idPrefix to a starts-with id match", () => {
assert.deepEqual(selectorFromObject({ idPrefix: "customer_row_" }), {
css: `[id^="customer_row_"]`,
});
});
// The native rule matches an iOS merged label ("account_card:7, Tim, $100") by
// its leading name, and the web table has to mean the same thing by desc.
test("selectorFromObject matches a merged label by its leading name", () => {
assert.deepEqual(selectorFromObject({ desc: "account_card" }), {
css: `:is([aria-label="account_card"], [aria-label^="account_card, "])`,
});
});
test("selectorFromString and selectorFromObject agree on descPrefix", () => {
assert.deepEqual(selectorFromString("descPrefix:account:"), {
css: `[aria-label^="account\\:"]`,
});
assert.deepEqual(selectorFromObject({ descPrefix: "account:" }), {
css: `[aria-label^="account\\:"]`,
});
});
test("selectorFromObject composes idPrefix with a second key", () => {
assert.deepEqual(selectorFromObject({ idPrefix: "customer_row_", "aria-label": "first" }), {
css: `[id^="customer_row_"][aria-label="first"]`,
});
});
// A key nothing can carry yields no match, which reads exactly like a screen
// with no such element: the generator declines to act, the runner waits out the
// step, and the run ends clean having explored nothing.
test("selectorFromObject rejects a key no element can carry", () => {
assert.throws(
() => selectorFromObject({ descripton: "Supplier" }),
(error: Error) =>
error.message.includes('"descripton"') && error.message.includes("accepted keys"),
);
});
// Raw attributes the key list does not enumerate stay reachable when the page
// actually carries them, matched on a substring the way internal/hierarchy
// matches the same key.
test("selectorFromObject accepts a raw attribute the page carries", () => {
withDocumentCarrying(["data-foo"], () => {
assert.deepEqual(selectorFromObject({ "data-foo": "bar" }), {
css: `[data-foo*="bar"]`,
});
assert.deepEqual(selectorFromObject({ "data-foo": "true" }), {
css: `[data-foo="true"]`,
});
});
});
// The string form's kind space stays open on both sides: "<attr>:<value>" is
// the documented way to reach a raw driver attribute, and internal/hierarchy
// resolves an unknown kind to an empty result rather than an error.
test("selectorFromString accepts a kind the object form would reject", () => {
assert.deepEqual(selectorFromString("descripton:Supplier"), {
css: `[descripton*="Supplier"]`,
});
});
function withDocumentCarrying(attributes: string[], run: () => void): void {
const global = globalThis as Record<string, unknown>;
const original = global.document;
global.document = {
querySelector: (selector: string) =>
attributes.some((name) => selector === `[${name}]`) ? {} : null,
};
try {
run();
} finally {
global.document = original;
}
}
test("selectorFromObject text-only selector becomes an XPath", () => {
assert.deepEqual(selectorFromObject({ text: "Go" }), {
xpath:
`.//*[contains(normalize-space(.), "Go") ` +
`and not(.//*[contains(normalize-space(.), "Go")])]`,
});
});
// domElement is one element as elementHandle reads it. dataset camelCases its
// keys the way a real DOMStringMap does, which is what hid `data-cents` and
// friends behind `attrs.cents` and made every assertion over them read
// undefined.
function domElement(spec: {
tag: string;
attributes?: Record<string, string>;
labels?: string[];
text?: string;
checked?: boolean;
contentEditable?: boolean;
type?: string;
}): unknown {
const attributes = spec.attributes ?? {};
return {
tagName: spec.tag.toUpperCase(),
type: spec.type ?? (spec.tag === "input" ? "text" : ""),
isContentEditable: spec.contentEditable ?? false,
checked: spec.checked,
id: attributes.id ?? "",
className: attributes.class ?? "",
textContent: spec.text ?? "",
dataset: Object.fromEntries(
Object.entries(attributes)
.filter(([name]) => name.startsWith("data-"))
.map(([name, value]) => [
name.slice("data-".length).replace(/-(.)/g, (_, letter: string) => letter.toUpperCase()),
value,
]),
),
attributes: Object.entries(attributes).map(([name, value]) => ({ name, value })),
labels: (spec.labels ?? []).map((textContent) => ({ textContent })),
getAttribute: (name: string) => attributes[name] ?? null,
matches: (selector: string) => matchesAnyPart(selector, spec.tag, attributes),
getBoundingClientRect: () => ({ left: 0, top: 0, right: 40, bottom: 20, width: 40, height: 20 }),
};
}
// matchesAnyPart answers a comma-joined list of tag and attribute selectors over
// the fake's own tag and attributes, so the production selector string is what
// gets evaluated here and a role added to it is covered without teaching this
// harness about it.
function matchesAnyPart(
selector: string,
tag: string,
attributes: Record<string, string>,
): boolean {
return selector.split(",").some((part) => {
const attribute = /^\[([^\]=]+)(?:="([^"]*)")?\]$/.exec(part.trim());
if (!attribute) return part.trim() === tag;
const value = attributes[attribute[1]!];
return value !== undefined && (attribute[2] === undefined || value === attribute[2]);
});
}
function handleOf(element: unknown): Record<string, unknown> {
const global = globalThis as Record<string, unknown>;
const original = global.document;
global.document = { querySelector: () => element, querySelectorAll: () => [element] };
try {
const ax = __testing__.buildAx() as { find(selector: unknown): Record<string, unknown> };
return ax.find({ id: "any" });
} finally {
global.document = original;
}
}
function attrsOf(element: unknown): Record<string, string> {
return handleOf(element).attrs as Record<string, string>;
}
// `attrs` means the same thing on every backend: the attributes the markup
// writes, keyed by the names it writes them under. A spec reading
// attrs["data-cents"] the way examples/folio-web does read undefined here, so
// the properties over those values could never hold OR fail.
test("attrs keys data attributes by the name the markup writes", () => {
const element = domElement({
tag: "div",
attributes: { id: "ledger", "data-txn-count": "3", "data-account-id": "a-1" },
});
assert.equal(attrsOf(element)["data-txn-count"], "3");
assert.equal(attrsOf(element)["data-account-id"], "a-1");
// `dataset` stays the DOMStringMap view, camelCase keys and all.
assert.deepEqual(handleOf(element).dataset, { txnCount: "3", accountId: "a-1" });
});
// docs/manual/spec-language.md lists `checked` on every element find returns,
// and HTML keeps that state in the DOM property: the markup attribute only
// records what the page started with. A handle reading the attribute reports a
// checkbox's starting state forever, so a property over "the box is ticked"
// holds on a page where nothing was ever ticked.
test("checked reads the live property, not the markup attribute", () => {
const ticked = domElement({ tag: "input", attributes: { id: "toggle-all" }, checked: true });
assert.equal(handleOf(ticked).checked, true);
const cleared = domElement({
tag: "input",
attributes: { id: "toggle-all", checked: "" },
checked: false,
});
assert.equal(handleOf(cleared).checked, false);
});
// `secure` answers three ways. A consumer deciding what a typed value may be
// written into a record has to tell "not a password field" apart from "no
// platform said", and android says nothing: a field answering false only when
// asked about a password would make every web field look like an android one.
test("secure states the field type either way, and nothing off a field", () => {
const password = domElement({ tag: "input", attributes: { id: "pwd" }, type: "password" });
assert.equal(handleOf(password).secure, true);
const email = domElement({ tag: "input", attributes: { id: "email" }, type: "email" });
assert.equal(handleOf(email).secure, false);
const heading = domElement({ tag: "h1", attributes: { id: "title" } });
assert.equal(handleOf(heading).secure, null);
});
test("attrs carries every other attribute alongside tag and aria-label", () => {
const attrs = attrsOf(
domElement({ tag: "input", attributes: { id: "txn-note", placeholder: "What's this for?" } }),
);
assert.equal(attrs.tag, "input");
assert.equal(attrs["aria-label"], "");
assert.equal(attrs.id, "txn-note");
assert.equal(attrs.placeholder, "What's this for?");
});
// An input has no text of its own, so a handle that names it by text names it
// "". hintText is the rung visibleLabel reads first for an editable element,
// and it is what lets a model tell the amount field from the note field.
test("an editable field's hintText is the label bound to it", () => {
const element = domElement({
tag: "input",
attributes: { id: "txn-amount", placeholder: "0.00" },
labels: ["Amount"],
});
assert.equal(attrsOf(element).hintText, "Amount");
assert.equal(handleOf(element).editable, true);
assert.equal(handleOf(element).text, "");
});
test("an unlabelled field's hintText falls back to aria-label, placeholder, then name", () => {
assert.equal(
attrsOf(domElement({ tag: "input", attributes: { "aria-label": "Search", placeholder: "Type here" } }))
.hintText,
"Search",
);
assert.equal(
attrsOf(domElement({ tag: "input", attributes: { placeholder: "What's this for?" } })).hintText,
"What's this for?",
);
assert.equal(attrsOf(domElement({ tag: "input", attributes: { name: "note" } })).hintText, "note");
});
// clickable was hardcoded true here while the enumeration and the hierarchy dump
// both resolved it through TAPPABLE_SELECTOR, so every text node and container a
// spec reached through state.ax claimed to be a tap target on one host only.
test("an element reached through ax reports the tappable selector's clickability", () => {
const clickabilityOf = (element: unknown) => handleOf(element).clickable;
assert.equal(clickabilityOf(domElement({ tag: "button", attributes: { id: "submit" } })), true);
assert.equal(clickabilityOf(domElement({ tag: "input", attributes: { id: "amount" } })), true);
assert.equal(
clickabilityOf(domElement({ tag: "div", attributes: { id: "row", role: "option" } })),
true,
);
assert.equal(
clickabilityOf(domElement({ tag: "div", attributes: { id: "click", onclick: "void 0" } })),
true,
);
assert.equal(clickabilityOf(domElement({ tag: "div", attributes: { id: "balance" } })), false);
assert.equal(
clickabilityOf(domElement({ tag: "span", attributes: { id: "note", role: "presentation" } })),
false,
);
});
// isContentEditable is inherited, so the handle called every span inside a
// contenteditable container typeable while the enumeration and the hierarchy
// dump, which both ask whether the element itself matches EDITABLE_SELECTOR,
// called the same span inert.
test("an element reached through ax reports the editable selector's editability", () => {
const editabilityOf = (element: unknown) => handleOf(element).editable;
assert.equal(
editabilityOf(
domElement({ tag: "div", attributes: { id: "note", contenteditable: "" }, contentEditable: true }),
),
true,
);
assert.equal(
editabilityOf(domElement({ tag: "span", attributes: { id: "word" }, contentEditable: true })),
false,
);
assert.equal(editabilityOf(domElement({ tag: "textarea", attributes: { id: "memo" } })), true);
});
test("a non-editable element carries no hintText", () => {
const element = domElement({ tag: "button", attributes: { id: "txn-submit" }, text: "Add credit" });
assert.equal(attrsOf(element).hintText, undefined);
assert.equal(handleOf(element).editable, false);
});
// An ax element is labelled with the selector it was found by, in the same
// canonical grammar selectorStringFromJS emits in internal/verifier/marshal.go.
// The label is what a spec's own Tap({ on: state.ax.find(...) }) carries to the
// runner: with no label the action is coordinates only, `lastAction.on` is
// empty, and a property matching on WHICH control was tapped cannot fire.
const { selectorTag } = __testing__;
test("selectorTag renders the selector shapes the goja host renders", () => {
assert.equal(selectorTag("testTag:TxnSubmit"), "testTag:TxnSubmit");
assert.equal(selectorTag({ testTag: "TxnSubmit" }), "testTag:TxnSubmit");
assert.equal(
selectorTag([{ testTag: "AddTransactionScreen" }, { testTag: "TxnSubmit" }]),
"testTag:AddTransactionScreen > testTag:TxnSubmit",
);
assert.equal(selectorTag({ testTag: "Row", "aria-label": "first" }), "testTag:Row aria-label:first");
assert.equal(selectorTag(undefined), "");
});
// A selector path scopes the second segment to each match of the first. It
// returned nothing at all on web while returning matches on native, so folio's
// accounts/totalBalance extractors (findAll([{HomeScreen}, {AccountCard}]))
// were empty on every web step and the properties over them checked nothing.
test("ax.findAll resolves a selector path segment by segment", () => {
const card = (id: string, y: number): FakeElementSpec => ({
tag: "div", x: 0, y, width: 10, height: 10, testid: "AccountCard", text: id,
});
// The stray card is outside HomeScreen, so a document-wide sweep for the
// second segment picks it up and the scoping assertion below fails.
const page = fakeElement({
tag: "div", x: 0, y: 0, width: 100, height: 100,
children: [
{
tag: "div", x: 0, y: 0, width: 100, height: 50, testid: "HomeScreen",
children: [card("first", 0), card("second", 10)],
},
card("stray", 60),
],
});
withFakeDocument([page], () => {
__testing__.extractors.length = 0;
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { findAll(s: unknown): Record<string, unknown>[] } }).ax;
return ax
.findAll([{ testTag: "HomeScreen" }, { testTag: "AccountCard" }])
.map((card) => card.text);
});
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { findAll(s: unknown): Record<string, unknown>[] } }).ax;
return ax
.findAll([{ testTag: "HomeScreen" }, { testTag: "AccountCard" }])
.map((card) => card.__sanderlingSelector);
});
const values = __testing__.evaluateExtractors();
// Scoped to the head match: the cards come from the HomeScreen node, not
// from a document-wide sweep for AccountCard.
assert.deepEqual(readingOf(values, 0), ["first", "second"]);
// Both cards answer to the same path, so neither may carry it: the runner
// re-resolves a named target and would send both taps to the first card.
assert.deepEqual(readingOf(values, 1), ["", ""]);
});
});
// A selector is a name only while ONE element answers to it. The runner prefers
// the name over the coordinates the element reported (resolveCoordinates in
// internal/runner) and takes the first match, so labelling siblings that share a
// testTag sends every one of their taps to the first sibling: on folio's Home
// screen no account but the first could ever be opened.
test("ax.find and ax.findAll label the element with the selector only when it names that element alone", () => {
const sibling = (text: string, y: number): FakeElementSpec => ({
tag: "div", x: 0, y, width: 10, height: 10, testid: "AccountCard", text,
});
const page = fakeElement({
tag: "div", x: 0, y: 0, width: 100, height: 100,
children: [
{ tag: "div", x: 0, y: 0, width: 10, height: 10, id: "TxnSubmit", text: "Submit" },
sibling("Alpha", 20),
sibling("Beta", 40),
sibling("Gamma", 60),
],
});
withFakeDocument([page], () => {
__testing__.extractors.length = 0;
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { find(s: unknown): Record<string, unknown> | undefined } }).ax;
return ax.find({ testTag: "TxnSubmit" });
});
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { findAll(s: unknown): Record<string, unknown>[] } }).ax;
return ax.findAll({ testTag: "TxnSubmit" });
});
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { findAll(s: unknown): Record<string, unknown>[] } }).ax;
return ax.findAll({ testTag: "AccountCard" });
});
const values = __testing__.evaluateExtractors();
const found = readingOf(values, 0) as Record<string, unknown>;
assert.equal(found.__sanderlingSelector, "testTag:TxnSubmit");
// findAll passes each element through map(); passing the callback by
// reference would hand the array INDEX to the runtime as the selector.
const all = readingOf(values, 1) as Record<string, unknown>[];
assert.equal(all[0]!.__sanderlingSelector, "testTag:TxnSubmit");
const siblings = readingOf(values, 2) as Record<string, unknown>[];
assert.deepEqual(
siblings.map((card) => card.__sanderlingSelector),
["", "", ""],
);
assert.deepEqual(
siblings.map((card) => card.y),
[25, 45, 65],
);
});
});
// The same rule for a child lookup, which is the shape a spec reaches a row
// through: screen.findAll({...}). The runner resolves the child selector against
// the whole dump, not the parent's subtree, so scoping does not make a shared
// name safe.
test("element.find and element.findAll label a child only when the selector names it alone", () => {
const home = fakeElement({
tag: "div", x: 0, y: 0, width: 100, height: 100, testid: "HomeScreen",
children: [
{ tag: "div", x: 0, y: 0, width: 10, height: 10, testid: "AccountCard", text: "first" },
{ tag: "div", x: 0, y: 20, width: 10, height: 10, testid: "AccountCard", text: "second" },
{ tag: "div", x: 0, y: 40, width: 10, height: 10, testid: "Total", text: "Total" },
],
});
withFakeDocument([home], () => {
__testing__.extractors.length = 0;
__testing__.runtime.extract((state) => {
const ax = (state as {
ax: { find(s: unknown): { findAll(s: unknown): Record<string, unknown>[] } };
}).ax;
return ax
.find({ testTag: "HomeScreen" })
.findAll({ testTag: "AccountCard" })
.map((card) => card.__sanderlingSelector);
});
__testing__.runtime.extract((state) => {
const ax = (state as {
ax: { find(s: unknown): { find(s: unknown): Record<string, unknown> } };
}).ax;
return ax.find({ testTag: "HomeScreen" }).find({ testTag: "Total" }).__sanderlingSelector;
});
const values = __testing__.evaluateExtractors();
assert.deepEqual(readingOf(values, 0), ["", ""]);
assert.equal(readingOf(values, 1), "testTag:Total");
});
});
// One page, one selector, two hosts. The goja host resolves a selector against
// the hierarchy dump, whose buildTree (internal/driver/chrome/driver.go) emits
// a host's shadow children BEFORE its light ones, so a pre-order search there
// reaches a shadow-hosted match first. deepQueryAll swept the whole light DOM
// first and only then descended, so this page answered find({id:"x"}) with the
// light node in V8 and the shadow node in goja, and on web V8's answer is the
// one that reaches the properties.
test("ax.find resolves the shadow-hosted match the hierarchy dump reaches first", () => {
const page = fakeElement({
tag: "div", x: 0, y: 0, width: 400, height: 800, id: "page",
children: [
{
tag: "div", x: 0, y: 0, width: 400, height: 100, id: "mount",
shadow: [{ tag: "span", x: 0, y: 0, width: 40, height: 20, id: "x", text: "shadow" }],
},
{ tag: "span", x: 0, y: 100, width: 40, height: 20, id: "x", text: "light" },
],
});
withFakeDocument([page], () => {
__testing__.extractors.length = 0;
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { find(s: unknown): Record<string, unknown> | undefined } }).ax;
return ax.find("id:x")?.text;
});
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { findAll(s: unknown): Record<string, unknown>[] } }).ax;
return ax.findAll("id:x").map((element) => element.text);
});
const values = __testing__.evaluateExtractors();
assert.equal(readingOf(values, 0), "shadow");
assert.deepEqual(readingOf(values, 1), ["shadow", "light"]);
});
});
// document.activeElement stops at every shadow boundary it meets, so a Compose
// for Web page, which mounts its whole tree in a shadow root, answered `focused`
// on the mount element and never on the field the user was typing into.
// internal/driver/chrome/driver.go descends the same chain for the dump the goja
// host reads, so a handle that compares against the host alone puts the two
// hosts on opposite answers for one page.
test("ax.find reports focus on the field inside the shadow root, not on its hosts", () => {
const app = fakeElement({
tag: "div", x: 0, y: 0, width: 400, height: 800, id: "app",
shadow: [
{
tag: "div", x: 0, y: 0, width: 400, height: 100, id: "form",
shadow: [
{
tag: "input", x: 0, y: 0, width: 200, height: 40, id: "amount",
editable: true, focused: true,
},
],
},
],
});
withFakeDocument([app], () => {
__testing__.extractors.length = 0;
for (const id of ["amount", "form", "app"]) {
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { find(s: unknown): Record<string, unknown> | undefined } }).ax;
return ax.find(`id:${id}`)?.focused;
});
}
const values = __testing__.evaluateExtractors();
assert.equal(readingOf(values, 0), true);
assert.equal(readingOf(values, 1), false);
assert.equal(readingOf(values, 2), false);
});
});
// Descending the shadow roots is still not enough on Compose for Web: it takes
// keystrokes on a 1px input pinned to the caret, a SIBLING of the accessibility
// tree, so DOM focus never reaches the semantics element carrying the test tag
// and every field read unfocused. internal/driver/chrome/driver.go re-attributes
// focus to the field the caret sits in, and TestElementState_FocusFollowsTheCaretToItsField
// pins it there over a real Compose-shaped page.
//
// Both fields are focused in turn, because answering with the first editable in
// the tree would satisfy the email half and still name the wrong field. The
// password caret overhangs its box, as it does whenever the text style is taller
// than the field's layout box, so requiring the caret to be CONTAINED rather
// than to have its centre inside would drop that field back to unfocused.
test("focus follows the caret to the field it types into, not the input it is", () => {
const carets = [
{ field: "EmailField", y: 78, height: 17.578125 },
{ field: "PasswordField", y: 157, height: 20 },
];
for (const caret of carets) {
const app = fakeElement({
tag: "div", x: 0, y: 0, width: 760, height: 800, id: "app",
shadow: [
{
tag: "div", x: 0, y: 0, width: 0, height: 0, id: "caret-holder",
customProperties: {
"--compose-internal-web-backing-input-left": "34",
"--compose-internal-web-backing-input-top": String(caret.y),
"--compose-internal-web-backing-input-width": "1",
"--compose-internal-web-backing-input-height": String(caret.height),
},
children: [
{
tag: "input", x: 34, y: caret.y, width: 1, height: caret.height,
id: "caret-input", editable: true, focused: true,
},
],
},
{
tag: "div", x: 0, y: 0, width: 760, height: 800, id: "a11y-root",
children: [
{
tag: "div", x: 34, y: 78, width: 688, height: 18, id: "EmailField",
attrs: { role: "textbox", contenteditable: "true" }, editable: true,
},
{
tag: "div", x: 34, y: 158, width: 688, height: 18, id: "PasswordField",
attrs: { role: "textbox", contenteditable: "true" }, editable: true,
},
],
},
],
});
withFakeDocument([app], () => {
__testing__.extractors.length = 0;
const ids = ["EmailField", "PasswordField", "caret-input", "caret-holder", "a11y-root", "app"];
for (const id of ids) {
__testing__.runtime.extract((state) => {
const ax = (state as { ax: { find(s: unknown): Record<string, unknown> | undefined } }).ax;
return ax.find(`id:${id}`)?.focused;
});
}
const values = __testing__.evaluateExtractors();
const focused = ids.filter((_, index) => readingOf(values, index) === true);
assert.deepEqual(focused, [caret.field]);
});
}
});
// A nested undefined is the one reading shape the two hosts do NOT encode
// alike, and this pins the split instead of hiding it. JSON has no undefined,
// so the key goes with the value here; goja marshals the same member as null,
// and it cannot do otherwise, because an exported goja object reports undefined
// and null identically, so dropping those keys there would drop the genuine
// nulls this host keeps. Carrying the member across would take a wire format
// that can express undefined.
//
// What both hosts DO agree on is the member's value: reading it answers
// undefined either way, and that is the guarantee a property may rely on. Key
// presence (`in`, Object.keys) is not.
// TestExtractorEncoding_NestedUndefinedIsNotOnTheWire in
// internal/verifier/extractor_encoding_test.go pins the other half.
test("a nested undefined leaves the page as a dropped key, a nested null does not", () => {
__testing__.extractors.length = 0;
__testing__.runtime.extract(() => ({ absent: undefined, empty: null, present: 1 }));
let wire = "";
withState(() => {
// Exactly what extractorScript in internal/driver/chrome/driver.go sends.
wire = JSON.stringify(__testing__.evaluateExtractors());
});
assert.equal(wire, `{"0":{"value":{"empty":null,"present":1}}}`);
});