@dloizides/game-e2e 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  import { devices, expect } from '@playwright/test';
2
- import { STANDARD_BUTTON, DIALOG_SELECTOR, MENU_FOCUSABLE_SELECTOR } from '@dloizides/game-input';
2
+ import { STANDARD_BUTTON, DIALOG_SELECTOR, MENU_FOCUSABLE_SELECTOR, MENU_WALK_HOOK } from '@dloizides/game-input';
3
3
 
4
4
  // src/boxes.ts
5
5
  var CONTROL_TEXT_CHARS = 12;
@@ -503,6 +503,30 @@ async function stubGamepad(page) {
503
503
  };
504
504
  }
505
505
 
506
+ // src/menu-walk-report.ts
507
+ var WALK_INPUTS = { keys: "keys", pad: "pad" };
508
+ var walkFailed = (r) => r.unreached.length > 0 || r.problems.length > 0;
509
+ function renderWalk(results) {
510
+ return results.map((r) => [
511
+ `${r.screen} [${r.via}] reached ${r.reached}/${r.total}`,
512
+ ...r.unreached.map((n) => ` unreached: ${n}`),
513
+ ...r.problems.map((p) => ` problem: ${p}`),
514
+ ...r.exempt.map((e) => ` exempt: ${e}`),
515
+ ...r.notes.map((n) => ` note: ${n}`)
516
+ ].join("\n")).join("\n");
517
+ }
518
+
519
+ // src/menu-walk-driver.ts
520
+ var DIRS = ["up", "down", "left", "right"];
521
+ var KEYS = { up: "ArrowUp", down: "ArrowDown", left: "ArrowLeft", right: "ArrowRight" };
522
+ var PAD_BUTTONS = { up: STANDARD_BUTTON.dpadUp, down: STANDARD_BUTTON.dpadDown, left: STANDARD_BUTTON.dpadLeft, right: STANDARD_BUTTON.dpadRight };
523
+ function driverFor(page, via, pad) {
524
+ if (via === WALK_INPUTS.pad && pad !== null) {
525
+ return { dir: (d) => pad.press(PAD_BUTTONS[d]), back: () => pad.press(STANDARD_BUTTON.east), activate: () => pad.press(STANDARD_BUTTON.south) };
526
+ }
527
+ return { dir: (d) => page.keyboard.press(KEYS[d]), back: () => page.keyboard.press("Escape"), activate: () => page.keyboard.press("Enter") };
528
+ }
529
+
506
530
  // src/menu-walk-listeners.ts
507
531
  var POINTER_EVENTS = ["click", "pointerdown", "pointerup"];
508
532
  var NO_CDP_NOTE = "CDP unavailable (not Chromium): click/pointer listeners added with addEventListener were not checked; only [onclick] and handler properties were";
@@ -528,24 +552,14 @@ async function openCdp(page) {
528
552
  return null;
529
553
  }
530
554
  }
