feat: Resimulate transactions for every 3 seconds on focused MM window #29878

OGPoyraz · 2025-01-23T15:23:20Z

Description

This PR aims to implement re-simulation (updating simulationData on transactionMeta) of transaction type of confirmations on every 3 seconds if notification window is focused.

Core PR that updates simulation data on active transactions: MetaMask/core#5189

Related issues

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

Manual testing steps

See original task description.

Screenshots/Recordings

Resimulation.mov

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.

socket-security · 2025-01-23T15:30:07Z

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

## Explanation  This PR adds `ResimulateHelper`, which focuses on `transactionMeta.isActive` property and re-simulates transaction depending on that value. In order to capsulate re-simulation logic, this PR also relocates other utility functions under the new created `ResimulationHelper.ts` file. ## References  Fixes: MetaMask/MetaMask-planning#3922 Extension PR: MetaMask/metamask-extension#29878 ## Changelog  ### `@metamask/transaction-controller` - **ADDED**: Adds ability of re-simulating transaction depending on the `isActive` property on `transactionMeta` - `isActive` property is expected to set by client. - Re-simulation of transactions will occur every 3 seconds if `isActive` is `true`. - Adds `setTransactionActive` function to update the `isActive` property on `transactionMeta`. ## Checklist - [X] I've updated the test suite for new or updated code as appropriate - [X] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [X] I've highlighted breaking changes using the "BREAKING" category above as appropriate - [X] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes --------- Co-authored-by: Elliot Winkler <[email protected]>

metamaskbot · 2025-03-11T09:19:00Z

Builds ready [cef1628]

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, 8
- 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
- content-script: 0
- offscreen: 0

Page Load Metrics (1900 ± 107 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	260	2570	1805	409	196
		domContentLoaded	1641	2492	1858	210	101
		load	1668	2608	1900	223	107
		domInteractive	27	44	32	5	3
		backgroundConnect	13	128	45	33	16
		firstReactRender	15	74	30	19	9
		getState	6	57	21	18	9
		initialActions	0	0	0	0	0
		loadScripts	1215	1987	1407	179	86
		setupStore	8	65	26	21	10
		uiStartup	1906	3010	2202	293	141

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

background: 52 Bytes (0.00%)
ui: 2.54 KiB (0.03%)
common: 123 Bytes (0.00%)

metamaskbot · 2025-03-18T06:32:47Z

Builds ready [af73098]

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, 8
- 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
- content-script: 0
- offscreen: 0

Page Load Metrics (3125 ± 1431 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	310	15859	2807	3087	1482
		domContentLoaded	1714	15757	2960	2969	1426
		load	1729	15869	3125	2979	1431
		domInteractive	23	672	103	146	70
		backgroundConnect	13	1093	180	244	117
		firstReactRender	16	191	57	43	21
		getState	5	1035	116	228	109
		initialActions	0	1	0	0	0
		loadScripts	1272	13277	2277	2543	1221
		setupStore	8	497	59	105	50
		uiStartup	1937	16046	4124	3517	1689

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

background: 52 Bytes (0.00%)
ui: 2.54 KiB (0.03%)
common: 123 Bytes (0.00%)

digiwand

logic looks good. suggestion to rename some methods and variables to improve readability through more explicit naming

digiwand · 2025-03-20T05:31:14Z

ui/pages/confirmations/hooks/useTransactionFocusEffect.ts

+    type === TransactionType.tokenMethodTransferFrom ||
+    type === TransactionType.tokenMethodSafeTransferFrom
+  );
+};


[suggestion] we could use an O(1) lookup rather than the conditional O(n)

const FOCUSABLE_TYPES: Set<TransactionType> = new Set([ TransactionType.contractInteraction, TransactionType.deployContract, TransactionType.simpleSend, TransactionType.smart, TransactionType.tokenMethodTransfer, TransactionType.tokenMethodTransferFrom, TransactionType.tokenMethodSafeTransferFrom, ]);

then we could update

const shouldBeMarked = shouldSetFocusedForType(type as TransactionType);

to

const shouldBeMarked = FOCUSABLE_TYPES.has(type);

There were initially other logics inside shouldSetFocusedForType but they all removed, Set definitely make sense now, done.

ui/pages/confirmations/hooks/useTransactionFocusEffect.ts

digiwand · 2025-03-20T05:40:26Z

ui/pages/confirmations/hooks/useTransactionFocusEffect.ts

