fix(accounts-controller): re-use current internal state in updateAccounts
#5161
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. |
danroc
reviewed
Jan 16, 2025
danroc
reviewed
Jan 16, 2025
danroc
reviewed
Jan 16, 2025
danroc
reviewed
Jan 16, 2025
ccharly
changed the title
updateAccounts state update
danroc
reviewed
Jan 16, 2025
ccharly
changed the title
updateAccounts state updateupdateAccounts
danroc
reviewed
Jan 16, 2025
Co-authored-by: Daniel Rocha <[email protected]>
ccharly
force-pushed
the
fix/do-not-overwrite-internal-accounts-from-state
branch
from
49b28e1 to
d2b96e9
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. |
ccharly
force-pushed
the
fix/do-not-overwrite-internal-accounts-from-state
branch
from
d2b96e9 to
5b0a5fe
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. |
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
The
AccountsControllersometimes re-build its state by querying all accounts from every keyrings. This makes sure it's in-sync with theKeyringController's state (mirroring).However, the way this was done was preventing clients from doing migrations to the
AccountsController's state (mainly on the fields owned by him, like theInternalAccount's fields).The previous logic was re-creating all internal accounts with a new copy of all "keyring accounts", thus overriding changes done to the
state.AccountsController.internalAccountsobject.This issue was found while adding the new required
scopesfield with a migration, see:scopesfield toKeyringAccountmetamask-extension#29195Detailed explanations (for the extension):
scopesto each accounts (see here)updateAccountsto re-create the internal stateupdateAccountsfetches accounts from each keyrings:scopessince we were using the previous Snap keyring state (the migration only affects theAccountsControllerstate) which did not have thescopesfield, noscopeswas added when re-creating the internal state here.This logic was overwriting the migration state update, resulting in a non-consistent state where we had
scopesfor all "normal" accounts, but anundefinedscopesfor ALL Snap accounts.The fix
To prevent this from happening, we are now re-using the current internal state if the account already exists, thus, keeping its current "representation" (in our case, this representation got migrated and now has a new
scopesfor all existing accounts).However, if the account does not exist on the current internal state, we are then just adding it to the state "as-is".
References
scopesfield toKeyringAccountmetamask-extension#29195Changelog
@metamask/accounts-controllerupdateAccountsChecklist