refactor: migrate PermissionLogController to @metamask/messenger

Author: cryptodev-2s

packages/permission-log-controller/CHANGELOG.md

@@ -10,9 +10,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6525](https://github.com/MetaMask/core/pull/6525))
+- Export new Messenger action/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`.
 - Bump `@metamask/utils` from `^11.4.2` to `^11.8.1` ([#6588](https://github.com/MetaMask/core/pull/6588), [#6708](https://github.com/MetaMask/core/pull/6708))
 - Bump `@metamask/base-controller` from `^8.0.1` to `^8.4.0` ([#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465), [#6632](https://github.com/MetaMask/core/pull/6632))
 - Bump `@metamask/json-rpc-engine` from `^10.0.3` to `^10.1.0` ([#6678](https://github.com/MetaMask/core/pull/6678))

packages/permission-log-controller/package.json

@@ -49,6 +49,7 @@
   "dependencies": {
     "@metamask/base-controller": "^8.4.0",
     "@metamask/json-rpc-engine": "^10.1.0",
+    "@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 {}`);
     });

yarn.lock

@@ -4176,6 +4176,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.0"
     "@metamask/json-rpc-engine": "npm:^10.1.0"
+    "@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"