fix: handle null STX status as pre-enabled state #29968

httpJunkie · 2025-01-29T15:22:34Z

Description

Only remaining QA issue for feature: [EXT] STX Banner Alert & STX x Default Migration

Update migration to treat null preference value as an existing enabled state, preventing unneeded banner display for v12.6.0-12.7.2 migrations.

The update removes the null check in the migration's transformState function (near line 46 of 135.ts)

  if (
    currentOptInStatus === undefined ||
    currentOptInStatus === null ||  // remove this line
    (currentOptInStatus === false && !hasExistingSmartTransactions(state))
  ) {

And let the condition fall through to the else block. This will ensure that smartTransactionsMigrationApplied: false and ensure that we don't see a banner on Transaction Confirmation.

Related issues

Fixes: #29970

Description
Migration fails when the origin extension is version 12.7.x (tested 1 and 2)
In this cases, the alert banner is displayed in the confirmation screen (e.g: send and swaps) when the parameter STX in settings was enabled in the older extension.

Expected behavior
The behaviour should be:
extension 12.11.0 < with STX activated -> update to 12.11.0 and no banner is displayed in the confirmation screen

Manual testing steps for fix

Migrate from any version 12.6.* to 12.7.* to 12.10.1 (or 12.11.0 depending)
Ensure that STX is ON in the old version (before migrating to the newer version)
After migration try to Swap or Send on Ethereum Mainnet & Sepolia and ensure there is no STX Banner Alert shown

Screenshots/Recordings

For users with STX ON before and after Migration:

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.

Update migration to treat null preference value as an existing enabled state, preventing unneeded banner display for v12.6.0-12.7.2 migrations.

github-actions · 2025-01-29T15:22:48Z

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.

- ui/components/app/snaps/snap-ui-address/snap-ui-address.test.tsx - ui/components/multichain/connect-accounts-modal/connect-accounts-modal.test.tsx

- ui/components/multichain/connect-accounts-modal/__snapshots__/connect-accounts-modal.test.tsx.snap

Adds Google's image hosting domain to allowed hosts list for Solana account testing.

metamaskbot · 2025-01-29T17:41:44Z

Builds ready [2972e76]

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

Page Load Metrics (1921 ± 85 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	296	2167	1737	484	232
		domContentLoaded	1644	2407	1888	171	82
		load	1655	2412	1921	176	85
		domInteractive	29	106	48	24	12
		backgroundConnect	10	110	30	26	12
		firstReactRender	17	104	41	29	14
		getState	6	97	22	23	11
		initialActions	0	1	0	0	0
		loadScripts	1180	1823	1379	145	70
		setupStore	9	80	27	23	11
		uiStartup	1923	2970	2257	284	136

Bundle size diffs [🚀 Bundle size reduced!]

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

metamaskbot · 2025-01-29T22:55:36Z

Builds ready [54b7ef1]

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

Page Load Metrics (1824 ± 81 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	297	2406	1669	468	225
		domContentLoaded	1598	2379	1797	169	81
		load	1612	2395	1824	169	81
		domInteractive	26	116	42	24	11
		backgroundConnect	11	58	28	17	8
		firstReactRender	16	84	35	23	11
		getState	5	54	17	15	7
		initialActions	0	0	0	0	0
		loadScripts	1155	1872	1344	152	73
		setupStore	7	58	28	22	11
		uiStartup	1843	2645	2095	201	96

Bundle size diffs [🚀 Bundle size reduced!]

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

metamaskbot · 2025-01-29T23:46:51Z

Builds ready [c1df208]

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

Page Load Metrics (1464 ± 40 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1306	1673	1462	80	38
		domContentLoaded	1280	1651	1441	80	38
		load	1301	1677	1464	83	40
		domInteractive	22	68	30	13	6
		backgroundConnect	8	64	24	18	9
		firstReactRender	14	98	35	29	14
		getState	4	65	15	18	8
		initialActions	0	0	0	0	0
		loadScripts	877	1222	1035	74	35
		setupStore	6	53	12	13	6
		uiStartup	1482	2149	1700	165	79

Bundle size diffs [🚀 Bundle size reduced!]

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

metamaskbot · 2025-01-30T04:30:56Z

Builds ready [11904f6]

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

Page Load Metrics (1667 ± 68 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	245	2080	1599	344	165
		domContentLoaded	1448	2000	1643	140	67
		load	1457	2043	1667	142	68
		domInteractive	21	110	35	19	9
		backgroundConnect	9	53	24	16	8
		firstReactRender	15	78	43	26	12
		getState	5	48	10	9	4
		initialActions	0	1	0	0	0
		loadScripts	1052	1467	1202	116	56
		setupStore	7	94	20	23	11
		uiStartup	1673	2961	1972	286	137

Bundle size diffs [🚀 Bundle size reduced!]

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

metamaskbot · 2025-01-30T10:24:31Z

Builds ready [bb84ecb]

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

Page Load Metrics (1599 ± 41 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1470	1792	1600	83	40
		domContentLoaded	1461	1777	1577	85	41
		load	1470	1791	1599	85	41
		domInteractive	22	71	35	15	7
		backgroundConnect	9	75	26	18	8
		firstReactRender	15	72	34	23	11
		getState	4	47	9	9	4
		initialActions	0	1	0	0	0
		loadScripts	1041	1296	1140	72	35
		setupStore	7	53	16	16	8
		uiStartup	1648	2044	1805	99	47

Bundle size diffs [🚀 Bundle size reduced!]

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

metamaskbot · 2025-01-30T13:16:50Z

Builds ready [367f825]

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

Page Load Metrics (1697 ± 83 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	263	2172	1614	347	167
		domContentLoaded	1398	2101	1657	145	70
		load	1406	2255	1697	172	83
		domInteractive	24	71	38	16	8
		backgroundConnect	10	192	40	43	21
		firstReactRender	16	95	45	27	13
		getState	4	152	23	36	17
		initialActions	0	1	0	0	0
		loadScripts	1004	1614	1199	130	62
		setupStore	7	53	14	13	6
		uiStartup	1582	2882	1964	271	130

Bundle size diffs [🚀 Bundle size reduced!]

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

fix: handle null STX status as pre-enabled state

16faf7d

Update migration to treat null preference value as an existing enabled state, preventing unneeded banner display for v12.6.0-12.7.2 migrations.

httpJunkie added the team-transactions Transactions team label Jan 29, 2025

httpJunkie self-assigned this Jan 29, 2025

fix: snapshot issues

6e2b20b

- ui/components/app/snaps/snap-ui-address/snap-ui-address.test.tsx - ui/components/multichain/connect-accounts-modal/connect-accounts-modal.test.tsx

httpJunkie requested review from a team as code owners January 29, 2025 16:05

fix: snapshot

7337001

- ui/components/multichain/connect-accounts-modal/__snapshots__/connect-accounts-modal.test.tsx.snap

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Jan 29, 2025

httpJunkie added 2 commits January 29, 2025 11:41

fix: snapshot

f5bc4a3

- ui/components/multichain/connect-accounts-modal/__snapshots__/connect-accounts-modal.test.tsx.snap

fix: add lh3.googleusercontent.com to privacy snapshot

2972e76

Adds Google's image hosting domain to allowed hosts list for Solana account testing.

httpJunkie requested a review from a team as a code owner January 29, 2025 17:08

httpJunkie marked this pull request as draft January 29, 2025 17:10

httpJunkie added release-12.11.0 Issue or pull request that will be included in release 12.11.0 and removed INVALID-PR-TEMPLATE PR's body doesn't match template labels Jan 29, 2025

httpJunkie added 2 commits January 29, 2025 12:57

fix: remove previous commit change to privacy-snapshot.json

eb01f78

Merge branch 'main' into fix/handle-null-stx-state

54b7ef1

Merge branch 'main' into fix/handle-null-stx-state

c1df208

Merge branch 'main' into fix/handle-null-stx-state

11904f6

Merge branch 'main' into fix/handle-null-stx-state

bb84ecb

pedronfigueiredo approved these changes Jan 30, 2025

View reviewed changes

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Jan 30, 2025

dan437 approved these changes Jan 30, 2025

View reviewed changes

Merge branch 'main' into fix/handle-null-stx-state

367f825

httpJunkie removed the INVALID-PR-TEMPLATE PR's body doesn't match template label Jan 30, 2025

httpJunkie marked this pull request as ready for review January 30, 2025 13:12

httpJunkie added this pull request to the merge queue Jan 30, 2025

Merged via the queue into main with commit 5bbe82c Jan 30, 2025
74 checks passed

httpJunkie deleted the fix/handle-null-stx-state branch January 30, 2025 14:11

github-actions bot locked and limited conversation to collaborators Jan 30, 2025

metamaskbot added the release-12.12.0 Issue or pull request that will be included in release 12.12.0 label Jan 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: handle null STX status as pre-enabled state #29968

fix: handle null STX status as pre-enabled state #29968

httpJunkie commented Jan 29, 2025 •

edited by dbrans

Loading

github-actions bot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 30, 2025

metamaskbot commented Jan 30, 2025

metamaskbot commented Jan 30, 2025

fix: handle null STX status as pre-enabled state #29968

fix: handle null STX status as pre-enabled state #29968

Conversation

httpJunkie commented Jan 29, 2025 • edited by dbrans Loading

Description

Related issues

Manual testing steps for fix

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 30, 2025

metamaskbot commented Jan 30, 2025

metamaskbot commented Jan 30, 2025

httpJunkie commented Jan 29, 2025 •

edited by dbrans

Loading