@sun-asterisk/sungen 2.6.15 → 2.7.0-beta.1

package/src/orchestrator/templates/ai-instructions/github-skill-sungen-selector-fix.md

@@ -55,13 +55,23 @@ When running Phase 0 for a **flow** (`qa/flows/<name>/`), check existing screen
    - Read `baseURL` from `playwright.config.ts`.
    - `browser_navigate` to the page URL.
    - If redirected to login → **ask the user to log in manually in the MCP browser**, wait for confirmation, then continue. Never use `sungen makeauth`. Never inject cookies via `browser_evaluate`.
-5. **Snapshot**: take **ONE** `browser_snapshot`. All Phase 0 selectors come from this single snapshot.
+5. **Snapshot**: Wait for the page to fully load before snapshotting.
+   - Check if the page is still loading (spinner visible, skeleton placeholders, empty table with 0 rows). If so, use `browser_wait_for` to wait until content is rendered.
+   - Then take **ONE** `browser_snapshot`. All Phase 0 selectors come from this single snapshot.
 6. **Generate YAML entries**:
    - Keys: follow `sungen-selector-keys` (lowercase, Unicode preserved, `--type` / `--N` suffixes).
-   - Selector priority: follow the table in **Diagnosis & Fix § Step 3** (`testid` > `role`+name > `placeholder` > `label` > `locator` > `text`).
+   - Selector priority: follow the table in **Diagnosis & Fix § Step 3** (`testid` > `role`+name > `label` > `placeholder` > `text` > `locator` CSS last resort).
    - Copy names **character-for-character** from the snapshot. Never infer from the Gherkin label.
    - If an element is auto-inferable per `sungen-selector-keys` § Auto-Infer, **omit it** from YAML — keep the file minimal.
    - **i18n sites**: if the site supports multiple languages, use `{{variable}}` in `name`/`value` fields instead of hardcoded text. Add corresponding `lbl_*` keys to `test-data.yaml` + locale overlay files (see `sungen-selector-keys` § i18n).
