Skip to content

refactor: migrate PreferencesController to @metamask/messenger #6534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 27, 2025
Merged

refactor: migrate PreferencesController to @metamask/messenger #6534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9e1042e
refactor: migrate PreferencesController to @metamask/messenger
cryptodev-2s Oct 7, 2025
1b628c6
Merge remote-tracking branch 'origin/main' into cryptodev-2s/messenge…
cryptodev-2s Oct 15, 2025
b8ce382
Merge branch 'main' into cryptodev-2s/messenger/preferences-controller
mikesposito Oct 20, 2025
bd26075
fix changelog
mikesposito Oct 20, 2025
5130444
Merge branch 'main' into cryptodev-2s/messenger/preferences-controller
mikesposito Oct 24, 2025
b579a27
Merge branch 'main' into cryptodev-2s/messenger/preferences-controller
cryptodev-2s Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ linkStyle default opacity:0.5
earn_controller --> transaction_controller;
eip_5792_middleware --> transaction_controller;
eip_5792_middleware --> keyring_controller;
eip_7702_internal_rpc_middleware --> controller_utils;
eip1193_permission_middleware --> chain_agnostic_permission;
eip1193_permission_middleware --> controller_utils;
eip1193_permission_middleware --> json_rpc_engine;
Expand Down Expand Up @@ -293,6 +294,7 @@ linkStyle default opacity:0.5
polling_controller --> network_controller;
preferences_controller --> base_controller;
preferences_controller --> controller_utils;
preferences_controller --> messenger;
preferences_controller --> keyring_controller;
profile_sync_controller --> base_controller;
profile_sync_controller --> address_book_controller;
Expand Down
6 changes: 6 additions & 0 deletions packages/preferences-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6534](https://github.com/MetaMask/core/pull/6534))
- Previously, `PreferencesController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#6534](https://github.com/MetaMask/core/pull/6534))

## [20.1.1]

### Changed
Expand Down
3 changes: 2 additions & 1 deletion packages/preferences-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
},
"dependencies": {
"@metamask/base-controller": "^8.4.2",
"@metamask/controller-utils": "^11.14.1"
"@metamask/controller-utils": "^11.14.1",
"@metamask/messenger": "^0.3.0"
},
"devDependencies": {
"@metamask/auto-changelog": "^3.4.4",
Expand Down
84 changes: 48 additions & 36 deletions packages/preferences-controller/src/PreferencesController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
import { deriveStateFromMetadata } from '@metamask/base-controller/next';
import { getDefaultKeyringState } from '@metamask/keyring-controller';
import {
Messenger,
MOCK_ANY_NAMESPACE,
type MessengerActions,
type MessengerEvents,
type MockAnyNamespace,
} from '@metamask/messenger';
import { cloneDeep } from 'lodash';

import { ETHERSCAN_SUPPORTED_CHAIN_IDS } from './constants';
import type {
AllowedEvents,
EtherscanSupportedHexChainId,
PreferencesControllerActions,
PreferencesControllerEvents,
PreferencesControllerMessenger,
} from './PreferencesController';
import { PreferencesController } from './PreferencesController';

Expand Down Expand Up @@ -55,7 +60,7 @@ describe('PreferencesController', () => {

describe('KeyringController:stateChange', () => {
it('should update identities state to reflect new keyring accounts', () => {
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -103,7 +108,7 @@ describe('PreferencesController', () => {
});

it('should update identities state to reflect removed keyring accounts', () => {
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -142,7 +147,7 @@ describe('PreferencesController', () => {
});

it('should update selected address to first identity if the selected address was removed', () => {
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -184,7 +189,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -222,7 +227,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -260,7 +265,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -306,7 +311,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getMessenger();
const messenger = getRootMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -591,7 +596,7 @@ describe('PreferencesController', () => {
deriveStateFromMetadata(
controller.state,
controller.metadata,
'anonymous',
'includeInDebugSnapshot',
),
).toMatchInlineSnapshot(`
Object {
Expand Down Expand Up @@ -839,22 +844,27 @@ describe('PreferencesController', () => {
});
});

type AllPreferencesControllerActions =
MessengerActions<PreferencesControllerMessenger>;

type AllPreferencesControllerEvents =
MessengerEvents<PreferencesControllerMessenger>;

type RootMessenger = Messenger<
MockAnyNamespace,
AllPreferencesControllerActions,
AllPreferencesControllerEvents
>;

/**
* Construct a messenger for use in PreferencesController tests.
*
* This is a utility function that saves us from manually entering the correct
* type parameters for the Messenger each time we construct it.
* Creates and returns a root messenger for testing
*
* @returns A messenger
* @returns A messenger instance
*/
function getMessenger(): Messenger<
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents
> {
return new Messenger<
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents
>();
function getRootMessenger(): RootMessenger {
return new Messenger({
namespace: MOCK_ANY_NAMESPACE,
});
}

/**
Expand All @@ -867,22 +877,24 @@ function getMessenger(): Messenger<
*/
function setupPreferencesController({
options = {},
messenger = getMessenger(),
messenger = getRootMessenger(),
}: {
options?: Partial<ConstructorParameters<typeof PreferencesController>[0]>;
messenger?: Messenger<
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents
>;
messenger?: RootMessenger;
} = {}) {
const preferencesControllerMessenger = messenger.getRestricted<
const preferencesControllerMessenger = new Messenger<
'PreferencesController',
never,
AllowedEvents['type']
AllPreferencesControllerActions,
AllPreferencesControllerEvents,
RootMessenger
>({
name: 'PreferencesController',
allowedActions: [],
allowedEvents: ['KeyringController:stateChange'],
namespace: 'PreferencesController',
parent: messenger,
});
messenger.delegate({
messenger: preferencesControllerMessenger,
actions: [],
events: ['KeyringController:stateChange'],
Copy link

@cursor cursor bot Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: PreferencesController Fails to Sync Identities

The messenger.delegate call in setupPreferencesController incorrectly lists KeyringController:stateChange in its events array. This parameter is for events the child messenger publishes, but KeyringController:stateChange is an event the PreferencesController subscribes to. This misconfiguration prevents the PreferencesController from receiving these events, breaking identity synchronization.

Fix in Cursor Fix in Web

});
return new PreferencesController({
messenger: preferencesControllerMessenger,
Expand Down
Loading
Loading