refactor: migrate {Authentication,UserStorage}Controller to @metamask/messenger

Author: cryptodev-2s

packages/profile-sync-controller/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 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`.
 - Implement deferred login pattern in `SRPJwtBearerAuth` to prevent race conditions during concurrent authentication attempts ([#6353](https://github.com/MetaMask/core/pull/6353))
   - Add `#deferredLogin` method that ensures only one login operation executes at a time using Promise map caching
 - Bump `@metamask/base-controller` from `^8.1.0` to `^8.3.0` ([#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))

packages/profile-sync-controller/package.json

@@ -101,6 +101,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.3.0",
+    "@metamask/messenger": "^0.2.0",
     "@metamask/snaps-sdk": "^9.0.0",
     "@metamask/snaps-utils": "^11.0.0",
     "@noble/ciphers": "^1.3.0",

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

@@ -1,9 +1,14 @@
-import { Messenger } from '@metamask/base-controller';
+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 {
@@ -538,23 +543,52 @@ describe('AuthenticationController', () => {
   });
 });
 
+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 };
 }
 
 /**
@@ -583,6 +617,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 {
@@ -98,21 +98,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
 >;
 
 /**
@@ -136,16 +130,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;
       });
     },
@@ -212,32 +204,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),
     );
@@ -361,7 +353,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;
@@ -377,7 +369,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][];
@@ -407,7 +399,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;