feat: Add simulation metrics to "Transaction Submitted" and "Transaction Finalized" events #28240

digiwand · 2024-11-01T13:08:52Z

Description

This PR adds simulation metrics to the Transaction Submitted and Transaction Finalized events.

Please refer to Solution B) below for details.

The challenge here is that there are two separate transaction fragment buckets: transaction-added-<id> and transaction-submitted-<id>.
transaction-added-<id> fragments are associated with the events:

Transaction Added
Transaction Approved
Transaction Rejected

transaction-submitted-<id> fragments are associated with the events:

Transaction Submitted
Transaction Finalized

Simulation metrics were added to "Transaction Approved" and "Transaction Rejected" events using updateEventFragment. When they were added here through the useTransactionEventFragment hook, the transaction-submitted-<id> fragment had not yet been created. The transaction-submitted-<id> fragment is created after a user clicks the Confirm button on a transaction which invokes metrics#handleTransactionSubmitted and calls createTransactionEventFragment

To solve this, I proposed two solutions (TLDR; went with Solution B):

Solution A)

Create a single transaction fragment ID to handle all related transaction events. Here, the fragment would specify the props:

initialEvent: "Transaction Added"
successEvent:"Transaction Finalized"
failureEvent: "Transaction Rejected"

Add new method to MetaMetricsController to call trackEvent with specified eventName utilizing fragment props. This would support calling "Transaction Approved" and "Transaction Submitted" ad-hoc style.

Solution B)

Allow a premature fragment to exist for transaction-submitted-<id> fragment. Prior to this PR fragments only exist once they are created.
From useTransactionEventFragment hook
- Adds a premature transaction-submitted-<id> fragment
- Calls "updateEventFragment(transaction-submitted-${transactionId}, params)" to store simulation metric props
When handleTransactionSubmitted event is invoked, creating the fragment now merges the premature fragment with the newly created fragment
When a premature fragment is found as an abandoned fragment, we delete it from the store

Solution C)

store unlinked props in new store state: fragmentsUnlinkedProps on updateEventFragment
fragmentsUnlinkedProps can be applied to newly created fragments on createEventFragment
deleted abandoned fragmentsUnlinkedProps would need more investigation

I went with solution B due to time constraints.

Related issues

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

Manual testing steps

Turn on "Participate in MetaMetrics" setting
Confirm or Reject a Send transaction
Observe simulation props are added to Transaction Submitted and Transaction Finalized events

Screenshots/Recordings

no UI/UX changes

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.

…nt is created

…nd-finalized

github-actions · 2024-11-01T13:09:06Z

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.

digiwand · 2024-11-01T13:13:24Z

app/scripts/lib/transaction/metrics.ts

    case TransactionMetaMetricsEvent.finalized:
      transactionMetricsRequest.updateEventFragment(uniqueId, {
        properties: payload.properties,
        sensitiveProperties: payload.sensitiveProperties,
      });
      break;
+


minor cleanup since they were calling the same logic

app/scripts/controllers/metametrics.ts

metamaskbot · 2024-11-02T04:01:49Z

