refactor: migrate AddressBookController to @metamask/messenger (#6383)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->
This PR migrates the `AddressBookController` class to the new
`@metamask/messenger` comm system, as opposed to the one exported from
`@metamask/base-controller`.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->
* Related to #5626

## 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](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: mikesposito

README.md

@@ -160,6 +160,7 @@ linkStyle default opacity:0.5
   accounts_controller --> network_controller;
   address_book_controller --> base_controller;
   address_book_controller --> controller_utils;
+  address_book_controller --> messenger;
   announcement_controller --> base_controller;
   app_metadata_controller --> base_controller;
   approval_controller --> base_controller;

packages/address-book-controller/CHANGELOG.md

@@ -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` ([#6383](https://github.com/MetaMask/core/pull/6383))
+  - Previously, `AddressBookController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#6383](https://github.com/MetaMask/core/pull/6383))
+
 ## [6.2.1]
 
 ### Changed

packages/address-book-controller/package.json

@@ -49,6 +49,7 @@
   "dependencies": {
     "@metamask/base-controller": "^8.4.2",
     "@metamask/controller-utils": "^11.14.1",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/utils": "^11.8.1"
   },
   "devDependencies": {

packages/address-book-controller/src/AddressBookController.test.ts

@@ -1,48 +1,69 @@
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import { toHex } from '@metamask/controller-utils';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import type { Hex } from '@metamask/utils';
 
 import type {
-  AddressBookControllerActions,
-  AddressBookControllerEvents,
-  AddressBookControllerContactUpdatedEvent,
   AddressBookControllerContactDeletedEvent,
+  AddressBookControllerMessenger,
 } from './AddressBookController';
 import {
   AddressBookController,
   AddressType,
   controllerName,
 } from './AddressBookController';
 
+type AllActions = MessengerActions<AddressBookControllerMessenger>;
+
+type AllEvents = MessengerEvents<AddressBookControllerMessenger>;
+
+type RootMessenger = Messenger<MockAnyNamespace, AllActions, AllEvents>;
+
+/**
+ * Creates a new root messenger instance for testing.
+ *
+ * @returns A new Messenger instance.
+ */
+function getRootMessenger(): RootMessenger {
+  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
+}
+
 /**
  * Helper function to create test fixtures
  *
  * @returns Test fixtures including messenger, controller, and event listeners
  */
 function arrangeMocks() {
-  const messenger = new Messenger<
-    AddressBookControllerActions,
-    AddressBookControllerEvents
-  >();
-  const restrictedMessenger = messenger.getRestricted({
-    name: controllerName,
-    allowedActions: [],
-    allowedEvents: [],
+  const rootMessenger = getRootMessenger();
+  const addressBookControllerMessenger = new Messenger<
+    typeof controllerName,
+    AllActions,
+    AllEvents,
+    typeof rootMessenger
+  >({
+    namespace: controllerName,
+    parent: rootMessenger,
   });
   const controller = new AddressBookController({
-    messenger: restrictedMessenger,
+    messenger: addressBookControllerMessenger,
   });
 
   // Set up mock event listeners
   const contactUpdatedListener = jest.fn();
   const contactDeletedListener = jest.fn();
 
   // Subscribe to events
-  messenger.subscribe(
-    'AddressBookController:contactUpdated' as AddressBookControllerContactUpdatedEvent['type'],
+  rootMessenger.subscribe(
+    'AddressBookController:contactUpdated',
     contactUpdatedListener,
   );
-  messenger.subscribe(
+  rootMessenger.subscribe(
     'AddressBookController:contactDeleted' as AddressBookControllerContactDeletedEvent['type'],
     contactDeletedListener,
   );
@@ -627,7 +648,7 @@ describe('AddressBookController', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });

packages/address-book-controller/src/AddressBookController.ts

@@ -1,16 +1,16 @@
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+} from '@metamask/base-controller/next';
+import { BaseController } from '@metamask/base-controller/next';
 import {
   normalizeEnsName,
   isValidHexAddress,
   isSafeDynamicKey,
   toChecksumHexAddress,
   toHex,
 } from '@metamask/controller-utils';
+import type { Messenger } from '@metamask/messenger';
 import type { Hex } from '@metamask/utils';
 
 /**
@@ -150,7 +150,7 @@ const addressBookControllerMetadata = {
   addressBook: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
 };
@@ -170,12 +170,10 @@ export const getDefaultAddressBookControllerState =
 /**
  * The messenger of the {@link AddressBookController} for communication.
  */
-export type AddressBookControllerMessenger = RestrictedMessenger<
+export type AddressBookControllerMessenger = Messenger<
   typeof controllerName,
   AddressBookControllerActions,
-  AddressBookControllerEvents,
-  never,
-  never
+  AddressBookControllerEvents
 >;
 
 /**
@@ -275,7 +273,7 @@ export class AddressBookController extends BaseController<
     // These entries with chainId='*' are the wallet's own accounts (internal MetaMask accounts),
     // not user-created contacts. They don't need to trigger sync events.
     if (String(chainId) !== WALLET_ACCOUNTS_CHAIN_ID) {
-      this.messagingSystem.publish(
+      this.messenger.publish(
         'AddressBookController:contactDeleted',
         deletedEntry,
       );
@@ -335,10 +333,7 @@ export class AddressBookController extends BaseController<
     // These entries with chainId='*' are the wallet's own accounts (internal MetaMask accounts),
     // not user-created contacts. They don't need to trigger sync events.
     if (String(chainId) !== WALLET_ACCOUNTS_CHAIN_ID) {
-      this.messagingSystem.publish(
-        'AddressBookController:contactUpdated',
-        entry,
-      );
+      this.messenger.publish('AddressBookController:contactUpdated', entry);
     }
 
     return true;
@@ -348,15 +343,15 @@ export class AddressBookController extends BaseController<
    * Registers message handlers for the AddressBookController.
    */
   #registerMessageHandlers() {
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:list`,
       this.list.bind(this),
     );
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:set`,
       this.set.bind(this),
     );
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:delete`,
       this.delete.bind(this),
     );

packages/address-book-controller/tsconfig.build.json

@@ -7,7 +7,8 @@
   },
   "references": [
     { "path": "../base-controller/tsconfig.build.json" },
-    { "path": "../controller-utils/tsconfig.build.json" }
+    { "path": "../controller-utils/tsconfig.build.json" },
+    { "path": "../messenger/tsconfig.build.json" }
   ],
   "include": ["../../types", "./src"]
 }

packages/address-book-controller/tsconfig.json

@@ -5,7 +5,8 @@
   },
   "references": [
     { "path": "../base-controller" },
-    { "path": "../controller-utils" }
+    { "path": "../controller-utils" },
+    { "path": "../messenger" }
   ],
   "include": ["../../types", "./src"]
 }

yarn.lock

@@ -2668,6 +2668,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.2"
     "@metamask/controller-utils": "npm:^11.14.1"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/utils": "npm:^11.8.1"
     "@types/jest": "npm:^27.4.1"
     deepmerge: "npm:^4.2.2"