refactor: migrate {AccountActivity,BackendWebSocket}Service to @metamask/messenger

Author: cryptodev-2s

packages/core-backend/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6821](https://github.com/MetaMask/core/pull/6821))
+  - Previously, `AccountActivityService` and `BackendWebSocketService` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
+### Removed
+
+- **BREAKING:** Remove exported type aliases and constants that were specific to controller messenger integration ([#6821](https://github.com/MetaMask/core/pull/6821))
+  - Removed type exports: `BackendWebSocketServiceAllowedActions`, `BackendWebSocketServiceAllowedEvents`, `AccountActivityServiceAllowedActions`, `AccountActivityServiceAllowedEvents`
+  - Removed constant exports: `ACCOUNT_ACTIVITY_SERVICE_ALLOWED_ACTIONS`, `ACCOUNT_ACTIVITY_SERVICE_ALLOWED_EVENTS`
+  - These types and constants were internal implementation details that should not have been exposed. Consumers should use the service-specific messenger types directly.
+
 ## [1.0.1]
 
 ### Changed

packages/core-backend/package.json

@@ -47,8 +47,8 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.4.1",
     "@metamask/controller-utils": "^11.14.1",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/profile-sync-controller": "^25.1.1",
     "@metamask/utils": "^11.8.1",
     "uuid": "^8.3.2"

packages/core-backend/src/AccountActivityService.test.ts

@@ -1,25 +1,37 @@
-import { Messenger } from '@metamask/base-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import type { Hex } from '@metamask/utils';
 import nock, { isDone } from 'nock';
 
-import type {
-  AccountActivityServiceAllowedEvents,
-  AccountActivityServiceAllowedActions,
-} from './AccountActivityService';
 import {
   AccountActivityService,
   type AccountActivityServiceMessenger,
   type SubscriptionOptions,
-  ACCOUNT_ACTIVITY_SERVICE_ALLOWED_ACTIONS,
-  ACCOUNT_ACTIVITY_SERVICE_ALLOWED_EVENTS,
 } from './AccountActivityService';
 import type { ServerNotificationMessage } from './BackendWebSocketService';
 import { WebSocketState } from './BackendWebSocketService';
 import type { Transaction, BalanceUpdate } from './types';
 import type { AccountActivityMessage } from './types';
 import { flushPromises } from '../../../tests/helpers';
 
+type AllAccountActivityServiceActions =
+  MessengerActions<AccountActivityServiceMessenger>;
+
+type AllAccountActivityServiceEvents =
+  MessengerEvents<AccountActivityServiceMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllAccountActivityServiceActions,
+  AllAccountActivityServiceEvents
+>;
+
 // Helper function for completing async operations
 const completeAsyncOperations = async (timeoutMs = 0) => {
   await flushPromises();
@@ -49,25 +61,70 @@ const createMockInternalAccount = (options: {
   scopes: ['eip155:1'], // Required scopes property
 });
 
+/**
+ * Creates and returns a root messenger for testing
+ *
+ * @returns A messenger instance
+ */
+function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+}
+
 /**
  * Creates a real messenger with registered mock actions for testing
  * Each call creates a completely independent messenger to ensure test isolation
  *
  * @returns Object containing the messenger and mock action functions
  */
-const getMessenger = () => {
+const getMessenger = (): {
+  rootMessenger: RootMessenger;
+  messenger: AccountActivityServiceMessenger;
+  mocks: {
+    getSelectedAccount: jest.Mock;
+    connect: jest.Mock;
+    disconnect: jest.Mock;
+    subscribe: jest.Mock;
+    channelHasSubscription: jest.Mock;
+    getSubscriptionsByChannel: jest.Mock;
+    findSubscriptionsByChannelPrefix: jest.Mock;
+    addChannelCallback: jest.Mock;
+    removeChannelCallback: jest.Mock;
+  };
+} => {
   // Use any types for the root messenger to avoid complex type constraints in tests
   // Create a unique root messenger for each test
-  const rootMessenger = new Messenger<
-    AccountActivityServiceAllowedActions,
-    AccountActivityServiceAllowedEvents
-  >();
-  const messenger: AccountActivityServiceMessenger =
-    rootMessenger.getRestricted({
-      name: 'AccountActivityService',
-      allowedActions: [...ACCOUNT_ACTIVITY_SERVICE_ALLOWED_ACTIONS],
-      allowedEvents: [...ACCOUNT_ACTIVITY_SERVICE_ALLOWED_EVENTS],
-    });
+  const rootMessenger = getRootMessenger();
+  const messenger: AccountActivityServiceMessenger = new Messenger<
+    'AccountActivityService',
+    AllAccountActivityServiceActions,
+    AllAccountActivityServiceEvents,
+    RootMessenger
+  >({
+    namespace: 'AccountActivityService',
+    parent: rootMessenger,
+  });
+
+  rootMessenger.delegate({
+    actions: [
+      'AccountsController:getSelectedAccount',
+      'BackendWebSocketService:connect',
+      'BackendWebSocketService:disconnect',
+      'BackendWebSocketService:subscribe',
+      'BackendWebSocketService:getConnectionInfo',
+      'BackendWebSocketService:channelHasSubscription',
+      'BackendWebSocketService:getSubscriptionsByChannel',
+      'BackendWebSocketService:findSubscriptionsByChannelPrefix',
+      'BackendWebSocketService:addChannelCallback',
+      'BackendWebSocketService:removeChannelCallback',
+    ],
+    events: [
+      'AccountsController:selectedAccountChange',
+      'BackendWebSocketService:connectionStateChanged',
+    ],
+    messenger,
+  });
 
   // Create mock action handlers
   const mockGetSelectedAccount = jest.fn();
@@ -216,10 +273,7 @@ type WithServiceOptions = {
 type WithServiceCallback<ReturnValue> = (payload: {
   service: AccountActivityService;
   messenger: AccountActivityServiceMessenger;
-  rootMessenger: Messenger<
-    AccountActivityServiceAllowedActions,
-    AccountActivityServiceAllowedEvents
-  >;
+  rootMessenger: RootMessenger;
   mocks: {
     getSelectedAccount: jest.Mock;
     connect: jest.Mock;
@@ -633,7 +687,7 @@ describe('AccountActivityService', () => {
             });
 
           // Publish WebSocket ERROR state event - will be picked up by controller subscription
-          await rootMessenger.publish(
+          rootMessenger.publish(
             'BackendWebSocketService:connectionStateChanged',
             {
               state: WebSocketState.ERROR,
@@ -686,7 +740,7 @@ describe('AccountActivityService', () => {
           });
 
           // Publish account change event - will be picked up by controller subscription
-          await rootMessenger.publish(
+          rootMessenger.publish(
             'AccountsController:selectedAccountChange',
             solanaAccount,
           );
@@ -716,7 +770,7 @@ describe('AccountActivityService', () => {
           });
 
           // Publish account change event - will be picked up by controller subscription
-          await rootMessenger.publish(
+          rootMessenger.publish(
             'AccountsController:selectedAccountChange',
             unknownAccount,
           );
@@ -738,7 +792,7 @@ describe('AccountActivityService', () => {
           mocks.getSelectedAccount.mockReturnValue(null);
 
           // Publish WebSocket connection event - will be picked up by controller subscription
-          await rootMessenger.publish(
+          rootMessenger.publish(
             'BackendWebSocketService:connectionStateChanged',
             {
               state: WebSocketState.CONNECTED,
@@ -805,7 +859,7 @@ describe('AccountActivityService', () => {
             });
 
             // Publish account change event on root messenger
-            await rootMessenger.publish(
+            rootMessenger.publish(
               'AccountsController:selectedAccountChange',
               newAccount,
             );
@@ -843,7 +897,7 @@ describe('AccountActivityService', () => {
             });
 
             // Publish account change event on root messenger
-            await rootMessenger.publish(
+            rootMessenger.publish(
               'AccountsController:selectedAccountChange',
               newAccount,
             );

packages/core-backend/src/AccountActivityService.ts

@@ -9,8 +9,8 @@ import type {
   AccountsControllerGetSelectedAccountAction,
   AccountsControllerSelectedAccountChangeEvent,
 } from '@metamask/accounts-controller';
-import type { RestrictedMessenger } from '@metamask/base-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
+import type { Messenger } from '@metamask/messenger';
 
 import type { AccountActivityServiceMethodActions } from './AccountActivityService-method-action-types';
 import type {
@@ -119,27 +119,7 @@ export type AccountActivityServiceOptions = {
 // Action types for the messaging system - using generated method actions
 export type AccountActivityServiceActions = AccountActivityServiceMethodActions;
 
-// Allowed actions that AccountActivityService can call on other controllers
-export const ACCOUNT_ACTIVITY_SERVICE_ALLOWED_ACTIONS = [
-  'AccountsController:getSelectedAccount',
-  'BackendWebSocketService:connect',
-  'BackendWebSocketService:disconnect',
-  'BackendWebSocketService:subscribe',
-  'BackendWebSocketService:getConnectionInfo',
-  'BackendWebSocketService:channelHasSubscription',
-  'BackendWebSocketService:getSubscriptionsByChannel',
-  'BackendWebSocketService:findSubscriptionsByChannelPrefix',
-  'BackendWebSocketService:addChannelCallback',
-  'BackendWebSocketService:removeChannelCallback',
-] as const;
-
-// Allowed events that AccountActivityService can listen to
-export const ACCOUNT_ACTIVITY_SERVICE_ALLOWED_EVENTS = [
-  'AccountsController:selectedAccountChange',
-  'BackendWebSocketService:connectionStateChanged',
-] as const;
-
-export type AccountActivityServiceAllowedActions =
+type AllowedActions =
   | AccountsControllerGetSelectedAccountAction
   | BackendWebSocketServiceMethodActions;
 
@@ -176,16 +156,14 @@ export type AccountActivityServiceEvents =
   | AccountActivityServiceSubscriptionErrorEvent
   | AccountActivityServiceStatusChangedEvent;
 
-export type AccountActivityServiceAllowedEvents =
+export type AllowedEvents =
   | AccountsControllerSelectedAccountChangeEvent
   | BackendWebSocketServiceConnectionStateChangedEvent;
 
-export type AccountActivityServiceMessenger = RestrictedMessenger<
+export type AccountActivityServiceMessenger = Messenger<
   typeof SERVICE_NAME,
-  AccountActivityServiceActions | AccountActivityServiceAllowedActions,
-  AccountActivityServiceEvents | AccountActivityServiceAllowedEvents,
-  AccountActivityServiceAllowedActions['type'],
-  AccountActivityServiceAllowedEvents['type']
+  AccountActivityServiceActions | AllowedActions,
+  AccountActivityServiceEvents | AllowedEvents
 >;
 
 // =============================================================================

packages/core-backend/src/BackendWebSocketService.test.ts

@@ -1,13 +1,17 @@
-import { Messenger } from '@metamask/base-controller';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 
 import {
   BackendWebSocketService,
   getCloseReason,
   WebSocketState,
   type BackendWebSocketServiceOptions,
   type BackendWebSocketServiceMessenger,
-  type BackendWebSocketServiceAllowedActions,
-  type BackendWebSocketServiceAllowedEvents,
 } from './BackendWebSocketService';
 import { flushPromises } from '../../../tests/helpers';
 
@@ -18,6 +22,18 @@ import { flushPromises } from '../../../tests/helpers';
 // Type for global object with WebSocket mock
 type GlobalWithWebSocket = typeof global & { lastWebSocket: MockWebSocket };
 
+type AllBackendWebSocketServiceActions =
+  MessengerActions<BackendWebSocketServiceMessenger>;
+
+type AllBackendWebSocketServiceEvents =
+  MessengerEvents<BackendWebSocketServiceMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllBackendWebSocketServiceActions,
+  AllBackendWebSocketServiceEvents
+>;
+
 // =====================================================
 // MOCK WEBSOCKET CLASS
 // =====================================================
@@ -149,6 +165,17 @@ class MockWebSocket extends EventTarget {
 // TEST UTILITIES & MOCKS
 // =====================================================
 
+/**
+ * Creates and returns a root messenger for testing
+ *
+ * @returns A messenger instance
+ */
+function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+}
+
 /**
  * Creates a real messenger with registered mock actions for testing
  * Each call creates a completely independent messenger to ensure test isolation
@@ -157,15 +184,21 @@ class MockWebSocket extends EventTarget {
  */
 const getMessenger = () => {
   // Create a unique root messenger for each test
-  const rootMessenger = new Messenger<
-    BackendWebSocketServiceAllowedActions,
-    BackendWebSocketServiceAllowedEvents
-  >();
-  const messenger = rootMessenger.getRestricted({
-    name: 'BackendWebSocketService',
-    allowedActions: ['AuthenticationController:getBearerToken'],
-    allowedEvents: ['AuthenticationController:stateChange'],
-  }) as unknown as BackendWebSocketServiceMessenger;
+  const rootMessenger = getRootMessenger();
+  const messenger = new Messenger<
+    'BackendWebSocketService',
+    AllBackendWebSocketServiceActions,
+    AllBackendWebSocketServiceEvents,
+    RootMessenger
+  >({
+    namespace: 'BackendWebSocketService',
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    actions: ['AuthenticationController:getBearerToken'],
+    events: ['AuthenticationController:stateChange'],
+    messenger,
+  });
 
   // Create mock action handlers
   const mockGetBearerToken = jest.fn().mockResolvedValue('valid-default-token');
@@ -234,10 +267,7 @@ type TestSetupOptions = {
 type TestSetup = {
   service: BackendWebSocketService;
   messenger: BackendWebSocketServiceMessenger;
-  rootMessenger: Messenger<
-    BackendWebSocketServiceAllowedActions,
-    BackendWebSocketServiceAllowedEvents
-  >;
+  rootMessenger: RootMessenger;
   mocks: {
     getBearerToken: jest.Mock;
   };
@@ -256,10 +286,7 @@ type TestSetup = {
 type WithServiceCallback<ReturnValue> = (payload: {
   service: BackendWebSocketService;
   messenger: BackendWebSocketServiceMessenger;
-  rootMessenger: Messenger<
-    BackendWebSocketServiceAllowedActions,
-    BackendWebSocketServiceAllowedEvents
-  >;
+  rootMessenger: RootMessenger;
   mocks: {
     getBearerToken: jest.Mock;
   };