fix: Fix `currentNetwork` selector when current network config is missing #26327

Gudahtt · 2024-08-02T16:22:57Z

Description

The providerConfig state is not guaranteed to match a built-in or custom network. It should in the vast majority of cases, but there are some edge cases where that would not hold true. For example:

If the wallet crashed partway through removing the current network
If the user has had the same network selected since before we introduced the networkConfigurations state

The currentNetwork selector has been updated to handle this case by returning a configuration object constructed from the providerConfig state directly.

Related issues

Fixes #26320

Manual testing steps

Create a dev build and proceed through onboarding

Run this command in the background console to set providerConfig to a custom network that isn't present in the user's tracked network configurations:

chrome.storage.local.get(
  null,
  (state) => {
    state.data.NetworkController.providerConfig = {
      rpcUrl: 'https://mainnet.optimism.io',
      chainId: '0xa',
      ticker: 'ETH',
      type: 'rpc',
    };
    chrome.storage.local.set(state, () => chrome.runtime.reload());
  }
);

See that the UI can be opened and does not crash.

Screenshots/Recordings

N/A

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension 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.

…sing The `providerConfig` state is not guaranteed to match a built-in or custom network. It should in the vast majority of cases, but there are some edge cases where that would not hold true. For example: * If the wallet crashed partway through removing the current network * If the user has had the same network selected since before we introduced the `networkConfigurations` state The `currentNetwork` selector has been updated to handle this case by returning a configuration object constructed from the `providerConfig` state directly. Fixes #26320

sonarqubecloud · 2024-08-02T17:21:33Z

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 SonarCloud

codecov · 2024-08-02T17:38:32Z

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 70.04%. Comparing base (80f538e) to head (c38a3f5).
Report is 1 commits behind head on develop.

Files	Patch %	Lines
...nts/app/assets/nfts/nft-details/nft-full-image.tsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #26327   +/-   ##
========================================
  Coverage    70.04%   70.04%           
========================================
  Files         1411     1411           
  Lines        50029    50034    +5     
  Branches     13815    13820    +5     
========================================
+ Hits         35042    35046    +4     
- Misses       14987    14988    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Gudahtt · 2024-08-02T17:44:13Z

ui/pages/confirmations/confirmation/templates/__snapshots__/add-ethereum-chain.test.js.snap

          </div>
          <span
            class="mm-box mm-text mm-text--body-sm mm-text--ellipsis mm-box--color-text-default"
            data-testid="network-display"
-          />
+          >
+            Test initial state


The test fixtures used here were of the type affected by this change: providerConfig was not a built-in or custom network. Probably not intentional, but I didn't dig in further. This snapshot change is not wrong or totally unexpected at least.

Gudahtt · 2024-08-02T17:45:31Z

ui/selectors/selectors.js

