feat: upgrade network controller to v20 by bergeron · Pull Request #26150 · MetaMask/metamask-extension

bergeron · 2024-07-26T05:36:28Z

Description

Upgrades the network controller to v20, where providerConfig is removed from state.

To handle this, the getProviderConfig selector is shimmed to return the same data as before. Places that were accessing state directly are now sent through this selector.

A migration is added to remove providerConfig from state.

A helper function mockNetworkState is added to abstract the network schema from unit + e2e tests. This will simplify test writing and the next network controller upgrade, where this state will change again.

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

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.

github-actions · 2024-07-26T05:36:40Z

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.

socket-security · 2024-07-26T05:38:11Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/ens-controller@13.0.1	None	`0`	136 kB	metamaskbot
npm/eslint-visitor-keys@2.1.0	None	`0`	24.7 kB	eslintbot

🚮 Removed packages: npm/@metamask/ens-controller@12.0.0), npm/@metamask/ppom-validator@0.32.0), npm/@metamask/smart-transactions-controller@11.0.0), npm/builtin-modules@3.3.0), npm/crypto-js@4.2.0), npm/eslint-compat-utils@0.1.2), npm/eslint-plugin-es-x@7.5.0), npm/eslint-plugin-n@16.6.2), npm/eslint-visitor-keys@3.4.3), npm/globals@13.24.0), npm/is-builtin-module@3.2.1)

View full report↗︎

… brian/network-controller-v20

socket-security · 2024-07-26T20:26:02Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

… brian/network-controller-v20

metamaskbot · 2024-07-28T03:10:27Z

Builds ready [3c0373d]

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, 10, 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 (131 ± 137 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	75	208	102	31	15
		domContentLoaded	17	103	31	18	9
		load	47	1364	131	284	137
		domInteractive	17	103	31	18	9

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

background: 1.11 KiB (0.03%)
ui: 291 Bytes (0.00%)
common: 294 Bytes (0.00%)

… brian/network-controller-v20

bergeron · 2024-08-22T23:07:07Z

#26147 from develop breaks when merged in since it usses more provider config. Fixing which will reset votes

metamaskbot · 2024-08-23T00:40:01Z

Builds ready [304ebfd]

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, 10, 11, 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 (84 ± 9 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	82	175	116	25	12
		domContentLoaded	52	125	81	19	9
		load	59	132	84	18	9
		domInteractive	18	56	31	13	6

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

background: 2.86 KiB (0.08%)
ui: 310 Bytes (0.00%)
common: 37.04 KiB (0.44%)

bergeron · 2024-08-23T01:31:42Z

Thanks @legobeat, I've used those steps to regenerate yarn.lock #26150 (comment)

bergeron · 2024-08-23T01:37:16Z

@metamaskbot update-policies

metamaskbot · 2024-08-23T01:48:33Z

Policies updated

sonarqubecloud · 2024-08-23T01:53:24Z

Quality Gate passed

Issues
3 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

metamaskbot · 2024-08-23T02:35:56Z

Builds ready [d1e86fa]

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, 10, 11, 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 (80 ± 26 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	66	402	107	68	33
		domContentLoaded	41	312	75	55	26
		load	47	312	80	54	26
		domInteractive	9	110	29	20	10

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

background: -843 Bytes (-0.02%)
ui: 310 Bytes (0.00%)
common: 37.04 KiB (0.44%)

legobeat · 2024-08-23T02:36:33Z

.yarn/patches/@metamask-smart-transactions-controller-npm-11.0.0-83133fb677.patch

+         __classPrivateFieldGet(this, _SmartTransactionsController_instances, "m", _SmartTransactionsController_ensureUniqueSmartTransactions).call(this);
+-        onNetworkStateChange(({ providerConfig: newProvider }) => {
+-            const { chainId } = newProvider;
+        onNetworkStateChange((state) => {


It looks like this change is now part of released @metamask/smart-transactions-controller@12.0.0, while also bumping the transitive dep on @metamask/network-controller 19->20.

Is there a reason to not update to (seemingly equivalent, considering this resolutions entry) @metamask/smart-transactions-controller v12.0.0, or even v12.0.1?

yes that can be bumped now. I'll do that as quick follow up so i can get the bulk of this merged

bumped here #26644

jpuri

Changes in files owned by confirmations team look good 👍

initial upgrade

45417c6

bergeron mentioned this pull request Jul 26, 2024

Draft: Upgrade network controller #25673

Closed

bergeron and others added 7 commits July 25, 2024 22:40

fix ppom patch

20dc44c

yarn

796c047

Merge branch 'develop' into brian/network-controller-v20

ee9ec18

remove commented out provider configs

c2da45c

Update LavaMoat policies

52b7fdd

put providerConfig back in e2e test fixture

3bb52a5

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

9e86d59

… brian/network-controller-v20

bergeron added 9 commits July 26, 2024 13:26

package.json

2eded1f

fix stray comma

5faf951

lint

059f2e7

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

110f42e

… brian/network-controller-v20

fix mainnet network mock

bd3a378

fix test

4ce58b5

fix tests

8d828d8

fix rest of unit tests

e8ffb5f

fix integration tests

f89d5a5

MetaMask deleted a comment from metamaskbot Jul 27, 2024

MetaMask deleted a comment from sonarqubecloud bot Jul 27, 2024

bergeron added the team-assets label Jul 27, 2024

bergeron added 2 commits July 27, 2024 17:30

lint

4f80912

fix storybook

3c0373d

mikesposito previously approved these changes Aug 22, 2024

View reviewed changes

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

f5f7981

… brian/network-controller-v20

fix changes from #26147

7767a4a

bergeron dismissed stale reviews from mikesposito, hmalik88, and shane-t via 7767a4a August 22, 2024 23:38

remove additional ProviderConfig reference from #26147

304ebfd

hmalik88 previously approved these changes Aug 23, 2024

View reviewed changes

This comment was marked as resolved.

Sign in to view

regenerate yarn.lock

523d3d4

bergeron dismissed hmalik88’s stale review via 523d3d4 August 23, 2024 01:30

Update LavaMoat policies

d1e86fa

legobeat reviewed Aug 23, 2024

View reviewed changes

salimtb approved these changes Aug 23, 2024

View reviewed changes

zone-live approved these changes Aug 23, 2024

View reviewed changes

jpuri approved these changes Aug 23, 2024

View reviewed changes

infiniteflower approved these changes Aug 23, 2024

View reviewed changes

bergeron merged commit 800a9d3 into develop Aug 23, 2024

bergeron deleted the brian/network-controller-v20 branch August 23, 2024 15:30

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

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

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

Conversation

bergeron commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions bot commented Jul 26, 2024

Uh oh!

socket-security bot commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security bot commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

metamaskbot commented Jul 28, 2024

Uh oh!

bergeron commented Aug 22, 2024

Uh oh!

metamaskbot commented Aug 23, 2024

Uh oh!

This comment was marked as resolved.

bergeron commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bergeron commented Aug 23, 2024

Uh oh!

metamaskbot commented Aug 23, 2024

Uh oh!

sonarqubecloud bot commented Aug 23, 2024

Quality Gate passed

Uh oh!

metamaskbot commented Aug 23, 2024

Uh oh!

legobeat Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

bergeron Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

bergeron Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

jpuri left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

bergeron commented Jul 26, 2024 •

edited

Loading

socket-security bot commented Jul 26, 2024 •

edited

Loading

socket-security bot commented Jul 26, 2024 •

edited

Loading

bergeron commented Aug 23, 2024 •

edited

Loading