refactor: migrate {Permission,SubjectMetadata}Controller to @metamask/messenger

Author: cryptodev-2s

packages/permission-controller/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6537](https://github.com/MetaMask/core/pull/6537))
+  - Previously, `PermissionController` and `SubjectMetadataController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
 - Bump `@metamask/base-controller` from `^8.0.0` to `^8.3.0` ([#5722](https://github.com/MetaMask/core/pull/5722), [#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))
 - Bump `@metamask/controller-utils` from `^11.5.0` to `^11.12.0` ([#5439](https://github.com/MetaMask/core/pull/5439), [#5583](https://github.com/MetaMask/core/pull/5583), [#5765](https://github.com/MetaMask/core/pull/5765), [#5812](https://github.com/MetaMask/core/pull/5812), [#5935](https://github.com/MetaMask/core/pull/5935), [#6069](https://github.com/MetaMask/core/pull/6069), [#6303](https://github.com/MetaMask/core/pull/6303))
 - Bump `@metamask/utils` from `^11.1.0` to `^11.4.2` ([#5301](https://github.com/MetaMask/core/pull/5301), [#6054](https://github.com/MetaMask/core/pull/6054))

packages/permission-controller/package.json

@@ -50,6 +50,7 @@
     "@metamask/base-controller": "^8.3.0",
     "@metamask/controller-utils": "^11.12.0",
     "@metamask/json-rpc-engine": "^10.0.3",
+    "@metamask/messenger": "^0.2.0",
     "@metamask/rpc-errors": "^7.0.2",
     "@metamask/utils": "^11.4.2",
     "@types/deep-freeze-strict": "^1.1.0",

packages/permission-controller/src/Caveat.ts

@@ -12,8 +12,6 @@ import type {
   RestrictedMethodParameters,
 } from './Permission';
 import { PermissionType } from './Permission';
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import type { PermissionController } from './PermissionController';
 
 export type CaveatConstraint = {
   /**

packages/permission-controller/src/Permission.ts

@@ -1,16 +1,10 @@
-import type {
-  ActionConstraint,
-  EventConstraint,
-} from '@metamask/base-controller';
 import type { NonEmptyArray } from '@metamask/controller-utils';
+import type { ActionConstraint, EventConstraint } from '@metamask/messenger';
 import type { Json } from '@metamask/utils';
 import { nanoid } from 'nanoid';
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import type { CaveatConstraint, Caveat } from './Caveat';
+import type { CaveatConstraint } from './Caveat';
 import type {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  PermissionController,
   PermissionsRequest,
   SideEffectMessenger,
 } from './PermissionController';
@@ -117,8 +111,8 @@ export type ValidPermission<
 type ExtractArrayMembers<ArrayType> = ArrayType extends []
   ? never
   : ArrayType extends unknown[] | readonly unknown[]
-  ? ArrayType[number]
-  : never;
+    ? ArrayType[number]
+    : never;
 
 /**
  * A utility type for extracting the allowed caveat types for a particular
@@ -538,11 +532,12 @@ export type PermissionSpecificationBuilderExportConstraint = {
 
 type ValidRestrictedMethodSpecification<
   Specification extends RestrictedMethodSpecificationConstraint,
-> = Specification['methodImplementation'] extends ValidRestrictedMethod<
-  Specification['methodImplementation']
->
-  ? Specification
-  : never;
+> =
+  Specification['methodImplementation'] extends ValidRestrictedMethod<
+    Specification['methodImplementation']
+  >
+    ? Specification
+    : never;
 
 /**
  * Constraint for {@link PermissionSpecificationConstraint} objects that
@@ -556,10 +551,10 @@ export type ValidPermissionSpecification<
   ? Specification['permissionType'] extends PermissionType.Endowment
     ? Specification
     : Specification['permissionType'] extends PermissionType.RestrictedMethod
-    ? ValidRestrictedMethodSpecification<
-        Extract<Specification, RestrictedMethodSpecificationConstraint>
-      >
-    : never
+      ? ValidRestrictedMethodSpecification<
+          Extract<Specification, RestrictedMethodSpecificationConstraint>
+        >
+      : never
   : never;
 
 /**

packages/permission-controller/src/PermissionController.test.ts

@@ -1,12 +1,12 @@
-import type {
-  AcceptRequest as AcceptApprovalRequest,
-  AddApprovalRequest,
-  HasApprovalRequest,
-  RejectRequest as RejectApprovalRequest,
-} from '@metamask/approval-controller';
-import { Messenger } from '@metamask/base-controller';
 import { isPlainObject } from '@metamask/controller-utils';
 import { JsonRpcEngine } from '@metamask/json-rpc-engine';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import type { Json, JsonRpcRequest } from '@metamask/utils';
 import {
   assertIsJsonRpcFailure,
@@ -22,8 +22,7 @@ import type {
   CaveatMutator,
   ExtractSpecifications,
   PermissionConstraint,
-  PermissionControllerActions,
-  PermissionControllerEvents,
+  PermissionControllerMessenger,
   PermissionOptions,
   PermissionsRequest,
   RestrictedMethodOptions,
@@ -40,7 +39,6 @@ import {
 import * as errors from './errors';
 import type { EndowmentGetterParams } from './Permission';
 import { SubjectType } from './SubjectMetadataController';
-import type { GetSubjectMetadata } from './SubjectMetadataController';
 
 // Caveat types and specifications
 
@@ -546,13 +544,6 @@ type DefaultPermissionSpecifications = ExtractSpecifications<
 
 const controllerName = 'PermissionController' as const;
 
-type AllowedActions =
-  | HasApprovalRequest
-  | AddApprovalRequest
-  | AcceptApprovalRequest
-  | RejectApprovalRequest
-  | GetSubjectMetadata;
-
 /**
  * Params for `ApprovalController:addRequest` of type `wallet_requestPermissions`.
  */
@@ -565,41 +556,59 @@ type AddPermissionRequestParams = {
 
 type AddPermissionRequestArgs = [string, AddPermissionRequestParams];
 
+type AllPermissionControllerActions =
+  MessengerActions<PermissionControllerMessenger>;
+
+type AllPermissionControllerEvents =
+  MessengerEvents<PermissionControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllPermissionControllerActions,
+  AllPermissionControllerEvents
+>;
+
 /**
- * Gets an unrestricted messenger. Used for tests.
+ * Creates and returns a root messenger for testing
  *
- * @returns The unrestricted messenger.
+ * @returns A messenger instance
  */
-function getUnrestrictedMessenger() {
-  return new Messenger<
-    PermissionControllerActions | AllowedActions,
-    PermissionControllerEvents
-  >();
+function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
 }
 
 /**
- * Gets a restricted messenger.
+ * Gets a messenger for the permission controller.
  * Used as a default in {@link getPermissionControllerOptions}.
  *
- * @param messenger - Optional parameter to pass in a messenger
- * @returns The restricted messenger.
+ * @param rootMessenger - Optional parameter to pass in a root messenger
+ * @returns The messenger for the permission controller.
  */
 function getPermissionControllerMessenger(
-  messenger = getUnrestrictedMessenger(),
-) {
-  return messenger.getRestricted<typeof controllerName, AllowedActions['type']>(
-    {
-      name: controllerName,
-      allowedActions: [
-        'ApprovalController:hasRequest',
-        'ApprovalController:addRequest',
-        'ApprovalController:acceptRequest',
-        'ApprovalController:rejectRequest',
-        'SubjectMetadataController:getSubjectMetadata',
-      ],
-      allowedEvents: [],
-    },
-  );
+  rootMessenger = getRootMessenger(),
+): PermissionControllerMessenger {
+  const messenger = new Messenger<
+    typeof controllerName,
+    AllPermissionControllerActions,
+    AllPermissionControllerEvents,
+    RootMessenger
+  >({
+    namespace: controllerName,
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    actions: [
+      'ApprovalController:hasRequest',
+      'ApprovalController:addRequest',
+      'ApprovalController:acceptRequest',
+      'ApprovalController:rejectRequest',
+      'SubjectMetadataController:getSubjectMetadata',
+    ],
+    messenger,
+  });
+  return messenger;
 }
 
 /**
@@ -5572,7 +5581,7 @@ describe('PermissionController', () => {
 
   describe('controller actions', () => {
     it('action: PermissionController:clearPermissions', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5597,7 +5606,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:getEndowments', async () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5670,7 +5679,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:getSubjectNames', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5698,7 +5707,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:hasPermission', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5760,7 +5769,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:hasPermissions', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5790,7 +5799,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:getPermissions', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5824,7 +5833,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:revokeAllPermissions', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5858,7 +5867,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:revokePermissionForAllSubjects', () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5898,7 +5907,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:grantPermissions', async () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5919,7 +5928,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:grantPermissionsIncremental', async () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5943,7 +5952,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:requestPermissions', async () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5970,7 +5979,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:requestPermissionsIncremental', async () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const options = getPermissionControllerOptions({
         messenger: getPermissionControllerMessenger(messenger),
       });
@@ -5997,7 +6006,7 @@ describe('PermissionController', () => {
     });
 
     it('action: PermissionController:updateCaveat', async () => {
-      const messenger = getUnrestrictedMessenger();
+      const messenger = getRootMessenger();
       const state = {
         subjects: {
           'metamask.io': {