refactor: migrate {Authentication,UserStorage}Controller to @metamask/messenger (#6533)

## 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 `AuthenticationController`, `UserStorageController` to
the new `@metamask/messenger` message bus, 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

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Migrates `AuthenticationController` and `UserStorageController` to
`@metamask/messenger`, renames state metadata `anonymous` ->
`includeInDebugSnapshot`, and updates tests, configs, and deps.
> 
> - **Profile Sync Controller**:
> - Migrate `AuthenticationController` and `UserStorageController` from
`@metamask/base-controller` messenger to `@metamask/messenger`
(`messagingSystem` -> `messenger`; new handler/subscribe/call usage;
updated types).
>   - Update imports to `@metamask/base-controller/next`.
> - Rename state metadata key `anonymous` to `includeInDebugSnapshot`
and adjust tests accordingly.
> - Revise tests/mocks to construct root/child messengers and delegate
permissions; adapt mock handlers (e.g., `SnapController:handleRequest`).
> - **Dependencies/Config**:
> - Add `@metamask/messenger` dependency and TS project references;
update `yarn.lock`.
> - Update README dependency graph to include `@metamask/messenger` and
new edges.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
b09e552. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Michele Esposito <michele@esposito.codes>

Author: cryptodev-2s

README.md

@@ -320,6 +320,7 @@ linkStyle default opacity:0.5
   preferences_controller --> messenger;
   preferences_controller --> keyring_controller;
   profile_sync_controller --> base_controller;
+  profile_sync_controller --> messenger;
   profile_sync_controller --> address_book_controller;
   profile_sync_controller --> keyring_controller;
   rate_limit_controller --> base_controller;

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

packages/profile-sync-controller/package.json

@@ -101,6 +101,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.4.2",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/snaps-sdk": "^9.0.0",
     "@metamask/snaps-utils": "^11.0.0",
     "@metamask/utils": "^11.8.1",

packages/profile-sync-controller/src/controllers/authentication/AuthenticationController.test.ts

@@ -1,9 +1,15 @@
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 
 import AuthenticationController from './AuthenticationController';
 import type {
-  AllowedActions,
-  AllowedEvents,
+  AuthenticationControllerMessenger,
   AuthenticationControllerState,
 } from './AuthenticationController';
 import {
@@ -560,7 +566,7 @@ describe('metadata', () => {
       deriveStateFromMetadata(
         controller.state,
         controller.metadata,
-        'anonymous',
+        'includeInDebugSnapshot',
       ),
     ).toMatchInlineSnapshot(`
       Object {
@@ -726,23 +732,52 @@ describe('metadata', () => {
   });
 });
 
+type AllAuthenticationControllerActions =
+  MessengerActions<AuthenticationControllerMessenger>;
+
+type AllAuthenticationControllerEvents =
+  MessengerEvents<AuthenticationControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllAuthenticationControllerActions,
+  AllAuthenticationControllerEvents
+>;
+
+/**
+ * Constructs the root messenger.
+ *
+ * @returns A root messenger.
+ */
+function getRootMessenger(): RootMessenger {
+  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
+}
+
+const controllerName = 'AuthenticationController';
+
 /**
  * Jest Test Utility - create Auth Messenger
  *
  * @returns Auth Messenger
  */
 function createAuthenticationMessenger() {
-  const baseMessenger = new Messenger<AllowedActions, AllowedEvents>();
-  const messenger = baseMessenger.getRestricted({
-    name: 'AuthenticationController',
-    allowedActions: [
-      'KeyringController:getState',
-      'SnapController:handleRequest',
-    ],
-    allowedEvents: ['KeyringController:lock', 'KeyringController:unlock'],
+  const rootMessenger = getRootMessenger();
+  const messenger = new Messenger<
+    typeof controllerName,
+    AllAuthenticationControllerActions,
+    AllAuthenticationControllerEvents,
+    RootMessenger
+  >({
+    namespace: controllerName,
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    messenger,
+    actions: ['KeyringController:getState', 'SnapController:handleRequest'],
+    events: ['KeyringController:lock', 'KeyringController:unlock'],
   });
 
-  return { messenger, baseMessenger };
+  return { messenger, baseMessenger: rootMessenger };
 }
 
 /**
@@ -771,6 +806,12 @@ function createMockAuthenticationMessenger() {
   mockCall.mockImplementation((...args) => {
     const [actionType, params] = args;
     if (actionType === 'SnapController:handleRequest') {
+      if (typeof params === 'string') {
+        throw new Error(
+          `MOCK_FAIL - unsupported SnapController:handleRequest call: ${params}`,
+        );
+      }
+
       if (params?.request.method === 'getPublicKey') {
         return mockSnapGetPublicKey();
       }

packages/profile-sync-controller/src/controllers/authentication/AuthenticationController.ts

@@ -1,15 +1,15 @@
-import type {
-  ControllerGetStateAction,
-  ControllerStateChangeEvent,
-  RestrictedMessenger,
-  StateMetadata,
-} from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+import {
+  BaseController,
+  type ControllerGetStateAction,
+  type ControllerStateChangeEvent,
+  type StateMetadata,
+} from '@metamask/base-controller/next';
 import type {
   KeyringControllerGetStateAction,
   KeyringControllerLockEvent,
   KeyringControllerUnlockEvent,
 } from '@metamask/keyring-controller';
+import type { Messenger } from '@metamask/messenger';
 import type { HandleSnapRequest } from '@metamask/snaps-controllers';
 import type { Json } from '@metamask/utils';
 
@@ -46,7 +46,7 @@ const metadata: StateMetadata<AuthenticationControllerState> = {
   isSignedIn: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: true,
+    includeInDebugSnapshot: true,
     usedInUi: true,
   },
   srpSessionData: {
@@ -74,7 +74,7 @@ const metadata: StateMetadata<AuthenticationControllerState> = {
       );
     },
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
 };
@@ -125,21 +125,15 @@ export type AuthenticationControllerStateChangeEvent =
 export type Events = AuthenticationControllerStateChangeEvent;
 
 // Allowed Actions
-export type AllowedActions =
-  | HandleSnapRequest
-  | KeyringControllerGetStateAction;
+type AllowedActions = HandleSnapRequest | KeyringControllerGetStateAction;
 
-export type AllowedEvents =
-  | KeyringControllerLockEvent
-  | KeyringControllerUnlockEvent;
+type AllowedEvents = KeyringControllerLockEvent | KeyringControllerUnlockEvent;
 
 // Messenger
-export type AuthenticationControllerMessenger = RestrictedMessenger<
+export type AuthenticationControllerMessenger = Messenger<
   typeof controllerName,
   Actions | AllowedActions,
-  Events | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  Events | AllowedEvents
 >;
 
 /**
@@ -163,16 +157,14 @@ export default class AuthenticationController extends BaseController<
 
   readonly #keyringController = {
     setupLockedStateSubscriptions: () => {
-      const { isUnlocked } = this.messagingSystem.call(
-        'KeyringController:getState',
-      );
+      const { isUnlocked } = this.messenger.call('KeyringController:getState');
       this.#isUnlocked = isUnlocked;
 
-      this.messagingSystem.subscribe('KeyringController:unlock', () => {
+      this.messenger.subscribe('KeyringController:unlock', () => {
         this.#isUnlocked = true;
       });
 
-      this.messagingSystem.subscribe('KeyringController:lock', () => {
+      this.messenger.subscribe('KeyringController:lock', () => {
         this.#isUnlocked = false;
       });
     },
@@ -239,32 +231,32 @@ export default class AuthenticationController extends BaseController<
    * actions.
    */
   #registerMessageHandlers(): void {
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       'AuthenticationController:getBearerToken',
       this.getBearerToken.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       'AuthenticationController:getSessionProfile',
       this.getSessionProfile.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       'AuthenticationController:isSignedIn',
       this.isSignedIn.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       'AuthenticationController:performSignIn',
       this.performSignIn.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       'AuthenticationController:performSignOut',
       this.performSignOut.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       'AuthenticationController:getUserProfileLineage',
       this.getUserProfileLineage.bind(this),
     );
@@ -388,7 +380,7 @@ export default class AuthenticationController extends BaseController<
   async #snapGetPublicKey(entropySourceId?: string): Promise<string> {
     this.#assertIsUnlocked('#snapGetPublicKey');
 
-    const result = (await this.messagingSystem.call(
+    const result = (await this.messenger.call(
       'SnapController:handleRequest',
       createSnapPublicKeyRequest(entropySourceId),
     )) as string;
@@ -404,7 +396,7 @@ export default class AuthenticationController extends BaseController<
   async #snapGetAllPublicKeys(): Promise<[string, string][]> {
     this.#assertIsUnlocked('#snapGetAllPublicKeys');
 
-    const result = (await this.messagingSystem.call(
+    const result = (await this.messenger.call(
       'SnapController:handleRequest',
       createSnapAllPublicKeysRequest(),
     )) as [string, string][];
@@ -434,7 +426,7 @@ export default class AuthenticationController extends BaseController<
 
     this.#assertIsUnlocked('#snapSignMessage');
 
-    const result = (await this.messagingSystem.call(
+    const result = (await this.messenger.call(
       'SnapController:handleRequest',
       createSnapSignMessageRequest(message, entropySourceId),
     )) as string;

packages/profile-sync-controller/src/controllers/user-storage/UserStorageController.test.ts

@@ -1,4 +1,4 @@
-import { deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import type nock from 'nock';
 
 import { mockUserStorageMessenger } from './__fixtures__/mockMessenger';
@@ -766,7 +766,7 @@ describe('metadata', () => {
       deriveStateFromMetadata(
         controller.state,
         controller.metadata,
-        'anonymous',
+        'includeInDebugSnapshot',
       ),
     ).toMatchInlineSnapshot(`
       Object {