@testrelic/maestro-analytics 1.1.0 → 1.2.0

package/README.md

@@ -200,6 +200,8 @@ When the same setting is provided in multiple places, the following priority app
 |------|--------|
 | Flow pass/fail/skip | JUnit XML |
 | Per-step timing | commands-*.json |
+| Per-step parameters (text typed, swipe direction, lat/lon, etc.) | commands-*.json (`details` field) |
+| Retry / repeat command grouping | commands-*.json (`children` field) |
 | Assertions | commands-*.json |
 | Screenshots | --test-output-dir |
 | Video recordings | --test-output-dir |
@@ -208,6 +210,54 @@ When the same setting is provided in multiple places, the following priority app
 | Device/platform info | CLI output |
 | CI/CD context | Environment detection |
 | Git metadata | Local git |
+| API / HTTP calls | mitmproxy (`--capture-network`) or HAR import (`--har-path`) |
+
+### Mobile API capture
+
+Maestro is a black-box UI driver and can't see HTTP from inside the app the
+way Playwright can. Two opt-in strategies are supported:
+
+**Option A — auto-spawn mitmproxy (recommended for emulators):**
+
+```bash
+npx testrelic-maestro test --capture-network --platform android ./flows
+```
+
+Requires `mitmdump` on PATH (`brew install mitmproxy` /
+`pipx install mitmproxy`). The SDK spawns mitmproxy with a bundled redaction
+addon, sets the device's HTTP proxy via `adb` (Android) or prints simulator
+setup instructions (iOS), and binds captured calls to each flow by timestamp.
+
+| Flag | Description |
+|------|-------------|
+| `--capture-network` | Enable mitmproxy capture |
+| `--proxy-port <n>` | Proxy listen port (default: 8080) |
+| `--proxy-host <host>` | Proxy listen host (default: 127.0.0.1) |
+| `--skip-cert-install` | Skip auto-installing the mitmproxy CA |
+| `--proxy-include <pat>` | Only capture URLs matching this substring or regex (repeatable) |
+| `--proxy-exclude <pat>` | Drop URLs matching this substring or regex (repeatable) |
+
+Sensitive headers (`authorization`, `cookie`, `set-cookie`, `x-api-key`) and
+body fields (`password`, `secret`, `token`, `apiKey`, `api_key`) are redacted
+by the mitmproxy addon **before** anything is written to disk — secrets never
+touch your filesystem.
+
+**Option B — import a HAR file (works without any runtime deps):**
+
+```bash
+npx testrelic-maestro test --har-path ./run.har ./flows
+```
+
+Useful when you already capture traffic with Charles, Proxyman, or `mitmweb`
+and want to fold it into the same TestRelic report.
+
+**TLS pinning:** apps that pin certificates will reject the proxy. Build a
+debug variant with pinning disabled or skip network capture for those flows.
+
+**Cloud integration:** captured calls upload as `apiCalls` per test and show
+up in the platform's Test Detail Network panel — and Ask AI's
+`query_network_logs` tool can reason over them the same way it does for
+Playwright tests.
 
 ## E2E Integration Test (Real Device Recording)