[pull] main from MetaMask:main#523
Merged
Merged
Conversation
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->
## **Description**
<!--
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?
-->
- Add `fixture-validation.ts` with utilities to compare committed
fixture JSON against live app state exports (schema diffing,
merging, formatting)
- Add `fixture-validation.spec.ts` E2E test that runs post-onboarding,
captures live state via CommandQueueServer, and diffs it
against the default fixture
- Outputs diff report to `artifacts/fixture-validation-diff.txt` and
auto-generates an updated fixture at
`artifacts/updated-default-fixture.json` when drift is detected
## Detail
The validation utilities flatten nested objects into dot-path type maps
and compare keys, types, and values between a baseline
fixture and a candidate (live state). A configurable ignored-keys list
filters out runtime-dynamic data (timestamps, vaults, remote
feature flags, dapp permissions, exchange rates, transaction state,
etc.) so the diff only surfaces actionable fixture drift.
Key exports:
- `computeSchemaDiff()` — detects new/missing keys, type mismatches, and
value mismatches
- `mergeFixtureChanges()` — applies a diff to produce an updated fixture
- `formatSchemaDiff()` — human-readable report with `+`/`-`/`~` prefixes
- `getMobileFixtureIgnoredKeys()` — mobile-specific runtime keys to skip
## **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**
```gherkin
Feature: my feature name
Scenario: user [verb for user action]
Given [describe expected initial app state]
When user [verb for user action]
Then [describe expected outcome]
```
## **Screenshots/Recordings**
<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->
### **Before**
<!-- [screenshots/recordings] -->
### **After**
<!-- [screenshots/recordings] -->
## **Pre-merge author checklist**
- [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.
## **Pre-merge reviewer checklist**
- [ ] 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**
> Touches only test code, but adds a new E2E spec that performs
filesystem writes and may introduce CI flakiness/noise until the
ignored-keys list is fully tuned.
>
> **Overview**
> Adds `fixture-validation` utilities to **diff committed fixture JSON
vs live exported app state**, including deep key sorting, dot-path
schema/type/value comparison with a mobile-specific ignored-keys list
(supports `*` wildcards), human-readable diff formatting, and diff-based
merging to generate an updated fixture (including safe array index
deletions).
>
> Introduces unit coverage for the utilities and a new post-onboarding
regression spec that exports state via `CommandQueueServer`, compares it
to `default-fixture.json`, and writes a diff report plus an
auto-generated updated fixture into `artifacts/` (currently logs drift
rather than failing the test).
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
11d585c. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )