fix: enhance metrics for Transaction/Signatures events (Shield) cp-13.10.0 #37804

vinistevam · 2025-11-13T16:48:29Z

Description

This PR aims to add metrics for transaction shield.

shield_result_response_latency_ms: latency to receive response from Shield

Upgrading @metamask/shield-controller from ^1.2.0 to ^2.1.0, to support tracking latency of the requests.

Changelog

CHANGELOG entry: null

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/6136

Manual testing steps

Start the app
Switch to Sepolia network
Mint some USDC on sepolia on this smart contract (at least 80 for annual plan, 96 for monthly).
Import the token manually in the assets list
Navigate to Settings > Transaction Shield
Select pay with crypto, and Continue
The confirmation screen should appear and new shield properties should be added to the transaction/signature events
Check Segment

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.

Note

Adds shield_result_response_latency_ms to transaction/signature event fragments, introduces getCoverageMetrics selector, updates tests, and bumps @metamask/shield-controller to ^2.1.0.

Alerts/Telemetry:
- useShieldCoverageAlert now records shield_result_response_latency_ms (from metrics.latency or "N/A") in event fragments.
- Pulls metrics via new selector getCoverageMetrics; refines getShieldResult default handling and effect dependencies.
Selectors:
- Add types CoverageStatusResult, CoverageMetrics and helper getFirstCoverageResult.
- Implement getCoverageMetrics and refactor getCoverageStatus to use shared helper.
Tests:
- Extend useShieldCoverageAlert.test to assert latency propagation for tx/signature paths and various statuses.
- Add comprehensive tests for getCoverageMetrics and edge cases in getCoverageStatus.
Dependencies:
- Upgrade @metamask/shield-controller to ^2.1.0.

^{Written by Cursor Bugbot for commit bab9a95. This will update automatically on new commits. Configure here.}

…trics events

github-actions · 2025-11-13T16:48:39Z

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 · 2025-11-13T16:50:25Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@metamask/shield-controller@1.2.0 ⏵ 2.1.0	⁺¹		⁺¹	⁺¹

View full report

metamaskbot · 2025-11-13T16:50:48Z

✨ Files requiring CODEOWNER review ✨

✅ @MetaMask/confirmations (2 files, +33 -9)

📁 ui/
- 📁 pages/
  - 📁 confirmations/
    - 📁 hooks/
      - 📁 alerts/
        
        📄 useShieldCoverageAlert.test.ts +16 -2
        
        📄 useShieldCoverageAlert.ts +17 -7

🔐 @MetaMask/web3auth (2 files, +33 -9)

📁 ui/
- 📁 pages/
  - 📁 confirmations/
    - 📁 hooks/
      - 📁 alerts/
        
        📄 useShieldCoverageAlert.test.ts +16 -2
        
        📄 useShieldCoverageAlert.ts +17 -7

metamaskbot · 2025-11-13T17:14:29Z

Builds ready [fd8b295]

builds: chrome, firefox
builds (beta): chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16
- content-script: 0
- offscreen: 0

