mirror of
https://github.com/garrytan/gstack.git
synced 2026-05-21 20:28:24 +08:00
Revert "fix: snapshot -i auto-detects dropdown/popover interactive elements (#844)"
This reverts commit 542e7836d0.
This commit is contained in:
@@ -1,102 +0,0 @@
|
|||||||
# Plan: Snapshot Dropdown/Autocomplete Interactive Element Detection
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
`snapshot -i` misses dropdown/autocomplete items on modern web apps. These elements:
|
|
||||||
1. Are often `<div>`/`<li>` with click handlers but no semantic ARIA roles
|
|
||||||
2. Live inside dynamically-created portals/popovers (floating containers)
|
|
||||||
3. Don't appear in Playwright's accessibility tree (`ariaSnapshot()`)
|
|
||||||
|
|
||||||
The `-C` flag (cursor-interactive scan) was designed for this but:
|
|
||||||
- Requires separate flag — agents using `-i` don't get it automatically
|
|
||||||
- Skips elements that HAVE an ARIA role (even if the ARIA tree missed them)
|
|
||||||
- Doesn't prioritize popover/portal containers where dropdown items live
|
|
||||||
|
|
||||||
## Root Cause
|
|
||||||
|
|
||||||
Playwright's `ariaSnapshot()` builds from the browser's accessibility tree. Dynamically-rendered popovers (React portals, Radix Popover, etc.) may not be in the accessibility tree if:
|
|
||||||
- The component doesn't set ARIA roles
|
|
||||||
- The portal renders outside the scoped `body` locator's subtree timing
|
|
||||||
- The browser hasn't updated the accessibility tree yet after DOM mutation
|
|
||||||
|
|
||||||
## Changes
|
|
||||||
|
|
||||||
### 1. Auto-enable cursor-interactive scan with `-i` flag
|
|
||||||
|
|
||||||
**File:** `browse/src/snapshot.ts`
|
|
||||||
|
|
||||||
When `-i` (interactive) is passed, automatically include the cursor-interactive scan. This means agents always see clickable non-ARIA elements when they ask for interactive elements.
|
|
||||||
|
|
||||||
The `-C` flag remains as a standalone option for non-interactive snapshots.
|
|
||||||
|
|
||||||
```
|
|
||||||
if (opts.interactive) {
|
|
||||||
opts.cursorInteractive = true;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Add popover/portal priority scanning
|
|
||||||
|
|
||||||
**File:** `browse/src/snapshot.ts` (inside cursor-interactive evaluate block)
|
|
||||||
|
|
||||||
Before the general cursor:pointer scan, specifically scan for visible floating containers (popovers, dropdowns, menus) and include ALL their direct children as interactive:
|
|
||||||
|
|
||||||
Detection heuristics for floating containers:
|
|
||||||
- `position: fixed` or `position: absolute` with `z-index >= 10`
|
|
||||||
- Has `role="listbox"`, `role="menu"`, `role="dialog"`, `role="tooltip"`, `[data-radix-popper-content-wrapper]`, `[data-floating-ui-portal]`, etc.
|
|
||||||
- Appeared recently in the DOM (not in initial page load)
|
|
||||||
- Is visible (`offsetParent !== null` or `position: fixed`)
|
|
||||||
|
|
||||||
For each floating container, include child elements that:
|
|
||||||
- Have text content
|
|
||||||
- Are visible
|
|
||||||
- Have cursor:pointer OR onclick OR role="option" OR role="menuitem"
|
|
||||||
- Tag with reason `popover-child` for clarity
|
|
||||||
|
|
||||||
### 3. Remove the `hasRole` skip in cursor-interactive scan
|
|
||||||
|
|
||||||
**File:** `browse/src/snapshot.ts`
|
|
||||||
|
|
||||||
Currently: `if (hasRole) continue;` — skips any element with an ARIA role, assuming the ARIA tree already captured it.
|
|
||||||
|
|
||||||
Problem: if the ARIA tree MISSED the element (timing, portal, bad DOM structure), it falls through both systems.
|
|
||||||
|
|
||||||
Fix: Only skip if the element's role is in `INTERACTIVE_ROLES` AND it was actually captured in the main refMap. Otherwise include it.
|
|
||||||
|
|
||||||
Since we can't easily check the refMap from inside `page.evaluate()`, the simpler fix: remove the `hasRole` skip entirely for elements inside detected floating containers. For elements outside floating containers, keep the `hasRole` skip as-is (to avoid duplicates in normal page content).
|
|
||||||
|
|
||||||
### 4. Add dropdown test fixture and tests
|
|
||||||
|
|
||||||
**File:** `browse/test/fixtures/dropdown.html`
|
|
||||||
|
|
||||||
HTML page with:
|
|
||||||
- A combobox input that shows a dropdown on focus/type
|
|
||||||
- Dropdown items as `<div>` with click handlers (no ARIA roles)
|
|
||||||
- Dropdown items as `<li>` with `role="option"`
|
|
||||||
- A React-portal-style container (`position: fixed`, high z-index)
|
|
||||||
|
|
||||||
**File:** `browse/test/snapshot.test.ts`
|
|
||||||
|
|
||||||
New test cases:
|
|
||||||
- `snapshot -i` on dropdown page finds dropdown items via cursor scan
|
|
||||||
- `snapshot -i` on dropdown page includes popover-child elements
|
|
||||||
- `@c` refs from dropdown scan are clickable
|
|
||||||
- Elements inside floating containers with ARIA roles are captured even when ARIA tree misses them
|
|
||||||
|
|
||||||
## Rollout Risk
|
|
||||||
|
|
||||||
**Low.** The `-C` scan is additive — it only adds `@c` refs, never removes `@e` refs. The change to auto-enable it with `-i` increases output size but agents already handle mixed ref types.
|
|
||||||
|
|
||||||
**One concern:** The `-C` scan queries ALL elements (`document.querySelectorAll('*')`) which can be slow on heavy pages. For the popover-specific scan, we limit to elements inside detected floating containers, which is fast (small subtree).
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd /data/gstack/browse && bun test snapshot
|
|
||||||
```
|
|
||||||
|
|
||||||
## Files Changed
|
|
||||||
|
|
||||||
1. `browse/src/snapshot.ts` — auto-enable -C with -i, popover scanning, remove hasRole skip in floating containers
|
|
||||||
2. `browse/test/fixtures/dropdown.html` — new test fixture
|
|
||||||
3. `browse/test/snapshot.test.ts` — new dropdown/popover test cases
|
|
||||||
@@ -233,12 +233,7 @@ export async function handleSnapshot(
|
|||||||
output.push(outputLine);
|
output.push(outputLine);
|
||||||
}
|
}
|
||||||
|
|
||||||
// ─── Cursor-interactive scan (-C, or auto with -i) ────────
|
// ─── Cursor-interactive scan (-C) ─────────────────────────
|
||||||
// Auto-enable cursor scan when interactive mode is on — agents asking for
|
|
||||||
// interactive elements should always see clickable non-ARIA items too.
|
|
||||||
if (opts.interactive && !opts.cursorInteractive) {
|
|
||||||
opts.cursorInteractive = true;
|
|
||||||
}
|
|
||||||
if (opts.cursorInteractive) {
|
if (opts.cursorInteractive) {
|
||||||
try {
|
try {
|
||||||
const cursorElements = await target.evaluate(() => {
|
const cursorElements = await target.evaluate(() => {
|
||||||
@@ -261,37 +256,9 @@ export async function handleSnapshot(
|
|||||||
const hasTabindex = el.hasAttribute('tabindex') && parseInt(el.getAttribute('tabindex')!, 10) >= 0;
|
const hasTabindex = el.hasAttribute('tabindex') && parseInt(el.getAttribute('tabindex')!, 10) >= 0;
|
||||||
const hasRole = el.hasAttribute('role');
|
const hasRole = el.hasAttribute('role');
|
||||||
|
|
||||||
// Check if element is inside a floating container (portal/popover/dropdown)
|
if (!hasCursorPointer && !hasOnclick && !hasTabindex) continue;
|
||||||
const isInFloating = (() => {
|
// Skip if it has an ARIA role (likely already captured)
|
||||||
let parent: Element | null = el;
|
if (hasRole) continue;
|
||||||
while (parent && parent !== document.documentElement) {
|
|
||||||
const pStyle = getComputedStyle(parent);
|
|
||||||
const isFloating = (pStyle.position === 'fixed' || pStyle.position === 'absolute') &&
|
|
||||||
parseInt(pStyle.zIndex || '0', 10) >= 10;
|
|
||||||
const hasPortalAttr = parent.hasAttribute('data-floating-ui-portal') ||
|
|
||||||
parent.hasAttribute('data-radix-popper-content-wrapper') ||
|
|
||||||
parent.hasAttribute('data-radix-portal') ||
|
|
||||||
parent.hasAttribute('data-popper-placement') ||
|
|
||||||
parent.getAttribute('role') === 'listbox' ||
|
|
||||||
parent.getAttribute('role') === 'menu';
|
|
||||||
if (isFloating || hasPortalAttr) return true;
|
|
||||||
parent = parent.parentElement;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
})();
|
|
||||||
|
|
||||||
if (!hasCursorPointer && !hasOnclick && !hasTabindex) {
|
|
||||||
// For elements inside floating containers, also check for role="option"/"menuitem"
|
|
||||||
if (isInFloating && hasRole) {
|
|
||||||
const role = el.getAttribute('role');
|
|
||||||
if (role !== 'option' && role !== 'menuitem' && role !== 'menuitemcheckbox' && role !== 'menuitemradio') continue;
|
|
||||||
} else {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Skip elements with ARIA roles UNLESS they're inside a floating container
|
|
||||||
// (floating container items may be missed by the accessibility tree)
|
|
||||||
if (hasRole && !isInFloating) continue;
|
|
||||||
|
|
||||||
// Build deterministic nth-child CSS path
|
// Build deterministic nth-child CSS path
|
||||||
const parts: string[] = [];
|
const parts: string[] = [];
|
||||||
@@ -308,11 +275,9 @@ export async function handleSnapshot(
|
|||||||
|
|
||||||
const text = (el as HTMLElement).innerText?.trim().slice(0, 80) || el.tagName.toLowerCase();
|
const text = (el as HTMLElement).innerText?.trim().slice(0, 80) || el.tagName.toLowerCase();
|
||||||
const reasons: string[] = [];
|
const reasons: string[] = [];
|
||||||
if (isInFloating) reasons.push('popover-child');
|
|
||||||
if (hasCursorPointer) reasons.push('cursor:pointer');
|
if (hasCursorPointer) reasons.push('cursor:pointer');
|
||||||
if (hasOnclick) reasons.push('onclick');
|
if (hasOnclick) reasons.push('onclick');
|
||||||
if (hasTabindex) reasons.push(`tabindex=${el.getAttribute('tabindex')}`);
|
if (hasTabindex) reasons.push(`tabindex=${el.getAttribute('tabindex')}`);
|
||||||
if (hasRole) reasons.push(`role=${el.getAttribute('role')}`);
|
|
||||||
|
|
||||||
results.push({ selector, text, reason: reasons.join(', ') });
|
results.push({ selector, text, reason: reasons.join(', ') });
|
||||||
}
|
}
|
||||||
|
|||||||
61
browse/test/fixtures/dropdown.html
vendored
61
browse/test/fixtures/dropdown.html
vendored
@@ -1,61 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<title>Test Page - Dropdown/Autocomplete</title>
|
|
||||||
<style>
|
|
||||||
.search-container { position: relative; width: 300px; }
|
|
||||||
.search-input { width: 100%; padding: 8px; }
|
|
||||||
.dropdown-portal {
|
|
||||||
position: fixed;
|
|
||||||
top: 60px;
|
|
||||||
left: 20px;
|
|
||||||
z-index: 9999;
|
|
||||||
background: white;
|
|
||||||
border: 1px solid #ccc;
|
|
||||||
box-shadow: 0 4px 12px rgba(0,0,0,0.15);
|
|
||||||
width: 300px;
|
|
||||||
}
|
|
||||||
.dropdown-item {
|
|
||||||
padding: 8px 12px;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
.dropdown-item:hover { background: #f0f0f0; }
|
|
||||||
.dropdown-item-no-cursor {
|
|
||||||
padding: 8px 12px;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<h1>Dropdown Test</h1>
|
|
||||||
|
|
||||||
<div class="search-container">
|
|
||||||
<input type="text" class="search-input" placeholder="Search for someone..." id="search" aria-label="Search">
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Simulates a React portal / floating-ui popover -->
|
|
||||||
<div class="dropdown-portal" id="dropdown-portal" data-floating-ui-portal>
|
|
||||||
<!-- Items with cursor:pointer but NO ARIA roles (common pattern) -->
|
|
||||||
<div class="dropdown-item" onclick="selectItem('alice')">Alice Johnson - Acme Corp</div>
|
|
||||||
<div class="dropdown-item" onclick="selectItem('bob')">Bob Smith - Beta Inc</div>
|
|
||||||
<div class="dropdown-item" onclick="selectItem('carol')">Carol Davis - Gamma LLC</div>
|
|
||||||
|
|
||||||
<!-- Items WITH role="option" (well-built component) -->
|
|
||||||
<div class="dropdown-item" role="option" onclick="selectItem('dave')">Dave Wilson - Delta Co</div>
|
|
||||||
|
|
||||||
<!-- Item with no cursor, no onclick, just text (should NOT be captured) -->
|
|
||||||
<div class="dropdown-item-no-cursor" id="static-text">No results? Try a different search.</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Standard interactive elements (should appear in ARIA tree normally) -->
|
|
||||||
<button id="submit-btn">Submit</button>
|
|
||||||
<a href="/test">Normal Link</a>
|
|
||||||
|
|
||||||
<script>
|
|
||||||
function selectItem(name) {
|
|
||||||
document.getElementById('search').value = name;
|
|
||||||
document.getElementById('dropdown-portal').style.display = 'none';
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -386,77 +386,6 @@ describe('Cursor-interactive', () => {
|
|||||||
// And cursor-interactive section
|
// And cursor-interactive section
|
||||||
expect(result).toContain('cursor-interactive');
|
expect(result).toContain('cursor-interactive');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('snapshot -i alone also includes cursor-interactive elements', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/cursor-interactive.html'], bm);
|
|
||||||
const result = await handleMetaCommand('snapshot', ['-i'], bm, shutdown);
|
|
||||||
// -i now auto-enables -C
|
|
||||||
expect(result).toContain('[button]');
|
|
||||||
expect(result).toContain('[link]');
|
|
||||||
expect(result).toContain('cursor-interactive');
|
|
||||||
expect(result).toContain('@c');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// ─── Dropdown/Popover Detection ─────────────────────────────────
|
|
||||||
|
|
||||||
describe('Dropdown/popover detection', () => {
|
|
||||||
test('snapshot -i auto-enables cursor scan and finds dropdown items', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/dropdown.html'], bm);
|
|
||||||
const result = await handleMetaCommand('snapshot', ['-i'], bm, shutdown);
|
|
||||||
// Should find standard interactive elements
|
|
||||||
expect(result).toContain('[button]');
|
|
||||||
expect(result).toContain('[link]');
|
|
||||||
expect(result).toContain('[textbox]');
|
|
||||||
// Should also find cursor-interactive dropdown items
|
|
||||||
expect(result).toContain('cursor-interactive');
|
|
||||||
expect(result).toContain('@c');
|
|
||||||
expect(result).toContain('Alice Johnson');
|
|
||||||
expect(result).toContain('Bob Smith');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('dropdown items in floating container are tagged as popover-child', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/dropdown.html'], bm);
|
|
||||||
const result = await handleMetaCommand('snapshot', ['-i'], bm, shutdown);
|
|
||||||
expect(result).toContain('popover-child');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('dropdown items with role="option" in portal are captured', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/dropdown.html'], bm);
|
|
||||||
const result = await handleMetaCommand('snapshot', ['-i'], bm, shutdown);
|
|
||||||
// Dave Wilson has role="option" — should be captured even though it has a role
|
|
||||||
expect(result).toContain('Dave Wilson');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('static text in dropdown without interactivity is NOT captured', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/dropdown.html'], bm);
|
|
||||||
const result = await handleMetaCommand('snapshot', ['-i'], bm, shutdown);
|
|
||||||
// "No results? Try a different search." has no cursor:pointer, no onclick, no tabindex
|
|
||||||
expect(result).not.toContain('No results');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('@c ref from dropdown is clickable', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/dropdown.html'], bm);
|
|
||||||
const snap = await handleMetaCommand('snapshot', ['-i'], bm, shutdown);
|
|
||||||
// Find a @c ref for Alice
|
|
||||||
const aliceLine = snap.split('\n').find(l => l.includes('@c') && l.includes('Alice'));
|
|
||||||
if (aliceLine) {
|
|
||||||
const refMatch = aliceLine.match(/@(c\d+)/);
|
|
||||||
if (refMatch) {
|
|
||||||
const result = await handleWriteCommand('click', [`@${refMatch[1]}`], bm);
|
|
||||||
expect(result).toContain('Clicked');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test('snapshot -C still works standalone without -i', async () => {
|
|
||||||
await handleWriteCommand('goto', [baseUrl + '/dropdown.html'], bm);
|
|
||||||
const result = await handleMetaCommand('snapshot', ['-C'], bm, shutdown);
|
|
||||||
expect(result).toContain('cursor-interactive');
|
|
||||||
expect(result).toContain('Alice Johnson');
|
|
||||||
// Without -i, should include non-interactive ARIA elements too
|
|
||||||
expect(result).toContain('[heading]');
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// ─── Snapshot Error Paths ───────────────────────────────────────
|
// ─── Snapshot Error Paths ───────────────────────────────────────
|
||||||
|
|||||||
Reference in New Issue
Block a user