feat: decouple account sync logic from UserStorageController
#5078
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
mathieuartu
added
the
team-identity
|
@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. |
| const mappedAccount = | ||
| mapInternalAccountToUserStorageAccount(internalAccount); | ||
|
|
||
| await getUserStorageControllerInstance().performSetStorage( |
There was a problem hiding this comment.
(not actionable, just a comment) Oooh... I just realised, that if we have the messenger, then you don't need the controller instance..
const messenger = options.getMessenger();
await messenger.call('UserStorageController:performSetStorage', ..., ....)Hmm need to weigh pros/cons.
Pro:
- 1 less dependency to manage
- We technically don't need the entire controller instance, just methods, which this has.
Cons:
- I think tests (the messenger mock) may need to support this.
There was a problem hiding this comment.
Yeah no need to action this. Can be a future refactor if we want it.
But maybe we can store the instance as a variable so it can be reused (only if we call this alot).
const messenger = options.getMessenger()
const controller - options.getUserStorageControllerInstance();
There was a problem hiding this comment.
This is exactly the type of thing the messenger is intended for! it's also intended to be very easy to mock (much easier than a controller).
Prithpal-Sooriya
approved these changes
Dec 18, 2024
This was referenced Dec 19, 2024
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 moves the logic related to account syncing from
UserStorageControllerto separated files in theaccount-syncingfolder.It also improves test coverage related to account syncing to 100%.
References
Related to #4923
isAccountSyncingInProgressstate key at various places to make it pass CI (as expected)NetworkControllerand itsNetworkController:networkDidChangeevent. This latest version is requested by our controller as part of the upcoming network syncing feature.NetworkControllertov22.1.1(or another incriminated dependency TBD)Changelog
@metamask/profile-sync-controllerisAccountSyncingInProgressstate keyChecklist