+   - **Selector quality rule**: the Playwright MCP accessibility tree snapshot gives you roles and accessible names directly — use them. Do NOT write XPath or class-based CSS selectors. Only write `type: locator` when no role/text/label/placeholder/testid is available, and restrict the CSS to `#id` or `[data-*]` / `[aria-*]` attribute selectors.
+6b. **Cross-verify Gherkin labels vs snapshot** (prevents the #1 production failure):
+   - For **every** `[Reference]` in the `.feature` that will rely on auto-infer (not written to YAML), check the snapshot:
+     - `[X] button` — is there a button with accessible name **exactly** `X`?
+     - `[X] field` — does an input have placeholder **exactly** `X`? Does it even have a placeholder?
+     - `[X] heading` / `text` / `message` — is that text literally visible in the snapshot?
+   - If any mismatch → write an explicit YAML entry using the real DOM name. Do not leave a mismatch to be caught at runtime.
+   - **Typical mismatch cases**: Gherkin uses English label (`[Submit]`) but app displays Vietnamese (`"Gửi"`); placeholder is descriptive (`"Nhập email của bạn"`) not a bare field name (`"Email"`); button text includes an icon glyph before/after the word.
 7. **Substring ambiguity check**: for each `role` + `name` selector, check if any other element in the snapshot has a name that **contains** this name as a substring (e.g., `"Đăng ký"` vs `"Đăng ký bằng Google"`). If yes → add `exact: true` to prevent strict mode violation at runtime.
 8. **Merge, don't overwrite**: preserve the page selector and any user-authored entries in `selectors.yaml`. Only add missing keys.
 9. **Show summary + confirm**: list the keys that will be added, ask the user to approve, then write the file.
@@ -69,9 +79,13 @@ When running Phase 0 for a **flow** (`qa/flows/<name>/`), check existing screen
 
 ### Common Phase 0 pitfalls
 
-- Writing keys inferred from the Gherkin label instead of the snapshot name → Phase 1 will fail with "no element found".
+- Writing keys inferred from the Gherkin label instead of the snapshot name → Phase 1 will fail with `No element found`.
 - Skipping Phase 0.5 when an auth redirect happened → snapshot captures the login page, all selectors wrong.
+- Taking snapshot while page is still loading (spinner visible, table empty) → selectors for dynamic content will be missing or wrong.
+- Skipping step 6b for "simple" elements like buttons → silent mismatch between Gherkin label and DOM name fails at runtime.
 - Using `browser_evaluate` alone to scrape cookies → misses httpOnly session cookies. Always use `browser_storage_state` (or the `browser_run_code` fallback).
+- Writing XPath or class-based CSS selectors → breaks on DOM/style refactoring. Use role/testid/text/label/placeholder from the accessibility tree.
+- Falling back to `locator: 'div.some-class > span'` when the element IS visible in the accessibility snapshot with a role + name → the snapshot gives you `getByRole` for free; use it.
 - Overwriting user-authored selectors → always merge.
 
 ---
@@ -98,10 +112,10 @@ When running Phase 0 for a **flow** (`qa/flows/<name>/`), check existing screen
    |---|---|---|
    | 1 | `testid` | Dev annotation `data-testid=X` in component metadata |
    | 2 | `role` + name | Component type is Button/Link + has text label |
-   | 3 | `placeholder` | Component type is Input/Field + has placeholder text |
-   | 4 | `label` | Component has associated label text (not placeholder) |
-   | 5 | `locator` (CSS) | No accessible name derivable from Figma data |
-   | 6 | `text` | Plain text node (not inside interactive component) |
+   | 3 | `label` | Component has associated label text (not placeholder) |
+   | 4 | `placeholder` | Component type is Input/Field + has placeholder text |
+   | 5 | `text` | Plain text node (not inside interactive component) |
+   | 6 | `locator` (CSS) | Last resort — `#id` or `[attr=value]` only, never classes or XPath |
 
    See `sungen-figma-source` skill for the authoritative heuristics table mapping Figma signals to YAML entry types.
 
@@ -271,12 +285,24 @@ Selector priority (use first applicable):
 
 | Priority | type | When |
 |---|---|---|
-| 1 | `testid` | `data-testid` exists |
-| 2 | `role` + exact name | Interactive elements |
-| 3 | `placeholder` | Input with placeholder |
-| 4 | `label` | Form field with `<label>` |
-| 5 | `locator` (CSS) | No accessible name |
-| 6 | `text` | Static text only |
+| 1 | `testid` | `data-testid` or any stable test attribute exists |
+| 2 | `role` + exact name | Interactive elements with an accessible name |
+| 3 | `label` | Form field with a visible `<label>` |
+| 4 | `placeholder` | Input/textarea with a placeholder attribute |
+| 5 | `text` | Static visible text content |
+| 6 | `locator` (CSS) | Last resort — `#id` or `[attr=value]` **only** (see restrictions below) |
+
+> ⚠️ **Playwright best practice** ([source](https://playwright.dev/docs/best-practices#use-locators)): user-facing locators (`role`, `label`, `text`, `placeholder`, `testid`) are resilient to refactoring and far less likely to break. CSS class selectors and XPath break whenever a developer renames a class or restructures the DOM — even without changing the UI.
+>
+> **Never write these in `selectors.yaml`**:
+> - XPath: `xpath=//div[@class='...']` or `//button[contains(@class,'btn')]`
+> - Class-based CSS: `div.btn-primary`, `.modal-footer > .submit-btn`
+> - Deep structural CSS: `div:nth-child(3) > ul > li > button`
+>
+> **Acceptable CSS (last resort only)**:
+> - Stable `id`: `#submit-button` (only if the id is truly stable and not dynamic)
+> - Data attributes: `[data-id="123"]`, `[aria-controls="menu"]`
+> - Input type: `input[type="file"]` (when no testid/label exists)
 
 **Exact name rule**: copy name character-for-character from snapshot. Never infer from Gherkin label.
 
@@ -290,9 +316,9 @@ Common fixes:
 - Name mismatch → copy exact name from snapshot
 - Multiple matches → add `nth` or `exact: true`
 - Substring ambiguity (e.g., `"Submit"` matches `"Submit"` and `"Submit & Continue"`) → add `exact: true`
-- No accessible name → use `testid` or `locator` (CSS)
+- No accessible name → use `testid`; only fall back to `locator` CSS as last resort
 - Element in iframe → add `frame` field
-- Dynamic content → use `testid` or structural `role` + `nth`
+- Dynamic content → use `testid` or `role` + `nth`
 
 ### Step 4: Recompile After Fix
 
@@ -309,6 +335,26 @@ Then re-run only the current phase's failing tests, not all tests.
 
 ---
 
+## Common Failure Patterns
+
+Quick reference for the most frequent production failures:
+
+| Symptom | Root cause | Fix |
+|---------|-----------|-----|
+| `No element found` on button/link/heading | Gherkin `[Reference]` label ≠ DOM accessible name (different language or text) | Write explicit YAML: `type: role, value: button, name: "<exact DOM name>"` |
+| `No element found` on `[X] field` | Field has no placeholder, or placeholder ≠ X | Write explicit YAML: `type: label, value: "Actual label"` or `type: placeholder, value: "Actual placeholder"` |
+| `No element found` on `[X] text` / `message` | Visible text differs from Gherkin label, or text is dynamic | Write explicit YAML or use `{{variable}}` for dynamic content |
+| `strict mode violation` | Multiple elements match the same name/text | Add `exact: true` to YAML entry, or add `nth` |
+| `toBeVisible` timeout on dynamic content | Snapshot was taken while page was still loading | Wait for spinner/skeleton to clear before snapshotting; add `browser_wait_for` |
+| All tests fail with page navigate error | Page selector URL wrong or baseURL mismatch | Re-check `playwright.config.ts` `baseURL` and page selector `value` path |
+| Auth redirect on every test | `specs/.auth/<role>.json` missing or expired | Run Phase 0.5 to capture fresh session |
+| Table row assertions fail | `columns` config has wrong indices | Count column headers left-to-right (0-indexed) from snapshot |
+| Wrong text assertions on locale page | Hardcoded Vietnamese/English text in YAML `name`/`value` | Use `{{lbl_*}}` variables with locale overlay files |
+| Element inside iframe not found | `frame` field missing in YAML entry | Add `frame: "iframe[src*='...']"` to the selector entry |
+| Selector breaks after UI redesign with no functional change | CSS class or XPath used — brittle to style refactoring | Rewrite with `role`/`testid`/`label`/`text` from accessibility snapshot |
+
+---
+
 ## Table Selectors
 
 For table patterns, add table selectors with `columns` config:

package/src/orchestrator/templates/ai-instructions/github-skill-sungen-selector-keys.md

@@ -166,37 +166,47 @@ Resolver searches in this order:
 
 If no YAML key exists, the resolver infers from the Gherkin element type:
 
-| Gherkin | Inferred locator |
-|---|---|
-| `[X] button` | `getByRole('button', { name: 'X' })` |
-| `[X] link` | `getByRole('link', { name: 'X' })` |
-| `[X] heading` / `header` | `getByRole('heading', { name: 'X' })` |
-| `[X] checkbox` | `getByRole('checkbox', { name: 'X' })` |
-| `[X] radio` | `getByRole('radio', { name: 'X' })` |
-| `[X] field` | `getByPlaceholder('X')` |
-| `[X] text` / `message` / `label` | `getByText('X')` |
-| `[X] logo/image/icon` | `getByRole('img', { name: 'X' })` |
-| `[X] search` | `getByRole('searchbox', { name: 'X' })` |
-| `[X] option` | `getByRole('option', { name: 'X' })` |
-| `[X] slider` | `getByRole('slider', { name: 'X' })` |
-| `[X] toggle` | `getByRole('switch', { name: 'X' })` |
-| `[X] tab` | `getByRole('tab', { name: 'X' })` |
-| `[X] table` | `getByRole('table', { name: 'X' })` |
-| `[X] list` | `getByRole('list', { name: 'X' })` |
-| `[X] column` | `getByRole('columnheader', { name: 'X' })` |
-| `[X] dialog` / `modal` / `drawer` | `getByRole('dialog', { name: 'X' })` |
-| `[X] dropdown` / `select` | `getByRole('combobox', { name: 'X' })` |
-| `[X] menuitem` | `getByRole('menuitem', { name: 'X' })` |
-| `[X] progressbar` | `getByRole('progressbar', { name: 'X' })` |
-| `[X] section` | `getByRole('region', { name: 'X' })` |
-| `[X] card` | `getByRole('article', { name: 'X' })` |
-| `[X] item` | `getByRole('listitem', { name: 'X' })` |
-| `[X] cell` | `getByRole('cell', { name: 'X' })` |
-| `[X] spinner` | `getByRole('status', { name: 'X' })` |
-| `[X] breadcrumb` | `getByRole('navigation', { name: 'X' })` |
-| `[X] badge` / `tooltip` / `tag` | `getByText('X')` |
-
-**Only add a YAML entry when** the auto-inferred locator won't work (wrong name, need testid, need nth, etc.).
+> ⚠️ **Auto-infer pitfall — the #1 cause of selector failures in production.**
+>
+> `[X] button` auto-infers as `getByRole('button', { name: 'X' })`. This **only works** when the button's accessible name in the DOM is **exactly `X`** — same language, same text, same casing.
+>
+> The Gherkin `[Reference]` is your human label for the element, **not** the DOM name. If the app is in Vietnamese (or any language where the Gherkin label differs from DOM text), auto-infer will produce `No element found` at runtime. **Write an explicit YAML entry** with the real DOM name instead.
+>
+> **Decision rule**: auto-infer is safe ONLY when you have confirmed in the snapshot that the DOM element's accessible name / placeholder text is literally `X`. When in doubt → write YAML.
+
+| Gherkin | Inferred locator | Safe when… |
+|---|---|---|
+| `[X] button` | `getByRole('button', { name: 'X' })` | Button's accessible name = X |
+| `[X] link` | `getByRole('link', { name: 'X' })` | Link text = X |
+| `[X] heading` / `header` | `getByRole('heading', { name: 'X' })` | Heading text = X |
+| `[X] checkbox` | `getByRole('checkbox', { name: 'X' })` | Checkbox label = X |
+| `[X] radio` | `getByRole('radio', { name: 'X' })` | Radio label = X |
+| `[X] field` | `getByPlaceholder('X')` | Placeholder text = X AND field has a placeholder |
+| `[X] text` / `message` / `label` | `getByText('X')` | Visible text = X (partial match) |
+| `[X] logo/image/icon` | `getByRole('img', { name: 'X' })` | Image alt = X |
+| `[X] search` | `getByRole('searchbox', { name: 'X' })` | Searchbox label = X |
+| `[X] option` | `getByRole('option', { name: 'X' })` | Option text = X |
+| `[X] slider` | `getByRole('slider', { name: 'X' })` | Slider label = X |
+| `[X] toggle` | `getByRole('switch', { name: 'X' })` | Toggle label = X |
+| `[X] tab` | `getByRole('tab', { name: 'X' })` | Tab text = X |
+| `[X] table` | `getByRole('table', { name: 'X' })` | Table aria-label = X |
+| `[X] list` | `getByRole('list', { name: 'X' })` | List aria-label = X |
+| `[X] column` | `getByRole('columnheader', { name: 'X' })` | Column header text = X |
+| `[X] dialog` / `modal` / `drawer` | `getByRole('dialog', { name: 'X' })` | Dialog aria-label/heading = X |
+| `[X] dropdown` / `select` | `getByRole('combobox', { name: 'X' })` | Combobox label = X |
+| `[X] menuitem` | `getByRole('menuitem', { name: 'X' })` | Menu item text = X |
+| `[X] progressbar` | `getByRole('progressbar', { name: 'X' })` | Progressbar label = X |
+| `[X] section` | `getByRole('region', { name: 'X' })` | Section aria-label = X |
+| `[X] card` | `getByRole('article', { name: 'X' })` | Card aria-label = X |
+| `[X] item` | `getByRole('listitem', { name: 'X' })` | List item text = X |
+| `[X] cell` | `getByRole('cell', { name: 'X' })` | Cell text = X |
+| `[X] spinner` | `getByRole('status', { name: 'X' })` | Spinner aria-label = X |
+| `[X] breadcrumb` | `getByRole('navigation', { name: 'X' })` | Navigation aria-label = X |
+| `[X] badge` / `tooltip` / `tag` | `getByText('X')` | Visible text = X |
+
+**Special note on `[X] field`**: `getByPlaceholder('X')` only works when (1) the field has a placeholder attribute AND (2) the placeholder text equals X. For fields without placeholders (floating labels, aria-label), write explicit YAML: `type: label, value: "Actual label text"`.
+
+**Only add a YAML entry when** auto-infer cannot work: DOM name differs from Gherkin label, need `testid`, need `nth`, need `exact: true`, or the field type requires explicit config.
 
 ### Types requiring YAML entry (no auto-infer)