chore: Handle async migrations & add migration tests #8967
Merged
Conversation
This file contains 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
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
Cal-L
added
No QA Needed/E2E Only
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8967 +/- ##
==========================================
+ Coverage 45.30% 45.35% +0.04%
==========================================
Files 1272 1272
Lines 31239 31247 +8
Branches 3189 3189
==========================================
+ Hits 14154 14171 +17
+ Misses 16245 16234 -11
- Partials 840 842 +2 ☔ View full report in Codecov by Sentry. |
tommasini
reviewed
Mar 18, 2024
tommasini
previously approved these changes
Mar 18, 2024
tommasini
reviewed
Mar 18, 2024
Cal-L
added
needs-qa
Cal-L
added
Run Smoke E2E
|
13 tasks
…/handle-async-migrations
Cal-L
added
Run Smoke E2E
|
@Cal-L can you take a look at the merge conflicts. |
Cal-L
added
Run Smoke E2E
|
9 tasks
owencraston
added a commit
that referenced
this pull request
Mar 27, 2024
<!-- 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** 1. What is the reason for the change? - @Cal-L discovered a missing test case in [his PR](#8967) for my migration. In order to perfectly handle the edge cases for this migration we must also check if the Preferences controller state is defined. - In order to unblock the above PR we need to handle this edge case. 2. What is the improvement/solution? - check if the preferences controller state is defined - add tests for the error cases and error messages ## **Related issues** Fixes: N/A ## **Manual testing steps** - [x] the tests should all pass. - [x] this migration was already tested and QAd in this previous [PR](https://github.com/pulls?page=2&q=is%3Apr+author%3Aowencraston+archived%3Afalse+is%3Aclosed) ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** <!-- [screenshots/recordings] --> ### **After** <img width="1246" alt="Screenshot 2024-03-27 at 11 54 27 AM" src="https://github.com/MetaMask/metamask-mobile/assets/22918444/f9a34068-8ab9-45fa-8f80-1b45eb6115d0"> ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask 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.
…/handle-async-migrations
Cal-L
added
No QA Needed/E2E Only
|
tommasini
approved these changes
Mar 28, 2024
Cal-L
added
Run Smoke E2E
|
Cal-L
removed
the
needs-qa
|
metamaskbot
added
the
release-7.20.0
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
This PR enables the ability to write both asynchronous and synchronous migrations. Moving forward, we should not have to worry about resolving the incoming states within migration themselves. This change wraps each migration in an asynchronous function, which resolves the state before sending it to the next migration. We also added unit tests for checking migration functionality using
createMigrateRelated issues
Fixes:
Manual testing steps
Screenshots/Recordings
Before
After
The videos below shows that migrations are still functioning as expected. There is no change in user experience. In addition to E2E tests, the main QA test to check is testing upgrading from current release (7.18.0) to this branch.
Video of upgrade from 7.17.0 -> This branch. Example: Shows migration 35 being applied, which sets the displayed currency to ETH
https://github.com/MetaMask/metamask-mobile/assets/10508597/ab21c8f1-de46-40b4-85a7-5ece5fbe4425
Same flow going from 7.15.0 -> This branch
https://github.com/MetaMask/metamask-mobile/assets/10508597/4d03ddea-2391-4372-b553-f79c9bd5300f
Pre-merge author checklist
Pre-merge reviewer checklist