Bump @metamask/providers to v13.0.0 by jiexi · Pull Request #20917 · MetaMask/metamask-extension

jiexi · 2023-09-15T21:22:47Z

Driven by a need to get rid of window.ethereum.networkVersion as a part of removing networkId work. This PR bumps @metamask/providers from v11.1.0 to v13.0.0, which introduces a deprecation warning when accessing window.ethereum.networkVersion (as well as chainId and selectedAddress). The goal is to get this into the wild, alert devs, and to finally remove these properties in the future.

~~Additionally, this PR bumps browserify from v16.5.1 to v17.0.0 which is required for polyfilling streams.pipeline which is now used in @metamask/providers~~ Completed in a separate PR already

MetaMask/providers@v11.1.0...v13.0.0

Explanation

Screenshots/Screencaps

Before

After

Manual Testing Steps

Open browser console in any page
Enter window.ethereum.chainId
You should get the value for the current selected chain ID and a deprecation warning
Enter window.ethereum.chainId again
You should get the value for the current selected chain ID, but no deprecation warning this time
Repeat 2-6 for window.ethereum.networkVersion and window.ethereum.selectedAddress

Pre-merge author checklist

I've clearly explained:
- What problem this PR is solving
- How this problem was solved
- How reviewers can test my changes
Sufficient automated test coverage has been added

Pre-merge reviewer checklist

Manual testing (e.g. pull and build branch, run in browser, test code being changed)
PR is linked to the appropriate GitHub issue
IF this PR fixes a bug in the release milestone, add this PR to the release milestone

If further QA is required (e.g. new feature, complex testing steps, large refactor), add the Extension QA Board label.

In this case, a QA Engineer approval will be be required.

github-actions · 2023-09-15T21:22:58Z

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 · 2023-09-15T21:28:02Z

No top level dependency changes detected. Learn more about Socket for GitHub ↗︎

socket-security · 2023-09-18T16:41:10Z

👍 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.

jiexi · 2023-09-18T17:44:35Z

@metamaskbot update-policies

metamaskbot · 2023-09-18T17:58:10Z

Policies updated

jiexi · 2023-09-19T16:53:46Z

@metamaskbot update-policies

metamaskbot · 2023-09-19T17:07:06Z

Policies updated

metamaskbot · 2023-09-19T20:50:44Z

Builds ready [9873ef8]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): 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
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1590 ± 57 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	112	191	142	18	9
		domContentLoaded	1441	2009	1590	118	57
		load	1442	2009	1590	118	57
		domInteractive	1441	2009	1590	118	57

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

background: 340 Bytes (0.01%)
ui: -13.88 KiB (-0.17%)
common: 64.57 KiB (1.41%)

codecov · 2023-09-19T20:50:53Z

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (c32d063) 68.63% compared to head (806e33b) 68.63%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #20917   +/-   ##
========================================
  Coverage    68.63%   68.63%           
========================================
  Files         1017     1017           
  Lines        40790    40790           
  Branches     10896    10896           
========================================
  Hits         27996    27996           
  Misses       12794    12794

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

adonesky1 · 2023-09-19T21:17:53Z

Can we only have one version of browserify in our dependency graph? Otherwise shouldn't @metamask/providers bring the different version requirement with it?

jiexi · 2023-09-20T16:04:34Z

One thought on making this upgrades as safe and smooth as we can: If browserify@16->17 can be broken out separately and merged prior to upgrading providers to 13, that would be preferred

Resolved by #20946 . Thank you for taking care of that!

@metamask/keyring-api@0.2.5

~~Can bump this in a separate PR~~
MetaMask/eth-snap-keyring#102

MetaMask/snaps#1748

Looks like this may require some manual attention. I'll try to take a look today.

But yes, if this actually relies on a polyfill that browserify pulls in, sounds like something that should be done wither by providers or directly in metamask-extension itself?

Hard to say. It's awkward because the provider is almost always used in the browser context, but not strictly. Because it's totally valid to be used in nodejs, I think this is a concern of metamask-extension and not providers.

jiexi · 2023-10-04T18:08:44Z

Current provider alignment status. Still have v11 floating around

bump provider to v13 in @metamask/snaps-execution-environments
- consume in @metamask/snaps-controllers
- consume in @metamask/eth-snap-keyring
- consume in @metamask/keyring-api
  - consume in @metamask/eth-snap-keyring

bump provider to v13 in @metamask/snaps-execution-environments: MetaMask/snaps#1748

adonesky1 · 2023-10-05T16:24:53Z

lavamoat/build-system/policy.json

@@ -1136,6 +1136,21 @@
        "string.prototype.matchall>side-channel": true


pretty sure we don't want to commit these changes? I believe these are OS specific.

i believe this comes from the auto generated lavamoat policies

jiexi · 2023-10-05T17:21:04Z

@metamaskbot update-policies

metamaskbot · 2023-10-05T17:37:03Z

Policies updated

metamaskbot · 2023-10-05T22:22:02Z

Builds ready [37f4f50]

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
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1324 ± 344 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	82	138	99	15	7
		domContentLoaded	69	132	93	18	8
		load	83	1996	1324	717	344
		domInteractive	69	132	93	18	8

Bundle size diffs

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

jiexi · 2023-10-06T16:59:11Z

No longer blocked by having to align snaps (provider v11) and this change

adonesky1

LGTM

metamaskbot · 2023-10-06T19:16:25Z

