feat: Upgrade alert controller to base controller v2 #28054

kanthesha · 2024-10-23T22:13:18Z

Description

Following the Wallet Framework team's OKRs for Q3 2024, we want to bring AlertController up to date with our latest controller patterns.

Related issues

Fixes: #25915

Manual testing steps

Go to this page...

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-10-23T22:13:33Z

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.

…troller-v2

metamaskbot · 2024-10-23T22:56:22Z

Builds ready [3c04312]

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, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2279 ± 109 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	284	2620	1862	786	377
		domContentLoaded	1780	2547	2241	235	113
		load	1831	2594	2279	228	109
		domInteractive	31	104	59	21	10
		backgroundConnect	8	104	36	31	15
		firstReactRender	62	303	139	59	28
		getState	7	66	35	20	10
		initialActions	0	0	0	0	0
		loadScripts	1298	1974	1698	206	99
		setupStore	16	90	39	22	11
		uiStartup	2040	3337	2613	316	152

Bundle size diffs [🚀 Bundle size reduced!]

background: -587 Bytes (-0.01%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

mikesposito

Looks good! only minor comments.

app/scripts/controllers/alert-controller.ts

app/scripts/controllers/alert-controller.test.ts

metamaskbot · 2024-10-25T13:17:31Z

Builds ready [7c3949e]

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, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1957 ± 74 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1772	2460	1951	157	75
		domContentLoaded	1726	2389	1901	148	71
		load	1773	2464	1957	155	74
		domInteractive	17	97	55	21	10
		backgroundConnect	12	95	51	28	13
		firstReactRender	54	192	104	27	13
		getState	6	65	21	19	9
		initialActions	0	1	0	0	0
		loadScripts	1278	1788	1425	118	56
		setupStore	12	80	27	21	10
		uiStartup	1939	2687	2181	176	84

Bundle size diffs [🚀 Bundle size reduced!]

background: -587 Bytes (-0.01%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

mcmire

Overall looks pretty good, just had some suggestions on simplifying certain sections.

app/scripts/controllers/alert-controller.ts

app/scripts/controllers/alert-controller.test.ts

…imUsageState

…troller-v2

metamaskbot · 2024-10-30T13:34:53Z

Builds ready [7c85b54]

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, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1867 ± 97 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	214	2711	1804	424	204
		domContentLoaded	1624	2579	1838	198	95
		load	1628	2616	1867	203	97
		domInteractive	16	81	42	16	8
		backgroundConnect	7	78	27	23	11
		firstReactRender	44	198	93	32	15
		getState	5	59	23	22	10
		initialActions	0	1	0	0	0
		loadScripts	1154	1956	1345	168	81
		setupStore	11	67	26	22	10
		uiStartup	1821	2887	2086	233	112

Bundle size diffs [🚀 Bundle size reduced!]

background: -592 Bytes (-0.01%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

…troller-v2

metamaskbot · 2024-10-30T14:17:18Z

Builds ready [47d9e70]

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, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1938 ± 144 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	484	3012	1807	531	255
		domContentLoaded	1634	2925	1912	285	137
		load	1646	2998	1938	301	144
		domInteractive	17	231	55	45	21
		backgroundConnect	11	91	30	23	11
		firstReactRender	48	295	105	47	23
		getState	4	73	17	19	9
		initialActions	0	1	0	0	0
		loadScripts	1164	2221	1422	230	111
		setupStore	12	89	33	25	12
		uiStartup	1883	3292	2176	323	155

Bundle size diffs [🚀 Bundle size reduced!]

background: -592 Bytes (-0.01%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

mcmire

A few more things and then I'm good!

app/scripts/controllers/alert-controller.test.ts

app/scripts/controllers/alert-controller.ts

app/scripts/controllers/alert-controller.test.ts

metamaskbot · 2024-10-30T16:11:20Z

Builds ready [9024513]

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, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2078 ± 100 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	225	2590	1982	455	218
		domContentLoaded	1738	2551	2049	204	98
		load	1781	2570	2078	208	100
		domInteractive	24	97	48	20	10
		backgroundConnect	8	78	24	22	11
		firstReactRender	94	175	118	23	11
		getState	7	61	21	18	9
		initialActions	0	1	0	0	0
		loadScripts	1248	1854	1509	159	76
		setupStore	12	73	31	23	11
		uiStartup	2003	2833	2309	226	109

Bundle size diffs [🚀 Bundle size reduced!]

background: -592 Bytes (-0.01%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

mcmire

Looks good!

upgrade alert controller to base controller v2

9a7393b

kanthesha added the team-wallet-framework label Oct 23, 2024

kanthesha requested a review from a team October 23, 2024 22:13

kanthesha self-assigned this Oct 23, 2024

Merge branch 'develop' into feat/upgrade-alert-controller-to-base-con…

3c04312

…troller-v2

kanthesha marked this pull request as ready for review October 24, 2024 08:33

kanthesha requested a review from a team as a code owner October 24, 2024 08:33

mikesposito previously approved these changes Oct 24, 2024

View reviewed changes

app/scripts/controllers/alert-controller.ts Show resolved Hide resolved

app/scripts/controllers/alert-controller.test.ts Outdated Show resolved Hide resolved

cryptodev-2s previously approved these changes Oct 24, 2024

View reviewed changes

add jsdoc to getDefaultState and add withController in tests

7c3949e

kanthesha dismissed stale reviews from cryptodev-2s and mikesposito via 7c3949e October 25, 2024 12:44

mcmire reviewed Oct 25, 2024

View reviewed changes

kanthesha added 4 commits October 30, 2024 11:54

remove initState from default state in tests and update the setWeb3Sh…

d788399

…imUsageState

fix lint error

2f0584c

Merge branch 'develop' into feat/upgrade-alert-controller-to-base-con…

7c85b54

…troller-v2

remove initstate from tests

9c1f55a

Merge branch 'develop' into feat/upgrade-alert-controller-to-base-con…

47d9e70

…troller-v2

mcmire reviewed Oct 30, 2024

View reviewed changes

app/scripts/controllers/alert-controller.test.ts Outdated Show resolved Hide resolved

app/scripts/controllers/alert-controller.ts Outdated Show resolved Hide resolved

app/scripts/controllers/alert-controller.test.ts Outdated Show resolved Hide resolved

state optional and remove messenger.call used for state check in tests

9024513

desi requested a review from a team October 31, 2024 15:56

mcmire approved these changes Nov 1, 2024

View reviewed changes

DDDDDanica approved these changes Nov 1, 2024

View reviewed changes

kanthesha added this pull request to the merge queue Nov 1, 2024

Merged via the queue into develop with commit 9b85efb Nov 1, 2024
76 checks passed

kanthesha deleted the feat/upgrade-alert-controller-to-base-controller-v2 branch November 1, 2024 17:31

github-actions bot locked and limited conversation to collaborators Nov 1, 2024

metamaskbot added the release-12.8.0 Issue or pull request that will be included in release 12.8.0 label Nov 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Upgrade alert controller to base controller v2 #28054

feat: Upgrade alert controller to base controller v2 #28054

kanthesha commented Oct 23, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Oct 23, 2024

metamaskbot commented Oct 23, 2024

mikesposito left a comment

metamaskbot commented Oct 25, 2024

mcmire left a comment

metamaskbot commented Oct 30, 2024

metamaskbot commented Oct 30, 2024

mcmire left a comment

metamaskbot commented Oct 30, 2024

mcmire left a comment

feat: Upgrade alert controller to base controller v2 #28054

feat: Upgrade alert controller to base controller v2 #28054

Conversation

kanthesha commented Oct 23, 2024 • edited by github-actions bot Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Oct 23, 2024

metamaskbot commented Oct 23, 2024

mikesposito left a comment

Choose a reason for hiding this comment

metamaskbot commented Oct 25, 2024

mcmire left a comment

Choose a reason for hiding this comment

metamaskbot commented Oct 30, 2024

metamaskbot commented Oct 30, 2024

mcmire left a comment

Choose a reason for hiding this comment

metamaskbot commented Oct 30, 2024

mcmire left a comment

Choose a reason for hiding this comment

kanthesha commented Oct 23, 2024 •

edited by github-actions bot

Loading