Correct invalid initial selectedNetworkClientId by mcmire · Pull Request #15941 · MetaMask/metamask-mobile

mcmire · 2025-05-30T21:09:49Z

Description

Currently, when NetworkController is instantiated with pre-existing state that contains an invalid selectedNetworkClientId — that is, no RPC endpoint exists which has the same network client ID — then it throws an error. This was intentionally done to bring attention to possible bugs in NetworkController, but this has the unfortunate side effect of bricking users' wallets.

To fix this, we now correct an invalid selectedNetworkClientId to point to the default RPC endpoint of the first network sorted by chain ID (which in the vast majority of cases will be Mainnet). We still do want to know about this, though, so we log the error in Sentry.

Related issues

See MetaMask/core#5851 for the equivalent changes to network-controller that were copied here.

Manual testing steps

Check out this branch.
Run yarn setup:expo.

We now have to force the initial state to be invalid. Open Engine.ts, scroll down to where NetworkController is initialized, and apply these changes:

      const networkControllerOpts = {
        infuraProjectId: process.env.MM_INFURA_PROJECT_ID || NON_EMPTY,
-       state: initialState.NetworkController,
+       state: {
+         ...initialState.NetworkController,
+         selectedNetworkClientId: "nonexistent",
+       },
        messenger: this.controllerMessenger.getRestricted({
          name: 'NetworkController',
          allowedEvents: [],
          allowedActions: [],
        }) as unknown as NetworkControllerMessenger,
        getRpcServiceOptions: () => ({
          fetch,
          btoa,
        }),
        additionalDefaultNetworks: [ChainId['megaeth-testnet']],
        captureException,
      };
      const networkController = new NetworkController(networkControllerOpts);
+     Logger.log('selectedNetworkClientId', networkController.state.selectedNetworkClientId);

Run yarn watch:clean.
Load the app, onboarding if necessary.
You should be able to get to the home screen without issues. If you check the terminal you should see a line that says selectedNetworkClientId mainnet. This proves that although the initial selectedNetworkClientId was invalid, it was auto-corrected to "mainnet".

Screenshots/Recordings

(N/A)

Before

After

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). 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.

Currently, when NetworkController is instantiated with pre-existing state that contains an invalid `selectedNetworkClientId` — that is, no RPC endpoint exists which has the same network client ID — then it throws an error. This was intentionally done to bring attention to possible bugs in NetworkController, but this has the unfortunate side effect of bricking users' wallets. To fix this, we now correct an invalid `selectedNetworkClientId` to point to the default RPC endpoint of the first network sorted by chain ID (which in the vast majority of cases will be Mainnet). We still do want to know about this, though, so we log the error in Sentry.

github-actions · 2025-05-30T21:10:01Z

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.

sonarqubecloud · 2025-06-04T13:28:58Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-06-04T13:55:04Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 0db14fe
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/9d156042-1dd4-4c59-87e9-6c2233c2697c

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

mcmire · 2025-06-04T21:25:43Z

I'm not sure why Bitrise is failing. I selected a few e2e tests to run locally, and they all passed. Additionally, the release/7.47.0 already does not pass CI.

## **Description**  If `selectedNetworkClientId` in NetworkController state does not point to an RPC endpoint and therefore does not also point to a network client, then we automatically correct it to point to the default RPC endpoint of the first network (sorted by chain ID). This allows the wallet to start normally. This change is being added as a patch because we do not want to upgrade to 23.5.1, as doing so would fix another unrelated bug, and we want to limit the scope of the change. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/33480?quickstart=1) ## **Related issues** See MetaMask/core#5851 for the equivalent changes to network-controller that were copied here. Also see MetaMask/metamask-mobile#15941 for a similar fix on the mobile side. ## **Manual testing steps** 1. Check out this branch. 2. Run `yarn start`. 3. Open the extension, and go through onboarding. 4. Close the UI. 5. Find the extension and open the service worker. 6. Navigate to the Application tab. 7. Click on "Extension storage", then "Local". 8. Click on the value for "data". 9. Look in the preview pane below (rendered JSON), right-click and choose "Copy value". 10. Paste the value in another screen such as TextEdit. 11. Look for `selectedNetworkClientId` and change it to something invalid. 12. Reload the extension. 13. The extension should still load successfully. 14. Go back to the service worker. You should still be on the Application tab, and the preview should have been updated so that `selectedNetworkClientId` should no longer be invalid. 15. Repeat the same steps, except run `yarn webpack --watch` instead of `yarn start` (to test MV2). ## **Screenshots/Recordings**  (N/A) ### **Before**  ### **After**  ## **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/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-extension/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. --------- Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com>