+  const { id, type } = currentConfirmation ?? {};
+  const isWindowFocused = useWindowFocus();
+  const dispatch = useDispatch();
+  const [focusedConfirmation, setFocusedConfirmation] = useState<string | null>(


[suggestion] rename focusedConfirmation → focusedConfirmationId for more context and improved readability

Good call, done

digiwand · 2025-03-20T05:46:43Z

ui/pages/confirmations/hooks/useTransactionFocusEffect.ts

+  );
+
+  useEffect(() => {
+    const shouldBeMarked = shouldSetFocusedForType(type as TransactionType);


[suggestion] maybe renaming shouldBeMarked → isFocusable.

I think "should" in shouldBeMarked implies that it will be set. However, the state is only conditionally set. The reason I suggested removing "Marked" is to avoid introducing synonyms. There is room for interpretation using Marked. We can be more explicit by choosing e.g. isFocusable, canSetFocus, canSetTransactionFocus

metamaskbot · 2025-03-20T07:22:41Z

Builds ready [66dda95]

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, 8
- 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
- content-script: 0
- offscreen: 0

Page Load Metrics (3289 ± 1145 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	357	13262	2896	2556	1227
		domContentLoaded	1464	13123	2824	2459	1181
		load	1537	13173	3289	2384	1145
		domInteractive	26	883	105	186	89
		backgroundConnect	65	1018	448	318	153
		firstReactRender	28	326	96	69	33
		getState	13	685	223	199	96
		initialActions	0	0	0	0	0
		loadScripts	1053	12689	2197	2471	1187
		setupStore	12	365	122	117	56
		uiStartup	1713	13419	5663	3213	1543

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

background: 52 Bytes (0.00%)
ui: 2.52 KiB (0.03%)
common: 123 Bytes (0.00%)

digiwand

Lgtm!

metamaskbot added the team-confirmations Push issues to confirmations team label Jan 23, 2025

OGPoyraz marked this pull request as ready for review January 24, 2025 12:24

OGPoyraz requested a review from a team as a code owner January 24, 2025 12:24

OGPoyraz mentioned this pull request Jan 24, 2025

feat: Re-simulate active transactions every 3000 ms MetaMask/core#5189

Merged

4 tasks

OGPoyraz force-pushed the 3922-re-simulate-transactions-for-every-new-block branch from 4642c4d to ef97961 Compare March 11, 2025 07:29

OGPoyraz changed the title ~~feat: Resimulate transactions for every new block~~ feat: Resimulate transactions for every 3 seconds on focused MM window Mar 11, 2025

pedronfigueiredo previously approved these changes Mar 14, 2025

View reviewed changes

OGPoyraz dismissed pedronfigueiredo’s stale review via ddcad08 March 17, 2025 10:58

OGPoyraz force-pushed the 3922-re-simulate-transactions-for-every-new-block branch from cef1628 to ddcad08 Compare March 17, 2025 10:58

pedronfigueiredo previously approved these changes Mar 19, 2025

View reviewed changes

digiwand requested changes Mar 20, 2025

View reviewed changes

OGPoyraz dismissed pedronfigueiredo’s stale review via 2dd406e March 20, 2025 06:42

OGPoyraz force-pushed the 3922-re-simulate-transactions-for-every-new-block branch from af73098 to 2dd406e Compare March 20, 2025 06:42

OGPoyraz added 13 commits March 20, 2025 07:43

Resimulate transactions on focused transaction confirmations

bb98a97

Add unit tests

dc5aa43

Update latest preview

4801780

Update preview version

19bda8d

Resimulate changes

b617b91

yarn lock update

b5a4f6e

Fix action name

3a08bff

Update action

ca6303a

Fix lint

4881420

Use default current confirmation

27f83fc

Alphabetical deps

21c123c

Remove unnecessary new line and import order

e4eddaa

yarn lock sync

c08653d

Update suggestions

66dda95

OGPoyraz force-pushed the 3922-re-simulate-transactions-for-every-new-block branch from 2dd406e to 66dda95 Compare March 20, 2025 06:44

OGPoyraz requested review from digiwand and pedronfigueiredo March 20, 2025 07:22

digiwand approved these changes Mar 20, 2025

View reviewed changes

pedronfigueiredo approved these changes Mar 20, 2025

View reviewed changes

OGPoyraz added this pull request to the merge queue Mar 20, 2025

Merged via the queue into main with commit 87946e4 Mar 20, 2025
76 checks passed

OGPoyraz deleted the 3922-re-simulate-transactions-for-every-new-block branch March 20, 2025 09:32

github-actions bot locked and limited conversation to collaborators Mar 20, 2025

metamaskbot added the release-12.16.0 Issue or pull request that will be included in release 12.16.0 label Mar 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Resimulate transactions for every 3 seconds on focused MM window #29878

feat: Resimulate transactions for every 3 seconds on focused MM window #29878

OGPoyraz commented Jan 23, 2025 •

edited

Loading

socket-security bot commented Jan 23, 2025 •

edited

Loading

metamaskbot commented Mar 11, 2025

metamaskbot commented Mar 18, 2025

digiwand left a comment

digiwand Mar 20, 2025

OGPoyraz Mar 20, 2025

digiwand Mar 20, 2025

OGPoyraz Mar 20, 2025

digiwand Mar 20, 2025

OGPoyraz Mar 20, 2025

metamaskbot commented Mar 20, 2025

digiwand left a comment

feat: Resimulate transactions for every 3 seconds on focused MM window #29878

feat: Resimulate transactions for every 3 seconds on focused MM window #29878

Conversation

OGPoyraz commented Jan 23, 2025 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

socket-security bot commented Jan 23, 2025 • edited Loading

metamaskbot commented Mar 11, 2025

metamaskbot commented Mar 18, 2025

digiwand left a comment

Choose a reason for hiding this comment

digiwand Mar 20, 2025

Choose a reason for hiding this comment

OGPoyraz Mar 20, 2025

Choose a reason for hiding this comment

digiwand Mar 20, 2025

Choose a reason for hiding this comment

OGPoyraz Mar 20, 2025

Choose a reason for hiding this comment

digiwand Mar 20, 2025

Choose a reason for hiding this comment

OGPoyraz Mar 20, 2025

Choose a reason for hiding this comment

metamaskbot commented Mar 20, 2025

digiwand left a comment

Choose a reason for hiding this comment

OGPoyraz commented Jan 23, 2025 •

edited

Loading

socket-security bot commented Jan 23, 2025 •

edited

Loading