Commit 75d1e2b
authored
test: fixes corner cases for metrics collection data (#30197)
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until this PR meets the canonical
Definition of Ready For Review in `docs/readme/ready-for-review.md`.
In short: the template must be materially complete (not just section
titles
present), all status checks must be currently passing, and the only
expected
follow-up commits must be reviewer-driven.
-->
## **Description**
Tightens the declarative MetaMetrics expectations static scan in
`collect-qa-stats.mjs` so QA stats include every event naming pattern
used under `tests/helpers/analytics/expectations/`.
The `metametrics` slice of `qa-stats.json` is built by regex-parsing
expectation modules. Several **valid** patterns produced **no** counted
event names, so Grafana / coverage metrics understated E2E analytics
coverage even when expectations existed.
## Cases that were previously missed
| Pattern | Example / where it showed up | Prior failure |
|--------|------------------------------|----------------------|
| **`{ name: SOME_CONST }`** (no comma before `}`) | Card expectations:
`events: [{ name: CARD_BUTTON_VIEWED }, …]` | Parser required `name:
Ident,` only; `}` after the identifier did not match. |
| **Only `eventNames: [ CONST ]`**, no `events[].name` |
`predict-geo-restriction.analytics.ts` (`Geo Blocked Triggered`) |
Inline `eventNames` arrays were never read; only `name:`, global
`onboardingEvents`, and `const … = […];` with an “event-ish” variable
name were. |
| **`eventNames: [ A, B, … ]`** as the **sole** or **extra** inline list
| Onramp (`RAMPS_*`), opt-out, bridge/swap/predict smoke files, etc. |
Same as above — redundant for files that also had `name:`, but
**`eventNames`-only** specs were fully dropped. |
**Not a regression / intentional:** **`eventNames: [ ...someArray ]`** —
spread segments are ignored here because the referenced `const` (e.g.
`transactionEventNames`, `expectedEventNames`) is still ingested via the
existing **`const *Names* / event-ish`** array path.
<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->
## **Changelog**
<!--
If this PR is not End-User-Facing and should not show up in the
CHANGELOG, you can choose to either:
1. Write `CHANGELOG entry: null`
2. Label with `no-changelog`
If this PR is End-User-Facing, please write a short User-Facing
description in the past tense like:
`CHANGELOG entry: Added a new tab for users to see their NFTs`
`CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker`
(This helps the Release Engineer do their job more quickly and
accurately)
-->
CHANGELOG entry:
## **Related issues**
Fixes:
## **Manual testing steps**
N/A
## **Screenshots/Recordings**
<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->
### **Before**
N/A
<!-- [screenshots/recordings] -->
### **After**
N/A
<!-- [screenshots/recordings] -->
## **Pre-merge author checklist**
<!--
Every checklist item must be consciously assessed before marking this PR
as
"Ready for review". A checked box means you deliberately considered that
responsibility, not that you literally performed every action listed.
Unchecked boxes are ambiguous: they are not an implicit "N/A" and they
are not
a silent "skip". See `docs/readme/ready-for-review.md` for the full
checklist
semantics.
-->
- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I've applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.
#### Performance checks (if applicable)
- [ ] I've tested on Android
- Ideally on a mid-range device; emulator is acceptable
- [ ] I've tested with a power user scenario
- Use these [power-user
SRPs](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/edit-v2/401401446401?draftShareId=9d77e1e1-4bdc-4be1-9ebb-ccd916988d93)
to import wallets with many accounts and tokens
- [ ] I've instrumented key operations with Sentry traces for production
performance metrics
- See [`trace()`](/app/util/trace.ts) for usage and
[`addToken`](/app/components/Views/AddAsset/components/AddCustomToken/AddCustomToken.tsx#L274)
for an example
For performance guidelines and tooling, see the [Performance
Guide](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/400085549067/Performance+Guide+for+Engineers).
## **Pre-merge reviewer checklist**
<!--
Reviewer checklist items follow the same semantics as the author
checklist: an
unchecked box is ambiguous, a checked box means the reviewer consciously
assessed that responsibility. See `docs/readme/ready-for-review.md`.
-->
- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Medium Risk**
> Changes the regex-based static scan that feeds Grafana QA metrics;
mistakes could under/over-count events or fail the stats job, impacting
CI observability but not app runtime behavior.
>
> **Overview**
> Tightens `.github/scripts/collect-qa-stats.mjs` MetaMetrics static
scanning so `qa-stats.json` captures more valid event-name patterns from
declarative `*.analytics.ts` expectations.
>
> The parser now (1) recognizes `name: SOME_CONST` even when it is the
last field in an object, (2) extracts inline `eventNames: [...]` lists
using a simple balanced-bracket slice, and (3) centralizes list-token
resolution (string literals, `onboardingEvents.*`, string consts) while
skipping spread entries like `...someArray`.
>
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
76bc803. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->1 parent 6375f80 commit 75d1e2b
1 file changed
Lines changed: 68 additions & 18 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
| 26 | + | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
| |||
348 | 349 | | |
349 | 350 | | |
350 | 351 | | |
351 | | - | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
352 | 409 | | |
353 | 410 | | |
354 | 411 | | |
| |||
368 | 425 | | |
369 | 426 | | |
370 | 427 | | |
371 | | - | |
| 428 | + | |
| 429 | + | |
372 | 430 | | |
373 | 431 | | |
374 | 432 | | |
375 | 433 | | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
376 | 440 | | |
377 | 441 | | |
378 | 442 | | |
| |||
382 | 446 | | |
383 | 447 | | |
384 | 448 | | |
385 | | - | |
386 | | - | |
387 | | - | |
388 | | - | |
389 | | - | |
390 | | - | |
391 | | - | |
392 | | - | |
393 | | - | |
394 | | - | |
395 | | - | |
396 | | - | |
397 | | - | |
398 | | - | |
399 | | - | |
| 449 | + | |
400 | 450 | | |
401 | 451 | | |
402 | 452 | | |
| |||
0 commit comments