Builds ready [806e33b]

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
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1045 ± 377 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	81	128	100	14	7
		domContentLoaded	69	120	93	14	7
		load	80	2173	1045	786	377
		domInteractive	69	120	93	14	7

Bundle size diffs

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

Bump @metamask/providers to v13.0.0

b17d231

Merge branch 'develop' into jl/deprecate-provider-properties

0dbd310

Update LavaMoat policies

03e7db5

jiexi and others added 8 commits September 18, 2023 11:32

Merge branch 'develop' into jl/deprecate-provider-properties

3045ab7

Merge branch 'develop' into jl/deprecate-provider-properties

e2291aa

Bump Browserify

552c6d8

Update LavaMoat policies

7d94f1c

Update LavaMoat policies

80a1dcf

Merge branch 'develop' into jl/deprecate-provider-properties

ea51f3b

Merge branch 'fb/bump-browserify' into jl/deprecate-provider-properties

4c9ca89

Lavamoat

7f65862

jiexi mentioned this pull request Sep 19, 2023

Bump Browserify #20946

Merged

jiexi changed the title ~~Bump @metamask/providers to v13.0.0~~ Bump @metamask/providers to v13.0.0, browserify to v17.0.0 Sep 19, 2023

jiexi marked this pull request as ready for review September 19, 2023 16:39

jiexi requested review from a team as code owners September 19, 2023 16:39

jiexi added the team-wallet-api-platform-deprecated DEPRECATED: please use "team-wallet-integrations" instead label Sep 19, 2023

Update LavaMoat policies

89d6df0

Merge branch 'develop' into jl/deprecate-provider-properties

9873ef8

legobeat added the dependencies Pull requests that update a dependency file label Sep 20, 2023

jiexi mentioned this pull request Sep 20, 2023

bump @metamask/keyring-api to v0.2.5 MetaMask/eth-snap-keyring#102

Merged

Merge branch 'develop' into jl/deprecate-provider-properties

5dfb62e

jiexi dismissed adonesky1’s stale review via 5dfb62e September 21, 2023 20:35

legobeat changed the title ~~Bump @metamask/providers to v13.0.0, browserify to v17.0.0~~ Bump @metamask/providers to v13.0.0 Sep 22, 2023

jiexi added 3 commits October 2, 2023 14:48

Merge branch 'develop' into jl/deprecate-provider-properties

210d6a2

Merge branch 'develop' into jl/deprecate-provider-properties

ecd1771

Merge branch 'develop' into jl/deprecate-provider-properties

2744a6c

Merge branch 'develop' into jl/deprecate-provider-properties

053f7e7

adonesky1 reviewed Oct 5, 2023

View reviewed changes

Merge branch 'develop' into jl/deprecate-provider-properties

a78dc73

Update LavaMoat policies

ce10eec

Merge branch 'develop' into jl/deprecate-provider-properties

37f4f50

Merge branch 'develop' into jl/deprecate-provider-properties

59627f9

jiexi added 2 commits October 6, 2023 09:59

Merge branch 'develop' into jl/deprecate-provider-properties

6b35b02

Merge branch 'develop' into jl/deprecate-provider-properties

806e33b

adonesky1 approved these changes Oct 6, 2023

View reviewed changes

brad-decker approved these changes Oct 6, 2023

View reviewed changes

shanejonas approved these changes Oct 6, 2023

View reviewed changes

jiexi merged commit 253b962 into develop Oct 6, 2023

jiexi deleted the jl/deprecate-provider-properties branch October 6, 2023 20:20

github-actions bot locked and limited conversation to collaborators Oct 6, 2023

metamaskbot added the release-11.4.0 Issue or pull request that will be included in release 11.4.0 label Oct 6, 2023

		@@ -1136,6 +1136,21 @@
		"string.prototype.matchall>side-channel": true

Conversation

jiexi commented Sep 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

Screenshots/Screencaps

Before

After

Manual Testing Steps

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions bot commented Sep 15, 2023

Uh oh!

socket-security bot commented Sep 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security bot commented Sep 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jiexi commented Sep 18, 2023

Uh oh!

metamaskbot commented Sep 18, 2023

Uh oh!

jiexi commented Sep 19, 2023

Uh oh!

metamaskbot commented Sep 19, 2023

Uh oh!

metamaskbot commented Sep 19, 2023

Uh oh!

codecov bot commented Sep 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

adonesky1 commented Sep 19, 2023

Uh oh!

jiexi commented Sep 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jiexi commented Oct 4, 2023

Uh oh!

adonesky1 Oct 5, 2023

Choose a reason for hiding this comment

Uh oh!

jiexi Oct 5, 2023

Choose a reason for hiding this comment

Uh oh!

jiexi commented Oct 5, 2023

Uh oh!

metamaskbot commented Oct 5, 2023

Uh oh!

metamaskbot commented Oct 5, 2023

Uh oh!

jiexi commented Oct 6, 2023

Uh oh!

adonesky1 left a comment

Choose a reason for hiding this comment

Uh oh!

metamaskbot commented Oct 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jiexi commented Sep 15, 2023 •

edited

Loading

socket-security bot commented Sep 15, 2023 •

edited

Loading

socket-security bot commented Sep 18, 2023 •

edited

Loading

codecov bot commented Sep 19, 2023 •

edited

Loading

jiexi commented Sep 20, 2023 •

edited

Loading