refactor: migrate PermissionLogController to @metamask/messenger (#6536)

## 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 `PermissionLogController` 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 PermissionLogController to @metamask/messenger, updates
types/metadata and exports, adapts tests, and updates configs/changelog.
> 
> - **PermissionLogController**:
> - Migrate to `@metamask/messenger` `Messenger`; use
`@metamask/base-controller/next` types (`ControllerGetStateAction`,
`ControllerStateChangeEvent`).
> - Define and export `PermissionLogControllerMessenger`,
`PermissionLogControllerActions`,
`PermissionLogControllerGetStateAction`,
`PermissionLogControllerEvents`,
`PermissionLogControllerStateChangeEvent`.
>   - Rename metadata `anonymous` to `includeInDebugSnapshot`.
>   - Switch `index` to named exports and re-export new types.
> - **Tests**:
> - Update to construct root/child messengers from `@metamask/messenger`
and use `deriveStateFromMetadata` from `@metamask/base-controller/next`.
> - **Package/Config**:
> - Add dependency `@metamask/messenger@^0.3.0`; add TS project
references to `packages/messenger`.
> - Changelog: note BREAKING migration to new `Messenger` and metadata
rename; document new exported types.
> - **Docs**:
> - README dependency graph: add `permission_log_controller -->
messenger`; minor graph tweak for `eip_7702_internal_rpc_middleware`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
2c60018. 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: Maarten Zuidhoorn <[email protected]>

Author: 3 people

README.md

@@ -310,6 +310,7 @@ linkStyle default opacity:0.5
   permission_controller --> approval_controller;
   permission_log_controller --> base_controller;
   permission_log_controller --> json_rpc_engine;
+  permission_log_controller --> messenger;
   phishing_controller --> base_controller;
   phishing_controller --> controller_utils;
   phishing_controller --> messenger;

packages/permission-log-controller/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Export new messenger action and event types: `PermissionLogControllerActions`, `PermissionLogControllerGetStateAction`, `PermissionLogControllerEvents`, and `PermissionLogControllerStateChangeEvent` ([#6536](https://github.com/MetaMask/core/pull/6536))
+
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6536](https://github.com/MetaMask/core/pull/6536))
+  - Previously, `PermissionLogController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#6536](https://github.com/MetaMask/core/pull/6536))
+
 ## [4.1.1]
 
 ### Changed

packages/permission-log-controller/package.json

@@ -49,6 +49,7 @@
   "dependencies": {
     "@metamask/base-controller": "^8.4.2",
     "@metamask/json-rpc-engine": "^10.1.1",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/utils": "^11.8.1"
   },
   "devDependencies": {

packages/permission-log-controller/src/PermissionLogController.ts

@@ -1,8 +1,10 @@
 import {
   BaseController,
-  type RestrictedMessenger,
-} from '@metamask/base-controller';
+  type ControllerGetStateAction,
+  type ControllerStateChangeEvent,
+} from '@metamask/base-controller/next';
 import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import type { Messenger } from '@metamask/messenger';
 import {
   type Json,
   type JsonRpcRequest,
@@ -70,12 +72,24 @@ export type PermissionLogControllerOptions = {
   messenger: PermissionLogControllerMessenger;
 };
 
-export type PermissionLogControllerMessenger = RestrictedMessenger<
+export type PermissionLogControllerGetStateAction = ControllerGetStateAction<
   typeof name,
-  never,
-  never,
-  never,
-  never
+  PermissionLogControllerState
+>;
+
+export type PermissionLogControllerActions =
+  PermissionLogControllerGetStateAction;
+
+export type PermissionLogControllerStateChangeEvent =
+  ControllerStateChangeEvent<typeof name, PermissionLogControllerState>;
+
+export type PermissionLogControllerEvents =
+  PermissionLogControllerStateChangeEvent;
+
+export type PermissionLogControllerMessenger = Messenger<
+  typeof name,
+  PermissionLogControllerActions,
+  PermissionLogControllerEvents
 >;
 
 const defaultState: PermissionLogControllerState = {
@@ -108,13 +122,13 @@ export class PermissionLogController extends BaseController<
         permissionHistory: {
           includeInStateLogs: true,
           persist: true,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: true,
         },
         permissionActivityLog: {
           includeInStateLogs: true,
           persist: false,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: false,
         },
       },

packages/permission-log-controller/src/index.ts

@@ -1 +1,17 @@
-export * from './PermissionLogController';
+export { PermissionLogController } from './PermissionLogController';
+export type {
+  JsonRpcRequestWithOrigin,
+  Caveat,
+  Permission,
+  PermissionActivityLog,
+  PermissionLog,
+  PermissionEntry,
+  PermissionHistory,
+  PermissionLogControllerActions,
+  PermissionLogControllerGetStateAction,
+  PermissionLogControllerStateChangeEvent,
+  PermissionLogControllerEvents,
+  PermissionLogControllerMessenger,
+  PermissionLogControllerState,
+  PermissionLogControllerOptions,
+} from './PermissionLogController';

packages/permission-log-controller/tests/PermissionLogController.test.ts

@@ -1,8 +1,15 @@
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import type {
   JsonRpcEngineReturnHandler,
   JsonRpcEngineNextCallback,
 } from '@metamask/json-rpc-engine';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import {
   type PendingJsonRpcResponse,
   type JsonRpcRequest,
@@ -13,9 +20,10 @@ import { nanoid } from 'nanoid';
 import { constants, getters, noop } from './helpers';
 import { LOG_LIMIT, LOG_METHOD_TYPES } from '../src/enums';
 import {
+  PermissionLogController,
   type Permission,
   type PermissionLogControllerState,
-  PermissionLogController,
+  type PermissionLogControllerMessenger,
 } from '../src/PermissionLogController';
 
 const { PERMS, RPC_REQUESTS } = getters;
@@ -33,17 +41,45 @@ class CustomError extends Error {
 
 const name = 'PermissionLogController';
 
+type AllPermissionLogControllerActions =
+  MessengerActions<PermissionLogControllerMessenger>;
+
+type AllPermissionLogControllerEvents =
+  MessengerEvents<PermissionLogControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllPermissionLogControllerActions,
+  AllPermissionLogControllerEvents
+>;
+
+/**
+ * Creates and returns a root messenger for testing
+ *
+ * @returns A messenger instance
+ */
+function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+}
+
 const initController = ({
   restrictedMethods,
   state,
 }: {
   restrictedMethods: Set<string>;
   state?: Partial<PermissionLogControllerState>;
 }): PermissionLogController => {
-  const messenger = new Messenger().getRestricted({
-    name,
-    allowedActions: [],
-    allowedEvents: [],
+  const rootMessenger = getRootMessenger();
+  const messenger = new Messenger<
+    typeof name,
+    AllPermissionLogControllerActions,
+    AllPermissionLogControllerEvents,
+    RootMessenger
+  >({
+    namespace: name,
+    parent: rootMessenger,
   });
   return new PermissionLogController({
     messenger,
@@ -824,7 +860,7 @@ describe('PermissionLogController', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });

packages/permission-log-controller/tsconfig.build.json

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

packages/permission-log-controller/tsconfig.json

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

yarn.lock

@@ -4433,6 +4433,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.2"
     "@metamask/json-rpc-engine": "npm:^10.1.1"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/utils": "npm:^11.8.1"
     "@types/deep-freeze-strict": "npm:^1.1.0"
     "@types/jest": "npm:^27.4.1"