-
Notifications
You must be signed in to change notification settings - Fork 5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Delete invalid SelectedNetworkController
state (#26428)
#26432
Merged
Gudahtt
merged 1 commit into
Version-v12.0.4
from
cherry-pick/delete-invalid-ids-from-selected-network-controller-state
Aug 14, 2024
Merged
fix: Delete invalid SelectedNetworkController
state (#26428)
#26432
Gudahtt
merged 1 commit into
Version-v12.0.4
from
cherry-pick/delete-invalid-ids-from-selected-network-controller-state
Aug 14, 2024
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
## **Description** The `SelectedNetworkController` state is cleared if any invalid `networkConfigurationId`s are found in state. We are seeing reports of this happening in production in v12.0.1. The suspected cause is `NetworkController` state corruption. We resolved a few cases of this in v12.0.1, but for users that were affected by this, the invalid IDs may have propogated to the `SelectedNetworkController` state already. That is what this migration intends to fix. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26428?quickstart=1) ## **Related issues** Fixes #26309 ## **Manual testing steps** We don't have clear reproduction steps for the bug itself. To artificially reproduce the scenario by changing extension state, this should work: * Create a dev build from v12.0.2 * Install the dev build from the `dist/chrome` directory and proceed through onboarding * Visit the test dapp, refresh, and connect to it. * Run this command in the background console: ``` chrome.storage.local.get( null, (state) => { state.data.SelectedNetworkController.domains['https://metamask.github.io'] = '123'; chrome.storage.local.set(state, () => chrome.runtime.reload()); } ); ``` * The linked error should now appear in the console of the popup * Disable the extension * Switch to this branch and create a dev build * Enable and reload the extension * The error should no longer appear. ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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-extension/blob/develop/.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.
Gudahtt
force-pushed
the
cherry-pick/delete-invalid-ids-from-selected-network-controller-state
branch
from
August 14, 2024 22:03
a38cb00
to
c211be3
Compare
danjm
approved these changes
Aug 14, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## Version-v12.0.4 #26432 +/- ##
===================================================
+ Coverage 65.72% 65.75% +0.03%
===================================================
Files 1371 1372 +1
Lines 54737 54782 +45
Branches 14251 14262 +11
===================================================
+ Hits 35975 36020 +45
Misses 18762 18762 ☔ View full report in Codecov by Sentry. |
Builds ready [c211be3]
Page Load Metrics (46 ± 2 ms)
|
DDDDDanica
approved these changes
Aug 14, 2024
Gudahtt
deleted the
cherry-pick/delete-invalid-ids-from-selected-network-controller-state
branch
August 14, 2024 23:50
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.
Cherry-pick of #26428 for v12.0.4. Original description:
Description
The
SelectedNetworkController
state is cleared if any invalidnetworkConfigurationId
s are found in state. We are seeing reports of this happening in production in v12.0.1.The suspected cause is
NetworkController
state corruption. We resolved a few cases of this in v12.0.1, but for users that were affected by this, the invalid IDs may have propogated to theSelectedNetworkController
state already. That is what this migration intends to fix.Related issues
Fixes #26309
Manual testing steps
We don't have clear reproduction steps for the bug itself. To artificially reproduce the scenario by changing extension state, this should work:
dist/chrome
directory and proceed through onboardingScreenshots/Recordings
N/A
Pre-merge author checklist
Standards.
Pre-merge reviewer checklist