Builds ready [54d3cb3]

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 (1763 ± 53 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	338	2011	1687	329	158
		domContentLoaded	1584	1940	1733	105	51
		load	1594	2013	1763	111	53
		domInteractive	17	231	63	58	28
		backgroundConnect	9	74	29	21	10
		firstReactRender	47	298	96	51	24
		getState	5	54	15	14	7
		initialActions	0	1	0	0	0
		loadScripts	1084	1411	1256	96	46
		setupStore	10	94	30	25	12
		uiStartup	1747	2557	1972	179	86

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

background: 513 Bytes (0.01%)
ui: 58 Bytes (0.00%)
common: 0 Bytes (0.00%)

metamaskbot · 2024-11-04T06:35:34Z

Builds ready [b279b9c]

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 (1841 ± 103 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1601	2581	1846	211	101
		domContentLoaded	1583	2554	1820	211	101
		load	1594	2577	1841	214	103
		domInteractive	17	165	59	36	17
		backgroundConnect	9	105	25	23	11
		firstReactRender	47	286	93	51	24
		getState	5	49	12	12	6
		initialActions	0	1	0	0	0
		loadScripts	1122	1886	1332	156	75
		setupStore	11	72	35	27	13
		uiStartup	1795	2711	2053	219	105

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

background: 503 Bytes (0.01%)
ui: 58 Bytes (0.00%)
common: 0 Bytes (0.00%)

metamaskbot · 2024-11-04T11:07:32Z

Builds ready [0f4c0d9]

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 (1982 ± 106 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	375	2614	1885	404	194
		domContentLoaded	1647	2606	1950	217	104
		load	1655	2614	1982	221	106
		domInteractive	30	126	55	23	11
		backgroundConnect	9	71	29	20	10
		firstReactRender	49	148	98	25	12
		getState	5	56	13	14	7
		initialActions	0	1	0	0	0
		loadScripts	1240	2050	1467	185	89
		setupStore	11	74	30	24	11
		uiStartup	1846	2847	2191	239	115

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

background: 502 Bytes (0.01%)
ui: 58 Bytes (0.00%)
common: 0 Bytes (0.00%)

…nd-finalized

…y spec

metamaskbot · 2024-11-05T10:07:28Z

Builds ready [671cadd]

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 (1936 ± 90 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	266	2401	1768	522	250
		domContentLoaded	1686	2325	1902	186	89
		load	1695	2401	1936	188	90
		domInteractive	19	197	53	36	17
		backgroundConnect	9	79	34	22	11
		firstReactRender	51	129	96	25	12
		getState	5	64	16	18	9
		initialActions	0	1	0	0	0
		loadScripts	1215	1732	1406	150	72
		setupStore	11	66	33	22	10
		uiStartup	1885	2587	2151	212	102

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

background: 502 Bytes (0.01%)
ui: 58 Bytes (0.00%)
common: 0 Bytes (0.00%)

…d" case

…nd-finalized

matthewwalsh0

Great fix, though eager for us to come back to this soon to reduce coupling.

digiwand · 2024-11-05T17:04:09Z

Thanks for the reviews and can do @matthewwalsh0!

dedupe related comment: #28240 (comment)

metamaskbot · 2024-11-05T17:17:36Z

Builds ready [9bebfe6]

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 (2012 ± 70 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	404	2271	1943	379	182
		domContentLoaded	1686	2212	1971	132	63
		load	1690	2267	2012	147	70
		domInteractive	19	290	55	57	27
		backgroundConnect	7	99	41	29	14
		firstReactRender	61	302	120	55	27
		getState	4	62	19	17	8
		initialActions	0	1	0	0	0
		loadScripts	1230	1608	1458	127	61
		setupStore	10	96	43	29	14
		uiStartup	1924	2725	2298	179	86

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

background: 502 Bytes (0.01%)
ui: 58 Bytes (0.00%)
common: 0 Bytes (0.00%)

digiwand added 3 commits October 30, 2024 21:44

refactor: transaction/metrics condense switch cases

19f43c0

feat: utilize updateEventFragment before submitted tx metametrics eve…

b4d0ca7

…nt is created

Merge branch 'develop' into add-tx-simulation-metrics-for-submitted-a…

a39fc4a

…nd-finalized

digiwand requested review from a team as code owners November 1, 2024 13:08

github-actions bot added the team-confirmations Push issues to confirmations team label Nov 1, 2024

digiwand commented Nov 1, 2024

View reviewed changes

matthewwalsh0 requested changes Nov 1, 2024

View reviewed changes

digiwand added 3 commits November 2, 2024 10:22

fix: deleteEventFragment conditional

a72f8e1

chore: rn canThrowAwayIfAbandoned -> canDeleteIfAbandoned

25d78c7

refactor: MetaMetricsController createIfNotFound tx submitted

54d3cb3

refactor: add MetaMetricsController#processAbandonedFragment

b279b9c

refactor: MetaMetricsController#createEventFragment additional props

0f4c0d9

digiwand added 4 commits November 4, 2024 19:03

Merge branch 'develop' into add-tx-simulation-metrics-for-submitted-a…

37f9db1

…nd-finalized

fix: MetaMetricsController#createFragmentId additional props conditional

0ec41f8

test: add MetaMetricsController#createEventFragment test

edfa676

test: MetaMetricsController#create track initialEvent and remove .onl…

671cadd

…y spec

digiwand added 3 commits November 5, 2024 17:29

fix: MetaMetricsController#createEventFragment merge order

a8f6728

test: MetaMetricsController#createEventFragment "Transaction Submitte…

8b6d0dc

…d" case

test: add MetaMetricsControllers#updateEventFragments

01e55a9

digiwand requested a review from matthewwalsh0 November 5, 2024 10:53

Merge branch 'develop' into add-tx-simulation-metrics-for-submitted-a…

9bebfe6

…nd-finalized

OGPoyraz approved these changes Nov 5, 2024

View reviewed changes

matthewwalsh0 approved these changes Nov 5, 2024

View reviewed changes

digiwand added this pull request to the merge queue Nov 5, 2024

Merged via the queue into develop with commit 82c1910 Nov 5, 2024
76 checks passed

digiwand deleted the add-tx-simulation-metrics-for-submitted-and-finalized branch November 5, 2024 17:29

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add simulation metrics to "Transaction Submitted" and "Transaction Finalized" events #28240

feat: Add simulation metrics to "Transaction Submitted" and "Transaction Finalized" events #28240

digiwand commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024

digiwand Nov 1, 2024

metamaskbot commented Nov 2, 2024

metamaskbot commented Nov 4, 2024

metamaskbot commented Nov 4, 2024

metamaskbot commented Nov 5, 2024

matthewwalsh0 left a comment

digiwand commented Nov 5, 2024

metamaskbot commented Nov 5, 2024

feat: Add simulation metrics to "Transaction Submitted" and "Transaction Finalized" events #28240

feat: Add simulation metrics to "Transaction Submitted" and "Transaction Finalized" events #28240

Conversation

digiwand commented Nov 1, 2024 • edited Loading

Description

Solution A)

Solution B)

Solution C)

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Nov 1, 2024

digiwand Nov 1, 2024

Choose a reason for hiding this comment

metamaskbot commented Nov 2, 2024

metamaskbot commented Nov 4, 2024

metamaskbot commented Nov 4, 2024

metamaskbot commented Nov 5, 2024

matthewwalsh0 left a comment

Choose a reason for hiding this comment

digiwand commented Nov 5, 2024

metamaskbot commented Nov 5, 2024

digiwand commented Nov 1, 2024 •

edited

Loading