refactor: migrate LoggingController to @metamask/messenger (#6463)

## 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 `LoggingController` 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 `LoggingController` to `@metamask/messenger`, renames
metadata key `anonymous` to `includeInDebugSnapshot`, and updates
tests/configs accordingly.
> 
> - **Logging Controller**
> - Migrate to `@metamask/messenger` and
`@metamask/base-controller/next`; register actions via
`messenger.registerActionHandler`.
> - Update `metadata`: replace `anonymous` with `includeInDebugSnapshot`
and type with `StateMetadata`.
> - Update `type` aliases to use `Messenger` instead of
`RestrictedMessenger`.
> - Add dependency `@metamask/messenger@^0.3.0` and TS project
references.
> - Changelog: mark BREAKING changes for messenger migration and
metadata key rename.
> - **Tests**
> - Rewrite messenger setup using root/child `Messenger` from
`@metamask/messenger` and update imports from
`@metamask/base-controller/next`.
>   - Adjust calls to `LoggingController:add` via root messenger.
> - **Repo Docs/Graph**
> - Dependency graph: add `logging_controller --> messenger`; add
`eip_7702_internal_rpc_middleware --> controller_utils`.
> - **Lockfile**
>   - Update for new `@metamask/messenger` dependency.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
28d9e41. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: mikesposito

README.md

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

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

packages/logging-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",
     "uuid": "^8.3.2"
   },
   "devDependencies": {

packages/logging-controller/src/LoggingController.test.ts

@@ -1,7 +1,14 @@
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import * as uuid from 'uuid';
 
-import type { LoggingControllerActions } from './LoggingController';
+import type { LoggingControllerMessenger } from './LoggingController';
 import { LoggingController } from './LoggingController';
 import { LogType } from './logTypes';
 import { SigningMethod, SigningStage } from './logTypes/EthSignLog';
@@ -15,44 +22,56 @@ jest.mock('uuid', () => {
   };
 });
 
-const name = 'LoggingController';
+type AllLoggingControllerActions = MessengerActions<LoggingControllerMessenger>;
+
+type AllLoggingControllerEvents = MessengerEvents<LoggingControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllLoggingControllerActions,
+  AllLoggingControllerEvents
+>;
+
+const namespace = 'LoggingController';
 
 /**
- * Constructs a unrestricted messenger.
+ * Constructs a root messenger instance.
  *
- * @returns A unrestricted messenger.
+ * @returns A root messenger.
  */