Copilot

Pull Request Overview

This PR backports a fix to automatically correct invalid selectedNetworkClientId values in the NetworkController, logging errors to Sentry instead of throwing and bricking the app. It also updates the Engine initialization to pass the Sentry captureException handler into the controller.

Rename validateNetworkControllerState to validateInitialState and remove strict throw on invalid selection.
Introduce correctInitialState using Immer to adjust invalid selectedNetworkClientId, logging via captureException.
Update Engine to import and supply captureException when creating NetworkController.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
patches/@MetaMask+network-controller+23.2.1-backport.patch	Adds `validateInitialState`, `correctInitialState`, updates constructor to apply corrections and log errors.
app/core/Engine/Engine.ts	Imports `captureException` and supplies it to `networkControllerOpts`.

Comments suppressed due to low confidence (2)

node_modules/@metamask/network-controller/dist/NetworkController.cjs:42

Add unit tests for correctInitialState to ensure invalid selectedNetworkClientId values are corrected properly and errors are logged as intended.

function correctInitialState(state, captureException) {

node_modules/@metamask/network-controller/dist/NetworkController.cjs:61

Consider providing a default no-op for captureException or validating that options.captureException is a function before use to prevent runtime errors if it's undefined.

const { messenger, state, infuraProjectId, log, getRpcServiceOptions, additionalDefaultNetworks, captureException, } = options;

metamaskbot added the team-wallet-framework-deprecated DEPRECATED: please use "team-core-platform" instead label May 30, 2025

mcmire added the Run Smoke E2E label May 30, 2025

This comment was marked as outdated.

Sign in to view

Merge branch 'release/7.47.0' into fix-incident-1051

5004088

mcmire added Run Smoke E2E and removed Run Smoke E2E labels Jun 2, 2025

This comment was marked as outdated.

Sign in to view

Merge branch 'release/7.47.0' into fix-incident-1051

0db14fe

mcmire added Run Smoke E2E and removed Run Smoke E2E labels Jun 4, 2025

NicolasMassart added the release-blocker This bug is blocking the next release label Jun 4, 2025

mcmire mentioned this pull request Jun 4, 2025

fix: Prevent invalid selectedNetworkClientId on startup MetaMask/metamask-extension#33480

Merged

7 tasks

mcmire marked this pull request as ready for review June 4, 2025 21:19

mcmire requested a review from a team June 4, 2025 21:19

NicolasMassart requested a review from Copilot June 5, 2025 09:10

Copilot AI reviewed Jun 5, 2025

View reviewed changes

NicolasMassart approved these changes Jun 5, 2025

View reviewed changes

NicolasMassart merged commit 00a364e into release/7.47.0 Jun 5, 2025
41 of 44 checks passed

NicolasMassart deleted the fix-incident-1051 branch June 5, 2025 09:15

github-actions bot locked and limited conversation to collaborators Jun 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Correct invalid initial selectedNetworkClientId#15941

Correct invalid initial selectedNetworkClientId#15941
NicolasMassart merged 3 commits intorelease/7.47.0from
fix-incident-1051

mcmire commented May 30, 2025

Uh oh!

github-actions bot commented May 30, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

sonarqubecloud bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025 •

edited by metamaskbot

Loading

Uh oh!

mcmire commented Jun 4, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

mcmire commented May 30, 2025

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions bot commented May 30, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

sonarqubecloud bot commented Jun 4, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Jun 4, 2025 • edited by metamaskbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bitrise

Uh oh!

mcmire commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Jun 4, 2025 •

edited by metamaskbot

Loading

mcmire commented Jun 4, 2025 •

edited

Loading