feat: add EventQueue
class util to guarantee the order of user-storage updates
#5937
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 add a new
EventQueue
shared class util to the@metamask/profile-sync-controller
package.We are using this to ensure user-storage updates are executed and fulfilled in the actual order they were called.
For now, this is used for account syncing when reacting to
AccountsController
accountRenamed
andaccountAdded
events.This addition has been made in reaction to a recent change to extension code that made it so that when a user adds a new account, without changing the default name, both
accountAdded
andaccountRenamed
were fired.This induced race conditions where we weren't in control of which user-storage request would land first.
With this change, we raise back our confidence to 100%.
References
Changelog
Checklist