refactor: migrate PhishingController to @metamask/messenger

Author: cryptodev-2s

packages/phishing-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` ([#6535](https://github.com/MetaMask/core/pull/6535))
+  - Previously, `PhishingController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ## [14.1.0]
 
 ### Added

packages/phishing-controller/package.json

@@ -49,6 +49,7 @@
   "dependencies": {
     "@metamask/base-controller": "^8.4.0",
     "@metamask/controller-utils": "^11.14.0",
+    "@metamask/messenger": "^0.3.0",
     "@noble/hashes": "^1.8.0",
     "@types/punycode": "^2.1.0",
     "ethereum-cryptography": "^2.1.2",

packages/phishing-controller/src/PhishingController.test.ts

@@ -1,5 +1,11 @@
-import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
-import type { TransactionControllerStateChangeEvent } from '@metamask/transaction-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import { strict as assert } from 'assert';
 import nock, { cleanAll, isDone, pendingMocks } from 'nock';
 import sinon from 'sinon';
@@ -10,15 +16,14 @@ import {
   METAMASK_STALELIST_FILE,
   PhishingController,
   PHISHING_CONFIG_BASE_URL,
-  type PhishingControllerActions,
-  type PhishingControllerEvents,
   type PhishingControllerOptions,
   CLIENT_SIDE_DETECION_BASE_URL,
   C2_DOMAIN_BLOCKLIST_ENDPOINT,
   PHISHING_DETECTION_BASE_URL,
   PHISHING_DETECTION_SCAN_ENDPOINT,
   PHISHING_DETECTION_BULK_SCAN_ENDPOINT,
   type BulkPhishingDetectionScanResponse,
+  type PhishingControllerMessenger,
 } from './PhishingController';
 import {
   createMockStateChangePayload,
@@ -32,24 +37,58 @@ import { getHostnameFromUrl } from './utils';
 
 const controllerName = 'PhishingController';
 
+type AllPhishingControllerActions =
+  MessengerActions<PhishingControllerMessenger>;
+
+type AllPhishingControllerEvents = MessengerEvents<PhishingControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllPhishingControllerActions,
+  AllPhishingControllerEvents
+>;
+
 /**
- * Constructs a restricted messenger with transaction events enabled.
+ * Creates and returns a root messenger for testing
  *
- * @returns A restricted messenger that can listen to TransactionController events.
+ * @returns A messenger instance
  */
-function getRestrictedMessengerWithTransactionEvents() {
+function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+}
+
+/**
+ * Constructs a messenger for use in PhishingController tests.
+ *
+ * @returns A messenger and the root messenger.
+ */
+function setupMessenger(): {
+  messenger: PhishingControllerMessenger;
+  rootMessenger: RootMessenger;
+} {
+  const rootMessenger = getRootMessenger();
+
   const messenger = new Messenger<
-    PhishingControllerActions,
-    PhishingControllerEvents | TransactionControllerStateChangeEvent
-  >();
+    typeof controllerName,
+    AllPhishingControllerActions,
+    AllPhishingControllerEvents,
+    RootMessenger
+  >({
+    namespace: controllerName,
+    parent: rootMessenger,
+  });
+
+  messenger.delegate({
+    actions: [],
+    events: ['TransactionController:stateChange'],
+    messenger: rootMessenger,
+  });
 
   return {
-    messenger: messenger.getRestricted({
-      name: controllerName,
-      allowedActions: [],
-      allowedEvents: ['TransactionController:stateChange'],
-    }),
-    globalMessenger: messenger,
+    messenger,
+    rootMessenger,
   };
 }
 
@@ -60,8 +99,9 @@ function getRestrictedMessengerWithTransactionEvents() {
  * @returns The constructed Phishing Controller.
  */
 function getPhishingController(options?: Partial<PhishingControllerOptions>) {
+  const { messenger } = setupMessenger();
   return new PhishingController({
-    messenger: getRestrictedMessengerWithTransactionEvents().messenger,
+    messenger,
     ...options,
   });
 }
@@ -407,8 +447,9 @@ describe('PhishingController', () => {
     });
 
     it('replaces existing phishing lists with completely new list from phishing detection API', async () => {
+      const { messenger } = setupMessenger();
       const controller = new PhishingController({
-        messenger: getRestrictedMessengerWithTransactionEvents().messenger,
+        messenger,
         stalelistRefreshInterval: 10,
         state: {
           phishingLists: [
@@ -3495,7 +3536,7 @@ describe('URL Scan Cache', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });
@@ -3561,18 +3602,16 @@ describe('URL Scan Cache', () => {
 
   describe('Transaction Controller State Change Integration', () => {
     let controller: PhishingController;
-    let globalMessenger: Messenger<
-      PhishingControllerActions,
-      PhishingControllerEvents | TransactionControllerStateChangeEvent
-    >;
+    let globalMessenger: RootMessenger;
     let bulkScanTokensSpy: jest.SpyInstance;
 
     beforeEach(() => {
-      const messengerSetup = getRestrictedMessengerWithTransactionEvents();
-      globalMessenger = messengerSetup.globalMessenger;
+      const { messenger, rootMessenger } = setupMessenger();
+
+      globalMessenger = rootMessenger;
 
       controller = new PhishingController({
-        messenger: messengerSetup.messenger,
+        messenger,
       });
 
       bulkScanTokensSpy = jest

packages/phishing-controller/src/PhishingController.ts

@@ -1,14 +1,14 @@
-import type {
-  ControllerGetStateAction,
-  ControllerStateChangeEvent,
-  RestrictedMessenger,
-  StateMetadata,
-} from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+import {
+  BaseController,
+  type StateMetadata,
+  type ControllerGetStateAction,
+  type ControllerStateChangeEvent,
+} from '@metamask/base-controller/next';
 import {
   safelyExecute,
   safelyExecuteWithTimeout,
 } from '@metamask/controller-utils';
+import { type Messenger } from '@metamask/messenger';
 import type {
   TransactionControllerStateChangeEvent,
   TransactionMeta,
@@ -238,49 +238,49 @@ const metadata: StateMetadata<PhishingControllerState> = {
   phishingLists: {
     includeInStateLogs: false,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
   whitelist: {
     includeInStateLogs: false,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
   whitelistPaths: {
     includeInStateLogs: false,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
   hotlistLastFetched: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
   stalelistLastFetched: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
   c2DomainBlocklistLastFetched: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
   urlScanCache: {
     includeInStateLogs: false,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
   tokenScanCache: {
     includeInStateLogs: false,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
 };
@@ -399,12 +399,10 @@ type AllowedActions = never;
  */
 export type AllowedEvents = TransactionControllerStateChangeEvent;
 
-export type PhishingControllerMessenger = RestrictedMessenger<
+export type PhishingControllerMessenger = Messenger<
   typeof controllerName,
   PhishingControllerActions | AllowedActions,
-  PhishingControllerEvents | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  PhishingControllerEvents | AllowedEvents
 >;
 
 /**
@@ -521,7 +519,7 @@ export class PhishingController extends BaseController<
   }
 
   #subscribeToTransactionControllerStateChange() {
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'TransactionController:stateChange',
       this.#transactionControllerStateChangeHandler,
     );
@@ -532,22 +530,22 @@ export class PhishingController extends BaseController<
    * actions.
    */
   #registerMessageHandlers(): void {
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:maybeUpdateState` as const,
       this.maybeUpdateState.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:testOrigin` as const,
       this.test.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:bulkScanUrls` as const,
       this.bulkScanUrls.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:bulkScanTokens` as const,
       this.bulkScanTokens.bind(this),
     );

packages/phishing-controller/tsconfig.build.json

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

packages/phishing-controller/tsconfig.json

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

yarn.lock

@@ -4212,6 +4212,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.0"
     "@metamask/controller-utils": "npm:^11.14.0"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/transaction-controller": "npm:^60.6.0"
     "@noble/hashes": "npm:^1.8.0"
     "@types/jest": "npm:^27.4.1"