chore: Accounts/PreferencesController state syncing #9564
+337
−45
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
|
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. |
owencraston
force-pushed
the
accounts-and-preferences-state-sync
branch
2 times, most recently
from
855f642
to
fc37b9f
Compare
7 tasks
owencraston
force-pushed
the
accounts-and-preferences-state-sync
branch
from
daa0d74
to
dd5a939
Compare
owencraston
commented
May 20, 2024
owencraston
force-pushed
the
accounts-and-preferences-state-sync
branch
from
dd5a939
to
b95cef4
Compare
gantunesr
reviewed
May 21, 2024
| } from '@metamask/preferences-controller'; | ||
|
|
||
| export function syncSelectedAddress( | ||
| preferencesState: PreferencesState, |
There was a problem hiding this comment.
How about just passing the selectedAddress here? Since you don't really need the entire state of the PreferencesController
Comment on lines
+1376
to
+1386
| this.controllerMessenger.subscribe( | ||
| 'PreferencesController:stateChange', | ||
| (preferencesState: PreferencesState) => { | ||
| syncSelectedAddress( | ||
| preferencesState, | ||
| () => accountsController, | ||
| () => preferencesController, | ||
| ); | ||
| syncAccountName(preferencesState, () => accountsController); | ||
| }, | ||
| ); |
There was a problem hiding this comment.
Should we also have a subscription to the other direction too?
| } | ||
|
|
||
| export function syncAccountName( | ||
| preferencesState: PreferencesState, |
There was a problem hiding this comment.
Similarly here since we're just using identities
| const preferencesController = getPreferencesController(); | ||
| const selectedAddressFromPreferences = preferencesState.selectedAddress; | ||
| const { selectedAccount: currentAccountId, accounts: internalAccounts } = | ||
| accountsController.state.internalAccounts; |
There was a problem hiding this comment.
is there a way to get internalAccounts without accessing the state directly?
Comment on lines
+45
to
+47
| for (const accountId in accountsController.state.internalAccounts.accounts) { | ||
| const account = | ||
| accountsController.state.internalAccounts.accounts[accountId]; |
There was a problem hiding this comment.
Similar comment here about getting internalAccounts without the need to access the state
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.
Description
The methods
Engine.setAccountLabelandEngine.setSelectedAddresswere added in in these two ( one and two) Prs. These mehtods are used to keep the shared state between the AccountsController and PreferenfesController in sync. However is not a good method since it is prone to error and requires a lot of context. This pr removes these methods in favour of automated state sync listeners.Listen for state change on the PreferencesController and automatically update the relevant state inside the accounts controller.
These listeners will ensure that the selected address and the account names stay in sync.
Related issues
Fixes: https://github.com/MetaMask/accounts-planning/issues/445
Manual testing steps
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist