@matware/e2e-runner 1.2.1 → 1.3.1

package/.opencode/skills/e2e-testing/references/troubleshooting.md

@@ -0,0 +1,224 @@
+# Troubleshooting Guide
+
+## Pool Connection Issues
+
+### "Pool not reachable" / Connection refused
+
+**Cause**: Chrome pool (browserless/chrome Docker container) is not running.
+
+**Fix**:
+```bash
+npx e2e-runner pool start
+npx e2e-runner pool status   # verify it's running
+```
+
+Pool management is CLI-only — `pool start` and `pool stop` are not available via MCP.
+
+### "Pool at capacity" / Tests queuing
+
+**Cause**: All Chrome sessions are occupied.
+
+**Fix**: Increase capacity or reduce concurrency:
+```bash
+npx e2e-runner pool stop
+npx e2e-runner pool start --max-sessions 10
+```
+Or reduce test concurrency: `--concurrency 2`
+
+The runner checks `/pressure` before each connection and waits up to 60s for a free slot.
+
+### Docker not running
+
+**Cause**: Docker daemon is not started.
+
+**Fix**: Start Docker Desktop or `sudo systemctl start docker`, then `npx e2e-runner pool start`.
+
+## React / SPA Issues
+
+### React inputs not updating state
+
+**Symptom**: `type` action enters text but React state doesn't change (form validation fails, submit disabled).
+
+**Fix**: Use `type_react` instead of `type` for React controlled inputs:
+```json
+{ "type": "type_react", "selector": "#email", "value": "user@test.com" }
+```
+
+`type_react` uses the native value setter and dispatches `input` + `change` events that React's synthetic event system recognizes.
+
+### SPA navigation not completing
+
+**Symptom**: `goto` hangs or times out on client-side route changes.
+
+**Fix**: Use `navigate` instead of `goto` for SPA route changes:
+```json
+{ "type": "navigate", "value": "/new-page" }
+```
+
+`navigate` uses a 5s race timeout and won't block if `load` doesn't fire (common in SPAs).
+
+### MUI autocomplete not opening
+
+**Symptom**: Clicking or typing in an MUI Autocomplete doesn't open the dropdown.
+
+**Fix**: Use `focus_autocomplete` to properly focus by label text:
+```json
+{ "type": "focus_autocomplete", "text": "Search by name" },
+{ "type": "type_react", "selector": "#autocomplete-input", "value": "search term" },
+{ "type": "click_option", "text": "Desired option" }
+```
+
+## Flaky Tests
+
+### Intermittent failures on dynamic content
+
+**Symptom**: Tests pass sometimes, fail others. Usually timing-related.
+
+**Fixes**:
+1. Add explicit `wait` before assertions:
+   ```json
+   { "type": "wait", "selector": ".data-loaded" },
+   { "type": "assert_text", "text": "Expected content" }
+   ```
+
+2. Use action-level retries for known flaky selectors:
+   ```json
+   { "type": "click", "selector": "#dynamic-btn", "retries": 3 }
+   ```
+
+3. Use test-level retries:
+   ```json
+   { "name": "flaky-test", "retries": 2, "actions": [...] }
+   ```
+
+4. Check the learning system for patterns:
+   ```
+   e2e_learnings("flaky") → identify consistently flaky tests
+   e2e_learnings("selectors") → find unstable selectors
+   ```
+
+### Tests interfering with each other
+
+**Symptom**: Tests pass individually but fail when run together.
+
+**Fix**: Mark tests that share mutable state as `serial`:
+```json
+{ "name": "create-item", "serial": true, "actions": [...] },
+{ "name": "verify-item", "serial": true, "actions": [...] }
+```
+
+## Timeout Issues
+
+### Test timeout (default 60s)
+
+**Fix**: Increase per-test or globally:
+```json
+{ "name": "slow-test", "timeout": 120000, "actions": [...] }
+```
+Or globally: `--test-timeout 120000`
+
+### Action timeout (default 10s)
+
+Each action's `waitForSelector` uses the default timeout. Override per-action:
+```json
+{ "type": "wait", "selector": ".slow-element", "timeout": 30000 }
+```
+Or globally: `--timeout 30000`
+
+## Network Errors
+
+### Tests passing but network requests failing
+
+**Symptom**: Tests pass but `networkSummary` shows failed requests.
+
+**Fix**: Enable strict mode to fail tests with network errors:
+```
+e2e_run({ all: true, failOnNetworkError: true })
+```
+
+Or use `assert_no_network_errors` at specific points:
+```json
+{ "type": "goto", "value": "/api-heavy-page" },
+{ "type": "wait", "selector": ".loaded" },
+{ "type": "assert_no_network_errors" }
+```
+
+### Investigating specific failures
+
+Use network log drill-down:
+```
+e2e_network_logs(runDbId, errorsOnly: true)                    → see all failed requests
+e2e_network_logs(runDbId, urlPattern: "/api/users")             → filter by URL
+e2e_network_logs(runDbId, testName: "create-user", includeBodies: true) → full request/response
+```
+
+## Common Mistakes
+
+### Using `beforeAll` for browser state
+
+`beforeAll` runs on a separate page that closes before tests. Use `beforeEach` for state setup.
+
+### Using `evaluate` for simple assertions
+
+Prefer granular assertion actions over `evaluate` with inline JS:
+```json
+// Bad: verbose, error-prone
+{ "type": "evaluate", "value": "if (!document.querySelector('h1').textContent.includes('Dashboard')) throw 'not found'" }
+
+// Good: clear, auto-waits
+{ "type": "assert_element_text", "selector": "h1", "text": "Dashboard" }
+```
+
+### Forgetting `cwd` in MCP calls
+
+All MCP tools need `cwd` to resolve config files and test directories. Always pass the project root.
+
+### Path-only `assert_url`
+
+When checking paths, use path-only format (starts with `/`):
+```json
+{ "type": "assert_url", "value": "/dashboard" }
+```
+This compares against the pathname only, ignoring the `host.docker.internal` origin.
+
+## Action Type Pre-Validation
+
+All action types are validated at **load time** (before any browser connections). If a test file contains an unknown action type (e.g., a typo like `"clik"`), loading throws immediately with the location:
+
+```
+Unknown action type(s) in auth.json: "clik" in test "login-test"
+```
+
+The `KNOWN_ACTION_TYPES` Set in `src/actions.js` is the single source of truth. Unknown actions also throw at runtime as a safety net.
+
+## Screenshot Hashes
+
+Every screenshot captured during a run is assigned a short hash (`ss:a3f2b1c9`) — the first 8 hex chars of the SHA-256 of its file path. Hashes are deterministic and computed identically on the server (Node `crypto`) and in the browser (Web Crypto API).
+
+**Flow**: screenshot saved on disk → `saveRun()` registers hash in SQLite `screenshot_hashes` table → dashboard shows `[ss:XXXXXXXX]` badge (click to copy) → user pastes hash in Claude Code → `e2e_screenshot` MCP tool looks up hash, reads file, returns the image.
+
+- Hashes are registered inside the `saveRun()` transaction (covers action, error, verification, and baseline screenshots)
+- The `ss:` prefix is optional when calling `e2e_screenshot` — stripped during lookup
+- Dashboard computes hashes client-side (Web Crypto) for the Live view (before `persistRun()` writes to DB)
+- Run detail API (`/api/db/runs/:id`) includes `screenshotHashes` map per test result
+- Dashboard endpoint `/api/screenshot-hash/:hash` serves the image by hash
+- Dashboard Screenshots view has a **search bar** — type a hash to find and display the screenshot
+
+## Web Dashboard
+
+**`src/dashboard.js`** — HTTP server, REST API, WebSocket broadcast, pool polling.
+**`templates/dashboard.html`** — SPA, dark theme, vanilla JS, safe DOM (textContent + createEl helper).
+
+**Features:**
+- Live test execution with WebSocket updates
+- Run history with inline detail expansion
+- Screenshots gallery with hash badges and hash search
+- Network request logs with clickable expandable rows (full request/response detail)
+- Pool status monitoring
+- Multi-project support via project selector
+- Variables tab with masked values, inline edit, add, and delete
+
+**CLI:** `e2e-runner dashboard [--port 8484]`
+**MCP tools:** `e2e_dashboard_start`, `e2e_dashboard_stop`
+
+Config defaults: `dashboardPort: 8484`, `maxHistoryRuns: 100`

