refactor: migrate {AbstractMessage,DecryptMessage,EncryptionPublicKey}Manager to @metamask/messenger (#6545)

## 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 `AbstractMessageManager`, `EncryptionPublicKeyManager`
and `DecryptMessageManager` 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 `AbstractMessageManager`, `DecryptMessageManager`, and
`EncryptionPublicKeyManager` to the new `@metamask/messenger` API,
updating types/events and wiring, and adds the messenger dependency.
> 
> - **Message Manager (breaking)**
> - Switch from `RestrictedMessenger` (`@metamask/base-controller`) to
`Messenger` (`@metamask/messenger`) across `AbstractMessageManager`,
`DecryptMessageManager`, and `EncryptionPublicKeyManager`.
> - Update publish calls to use `this.messenger.publish` and rework
action/event typings (`ControllerGetStateAction`,
`ControllerStateChangeEvent`).
> - Adjust state metadata keys (`anonymous` → `includeInDebugSnapshot`).
> - **Tests**
>   - Update mocks and types to use `Messenger` and new metadata flag.
> - **Configs/Dependencies**
> - Add `@metamask/messenger` dependency and TypeScript project
references.
> - Update README dependency graph to show `message_manager` →
`messenger` and add new edge for `eip-7702-internal-rpc-middleware`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
c9835ae. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Michele Esposito <[email protected]>
Co-authored-by: Michele Esposito <[email protected]>

Author: cryptodev-2s

README.md

@@ -256,6 +256,7 @@ linkStyle default opacity:0.5
   logging_controller --> controller_utils;
   message_manager --> base_controller;
   message_manager --> controller_utils;
+  message_manager --> messenger;
   multichain_account_service --> base_controller;
   multichain_account_service --> accounts_controller;
   multichain_account_service --> keyring_controller;

packages/message-manager/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` ([#6545](https://github.com/MetaMask/core/pull/6545))
+  - Previously, `AbstractMessageManager`, `DecryptMessageManager` and `EncryptionPublicKeyManager` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ## [13.0.2]
 
 ### Changed

packages/message-manager/package.json

@@ -50,6 +50,7 @@
     "@metamask/base-controller": "^8.4.2",
     "@metamask/controller-utils": "^11.14.1",
     "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/utils": "^11.8.1",
     "@types/uuid": "^8.3.0",
     "jsonschema": "^1.4.1",

packages/message-manager/src/AbstractMessageManager.test.ts

@@ -1,16 +1,19 @@
 import {
   deriveStateFromMetadata,
-  type RestrictedMessenger,
-} from '@metamask/base-controller';
+  type ControllerGetStateAction,
+  type ControllerStateChangeEvent,
+} from '@metamask/base-controller/next';
 import { ApprovalType } from '@metamask/controller-utils';
+import type { Messenger } from '@metamask/messenger';
 
-import type {
-  AbstractMessage,
-  AbstractMessageParams,
-  OriginalRequest,
-  SecurityProviderRequest,
+import {
+  AbstractMessageManager,
+  type AbstractMessage,
+  type AbstractMessageParams,
+  type MessageManagerState,
+  type OriginalRequest,
+  type SecurityProviderRequest,
 } from './AbstractMessageManager';
-import { AbstractMessageManager } from './AbstractMessageManager';
 
 type ConcreteMessage = AbstractMessage & {
   messageParams: ConcreteMessageParams;
@@ -24,16 +27,26 @@ type ConcreteMessageParamsMetamask = ConcreteMessageParams & {
   metamaskId?: string;
 };
 
-type ConcreteMessageManagerActions = never;
-type ConcreteMessageManagerEvents = never;
+type ConcreteMessageManagerActions = ControllerGetStateAction<
+  'TestManager',
+  MessageManagerState<ConcreteMessage>
+>;
+type ConcreteMessageManagerEvents = ControllerStateChangeEvent<
+  'TestManager',
+  MessageManagerState<ConcreteMessage>
+>;
+type ConcreteMessageManagerMessenger = Messenger<
+  'TestManager',
+  ConcreteMessageManagerActions,
+  ConcreteMessageManagerEvents
+>;
 
 class AbstractTestManager extends AbstractMessageManager<
   'TestManager',
   ConcreteMessage,
   ConcreteMessageParams,
   ConcreteMessageParamsMetamask,
-  ConcreteMessageManagerActions,
-  ConcreteMessageManagerEvents
+  ConcreteMessageManagerMessenger
 > {
   addRequestToMessageParams<MessageParams extends AbstractMessageParams>(
     messageParams: MessageParams,
@@ -71,13 +84,7 @@ const MOCK_MESSENGER = {
   publish: jest.fn(),
   registerActionHandler: jest.fn(),
   registerInitialEventPayload: jest.fn(),
-} as unknown as RestrictedMessenger<
-  'TestManager',
-  never,
-  never,
-  string,
-  string
->;
+} as unknown as Messenger<'TestManager'>;
 
 const MOCK_INITIAL_OPTIONS = {
   additionalFinishStatuses: undefined,
@@ -579,7 +586,7 @@ describe('AbstractTestManager', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });

packages/message-manager/src/AbstractMessageManager.ts

@@ -1,10 +1,14 @@
-import { BaseController } from '@metamask/base-controller';
+import {
+  BaseController,
+  type ControllerStateChangeEvent,
+  type ControllerGetStateAction,
+} from '@metamask/base-controller/next';
+import type { ApprovalType } from '@metamask/controller-utils';
 import type {
-  ActionConstraint,
+  Messenger,
   EventConstraint,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
-import type { ApprovalType } from '@metamask/controller-utils';
+  ActionConstraint,
+} from '@metamask/messenger';
 import type { Json } from '@metamask/utils';
 // This package purposefully relies on Node's EventEmitter module.
 // eslint-disable-next-line import-x/no-nodejs-modules
@@ -16,13 +20,13 @@ const stateMetadata = {
   unapprovedMessages: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
   unapprovedMessagesCount: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
 };
@@ -133,17 +137,17 @@ export type SecurityProviderRequest = (
 export type AbstractMessageManagerOptions<
   Name extends string,
   Message extends AbstractMessage,
-  Action extends ActionConstraint,
-  Event extends EventConstraint,
+  MessageManagerMessenger extends Messenger<
+    Name,
+    | ControllerGetStateAction<Name, MessageManagerState<Message>>
+    | ActionConstraint,
+    | ControllerStateChangeEvent<Name, MessageManagerState<Message>>
+    | UpdateBadgeEvent<Name>
+    | EventConstraint
+  >,
 > = {
   additionalFinishStatuses?: string[];
-  messenger: RestrictedMessenger<
-    Name,
-    Action,
-    Event | UpdateBadgeEvent<Name>,
-    string,
-    string
-  >;
+  messenger: MessageManagerMessenger;
   name: Name;
   securityProviderRequest?: SecurityProviderRequest;
   state?: MessageManagerState<Message>;
@@ -157,18 +161,18 @@ export abstract class AbstractMessageManager<
   Message extends AbstractMessage,
   Params extends AbstractMessageParams,
   ParamsMetamask extends AbstractMessageParamsMetamask,
-  Action extends ActionConstraint,
-  Event extends EventConstraint,
+  MessageManagerMessenger extends Messenger<
+    Name,
+    | ControllerGetStateAction<Name, MessageManagerState<Message>>
+    | ActionConstraint,
+    | ControllerStateChangeEvent<Name, MessageManagerState<Message>>
+    | UpdateBadgeEvent<Name>
+    | EventConstraint
+  >,
 > extends BaseController<
   Name,
   MessageManagerState<Message>,
-  RestrictedMessenger<
-    Name,
-    Action,
-    Event | UpdateBadgeEvent<Name>,
-    string,
-    string
-  >
+  MessageManagerMessenger
 > {
   protected messages: Message[];
 
@@ -184,7 +188,7 @@ export abstract class AbstractMessageManager<
     name,
     securityProviderRequest,
     state = {} as MessageManagerState<Message>,
-  }: AbstractMessageManagerOptions<Name, Message, Action, Event>) {
+  }: AbstractMessageManagerOptions<Name, Message, MessageManagerMessenger>) {
     super({
       messenger,
       metadata: stateMetadata,
@@ -200,7 +204,7 @@ export abstract class AbstractMessageManager<
   }
 
   /**
-   * Adds request props to the messsage params and returns a new messageParams object.
+   * Adds request props to the message params and returns a new messageParams object.
    * @param messageParams - The messageParams to add the request props to.
    * @param req - The original request object.
    * @returns The messageParams with the request props added.
@@ -257,7 +261,7 @@ export abstract class AbstractMessageManager<
       state.unapprovedMessagesCount = this.getUnapprovedMessagesCount();
     });
     if (emitUpdateBadge) {
-      this.messagingSystem.publish(`${this.name}:updateBadge`);
+      this.messenger.publish(`${this.name}:updateBadge` as const);
     }
   }
 

packages/message-manager/src/DecryptMessageManager.ts

@@ -1,9 +1,10 @@
 import type {
-  ActionConstraint,
-  EventConstraint,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
+  ControllerGetStateAction,
+  ControllerStateChangeEvent,
+} from '@metamask/base-controller/next';
 import { ApprovalType } from '@metamask/controller-utils';
+import type { Messenger } from '@metamask/messenger';
+import {} from '@metamask/messenger';
 
 import type {
   AbstractMessage,
@@ -30,14 +31,20 @@ export type DecryptMessageManagerUpdateBadgeEvent = {
   payload: [];
 };
 
-export type DecryptMessageManagerMessenger = RestrictedMessenger<
+type DecryptMessageManagerActions = ControllerGetStateAction<
   typeof managerName,
-  ActionConstraint,
-  | EventConstraint
+  DecryptMessageManagerState
+>;
+
+type DecryptMessageManagerEvents =
+  | ControllerStateChangeEvent<typeof managerName, DecryptMessageManagerState>
   | DecryptMessageManagerUnapprovedMessageAddedEvent
-  | DecryptMessageManagerUpdateBadgeEvent,
-  string,
-  string
+  | DecryptMessageManagerUpdateBadgeEvent;
+
+export type DecryptMessageManagerMessenger = Messenger<
+  typeof managerName,
+  DecryptMessageManagerActions,
+  DecryptMessageManagerEvents
 >;
 
 type DecryptMessageManagerOptions = {
@@ -97,10 +104,7 @@ export class DecryptMessageManager extends AbstractMessageManager<
   DecryptMessage,
   DecryptMessageParams,
   DecryptMessageParamsMetamask,
-  ActionConstraint,
-  | EventConstraint
-  | DecryptMessageManagerUnapprovedMessageAddedEvent
-  | DecryptMessageManagerUpdateBadgeEvent
+  DecryptMessageManagerMessenger
 > {
   constructor({
     additionalFinishStatuses,
@@ -194,7 +198,7 @@ export class DecryptMessageManager extends AbstractMessageManager<
     const messageId = messageData.id;
 
     await this.addMessage(messageData);
-    this.messagingSystem.publish(`${managerName}:unapprovedMessage`, {
+    this.messenger.publish(`${managerName}:unapprovedMessage`, {
       ...updatedMessageParams,
       metamaskId: messageId,
     });

packages/message-manager/src/EncryptionPublicKeyManager.ts

@@ -1,9 +1,9 @@
 import type {
-  ActionConstraint,
-  EventConstraint,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
+  ControllerGetStateAction,
+  ControllerStateChangeEvent,
+} from '@metamask/base-controller/next';
 import { ApprovalType } from '@metamask/controller-utils';
+import type { Messenger } from '@metamask/messenger';
 
 import type {
   AbstractMessage,
@@ -31,14 +31,23 @@ export type EncryptionPublicKeyManagerUpdateBadgeEvent = {
   payload: [];
 };
 
-export type EncryptionPublicKeyManagerMessenger = RestrictedMessenger<
+type EncryptionPublicKeyManagerActions = ControllerGetStateAction<
   typeof managerName,
-  ActionConstraint,
-  | EventConstraint
+  EncryptionPublicKeyManagerState
+>;
+
+type EncryptionPublicKeyManagerEvents =
+  | ControllerStateChangeEvent<
+      typeof managerName,
+      EncryptionPublicKeyManagerState
+    >
   | EncryptionPublicKeyManagerUnapprovedMessageAddedEvent
-  | EncryptionPublicKeyManagerUpdateBadgeEvent,
-  string,
-  string
+  | EncryptionPublicKeyManagerUpdateBadgeEvent;
+
+export type EncryptionPublicKeyManagerMessenger = Messenger<
+  typeof managerName,
+  EncryptionPublicKeyManagerActions,
+  EncryptionPublicKeyManagerEvents
 >;
 
 type EncryptionPublicKeyManagerOptions = {
@@ -95,10 +104,7 @@ export class EncryptionPublicKeyManager extends AbstractMessageManager<
   EncryptionPublicKey,
   EncryptionPublicKeyParams,
   EncryptionPublicKeyParamsMetamask,
-  ActionConstraint,
-  | EventConstraint
-  | EncryptionPublicKeyManagerUnapprovedMessageAddedEvent
-  | EncryptionPublicKeyManagerUpdateBadgeEvent
+  EncryptionPublicKeyManagerMessenger
 > {
   constructor({
     additionalFinishStatuses,
@@ -185,7 +191,7 @@ export class EncryptionPublicKeyManager extends AbstractMessageManager<
     const messageId = messageData.id;
 
     await this.addMessage(messageData);
-    this.messagingSystem.publish(`${this.name}:unapprovedMessage`, {
+    this.messenger.publish(`${this.name}:unapprovedMessage` as const, {
       ...updatedMessageParams,
       metamaskId: messageId,
     });

packages/message-manager/tsconfig.build.json

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

packages/message-manager/tsconfig.json

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

yarn.lock

@@ -4034,6 +4034,7 @@ __metadata:
     "@metamask/base-controller": "npm:^8.4.2"
     "@metamask/controller-utils": "npm:^11.14.1"
     "@metamask/eth-sig-util": "npm:^8.2.0"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/utils": "npm:^11.8.1"
     "@types/jest": "npm:^27.4.1"
     "@types/uuid": "npm:^8.3.0"