Migrate MetaMaskController from mocha to jest #20696

jiexi · 2023-09-02T00:25:52Z

Explanation

There is currently a fitness CI job that enforces the usage of assert/sinon does not increase. This PR migrates MetaMaskController from mocha to jest to resolve the fitness CI job failing for another branch. It achieves this by replacing usage of assert with jest expect and sinon with jest stubs.

See: Remove NetworkId #20652

Screenshots/Screencaps

Before

After

Manual Testing Steps

yarn test:unit:jest

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-02T00:26:04Z

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.

codecov · 2023-09-05T17:41:22Z

Codecov Report

Patch coverage: 62.50% and project coverage change: -0.67% ⚠️

Comparison is base (ac810ce) 68.87% compared to head (3e95edd) 68.20%.
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #20696      +/-   ##
===========================================
- Coverage    68.87%   68.20%   -0.67%     
===========================================
  Files          999      999              
  Lines        38978    39846     +868     
  Branches     10473    10669     +196     
===========================================
+ Hits         26845    27174     +329     
- Misses       12133    12672     +539

Files Changed	Coverage Δ
.mocharc.js	`100.00% <ø> (ø)`
app/scripts/metamask-controller.js	`54.36% <ø> (-11.03%)`	⬇️
app/scripts/controllers/app-state.js	`38.81% <50.00%> (-1.04%)`	⬇️
app/scripts/controllers/metametrics.js	`79.80% <75.00%> (ø)`

... and 20 files with indirect coverage changes

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

metamaskbot · 2023-09-05T17:56:09Z

Builds ready [afa9102]

builds: chrome, firefox
builds (beta): chrome
builds (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 (1539 ± 37 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	107	156	127	12	6
		domContentLoaded	1381	1664	1539	77	37
		load	1381	1664	1539	77	37
		domInteractive	1381	1664	1539	77	37

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

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

metamaskbot · 2023-09-05T18:49:50Z

Builds ready [d2e5b5a]

builds: chrome, firefox
builds (beta): chrome
builds (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 (1825 ± 101 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	111	233	158	32	15
		domContentLoaded	1562	2289	1824	210	101
		load	1562	2289	1825	211	101
		domInteractive	1562	2289	1824	211	101

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

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

app/scripts/controllers/app-state.js

metamaskbot · 2023-09-11T17:46:04Z

Builds ready [eb22439]

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 (1628 ± 85 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	111	164	134	15	7
		domContentLoaded	1457	2199	1628	176	85
		load	1457	2200	1628	176	85
		domInteractive	1457	2199	1628	176	85

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

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

app/scripts/metamask-controller.test.js

Co-authored-by: Alex Donesky <adonesky@gmail.com>

metamaskbot · 2023-09-11T19:00:25Z

Builds ready [3e95edd]

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 (1555 ± 83 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	100	184	134	19	9
		domContentLoaded	1376	2188	1554	172	83
		load	1376	2188	1555	172	83
		domInteractive	1376	2188	1554	172	83

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

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

adonesky1

LGTM!

adonesky1

LGTM!

jiexi added 10 commits August 31, 2023 14:22

convert swaps to expect

76b5c40

WIP mm controller

e52999d

Fix chrome.alarms polyfill

a3eda7d

replace sinon

2dac5f6

Merge branch 'develop' into jl/migrate-assert-sinon

11a5887

cleanup

1da81a0

lint

9c9c652

lint

6a0dced

fix jest coverage setting

6a8af1f

func to arrow

52b6ae8

jiexi requested a review from a team as a code owner September 2, 2023 00:25

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

jiexi added 4 commits September 5, 2023 09:05

Merge branch 'develop' into jl/migrate-assert-sinon

07f337f

Fix mmc test prefController spyOn

b908608

Add eslint-disable

5ab57e3

Merge branch 'develop' into jl/migrate-assert-sinon

afa9102

Merge branch 'develop' into jl/migrate-assert-sinon

d2e5b5a

jiexi requested a review from Gudahtt September 6, 2023 23:24

jiexi mentioned this pull request Sep 7, 2023

Remove NetworkId #20652

Merged

8 tasks

Merge branch 'develop' into jl/migrate-assert-sinon

eb22439

adonesky1 reviewed Sep 11, 2023

View reviewed changes

app/scripts/controllers/app-state.js Show resolved Hide resolved

adonesky1 reviewed Sep 11, 2023

View reviewed changes

app/scripts/metamask-controller.test.js Outdated Show resolved Hide resolved

Update app/scripts/metamask-controller.test.js

3e95edd

Co-authored-by: Alex Donesky <adonesky@gmail.com>

BelfordZ approved these changes Sep 11, 2023

View reviewed changes

adonesky1 reviewed Sep 11, 2023

View reviewed changes

adonesky1 approved these changes Sep 11, 2023

View reviewed changes

jiexi merged commit 37824db into develop Sep 11, 2023

jiexi deleted the jl/migrate-assert-sinon branch September 11, 2023 21:28

github-actions bot locked and limited conversation to collaborators Sep 11, 2023

metamaskbot added the release-11.2.0 Issue or pull request that will be included in release 11.2.0 label Sep 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Migrate MetaMaskController from mocha to jest #20696

Migrate MetaMaskController from mocha to jest #20696

jiexi commented Sep 2, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Sep 2, 2023

Uh oh!

codecov bot commented Sep 5, 2023 •

edited

Loading

Uh oh!

metamaskbot commented Sep 5, 2023

Uh oh!

metamaskbot commented Sep 5, 2023

Uh oh!

Uh oh!

metamaskbot commented Sep 11, 2023

Uh oh!

Uh oh!

metamaskbot commented Sep 11, 2023

Uh oh!

adonesky1 left a comment

Uh oh!

adonesky1 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Migrate MetaMaskController from mocha to jest #20696

Migrate MetaMaskController from mocha to jest #20696

Conversation

jiexi commented Sep 2, 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 2, 2023

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

metamaskbot commented Sep 5, 2023

Uh oh!

metamaskbot commented Sep 5, 2023

Uh oh!

Uh oh!

metamaskbot commented Sep 11, 2023

Uh oh!

Uh oh!

metamaskbot commented Sep 11, 2023

Uh oh!

adonesky1 left a comment

Choose a reason for hiding this comment

Uh oh!

adonesky1 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jiexi commented Sep 2, 2023 •

edited

Loading

codecov bot commented Sep 5, 2023 •

edited

Loading