feat: Re-simulate focused transactions every 3000 ms #5189
+356
−26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
jpuri
previously approved these changes
Jan 24, 2025
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
OGPoyraz
force-pushed
the
3922-re-simulate-transactions-for-every-new-block
branch
from
f159aea to
ea69888
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
OGPoyraz
changed the title
mcmire
reviewed
Jan 29, 2025
packages/transaction-controller/src/helpers/ResimulateHelper.ts
Outdated
Show resolved
Hide resolved
packages/transaction-controller/src/TransactionController.test.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Elliot Winkler <[email protected]>
Co-authored-by: Elliot Winkler <[email protected]>
Co-authored-by: Elliot Winkler <[email protected]>
matthewwalsh0
requested changes
Jan 30, 2025
| /** | ||
| * Whether the transaction confirmation window is focused. | ||
| */ | ||
| isFocused?: boolean; |
There was a problem hiding this comment.
Would it be more helpful to call this isActive?
As the UI can own what this means, currently focused and visible but those requirements may change in future?
| onStateChange: (listener) => { | ||
| this.messagingSystem.subscribe( | ||
| 'TransactionController:stateChange', | ||
| listener, |
There was a problem hiding this comment.
Can we use a selector to limit the events to when the transactions change?
| export type ResimulateHelperOptions = { | ||
| getTransactions: () => TransactionMeta[]; | ||
| onStateChange: (listener: () => void) => void; | ||
| updateSimulationData: (transactionMeta: TransactionMeta) => Promise<void>; |
There was a problem hiding this comment.
Would it be more explicit to call this simulateTransaction as it actually performs the simulation, not just updates state?
| this.#getTransactions = getTransactions; | ||
| this.#updateSimulationData = updateSimulationData; | ||
|
|
||
| onStateChange(() => { |
There was a problem hiding this comment.
Minor, would it be cleaner for this callback to go in a private function rather than within the constructor?
| ); | ||
|
|
||
| // Start or stop resimulation based on the current isFocused state | ||
| unapprovedTransactions.forEach((transactionMeta) => { |
There was a problem hiding this comment.
Minor, would it be cleaner to have a #getActiveUnapprovedTransactions(active: boolean)?
|
|
||
| export class ResimulateHelper { | ||
| // Map of transactionId <=> isActive | ||
| readonly #activeResimulations: Map<string, boolean> = new Map(); |
There was a problem hiding this comment.
Do we need this property at all?
Can we not infer the active transaction IDs from the keys of #intervalIds?
| } | ||
|
|
||
| this.#removeListener(transactionId); | ||
| log(`Stopped resimulating transaction ${transactionId} every 3 seconds`); |
There was a problem hiding this comment.
Minor, should we avoid hardcoding the duration here so it's dynamic based on the constant?
| @@ -926,6 +930,17 @@ export class TransactionController extends BaseController< | |||
| this.#checkForPendingTransactionAndStartPolling, | |||
| ); | |||
|
|
|||
| new ResimulateHelper({ | |||
| updateSimulationData: this.#updateSimulationData.bind(this), | |||
| onStateChange: (listener) => { | |||
There was a problem hiding this comment.
Should we call this onTransactionsUpdate for accuracy if we use a selector?
| * @param transactionId - The ID of the transaction to update. | ||
| * @param isFocused - The new focus state. | ||
| */ | ||
| updateTransactionFocus(transactionId: string, isFocused: boolean) { |
There was a problem hiding this comment.
setTransactionActive as per my other comment about decoupling?
| isFocused, | ||
| }; | ||
|
|
||
| this.updateTransaction( |
There was a problem hiding this comment.
We want to exclusively use #updateTransactionInternal going forward as it uses callbacks to update meaning there is no risk of race conditions from multiple updates.
It would also mean we don't need to query the existing state in this method.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This PR adds
ResimulateHelper, which focuses ontransactionMeta.isFocusedproperty 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.tsfile.References
Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3922
Extension PR: MetaMask/metamask-extension#29878
Changelog
@metamask/transaction-controllerisFocusedproperty ontransactionMetaisFocusedproperty is expected to set by client.isFocusedistrue.updateTransactionFocusfunction to update theisFocusedproperty ontransactionMeta.Checklist