UI Startup Metrics (1247 ± 94 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Standard Home	uiStartup	1247	1092	1468	94	1322	1425
			load	1082	947	1299	89	1154	1238
			domContentLoaded	1075	943	1289	88	1150	1223
			domInteractive	24	14	101	17	21	66
			firstPaint	634	88	1321	423	1053	1200
			backgroundConnect	238	224	314	12	241	253
			firstReactRender	25	17	53	5	26	35
			getState	20	8	70	8	24	36
			initialActions	1	0	5	1	1	2
			loadScripts	844	719	1062	87	920	994
			setupStore	10	6	22	2	11	14
			numNetworkReqs	13	6	77	20	6	71
	Browserify	Power User Home	uiStartup	2285	1891	2839	236	2470	2839
			load	1099	918	1452	179	1334	1452
			domContentLoaded	1078	907	1443	177	1322	1443
			domInteractive	61	19	242	66	130	242
			firstPaint	813	243	1454	418	1039	1454
			backgroundConnect	243	234	263	7	245	263
			firstReactRender	74	40	143	24	90	143
			getState	214	160	353	52	247	353
			initialActions	1	0	2	1	1	2
			loadScripts	854	678	1212	175	1079	1212
			setupStore	29	15	51	11	39	51
			numNetworkReqs	152	97	297	75	251	297
	Webpack	Standard Home	uiStartup	806	694	1150	90	809	1055
			load	601	550	948	82	596	839
			domContentLoaded	594	544	919	79	590	826
			domInteractive	17	11	118	15	13	48
			firstPaint	208	61	948	203	200	789
			backgroundConnect	25	11	80	15	30	59
			firstReactRender	28	17	76	9	32	34
			getState	11	7	19	3	13	16
			initialActions	1	0	2	1	1	1
			loadScripts	591	541	906	76	588	816
			setupStore	11	5	38	5	13	15
			numNetworkReqs	13	6	76	20	6	73
	Webpack	Power User Home	uiStartup	1070	906	1553	218	1231	1553
			load	668	578	978	127	733	978
			domContentLoaded	652	560	947	119	719	947
			domInteractive	41	13	146	42	87	146
			firstPaint	396	129	895	236	574	895
			backgroundConnect	56	11	188	59	80	188
			firstReactRender	38	33	43	3	40	43
			getState	136	85	163	25	150	163
			initialActions	1	0	1	0	1	1
			loadScripts	648	558	937	116	708	937
			setupStore	14	6	33	10	24	33
			numNetworkReqs	111	70	225	46	161	225
Firefox	Browserify	Standard Home	uiStartup	1445	1286	1961	121	1473	1679
			load	1219	1114	1470	82	1249	1397
			domContentLoaded	1218	1113	1470	81	1249	1396
			domInteractive	106	35	305	48	108	209
			firstPaint	-	-	-	-	-	-
			backgroundConnect	41	25	127	18	49	76
			firstReactRender	25	20	49	5	26	38
			getState	12	7	180	17	10	18
			initialActions	1	0	2	1	2	2
			loadScripts	1194	1097	1440	77	1222	1367
			setupStore	11	7	52	6	11	24
			numNetworkReqs	12	6	72	16	7	57
	Browserify	Power User Home	uiStartup	3483	2707	4379	513	3894	4379
			load	1565	1275	2353	318	1838	2353
			domContentLoaded	1565	1274	2353	318	1838	2353
			domInteractive	337	122	720	205	542	720
			firstPaint	-	-	-	-	-	-
			backgroundConnect	549	136	1305	410	978	1305
			firstReactRender	84	52	121	19	103	121
			getState	195	84	505	92	239	505
			initialActions	2	1	8	2	3	8
			loadScripts	1512	1214	2210	303	1785	2210
			setupStore	73	30	125	29	97	125
			numNetworkReqs	153	91	310	67	225	310
	Webpack	Standard Home	uiStartup	1794	1561	2258	147	1839	2105
			load	1507	1274	1903	112	1559	1740
			domContentLoaded	1507	1274	1902	112	1559	1739
			domInteractive	110	36	407	44	118	174
			firstPaint	-	-	-	-	-	-
			backgroundConnect	66	27	314	43	72	132
			firstReactRender	35	25	93	12	36	46
			getState	15	8	174	18	14	25
			initialActions	2	1	3	1	2	2
			loadScripts	1471	1254	1862	106	1528	1697
			setupStore	17	8	81	14	14	57
			numNetworkReqs	13	6	66	17	8	65
	Webpack	Power User Home	uiStartup	3429	2983	4357	411	3705	4357
			load	1663	1442	2027	191	1895	2027
			domContentLoaded	1662	1441	2027	191	1895	2027
			domInteractive	307	105	711	188	534	711
			firstPaint	-	-	-	-	-	-
			backgroundConnect	407	140	917	264	759	917
			firstReactRender	82	45	117	22	102	117
			getState	154	99	248	37	174	248
			initialActions	2	1	3	1	3	3
			loadScripts	1612	1401	1964	188	1812	1964
			setupStore	142	49	504	121	162	504
			numNetworkReqs	149	78	320	78	231	320

📊 Page Load Benchmark Results

Current Commit: fd8b295 | Date: 11/13/2025

📄 Localhost MetaMask Test Dapp

Samples: 100

Summary

pageLoadTime-> current mean value: 1.05s (±70ms) 🟡 | historical mean value: 1.04s ⬆️ (historical data)
domContentLoaded-> current mean value: 737ms (±68ms) 🟢 | historical mean value: 725ms ⬆️ (historical data)
firstContentfulPaint-> current mean value: 78ms (±13ms) 🟢 | historical mean value: 80ms ⬇️ (historical data)

📈 Detailed Results

Metric	Mean	Std Dev	Min	Max	P95	P99
pageLoadTime	1.05s	70ms	1.01s	1.32s	1.26s	1.32s
domContentLoaded	737ms	68ms	702ms	1.00s	944ms	1.00s
firstPaint	78ms	13ms	64ms	192ms	92ms	192ms
firstContentfulPaint	78ms	13ms	64ms	192ms	92ms	192ms
largestContentfulPaint	0ms	0ms	0ms	0ms	0ms	0ms

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

background: 148 Bytes (0%)
ui: 307 Bytes (0%)
common: 20 Bytes (0%)

metamaskbot · 2025-11-14T08:46:41Z

Builds ready [bab9a95]

builds: chrome, firefox
builds (beta): chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16
- content-script: 0
- offscreen: 0

UI Startup Metrics (1270 ± 104 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Standard Home	uiStartup	1270	1115	1615	104	1341	1462
			load	1096	955	1345	94	1185	1263
			domContentLoaded	1090	933	1339	93	1179	1256
			domInteractive	24	15	97	18	21	74
			firstPaint	636	82	1347	434	1090	1219
			backgroundConnect	241	223	340	13	244	259
			firstReactRender	27	19	82	9	28	46
			getState	22	8	79	9	25	38
			initialActions	1	0	4	1	1	2
			loadScripts	855	700	1108	91	941	1017
			setupStore	11	7	24	3	12	17
			numNetworkReqs	13	6	77	19	6	70
	Browserify	Power User Home	uiStartup	2269	1949	2839	241	2487	2839
			load	1176	992	1607	203	1454	1607
			domContentLoaded	1154	978	1600	208	1446	1600
			domInteractive	64	19	191	66	167	191
			firstPaint	637	144	1523	500	1028	1523
			backgroundConnect	254	237	276	11	260	276
			firstReactRender	73	52	107	14	83	107
			getState	245	154	330	48	298	330
			initialActions	1	0	3	1	1	3
			loadScripts	923	748	1366	203	1217	1366
			setupStore	27	11	40	8	34	40
			numNetworkReqs	123	91	179	29	166	179
	Webpack	Standard Home	uiStartup	827	704	1204	100	825	1108
			load	614	558	970	89	603	882
			domContentLoaded	607	553	942	84	596	865
			domInteractive	18	11	78	13	14	54
			firstPaint	202	61	971	206	201	786
			backgroundConnect	25	12	74	14	30	62
			firstReactRender	30	18	127	13	34	38
			getState	11	6	21	3	12	16
			initialActions	1	0	4	1	1	1
			loadScripts	604	552	931	82	594	855
			setupStore	11	5	38	4	13	16
			numNetworkReqs	13	6	73	19	8	70
	Webpack	Power User Home	uiStartup	1105	903	1696	284	1329	1696
			load	673	576	1026	153	790	1026
			domContentLoaded	653	566	988	138	770	988
			domInteractive	34	13	118	35	78	118
			firstPaint	320	69	949	260	572	949
			backgroundConnect	64	11	239	74	145	239
			firstReactRender	38	34	42	2	38	42
			getState	145	97	174	24	155	174
			initialActions	1	0	1	0	1	1
			loadScripts	648	564	977	134	760	977
			setupStore	14	6	28	9	25	28
			numNetworkReqs	82	63	133	27	120	133
Firefox	Browserify	Standard Home	uiStartup	1533	1350	2094	132	1557	1852
			load	1287	1162	1578	92	1324	1465
			domContentLoaded	1287	1162	1577	92	1324	1465
			domInteractive	119	36	380	72	114	313
			firstPaint	-	-	-	-	-	-
			backgroundConnect	48	28	220	27	54	106
			firstReactRender	27	22	72	7	27	43
			getState	12	7	49	7	12	29
			initialActions	2	1	3	1	2	3
			loadScripts	1260	1144	1536	85	1296	1438
			setupStore	15	8	89	12	13	40
			numNetworkReqs	12	6	69	15	7	56
	Browserify	Power User Home	uiStartup	3082	2301	4216	603	3653	4216
			load	1472	1254	1921	201	1681	1921
			domContentLoaded	1472	1254	1921	201	1680	1921
			domInteractive	220	54	584	181	482	584
			firstPaint	-	-	-	-	-	-
			backgroundConnect	492	120	1046	329	773	1046
			firstReactRender	84	44	115	18	98	115
			getState	162	99	263	42	186	263
			initialActions	2	1	3	1	2	3
			loadScripts	1418	1194	1751	182	1627	1751
			setupStore	94	34	204	55	144	204
			numNetworkReqs	126	69	231	57	194	231
	Webpack	Standard Home	uiStartup	1658	1435	2246	154	1705	1990
			load	1410	1214	1750	115	1489	1667
			domContentLoaded	1410	1214	1750	115	1488	1667
			domInteractive	98	35	256	38	106	178
			firstPaint	-	-	-	-	-	-
			backgroundConnect	54	26	192	31	55	135
			firstReactRender	31	24	76	6	33	39
			getState	12	8	67	9	12	19
			initialActions	1	0	3	1	2	2
			loadScripts	1378	1195	1721	108	1442	1606
			setupStore	18	7	211	26	12	72
			numNetworkReqs	13	6	68	17	8	65
	Webpack	Power User Home	uiStartup	3307	2471	4632	604	3679	4632
			load	1690	1452	2229	269	1957	2229
			domContentLoaded	1690	1452	2228	269	1957	2228
			domInteractive	333	115	900	268	567	900
			firstPaint	-	-	-	-	-	-
			backgroundConnect	449	108	1006	263	675	1006
			firstReactRender	87	50	130	20	104	130
			getState	193	104	658	128	198	658
			initialActions	3	1	7	1	3	7
			loadScripts	1635	1381	2192	272	1872	2192
			setupStore	149	27	503	128	188	503
			numNetworkReqs	127	76	231	55	191	231

📊 Page Load Benchmark Results

Current Commit: bab9a95 | Date: 11/14/2025

📄 Localhost MetaMask Test Dapp

Samples: 100

Summary

pageLoadTime-> current mean value: 1.05s (±72ms) 🟡 | historical mean value: 1.04s ⬆️ (historical data)
domContentLoaded-> current mean value: 732ms (±69ms) 🟢 | historical mean value: 727ms ⬆️ (historical data)
firstContentfulPaint-> current mean value: 75ms (±12ms) 🟢 | historical mean value: 78ms ⬇️ (historical data)

📈 Detailed Results

Metric	Mean	Std Dev	Min	Max	P95	P99
pageLoadTime	1.05s	72ms	1.00s	1.33s	1.26s	1.33s
domContentLoaded	732ms	69ms	692ms	1.01s	940ms	1.01s
firstPaint	75ms	12ms	56ms	176ms	84ms	176ms
firstContentfulPaint	75ms	12ms	56ms	176ms	84ms	176ms
largestContentfulPaint	0ms	0ms	0ms	0ms	0ms	0ms

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

background: 148 Bytes (0%)
ui: 307 Bytes (0%)
common: 20 Bytes (0%)

fix: add latency for shield requests to transactions and signature me…

fd8b295

…trics events

vinistevam requested review from a team as code owners November 13, 2025 16:48

vinistevam added the team-confirmations Push issues to confirmations team label Nov 13, 2025

vinistevam changed the title ~~fix: enhance metrics for Transaction/Signatures evens (Shield)~~ fix: enhance metrics for Transaction/Signatures events (Shield) Nov 13, 2025

github-actions bot added the size-M label Nov 13, 2025

vinistevam added 2 commits November 14, 2025 08:20

fix lint error

e49c20d

Merge branch 'main' into vs/add-metrics-shield-latency

bab9a95

chaitanyapotti changed the title ~~fix: enhance metrics for Transaction/Signatures events (Shield)~~ fix: enhance metrics for Transaction/Signatures events (Shield) cp-13.10.0 Nov 14, 2025

chaitanyapotti approved these changes Nov 14, 2025

View reviewed changes

vinistevam enabled auto-merge November 14, 2025 09:16

lwin-kyaw approved these changes Nov 14, 2025

View reviewed changes

vinistevam added this pull request to the merge queue Nov 14, 2025

Merged via the queue into main with commit ac3f905 Nov 14, 2025
332 of 334 checks passed

vinistevam deleted the vs/add-metrics-shield-latency branch November 14, 2025 09:54

github-actions bot locked and limited conversation to collaborators Nov 14, 2025

metamaskbot added the release-13.11.0 Issue or pull request that will be included in release 13.11.0 label Nov 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: enhance metrics for Transaction/Signatures events (Shield) cp-13.10.0 #37804

fix: enhance metrics for Transaction/Signatures events (Shield) cp-13.10.0 #37804

vinistevam commented Nov 13, 2025 •

edited by cursor bot

Loading

Uh oh!

github-actions bot commented Nov 13, 2025

Uh oh!

socket-security bot commented Nov 13, 2025 •

edited

Loading

Uh oh!

metamaskbot commented Nov 13, 2025

Uh oh!

metamaskbot commented Nov 13, 2025

📄 Localhost MetaMask Test Dapp

Summary

Uh oh!

metamaskbot commented Nov 14, 2025

📄 Localhost MetaMask Test Dapp

Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

fix: enhance metrics for Transaction/Signatures events (Shield) cp-13.10.0 #37804

fix: enhance metrics for Transaction/Signatures events (Shield) cp-13.10.0 #37804

Conversation

vinistevam commented Nov 13, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changelog

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions bot commented Nov 13, 2025

Uh oh!

socket-security bot commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

metamaskbot commented Nov 13, 2025

✨ Files requiring CODEOWNER review ✨

Uh oh!

metamaskbot commented Nov 13, 2025

📄 Localhost MetaMask Test Dapp

Summary

Uh oh!

metamaskbot commented Nov 14, 2025

📄 Localhost MetaMask Test Dapp

Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vinistevam commented Nov 13, 2025 •

edited by cursor bot

Loading

socket-security bot commented Nov 13, 2025 •

edited

Loading