fix: confusing error message when using wrong password

[mikesposito]

Explanation

When calling submitPassword with the wrong password, a confusing error is shown instead of Incorrect password. This is due to the recently added metadata length check in #restoreSerializedKeyrings, which doesn't match the correct behavior when isUnlocked = true.

We can move the metadata length check to #unlockKeyrings, so that it will be skipped everytime the controller is locked

References

• Related to [Sentry] Error: KeyringController - keyring metadata length mismatch metamask-extension#31373

Changelog

Changelog updated in the PR

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
• I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

[mikesposito]

@metamaskbot publish-preview

[github-actions]

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/accounts-controller": "27.0.0-preview-a906644",
  "@metamask-previews/address-book-controller": "6.0.3-preview-a906644",
  "@metamask-previews/announcement-controller": "7.0.3-preview-a906644",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-a906644",
  "@metamask-previews/approval-controller": "7.1.3-preview-a906644",
  "@metamask-previews/assets-controllers": "56.0.0-preview-a906644",
  "@metamask-previews/base-controller": "8.0.0-preview-a906644",
  "@metamask-previews/bridge-controller": "13.0.0-preview-a906644",
  "@metamask-previews/bridge-status-controller": "12.0.0-preview-a906644",
  "@metamask-previews/build-utils": "3.0.3-preview-a906644",
  "@metamask-previews/chain-agnostic-permission": "0.3.0-preview-a906644",
  "@metamask-previews/composable-controller": "11.0.0-preview-a906644",
  "@metamask-previews/controller-utils": "11.7.0-preview-a906644",
  "@metamask-previews/earn-controller": "0.11.0-preview-a906644",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-a906644",
  "@metamask-previews/ens-controller": "16.0.0-preview-a906644",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-a906644",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-a906644",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-a906644",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-a906644",
  "@metamask-previews/keyring-controller": "21.0.2-preview-a906644",
  "@metamask-previews/logging-controller": "6.0.4-preview-a906644",
  "@metamask-previews/message-manager": "12.0.1-preview-a906644",
  "@metamask-previews/multichain": "4.0.0-preview-a906644",
  "@metamask-previews/multichain-api-middleware": "0.1.1-preview-a906644",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-a906644",
  "@metamask-previews/multichain-transactions-controller": "0.9.0-preview-a906644",
  "@metamask-previews/name-controller": "8.0.3-preview-a906644",
  "@metamask-previews/network-controller": "23.2.0-preview-a906644",
  "@metamask-previews/notification-services-controller": "5.0.1-preview-a906644",
  "@metamask-previews/permission-controller": "11.0.6-preview-a906644",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-a906644",
  "@metamask-previews/phishing-controller": "12.4.1-preview-a906644",
  "@metamask-previews/polling-controller": "13.0.0-preview-a906644",
  "@metamask-previews/preferences-controller": "17.0.0-preview-a906644",
  "@metamask-previews/profile-sync-controller": "11.0.1-preview-a906644",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-a906644",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-a906644",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-a906644",
  "@metamask-previews/sample-controllers": "0.1.0-preview-a906644",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-a906644",
  "@metamask-previews/signature-controller": "27.1.0-preview-a906644",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-a906644",
  "@metamask-previews/transaction-controller": "54.0.0-preview-a906644",
  "@metamask-previews/user-operation-controller": "33.0.0-preview-a906644"
}

[cryptodev-2s]

LGTM!

[Gudahtt]

LGTM!

[cryptodev-2s]

LGTM!