refactor: migrate AccountsController to @metamask/messenger

README.md

@@ -154,6 +154,7 @@ linkStyle default opacity:0.5
   account_tree_controller --> multichain_account_service;
   account_tree_controller --> profile_sync_controller;
   accounts_controller --> base_controller;
+  accounts_controller --> messenger;
   accounts_controller --> controller_utils;
   accounts_controller --> keyring_controller;
   accounts_controller --> network_controller;

packages/accounts-controller/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6426](https://github.com/MetaMask/core/pull/6426))
+  - Previously, `AccountsController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ## [33.2.0]
 
 ### Added

packages/accounts-controller/package.json

@@ -53,6 +53,7 @@
     "@metamask/keyring-api": "^21.0.0",
     "@metamask/keyring-internal-api": "^9.0.0",
     "@metamask/keyring-utils": "^3.1.0",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/snaps-sdk": "^9.0.0",
     "@metamask/snaps-utils": "^11.0.0",
     "@metamask/superstruct": "^3.1.0",

packages/accounts-controller/src/AccountsController.test.ts

@@ -1,4 +1,4 @@
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import { InfuraNetworkType } from '@metamask/controller-utils';
 import type {
   AccountAssetListUpdatedEventPayload,
@@ -15,19 +15,23 @@
 } from '@metamask/keyring-api';
 import { KeyringTypes } from '@metamask/keyring-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
+import {
+  MOCK_ANY_NAMESPACE,
+  Messenger,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import type { NetworkClientId } from '@metamask/network-controller';
 import type { SnapControllerState } from '@metamask/snaps-controllers';
 import { SnapStatus } from '@metamask/snaps-utils';
 import type { CaipChainId } from '@metamask/utils';
 import type { V4Options } from 'uuid';
 import * as uuid from 'uuid';
 
 import type {
-  AccountsControllerActions,
-  AccountsControllerEvents,
+  AccountsControllerMessenger,
   AccountsControllerState,
-  AllowedActions,
-  AllowedEvents,
 } from './AccountsController';
 import { AccountsController, EMPTY_ACCOUNT } from './AccountsController';
 import {
@@ -41,6 +45,17 @@
   keyringTypeToName,
 } from './utils';
 
+type AllAccountsControllerActions =
+  MessengerActions<AccountsControllerMessenger>;
+
+type AllAccountsControllerEvents = MessengerEvents<AccountsControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllAccountsControllerActions,
+  AllAccountsControllerEvents
+>;
+
 jest.mock('uuid');
 const mockUUID = jest.spyOn(uuid, 'v4');
 const actualUUID = jest.requireActual('uuid').v4; // We also use uuid.v4 in our mocks
@@ -217,64 +232,66 @@
 }
 
 /**
- * Builds a new instance of the Messenger class for the AccountsController.
+ * Builds a new instance of the root messenger.
  *
- * @returns A new instance of the Messenger class for the AccountsController.
+ * @returns A new instance of the root messenger.
  */
-function buildMessenger() {
-  return new Messenger<
-    AccountsControllerActions | AllowedActions,
-    AccountsControllerEvents | AllowedEvents
-  >();
+function buildMessenger(): RootMessenger {
+  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
 }
 
 /**
- * Builds a restricted messenger for the AccountsController.
+ * Builds a messenger for the AccountsController.
  *
- * @param messenger - The messenger to restrict.
- * @returns The restricted messenger.
+ * @param rootMessenger - The root messenger.
+ * @returns The messenger for AccountsController.
  */
-function buildAccountsControllerMessenger(messenger = buildMessenger()) {
-  return messenger.getRestricted({
-    name: 'AccountsController',
-    allowedEvents: [
+function buildAccountsControllerMessenger(rootMessenger = buildMessenger()) {
+  const accountsControllerMessenger = new Messenger<
+    'AccountsController',
+    AllAccountsControllerActions,
+    AllAccountsControllerEvents,
+    typeof rootMessenger
+  >({
+    namespace: 'AccountsController',
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    messenger: accountsControllerMessenger,
+    actions: [
+      'KeyringController:getState',
+      'KeyringController:getKeyringsByType',
+    ],
+    events: [
       'SnapController:stateChange',
       'KeyringController:stateChange',
       'SnapKeyring:accountAssetListUpdated',
       'SnapKeyring:accountBalancesUpdated',
       'SnapKeyring:accountTransactionsUpdated',
       'MultichainNetworkController:networkDidChange',
     ],
-    allowedActions: [
-      'KeyringController:getState',
-      'KeyringController:getKeyringsByType',
-    ],
   });
+  return accountsControllerMessenger;
 }
 
 /**
  * Sets up an instance of the AccountsController class with the given initial state and callbacks.
  *
  * @param options - The options object.
  * @param [options.initialState] - The initial state to use for the AccountsController.
- * @param [options.messenger] - Messenger to use for the AccountsController.
+ * @param [options.messenger] - The root messenger to use for creating the AccountsController messenger.
  * @returns An instance of the AccountsController class.
  */
 function setupAccountsController({
   initialState = {},
   messenger = buildMessenger(),
 }: {
   initialState?: Partial<AccountsControllerState>;
-  messenger?: Messenger<
-    AccountsControllerActions | AllowedActions,
-    AccountsControllerEvents | AllowedEvents
-  >;
-} = {}): {
+  messenger?: RootMessenger;
+}): {
   accountsController: AccountsController;
-  messenger: Messenger<
-    AccountsControllerActions | AllowedActions,
-    AccountsControllerEvents | AllowedEvents
-  >;
+  messenger: RootMessenger;
+  accountsControllerMessenger: AccountsControllerMessenger;
   triggerMultichainNetworkChange: (id: NetworkClientId | CaipChainId) => void;
 } {
   const accountsControllerMessenger =
@@ -288,7 +305,12 @@
   const triggerMultichainNetworkChange = (id: NetworkClientId | CaipChainId) =>
     messenger.publish('MultichainNetworkController:networkDidChange', id);
 
-  return { accountsController, messenger, triggerMultichainNetworkChange };
+  return {
+    accountsController,
+    messenger,
+    accountsControllerMessenger,
+    triggerMultichainNetworkChange,
+  };
 }
 
 describe('AccountsController', () => {
@@ -1136,11 +1158,10 @@
 
       it('publishes accountAdded event', async () => {
         const messenger = buildMessenger();
-        const messengerSpy = jest.spyOn(messenger, 'publish');
 
         mockUUIDWithNormalAccounts([mockAccount, mockAccount2]);
 
-        setupAccountsController({
+        const { accountsControllerMessenger } = setupAccountsController({
           initialState: {
             internalAccounts: {
               accounts: {
@@ -1152,6 +1173,8 @@
           messenger,
         });
 
+        const messengerSpy = jest.spyOn(accountsControllerMessenger, 'publish');
+
         const mockNewKeyringState = {
           isUnlocked: true,
           keyrings: [
@@ -1172,11 +1195,10 @@
           [],
         );
 
-        // First call is 'KeyringController:stateChange'
+        // First call is 'AccountsController:stateChange'
         expect(messengerSpy).toHaveBeenNthCalledWith(
-          // 1. KeyringController:stateChange
-          // 2. AccountsController:stateChange
-          3,
+          // 1. AccountsController:stateChange
+          2,
           'AccountsController:accountAdded',
           MockExpectedInternalAccountBuilder.from(mockAccount2)
             .setExpectedLastSelectedAsAny()
@@ -1437,11 +1459,10 @@
 
       it('publishes accountRemoved event', async () => {
         const messenger = buildMessenger();
-        const messengerSpy = jest.spyOn(messenger, 'publish');
 
         mockUUIDWithNormalAccounts([mockAccount, mockAccount2]);
 
-        setupAccountsController({
+        const { accountsControllerMessenger } = setupAccountsController({
           initialState: {
             internalAccounts: {
               accounts: {
@@ -1454,6 +1475,8 @@
           messenger,
         });
 
+        const messengerSpy = jest.spyOn(accountsControllerMessenger, 'publish');
+
         const mockNewKeyringState = {
           isUnlocked: true,
           keyrings: [
@@ -1473,11 +1496,10 @@
           [],
         );
 
-        // First call is 'KeyringController:stateChange'
+        // First call is 'AccountsController:stateChange'
         expect(messengerSpy).toHaveBeenNthCalledWith(
-          // 1. KeyringController:stateChange
-          // 2. AccountsController:stateChange
-          3,
+          // 1. AccountsController:stateChange
+          2,
           'AccountsController:accountRemoved',
           mockAccount3.id,
         );
@@ -3165,19 +3187,20 @@
         },
         type: BtcAccountType.P2wpkh,
       });
-      const { accountsController, messenger } = setupAccountsController({
-        initialState: {
-          internalAccounts: {
-            accounts: {
-              [mockAccount.id]: mockAccount,
-              [mockNonEvmAccount.id]: mockNonEvmAccount,
+      const { accountsController, accountsControllerMessenger } =
+        setupAccountsController({
+          initialState: {
+            internalAccounts: {
+              accounts: {
+                [mockAccount.id]: mockAccount,
+                [mockNonEvmAccount.id]: mockNonEvmAccount,
+              },
+              selectedAccount: mockAccount.id,
             },
-            selectedAccount: mockAccount.id,
           },
-        },
-      });
+        });
 
-      const messengerSpy = jest.spyOn(messenger, 'publish');
+      const messengerSpy = jest.spyOn(accountsControllerMessenger, 'publish');
 
       accountsController.setSelectedAccount(mockNonEvmAccount.id);
 
@@ -3271,10 +3294,10 @@
     });
 
     it('publishes the accountRenamed event', () => {
-      const { accountsController, messenger } =
+      const { accountsController, accountsControllerMessenger } =
         setupAccountsController(mockState);
 
-      const messengerSpy = jest.spyOn(messenger, 'publish');
+      const messengerSpy = jest.spyOn(accountsControllerMessenger, 'publish');
 
       accountsController.setAccountNameAndSelectAccount(
         mockAccount.id,
@@ -3349,16 +3372,17 @@
     });
 
     it('publishes the accountRenamed event', () => {
-      const { accountsController, messenger } = setupAccountsController({
-        initialState: {
-          internalAccounts: {
-            accounts: { [mockAccount.id]: mockAccount },
-            selectedAccount: mockAccount.id,
+      const { accountsController, accountsControllerMessenger } =
+        setupAccountsController({
+          initialState: {
+            internalAccounts: {
+              accounts: { [mockAccount.id]: mockAccount },
+              selectedAccount: mockAccount.id,
+            },
           },
-        },
-      });
+        });
 
-      const messengerSpy = jest.spyOn(messenger, 'publish');
+      const messengerSpy = jest.spyOn(accountsControllerMessenger, 'publish');
 
       accountsController.setAccountName(mockAccount.id, 'new name');
 
@@ -3922,19 +3946,19 @@
 
   describe('metadata', () => {
     it('includes expected state in debug snapshots', () => {
-      const { accountsController: controller } = setupAccountsController();
+      const { accountsController: controller } = setupAccountsController({});
 
       expect(
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });
 
     it('includes expected state in state logs', () => {
-      const { accountsController: controller } = setupAccountsController();
+      const { accountsController: controller } = setupAccountsController({});
 
       expect(
         deriveStateFromMetadata(
@@ -3953,7 +3977,7 @@
     });
 
     it('persists expected state', () => {
-      const { accountsController: controller } = setupAccountsController();
+      const { accountsController: controller } = setupAccountsController({});
 
       expect(
         deriveStateFromMetadata(
@@ -3972,7 +3996,7 @@
     });
 
     it('exposes expected state to UI', () => {
-      const { accountsController: controller } = setupAccountsController();
+      const { accountsController: controller } = setupAccountsController({});
 
       expect(
         deriveStateFromMetadata(