531
- async function listenerProbes(cdp, probeAttr, count) {
532
- const hits = [];
533
- for (let i = 0; i < count; i += 1) {
534
- const { result } = await cdp.send("Runtime.evaluate", { expression: `document.querySelector('[${probeAttr}="${i}"]')` });
535
- if (result.objectId === void 0) {
536
- continue;
537
- }
538
- const { listeners } = await cdp.send("DOMDebugger.getEventListeners", { objectId: result.objectId });
539
- if (listeners.some((l) => POINTER_EVENTS.includes(l.type))) {
540
- hits.push(i);
541
- }
542
- await cdp.send("Runtime.releaseObject", { objectId: result.objectId });
543
- }
544
- return hits;
555
+ async function listenerProbes(cdp, probeAttr) {
556
+ const expression = `Array.from(document.querySelectorAll('[${probeAttr}]')).filter((el) => ${JSON.stringify(POINTER_EVENTS)}.some((t) => (getEventListeners(el)[t] ?? []).length > 0)).map((el) => Number(el.getAttribute('${probeAttr}')))`;
557
+ const { result } = await cdp.send("Runtime.evaluate", { expression, includeCommandLineAPI: true, returnByValue: true });
558
+ return Array.isArray(result.value) ? result.value : [];
545
559
  }
546
560
  async function pointerOnlyControls(page, cdp, args, start) {
547
561
  const marks = await page.evaluate(markProbes, args);
548
- const viaListener = cdp === null ? [] : await listenerProbes(cdp, args.probeAttr, marks.probes);
562
+ const viaListener = cdp === null || marks.probes === 0 ? [] : await listenerProbes(cdp, args.probeAttr);
549
563
  const ids = [.../* @__PURE__ */ new Set([...marks.withProperty, ...viaListener])];
550
564
  const identities = await page.evaluate(flagProbes, [args.attr, args.probeAttr, ids, start]);
551
565
  return { identities, notes: cdp === null ? [NO_CDP_NOTE] : [] };
@@ -592,33 +606,11 @@ function rootOpen(rootAttr) {
592
606
  return r !== null && r.getClientRects().length > 0 && r.closest("[hidden]") === null;
593
607
  }
594
608
 
595
- // src/menu-walk-report.ts
596
- var WALK_INPUTS = { keys: "keys", pad: "pad" };
597
- var walkFailed = (r) => r.unreached.length > 0 || r.problems.length > 0;
598
- function renderWalk(results) {
599
- return results.map((r) => [
600
- `${r.screen} [${r.via}] reached ${r.reached}/${r.total}`,
601
- ...r.unreached.map((n) => ` unreached: ${n}`),
602
- ...r.problems.map((p) => ` problem: ${p}`),
603
- ...r.exempt.map((e) => ` exempt: ${e}`),
604
- ...r.notes.map((n) => ` note: ${n}`)
605
- ].join("\n")).join("\n");
606
- }
607
-
608
609
  // src/menu-walk.ts
609
610
  var WALK_ATTR = "data-walk-id";
610
611
  var ROOT_ATTR = "data-walk-root";
611
612
  var PROBE_ATTR = "data-walk-probe";
612
613
  var PRESSES_PER_CONTROL = 4;
613
- var DIRS = ["up", "down", "left", "right"];
614
- var KEYS = { up: "ArrowUp", down: "ArrowDown", left: "ArrowLeft", right: "ArrowRight" };
615
- var PAD_BUTTONS = { up: STANDARD_BUTTON.dpadUp, down: STANDARD_BUTTON.dpadDown, left: STANDARD_BUTTON.dpadLeft, right: STANDARD_BUTTON.dpadRight };
616
- function driverFor(page, via, pad) {
617
- if (via === WALK_INPUTS.pad && pad !== null) {
618
- return { dir: (d) => pad.press(PAD_BUTTONS[d]), back: () => pad.press(STANDARD_BUTTON.east) };
619
- }
620
- return { dir: (d) => page.keyboard.press(KEYS[d]), back: () => page.keyboard.press("Escape") };
621
- }
622
614
  var active = (page) => page.evaluate(activeWalkId, WALK_ATTR);
623
615
  var focusId = (page, id) => page.evaluate(focusWalkId, [WALK_ATTR, id]);
624
616
  async function bfs(page, driver, total) {
@@ -703,6 +695,184 @@ ${renderWalk(results)}`);
703
695
  }
704
696
  }
705
697
 
706
- export { ANTI_ALIAS_TOLERANCE, CANVAS_TIMEOUT_MS, CONTROL_SELECTOR, DEFAULT_CANVAS_SELECTOR, DESKTOP_DEVICE, DESKTOP_SIZE, EXACT, FIT_TIMEOUT_MS, GAME_SHELL_HEIGHT_VAR, MAX_REPORTED, MIN_TARGET_PX, PHONE_DEVICE, PHONE_SIZE, RELAYOUT_TIMEOUT_MS, STUB_FRAMES, WALK_INPUTS, armVisibleHeight, auditRoute, auditTouchTargets, canvasBoxToPage, controlName, countDiff, desktop, deviceDescriptor, diffPngs, domControls, expectCanvasHeight, expectCanvasInside, expectFitTo, expectMenuWalkable, expectNoHorizontalOverflow, expectNoHorizontalOverflowAcrossRoutes, expectTouchTargets, expectTouchTargetsAcrossRoutes, findOverlaps, findOverlapsWithin, gameProjects, horizontalOverflowPx, measureHorizontalOverflow, overlaps, phone, readHorizontalOverflow, regionDiff, renderFindings, renderOverflow, renderRouteAudit, renderWalk, routeProblems, shrinkVisibleHeight, stubGamepad, summariseOverflow, summariseTouchTargets, toOverflowReading, walkFailed, walkMenus };
698
+ // src/menu-walk-graph.ts
699
+ var PRESSES_PER_ITEM = 16;
700
+ function shortestPath(edges, from, to) {
701
+ if (from === null) {
702
+ return null;
703
+ }
704
+ const prev = /* @__PURE__ */ new Map([[from, []]]);
705
+ const queue = [from];
706
+ while (queue.length > 0) {
707
+ const at2 = queue.shift();
708
+ const steps = prev.get(at2);
709
+ if (at2 === to) {
710
+ return steps;
711
+ }
712
+ for (const [d, next] of edges.get(at2) ?? []) {
713
+ if (next !== null && !prev.has(next)) {
714
+ prev.set(next, [...steps, d]);
715
+ queue.push(next);
716
+ }
717
+ }
718
+ }
719
+ return null;
720
+ }
721
+ function pendingDir(edges, node) {
722
+ const out = edges.get(node);
723
+ return out === void 0 ? void 0 : DIRS.find((x) => !out.has(x));
724
+ }
725
+ function nextUnexplored(edges, cur) {
726
+ const seen = new Set(cur === null ? [] : [cur]);
727
+ const queue = cur === null ? [] : [cur];
728
+ while (queue.length > 0) {
729
+ const at2 = queue.shift();
730
+ const d = pendingDir(edges, at2);
731
+ if (d !== void 0) {
732
+ return [at2, d];
733
+ }
734
+ for (const next of edges.get(at2)?.values() ?? []) {
735
+ if (next !== null && !seen.has(next)) {
736
+ seen.add(next);
737
+ queue.push(next);
738
+ }
739
+ }
740
+ }
741
+ for (const node of edges.keys()) {
742
+ const d = pendingDir(edges, node);
743
+ if (d !== void 0) {
744
+ return [node, d];
745
+ }
746
+ }
747
+ return null;
748
+ }
749
+ async function travel(m, edges, cur, node) {
750
+ let at2 = cur;
751
+ let steps = shortestPath(edges, at2, node);
752
+ if (steps === null) {
753
+ at2 = await m.reset();
754
+ steps = shortestPath(edges, at2, node) ?? [];
755
+ }
756
+ for (const d of steps) {
757
+ at2 = await m.press(d);
758
+ }
759
+ return at2;
760
+ }
761
+ async function exploreFocus(m, itemCount) {
762
+ const edges = /* @__PURE__ */ new Map();
763
+ let cur = await m.reset();
764
+ if (cur === null) {
765
+ cur = await m.press("down");
766
+ }
767
+ if (cur !== null) {
768
+ edges.set(cur, /* @__PURE__ */ new Map());
769
+ }
770
+ let budget = PRESSES_PER_ITEM * Math.max(itemCount, 1);
771
+ for (let next = nextUnexplored(edges, cur); next !== null && budget > 0; next = nextUnexplored(edges, cur)) {
772
+ const [node, d] = next;
773
+ const out = edges.get(node);
774
+ cur = await travel(m, edges, cur, node);
775
+ budget -= 1;
776
+ if (cur !== node) {
777
+ out.set(d, null);
778
+ continue;
779
+ }
780
+ cur = await m.press(d);
781
+ out.set(d, cur);
782
+ if (cur !== null && !edges.has(cur)) {
783
+ edges.set(cur, /* @__PURE__ */ new Map());
784
+ }
785
+ }
786
+ return { reached: new Set(edges.keys()), path: (from, to) => shortestPath(edges, from, to) };
787
+ }
788
+
789
+ // src/menu-walk-hook.ts
790
+ var HOOK_WALK_SIZES = [["phone", PHONE_SIZE], ["desktop", DESKTOP_SIZE]];
791
+ function readHook(name) {
792
+ const hook = window[name];
793
+ return hook === void 0 ? null : { screen: hook.screen(), items: hook.items(), focused: hook.focused() };
794
+ }
795
+ var read = (page) => page.evaluate(readHook, MENU_WALK_HOOK);
796
+ async function reopen(w) {
797
+ await w.opts.open(w.page, w.screen.name);
798
+ return read(w.page);
799
+ }
800
+ function machine(w) {
801
+ return {
802
+ press: async (d) => {
803
+ await w.driver.dir(d);
804
+ return (await read(w.page))?.focused ?? null;
805
+ },
806
+ reset: async () => (await reopen(w))?.focused ?? null
807
+ };
808
+ }
809
+ async function activationProblem(w, graph, target) {
810
+ const steps = graph.path((await reopen(w))?.focused ?? null, target.item);
811
+ if (steps === null) {
812
+ return `cannot reach ${target.item} to activate it`;
813
+ }
814
+ for (const d of steps) {
815
+ await w.driver.dir(d);
816
+ }
817
+ await w.driver.activate();
818
+ const landed = (await read(w.page))?.screen;
819
+ const key = w.via === WALK_INPUTS.pad ? "A" : "Enter";
820
+ return landed === target.to ? null : `${key} on ${target.item} opens "${String(landed)}", expected "${target.to}"`;
821
+ }
822
+ async function actionProblems(w, graph) {
823
+ const problems = [];
824
+ const target = w.screen.activates;
825
+ const activation = target === void 0 ? null : await activationProblem(w, graph, target);
826
+ if (activation !== null) {
827
+ problems.push(activation);
828
+ }
829
+ if (w.screen.leaves !== false) {
830
+ await reopen(w);
831
+ await w.driver.back();
832
+ const key = w.via === WALK_INPUTS.pad ? "B" : "Escape";
833
+ if ((await read(w.page))?.screen === w.screen.name) {
834
+ problems.push(`${key} does not leave ${w.screen.name}`);
835
+ }
836
+ }
837
+ return problems;
838
+ }
839
+ async function walkHookScreen(w, size) {
840
+ const exempt = w.screen.exempt ?? [];
841
+ const base = { screen: `${w.screen.name} @${size}`, via: w.via, exempt: exempt.map((e) => `${e.item}: ${e.reason}`), notes: [] };
842
+ const first = await reopen(w);
843
+ if (first === null) {
844
+ return { ...base, reached: 0, total: 0, unreached: [], problems: [`window.${MENU_WALK_HOOK} is not installed`] };
845
+ }
846
+ const problems = first.screen === w.screen.name ? [] : [`open landed on screen "${first.screen}"`];
847
+ const items = first.items.filter((i) => !exempt.some((e) => e.item === i));
848
+ const graph = await exploreFocus(machine(w), first.items.length);
849
+ const unreached = items.filter((i) => !graph.reached.has(i));
850
+ problems.push(...await actionProblems(w, graph));
851
+ return { ...base, reached: items.length - unreached.length, total: items.length, unreached, problems };
852
+ }
853
+ async function walkHookMenus(page, opts) {
854
+ const via = opts.via ?? [WALK_INPUTS.keys, WALK_INPUTS.pad];
855
+ const pad = via.includes(WALK_INPUTS.pad) ? await stubGamepad(page) : null;
856
+ const results = [];
857
+ for (const [label, size] of opts.sizes ?? HOOK_WALK_SIZES) {
858
+ await page.setViewportSize(size);
859
+ for (const s of opts.screens) {
860
+ const screen = typeof s === "string" ? { name: s } : s;
861
+ for (const v of via) {
862
+ results.push(await walkHookScreen({ page, opts, screen, driver: driverFor(page, v, pad), via: v }, label));
863
+ }
864
+ }
865
+ }
866
+ return results;
867
+ }
868
+ async function expectHookMenuWalkable(page, opts) {
869
+ const results = await walkHookMenus(page, opts);
870
+ if (results.some(walkFailed)) {
871
+ throw new Error(`Canvas menus not walkable by arrow keys / pad:
872
+ ${renderWalk(results)}`);
873
+ }
874
+ }
875
+
876
+ export { ANTI_ALIAS_TOLERANCE, CANVAS_TIMEOUT_MS, CONTROL_SELECTOR, DEFAULT_CANVAS_SELECTOR, DESKTOP_DEVICE, DESKTOP_SIZE, EXACT, FIT_TIMEOUT_MS, GAME_SHELL_HEIGHT_VAR, HOOK_WALK_SIZES, MAX_REPORTED, MIN_TARGET_PX, PHONE_DEVICE, PHONE_SIZE, RELAYOUT_TIMEOUT_MS, STUB_FRAMES, WALK_INPUTS, armVisibleHeight, auditRoute, auditTouchTargets, canvasBoxToPage, controlName, countDiff, desktop, deviceDescriptor, diffPngs, domControls, expectCanvasHeight, expectCanvasInside, expectFitTo, expectHookMenuWalkable, expectMenuWalkable, expectNoHorizontalOverflow, expectNoHorizontalOverflowAcrossRoutes, expectTouchTargets, expectTouchTargetsAcrossRoutes, findOverlaps, findOverlapsWithin, gameProjects, horizontalOverflowPx, measureHorizontalOverflow, overlaps, phone, readHorizontalOverflow, regionDiff, renderFindings, renderOverflow, renderRouteAudit, renderWalk, routeProblems, shrinkVisibleHeight, stubGamepad, summariseOverflow, summariseTouchTargets, toOverflowReading, walkFailed, walkHookMenus, walkMenus };
707
877
  //# sourceMappingURL=index.mjs.map
708
878
  //# sourceMappingURL=index.mjs.map