refactor: migrate PhishingController to @metamask/messenger (#6535)

## 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 `PhishingController` 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 `PhishingController` to use `@metamask/messenger` and renames
metadata field `anonymous` to `includeInDebugSnapshot`.
> 
> - **Breaking Changes**
> - Migrate `PhishingController` to `@metamask/messenger` `Messenger`
(replaces `RestrictedMessenger` from `@metamask/base-controller`).
>   - Rename metadata property `anonymous` to `includeInDebugSnapshot`.
> - **Controller**
(`packages/phishing-controller/src/PhishingController.ts`):
> - Switch imports to `@metamask/base-controller/next` and
`@metamask/messenger`.
> - Replace `messagingSystem` calls with
`messenger.registerActionHandler`/`messenger.subscribe`.
>   - Update `PhishingControllerMessenger` type to use `Messenger<...>`.
> - **Tests**:
> - Update test harness to create root/child messengers via
`@metamask/messenger` and delegate `TransactionController:stateChange`.
> - Use `deriveStateFromMetadata` from `@metamask/base-controller/next`
and expect `includeInDebugSnapshot`.
> - **Package/Build**:
> - Add dependency `@metamask/messenger` and tsconfig references to
`packages/messenger`.
> - Update README dependency graph to show `phishing_controller -->
messenger` and include `@metamask/messenger` in package list.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
c2988bb. 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

@@ -305,6 +305,7 @@ linkStyle default opacity:0.5
   permission_log_controller --> json_rpc_engine;
   phishing_controller --> base_controller;
   phishing_controller --> controller_utils;
+  phishing_controller --> messenger;
   phishing_controller --> transaction_controller;
   polling_controller --> base_controller;
   polling_controller --> controller_utils;

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

packages/phishing-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",
     "@noble/hashes": "^1.8.0",
     "@types/punycode": "^2.1.0",
     "ethereum-cryptography": "^2.1.2",

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

@@ -1,13 +1,17 @@
-import { Messenger } from '@metamask/base-controller';
 import { safelyExecuteWithTimeout } from '@metamask/controller-utils';
-import type { TransactionControllerStateChangeEvent } from '@metamask/transaction-controller';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import nock, { cleanAll } from 'nock';
 import sinon from 'sinon';
 
-import type { PhishingControllerEvents } from './PhishingController';
+import type { PhishingControllerMessenger } from './PhishingController';
 import {
   PhishingController,
-  type PhishingControllerActions,
   type PhishingControllerOptions,
   SECURITY_ALERTS_BASE_URL,
   TOKEN_BULK_SCANNING_ENDPOINT,
@@ -30,24 +34,55 @@ const mockSafelyExecuteWithTimeout =
 
 const controllerName = 'PhishingController';
 
+type AllPhishingControllerActions =
+  MessengerActions<PhishingControllerMessenger>;
+
+type AllPhishingControllerEvents = MessengerEvents<PhishingControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllPhishingControllerActions,
+  AllPhishingControllerEvents,
+  RootMessenger
+>;
+
+/**
+ * Creates and returns a root messenger for testing
+ *
+ * @returns A messenger instance
+ */
+function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+}
+
 /**
- * Constructs a restricted messenger with transaction events enabled.
+ * Constructs a messenger with transaction events enabled.
  *
  * @returns A restricted messenger that can listen to TransactionController events.
  */
-function getRestrictedMessengerWithTransactionEvents() {
+function getMessengerWithTransactionEvents() {
+  const rootMessenger = getRootMessenger();
+
   const messenger = new Messenger<
-    PhishingControllerActions,
-    PhishingControllerEvents | TransactionControllerStateChangeEvent
-  >();
+    typeof controllerName,
+    AllPhishingControllerActions,
+    AllPhishingControllerEvents,
+    RootMessenger
+  >({
+    namespace: controllerName,
+    parent: rootMessenger,
+  });
+
+  rootMessenger.delegate({
+    actions: [],
+    events: ['TransactionController:stateChange'],
+    messenger,
+  });
 
   return {
-    messenger: messenger.getRestricted({
-      name: controllerName,
-      allowedActions: [],
-      allowedEvents: ['TransactionController:stateChange'],
-    }),
-    globalMessenger: messenger,
+    messenger,
   };
 }
 
@@ -59,7 +94,7 @@ function getRestrictedMessengerWithTransactionEvents() {
  */
 function getPhishingController(options?: Partial<PhishingControllerOptions>) {
   return new PhishingController({
-    messenger: getRestrictedMessengerWithTransactionEvents().messenger,
+    messenger: getMessengerWithTransactionEvents().messenger,
     ...options,
   });
 }

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,59 @@ import { getHostnameFromUrl } from './utils';
 
 const controllerName = 'PhishingController';
 
+type AllPhishingControllerActions =
+  MessengerActions<PhishingControllerMessenger>;
+
+type AllPhishingControllerEvents = MessengerEvents<PhishingControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllPhishingControllerActions,
+  AllPhishingControllerEvents,
+  RootMessenger
+>;
+
 /**
- * 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,
+  });
+
+  rootMessenger.delegate({
+    actions: [],
+    events: ['TransactionController:stateChange'],
+    messenger,
+  });
 
   return {
-    messenger: messenger.getRestricted({
-      name: controllerName,
-      allowedActions: [],
-      allowedEvents: ['TransactionController:stateChange'],
-    }),
-    globalMessenger: messenger,
+    messenger,
+    rootMessenger,
   };
 }
 
@@ -60,8 +100,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 +448,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 +3537,7 @@ describe('URL Scan Cache', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });
@@ -3561,18 +3603,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