chore: emit cross-chain swaps metrics + validation error logic #28713

micaelae · 2024-11-26T04:10:27Z

Description

Changes include

Input/quote validation logic for isInsufficientBalance, isInsufficientGasBalance and isEstimatedReturnLow(no ui yet but these get included in metrics)
Type-safe event emitter for cross-chain swaps
Refactored token exchange rate fetching process so that values can be reused for metrics without additional network calls
Adding new events described in https://docs.google.com/document/d/1hAoqEzlSnPDMfmiYBf8FNykYZ_LLbmZjKyTtjPmeEbs/edit?tab=t.0
Note that these events that haven't been added bc they depend on tx status changes
- ActionFailed
- ActionCompleted

Related issues

Depends on this segment-schema PR

Fixes: https://consensyssoftware.atlassian.net/browse/MMS-1453

Manual testing steps

Open background inspector and filter requests including "batch"
Perform an e2e transaction
Verify that expected events are published

Screenshots/Recordings

Before

After

N/A

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-11-30T00:31:00Z

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.

metamaskbot · 2024-12-02T19:22:32Z

Builds ready [fc76208]

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

Page Load Metrics (1872 ± 78 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1688	2241	1890	156	75
		domContentLoaded	1621	2208	1854	158	76
		load	1632	2242	1872	162	78
		domInteractive	25	85	40	16	8
		backgroundConnect	8	44	17	9	4
		firstReactRender	15	62	22	12	6
		getState	26	90	66	20	10
		initialActions	0	1	0	0	0
		loadScripts	1213	1698	1410	127	61
		setupStore	6	56	12	14	7
		uiStartup	1839	2523	2143	184	88

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

background: -110 Bytes (-0.00%)
ui: 62.12 KiB (0.80%)
common: 3.95 KiB (0.05%)

ui/ducks/bridge/selectors.ts

ui/ducks/bridge/utils.ts

infiniteflower · 2024-12-02T23:04:43Z

Loving the many small hooks!

metamaskbot · 2024-12-03T01:09:06Z

Builds ready [8efc675]

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

Page Load Metrics (1957 ± 62 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1810	2278	1954	128	62
		domContentLoaded	1789	2212	1921	109	52
		load	1810	2283	1957	130	62
		domInteractive	25	75	38	13	6
		backgroundConnect	8	204	36	44	21
		firstReactRender	15	96	28	23	11
		getState	79	313	156	57	27
		initialActions	0	1	0	0	0
		loadScripts	1373	1800	1482	96	46
		setupStore	7	83	20	25	12
		uiStartup	2051	3101	2357	260	125

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

background: -110 Bytes (-0.00%)
ui: 62.52 KiB (0.80%)
common: 4.02 KiB (0.05%)

metamaskbot · 2024-12-03T18:24:57Z

Builds ready [1af674b]

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

Page Load Metrics (2108 ± 95 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1763	2475	2114	203	98
		domContentLoaded	1753	2391	2070	182	87
		load	1765	2480	2108	197	95
		domInteractive	26	67	40	12	6
		backgroundConnect	12	96	42	29	14
		firstReactRender	15	42	23	7	3
		getState	92	155	133	17	8
		initialActions	0	1	0	0	0
		loadScripts	1297	1894	1589	164	79
		setupStore	6	22	10	3	2
		uiStartup	2033	2915	2434	243	117

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

background: 957 Bytes (0.02%)
ui: 26.34 KiB (0.34%)
common: 1.41 KiB (0.02%)

The base branch was changed.

metamaskbot · 2024-12-06T03:24:03Z

Builds ready [562fcff]

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

Page Load Metrics (2086 ± 79 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1789	2520	2086	157	75
		domContentLoaded	1726	2478	2051	164	79
		load	1738	2542	2086	165	79
		domInteractive	25	51	35	7	4
		backgroundConnect	8	83	35	25	12
		firstReactRender	16	41	20	5	3
		getState	84	160	126	22	10
		initialActions	0	1	0	0	0
		loadScripts	1324	1797	1573	121	58
		setupStore	7	23	9	4	2
		uiStartup	2018	2772	2395	176	84

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

background: 436 Bytes (0.01%)
ui: 25.17 KiB (0.32%)
common: 1.21 KiB (0.01%)

metamaskbot · 2024-12-10T21:47:51Z

Builds ready [b80879e]

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

Page Load Metrics (1918 ± 85 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1665	2368	1926	186	90
		domContentLoaded	1607	2226	1895	177	85
		load	1665	2238	1918	176	85
		domInteractive	24	87	44	19	9
		backgroundConnect	9	82	26	20	10
		firstReactRender	15	110	35	30	15
		getState	72	366	159	80	38
		initialActions	0	1	0	0	0
		loadScripts	1250	1749	1477	139	67
		setupStore	6	66	12	13	6
		uiStartup	1894	3158	2319	364	175

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

background: 436 Bytes (0.01%)
ui: 25.2 KiB (0.32%)
common: 1.24 KiB (0.02%)

metamaskbot added the team-bridge label Nov 26, 2024

micaelae force-pushed the mms1453-bridge-metrics branch from a83e4d8 to 857539e Compare November 26, 2024 18:47

micaelae changed the title ~~chore: emit cross-chain swaps metrics for pre-confirmation events~~ chore: emit cross-chain swaps metrics + validation error logic Nov 26, 2024

micaelae force-pushed the mms1453-bridge-metrics branch 7 times, most recently from 064e1ab to 064329a Compare November 30, 2024 00:30

micaelae force-pushed the mms1453-bridge-metrics branch from 064329a to 36f6789 Compare November 30, 2024 00:33

micaelae changed the base branch from develop to mb1571-cross-chain-swap-stx November 30, 2024 00:33

micaelae force-pushed the mms1453-bridge-metrics branch from 36f6789 to a9085b0 Compare December 2, 2024 18:29

micaelae marked this pull request as ready for review December 2, 2024 19:22

micaelae requested a review from a team as a code owner December 2, 2024 19:22

micaelae requested a review from a team December 2, 2024 19:23

infiniteflower reviewed Dec 2, 2024

View reviewed changes

infiniteflower force-pushed the mb1571-cross-chain-swap-stx branch from f33d3f0 to 86e1202 Compare December 2, 2024 23:14

infiniteflower requested a review from a team as a code owner December 2, 2024 23:14

micaelae force-pushed the mms1453-bridge-metrics branch from 8efc675 to 1af674b Compare December 3, 2024 16:44

infiniteflower previously approved these changes Dec 3, 2024

View reviewed changes

Base automatically changed from mb1571-cross-chain-swap-stx to main December 5, 2024 16:50

micaelae force-pushed the mms1453-bridge-metrics branch from 1af674b to 562fcff Compare December 6, 2024 02:41

micaelae added 20 commits December 10, 2024 13:09

chore: emit QuoteSelected event

4b4ce2a

chore: emit QuotesReceived event

99c79c8

refactor: move useQuoteFetchEvents hook

5c89f70

refactor: rename balanceAmount

6fb2fb1

fix: selector unit tests (refactor)

248ee32

fix: bridge page unit tests

04df7c4

fix: lint error

abbcee9

fix: sentry e2e test

f854d27

fix: default test sort order

dbb94d9

fix: unit tests

7246c3b

refactor: rename conversion rate selectors

7832a64

chore: add comment

1f9f1b7

fix: use toString for readability

946aa59

refactor: rename exchange rates in selector

0d75389

chore: add comments for exchangeRate utils

d731910

refactor: rename fiat -> valueInCurrency

8a74dcc

refactor: rename Fiat -> Currency

375b3e2

chore: add cross-chain swaps page to route constants

edef303

chore: rename duplicate events

83860d3

fix: unit tests

b80879e

micaelae force-pushed the mms1453-bridge-metrics branch from b717695 to b80879e Compare December 10, 2024 21:10

infiniteflower approved these changes Dec 10, 2024

View reviewed changes

ejwessel approved these changes Dec 10, 2024

View reviewed changes

micaelae added this pull request to the merge queue Dec 10, 2024

Merged via the queue into main with commit 653177a Dec 10, 2024
75 checks passed

micaelae deleted the mms1453-bridge-metrics branch December 10, 2024 22:08

github-actions bot locked and limited conversation to collaborators Dec 10, 2024

metamaskbot added the release-12.10.1 Issue or pull request that will be included in release 12.10.1 label Dec 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: emit cross-chain swaps metrics + validation error logic #28713

chore: emit cross-chain swaps metrics + validation error logic #28713

micaelae commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 30, 2024

metamaskbot commented Dec 2, 2024

infiniteflower commented Dec 2, 2024

metamaskbot commented Dec 3, 2024

metamaskbot commented Dec 3, 2024

metamaskbot commented Dec 6, 2024

metamaskbot commented Dec 10, 2024

chore: emit cross-chain swaps metrics + validation error logic #28713

chore: emit cross-chain swaps metrics + validation error logic #28713

Conversation

micaelae commented Nov 26, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Nov 30, 2024

metamaskbot commented Dec 2, 2024

infiniteflower commented Dec 2, 2024

metamaskbot commented Dec 3, 2024

metamaskbot commented Dec 3, 2024

metamaskbot commented Dec 6, 2024

metamaskbot commented Dec 10, 2024

micaelae commented Nov 26, 2024 •

edited

Loading