-function getUnrestrictedMessenger() {
-  return new Messenger<LoggingControllerActions, never>();
+function getRootMessenger(): RootMessenger {
+  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
 }
 
 /**
- * Constructs a restricted messenger.
+ * Constructs a messenger instance for LoggingController.
  *
- * @param messenger - An optional unrestricted messenger
- * @returns A restricted messenger.
+ * @param messenger - An optional root messenger
+ * @returns A controller messenger.
  */
-function getRestrictedMessenger(messenger = getUnrestrictedMessenger()) {
-  return messenger.getRestricted({
-    name,
-    allowedActions: [],
-    allowedEvents: [],
+function getLoggingControllerMessenger(messenger = getRootMessenger()) {
+  return new Messenger<
+    typeof namespace,
+    AllLoggingControllerActions,
+    AllLoggingControllerEvents,
+    RootMessenger
+  >({
+    namespace,
+    parent: messenger,
   });
 }
 
 describe('LoggingController', () => {
   it('action: LoggingController:add with generic log', async () => {
-    const unrestricted = getUnrestrictedMessenger();
-    const messenger = getRestrictedMessenger(unrestricted);
+    const rootMessenger = getRootMessenger();
+    const messenger = getLoggingControllerMessenger(rootMessenger);
 
     const controller = new LoggingController({
       messenger,
     });
 
     expect(
-      // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      await unrestricted.call('LoggingController:add', {
+      rootMessenger.call('LoggingController:add', {
         type: LogType.GenericLog,
         data: `Generic log`,
       }),
@@ -70,17 +89,15 @@ describe('LoggingController', () => {
   });
 
   it('action: LoggingController:add for a signing request', async () => {
-    const unrestricted = getUnrestrictedMessenger();
-    const messenger = getRestrictedMessenger(unrestricted);
+    const rootMessenger = getRootMessenger();
+    const messenger = getLoggingControllerMessenger(rootMessenger);
 
     const controller = new LoggingController({
       messenger,
     });
 
     expect(
-      // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      await unrestricted.call('LoggingController:add', {
+      rootMessenger.call('LoggingController:add', {
         type: LogType.EthSignLog,
         data: {
           signingMethod: SigningMethod.PersonalSign,
@@ -106,18 +123,16 @@ describe('LoggingController', () => {
   });
 
   it('action: LoggingController:add prevents possible collision of ids', async () => {
-    const unrestricted = getUnrestrictedMessenger();
-    const messenger = getRestrictedMessenger(unrestricted);
+    const rootMessenger = getRootMessenger();
+    const messenger = getLoggingControllerMessenger(rootMessenger);
     const uuidV1Spy = jest.spyOn(uuid, 'v1');
 
     const controller = new LoggingController({
       messenger,
     });
 
     expect(
-      // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      await unrestricted.call('LoggingController:add', {
+      rootMessenger.call('LoggingController:add', {
         type: LogType.GenericLog,
         data: `Generic log`,
       }),
@@ -128,9 +143,7 @@ describe('LoggingController', () => {
     uuidV1Spy.mockReturnValueOnce(id);
 
     expect(
-      // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      await unrestricted.call('LoggingController:add', {
+      rootMessenger.call('LoggingController:add', {
         type: LogType.GenericLog,
         data: `Generic log 2`,
       }),
@@ -159,17 +172,15 @@ describe('LoggingController', () => {
   });
 
   it('internal method: clear', async () => {
-    const unrestricted = getUnrestrictedMessenger();
-    const messenger = getRestrictedMessenger(unrestricted);
+    const rootMessenger = getRootMessenger();
+    const messenger = getLoggingControllerMessenger(rootMessenger);
 
     const controller = new LoggingController({
       messenger,
     });
 
     expect(
-      // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      await unrestricted.call('LoggingController:add', {
+      rootMessenger.call('LoggingController:add', {
         type: LogType.EthSignLog,
         data: {
           signingMethod: SigningMethod.PersonalSign,
@@ -186,8 +197,8 @@ describe('LoggingController', () => {
 
   describe('metadata', () => {
     it('includes expected state in debug snapshots', () => {
-      const unrestricted = getUnrestrictedMessenger();
-      const messenger = getRestrictedMessenger(unrestricted);
+      const rootMessenger = getRootMessenger();
+      const messenger = getLoggingControllerMessenger(rootMessenger);
       const controller = new LoggingController({
         messenger,
       });
@@ -196,14 +207,14 @@ describe('LoggingController', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });
 
     it('includes expected state in state logs', () => {
-      const unrestricted = getUnrestrictedMessenger();
-      const messenger = getRestrictedMessenger(unrestricted);
+      const rootMessenger = getRootMessenger();
+      const messenger = getLoggingControllerMessenger(rootMessenger);
       const controller = new LoggingController({
         messenger,
       });
@@ -222,8 +233,8 @@ describe('LoggingController', () => {
     });
 
     it('persists expected state', () => {
-      const unrestricted = getUnrestrictedMessenger();
-      const messenger = getRestrictedMessenger(unrestricted);
+      const rootMessenger = getRootMessenger();
+      const messenger = getLoggingControllerMessenger(rootMessenger);
       const controller = new LoggingController({
         messenger,
       });
@@ -242,8 +253,8 @@ describe('LoggingController', () => {
     });
 
     it('exposes expected state to UI', () => {
-      const unrestricted = getUnrestrictedMessenger();
-      const messenger = getRestrictedMessenger(unrestricted);
+      const rootMessenger = getRootMessenger();
+      const messenger = getLoggingControllerMessenger(rootMessenger);
       const controller = new LoggingController({
         messenger,
       });

packages/logging-controller/src/LoggingController.ts

@@ -1,9 +1,10 @@
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+  StateMetadata,
+} from '@metamask/base-controller/next';
+import { BaseController } from '@metamask/base-controller/next';
+import type { Messenger } from '@metamask/messenger';
 import { v1 as random } from 'uuid';
 
 import type { Log } from './logTypes';
@@ -54,19 +55,17 @@ export type LoggingControllerStateChangeEvent = ControllerStateChangeEvent<
 
 export type LoggingControllerEvents = LoggingControllerStateChangeEvent;
 
-export type LoggingControllerMessenger = RestrictedMessenger<
+export type LoggingControllerMessenger = Messenger<
   typeof name,
   LoggingControllerActions,
-  LoggingControllerEvents,
-  never,
-  never
+  LoggingControllerEvents
 >;
 
-const metadata = {
+const metadata: StateMetadata<LoggingControllerState> = {
   logs: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
 };
@@ -107,9 +106,8 @@ export class LoggingController extends BaseController<
       },
     });
 
-    this.messagingSystem.registerActionHandler(
-      `${name}:add` as const,
-      (log: Log) => this.add(log),
+    this.messenger.registerActionHandler(`${name}:add` as const, (log: Log) =>
+      this.add(log),
     );
   }
 

packages/logging-controller/tsconfig.build.json

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

packages/logging-controller/tsconfig.json

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

yarn.lock

@@ -4017,6 +4017,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.2"
     "@metamask/controller-utils": "npm:^11.14.1"
+    "@metamask/messenger": "npm:^0.3.0"
     "@types/jest": "npm:^27.4.1"
     deepmerge: "npm:^4.2.2"
     jest: "npm:^27.5.1"