package/.opencode/skills/e2e-testing/references/variables.md

@@ -0,0 +1,41 @@
+# Variables Reference
+
+Variables replace hardcoded sensitive values (JWT tokens, user IDs, API keys, etc.) in test JSON. Stored in SQLite (`~/.e2e-runner/dashboard.db`), scoped per project and per suite, editable from the dashboard UI.
+
+## Syntax
+
+```
+{{var.TOKEN}}        → resolves from DB (suite scope → project scope)
+{{env.MY_VAR}}       → resolves from process.env
+{{param}}            → existing module param substitution (unchanged)
+```
+
+**Resolution priority:** suite vars > project vars > error if not found.
+
+## Usage in Test JSON
+
+```json
+{ "$use": "auth-jwt", "params": { "token": "{{var.JWT_TOKEN}}", "orgId": "{{var.ORG_ID}}" } }
+{ "type": "goto", "value": "/users/{{var.USER_ID}}/profile" }
+{ "type": "gql", "value": "{ user(id: \"{{var.USER_ID}}\") { name } }" }
+```
+
+## MCP Tool (`e2e_vars`)
+
+```
+e2e_vars({ action: "set", key: "TOKEN", value: "abc123", scope: "project" })
+e2e_vars({ action: "set", key: "TOKEN", value: "xyz789", scope: "auth" })  // suite-specific override
+e2e_vars({ action: "list" })
+e2e_vars({ action: "get", key: "TOKEN" })
+e2e_vars({ action: "delete", key: "TOKEN", scope: "project" })
+```
+
+## Dashboard UI
+
+Variables tab shows all variables grouped by scope. Values are masked by default (click to reveal). Inline edit, add new, and delete are supported.
+
+## REST API
+
+- `GET /api/db/projects/:id/variables` — list all vars for project
+- `PUT /api/db/projects/:id/variables` — set a variable `{ scope, key, value }`
+- `DELETE /api/db/projects/:id/variables/:scope/:key` — delete a variable