+   *
+   * @param {Record<string, unknown>[]} allNetworks - All network configurations.
+   * @param {Record<string, unknown>} providerConfig - The configuration for the current network's provider.
+   * @returns {{


I added a JSDoc block so that tsc could help spot any instances where this change was breaking.

Specifically the only difference in output before and after is that the id property is now optional, whereas before it was guaranteed to exist on the returned object in some cases (if an object was returned at all). But luckily nothing was relying on that.

Gudahtt · 2024-08-02T17:46:07Z

ui/selectors/selectors.js

-    return allNetworks.find(filter);
+    return (
+      allNetworks.find(filter) ?? {
+        chainId: providerConfig.chainId,


The providerConfig.type property is being excluded here because that's not an expected network configuration property.

id is excluded as well, since if it is set here it must be invalid (the filter above didn't find anything matching it).

Have we removed instances like the one causing this error expecting an id?

Looks like it's still in this file down on line 1912?

To clarify, the id property is still expected to be present in cases where providerConfig matches a valid custom network configuration. It would cause problems if this selector was used where an id must always present, but the line you linked works fine if id is undefined. If the current domain has a selected network configuration set, it'll find that it doesn't match undefined and it will switch, which is correct.

ah ok right. The issue I was thinking of was when currentNetwork is undefined not id: https://metamask.sentry.io/issues/5660992353/?environment=production&project=273505&query=firstRelease%3A12.0.0&referrer=issue-stream&sort=freq&statsPeriod=90d&stream_index=12

metamaskbot · 2024-08-02T17:49:22Z

Builds ready [c38a3f5]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (287 ± 301 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	74	313	122	59	29
		domContentLoaded	10	173	31	37	18
		load	46	2169	287	627	301
		domInteractive	10	173	31	37	18

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: 9 Bytes (0.00%)
common: 93 Bytes (0.00%)

metamaskbot added the team-wallet-framework label Aug 2, 2024

Gudahtt force-pushed the fix-current-network-undefined branch from 4a3bb7b to e4093a9 Compare August 2, 2024 16:42

Gudahtt added 3 commits August 2, 2024 14:49

Update test snapshots

4c9f43a

Fix lint errors

c38a3f5

Gudahtt force-pushed the fix-current-network-undefined branch from ec6b27f to c38a3f5 Compare August 2, 2024 17:19

Gudahtt marked this pull request as ready for review August 2, 2024 17:42

Gudahtt requested review from a team as code owners August 2, 2024 17:42

Gudahtt commented Aug 2, 2024

View reviewed changes

danjm approved these changes Aug 2, 2024

View reviewed changes

adonesky1 approved these changes Aug 2, 2024

View reviewed changes

sleepytanya approved these changes Aug 2, 2024

View reviewed changes

Gudahtt merged commit e5651cf into develop Aug 2, 2024
75 checks passed

Gudahtt deleted the fix-current-network-undefined branch August 2, 2024 19:19

github-actions bot locked and limited conversation to collaborators Aug 2, 2024

metamaskbot added the release-12.4.0 Issue or pull request that will be included in release 12.4.0 label Aug 2, 2024

gauthierpetetin added release-12.3.0 Issue or pull request that will be included in release 12.3.0 and removed release-12.4.0 Issue or pull request that will be included in release 12.4.0 labels Sep 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fix `currentNetwork` selector when current network config is missing #26327

fix: Fix `currentNetwork` selector when current network config is missing #26327

Gudahtt commented Aug 2, 2024 •

edited

Loading

sonarqubecloud bot commented Aug 2, 2024

codecov bot commented Aug 2, 2024

Gudahtt Aug 2, 2024

Gudahtt Aug 2, 2024 •

edited

Loading

Gudahtt Aug 2, 2024 •

edited

Loading

adonesky1 Aug 2, 2024

adonesky1 Aug 2, 2024

Gudahtt Aug 2, 2024 •

edited

Loading

adonesky1 Aug 2, 2024

metamaskbot commented Aug 2, 2024

fix: Fix currentNetwork selector when current network config is missing #26327

fix: Fix currentNetwork selector when current network config is missing #26327

Conversation

Gudahtt commented Aug 2, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Pre-merge author checklist

Pre-merge reviewer checklist

sonarqubecloud bot commented Aug 2, 2024

Quality Gate passed

codecov bot commented Aug 2, 2024

Codecov Report

Gudahtt Aug 2, 2024

Choose a reason for hiding this comment

Gudahtt Aug 2, 2024 • edited Loading

Choose a reason for hiding this comment

Gudahtt Aug 2, 2024 • edited Loading

Choose a reason for hiding this comment

adonesky1 Aug 2, 2024

Choose a reason for hiding this comment

adonesky1 Aug 2, 2024

Choose a reason for hiding this comment

Gudahtt Aug 2, 2024 • edited Loading

Choose a reason for hiding this comment

adonesky1 Aug 2, 2024

Choose a reason for hiding this comment

metamaskbot commented Aug 2, 2024

fix: Fix `currentNetwork` selector when current network config is missing #26327

fix: Fix `currentNetwork` selector when current network config is missing #26327

Gudahtt commented Aug 2, 2024 •

edited

Loading

Gudahtt Aug 2, 2024 •

edited

Loading

Gudahtt Aug 2, 2024 •

edited

Loading

Gudahtt Aug 2, 2024 •

edited

Loading