package/.opencode/skills/e2e-testing/references/visual-verification.md

@@ -0,0 +1,89 @@
+# Visual Verification Reference
+
+Tests can include an `expect` field for AI-powered visual verification. No API key required — Claude Code itself does the visual judgment.
+
+## Expect Field Formats
+
+### String form — free-form description
+```json
+{
+  "name": "dashboard-loads",
+  "expect": "Should show the data table with at least 3 rows, no error messages, and the sidebar with navigation links",
+  "actions": [
+    { "type": "goto", "value": "/dashboard" },
+    { "type": "wait", "selector": ".data-table" }
+  ]
+}
+```
+
+### Array form — per-criterion checklist (each evaluated independently as PASS/FAIL)
+```json
+{
+  "name": "dashboard-loads",
+  "expect": [
+    "Data table visible with at least 3 rows",
+    "No error messages or red banners",
+    "Sidebar shows navigation links"
+  ],
+  "actions": [
+    { "type": "goto", "value": "/dashboard" },
+    { "type": "wait", "selector": ".data-table" }
+  ]
+}
+```
+
+## Double Screenshot (Before/After)
+
+When `expect` is present, the runner captures TWO screenshots:
+1. **Baseline** (`baseline-{name}-{timestamp}.png`) — captured BEFORE test actions run (after `beforeEach` hooks)
+2. **Verification** (`verify-{name}-{timestamp}.png`) — captured AFTER all actions complete
+
+Both hashes are registered in SQLite and returned in the MCP response for before/after comparison.
+
+## Verification Strictness
+
+Controls how strictly Claude Code evaluates visual verification. Set via:
+- Config: `verificationStrictness: 'moderate'`
+- CLI: `--verification-strictness strict`
+- Env: `VERIFICATION_STRICTNESS=strict`
+- MCP: `verificationStrictness: 'strict'` in `e2e_run` args
+
+| Level | Behavior |
+|-------|----------|
+| **`strict`** | No ambiguity allowed. If any criterion is unclear, not fully visible, or doubtful → FAIL. |
+| **`moderate`** (default) | Reasonable judgment. Minor cosmetic differences acceptable, functional mismatches → FAIL. |
+| **`lenient`** | Only fail on clear, obvious contradictions. |
+
+## MCP Response Format
+
+The `e2e_run` response includes a `verifications` array:
+```json
+{
+  "verifications": [
+    {
+      "name": "dashboard-loads",
+      "expect": ["Data table visible...", "No error messages..."],
+      "success": true,
+      "screenshotHash": "ss:a3f2b1c9",
+      "baselineScreenshotHash": "ss:b4e1c2d8",
+      "isChecklist": true
+    }
+  ],
+  "verificationInstructions": "Verification strictness: MODERATE — ..."
+}
+```
+
+## Verdict Format
+
+After calling `e2e_screenshot` for each hash (after + baseline), Claude Code reports a structured verdict:
+
+```
+TEST: dashboard-loads
+VERDICT: PASS
+STATE CHANGE: Page loaded from blank to populated dashboard
+CRITERIA:
+  - "Data table visible with at least 3 rows": PASS
+  - "No error messages or red banners": PASS
+  - "Sidebar shows navigation links": PASS
+REASON: All criteria met, dashboard fully loaded with expected content
+```

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Matware
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.