Added revokePermissions to PermissionController actions (#708)

* Added revokePermissions to PermissionController actions Co-authored-by: Hassan Malik <[email protected]> Co-authored-by: Erik Marks <[email protected]>
MetaMask · Mar 7, 2022 · 477ee49 · 477ee49
1 parent eaba91f
commit 477ee49
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 5 deletions.
diff --git a/src/permissions/PermissionController.test.ts b/src/permissions/PermissionController.test.ts
@@ -6,9 +6,9 @@ import {
   HasApprovalRequest,
   RejectRequest as RejectApprovalRequest,
 } from '../approval/ApprovalController';
-import { hasProperty, isPlainObject } from '../util';
 import { Json } from '../BaseControllerV2';
 import { ControllerMessenger } from '../ControllerMessenger';
+import { hasProperty, isPlainObject } from '../util';
 import * as errors from './errors';
 import { EndowmentGetterParams } from './Permission';
 import {
@@ -4408,7 +4408,8 @@ describe('PermissionController', () => {
 
       expect(
         Object.keys(
-          messenger.call('PermissionController:getPermissions', 'foo'),
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          messenger.call('PermissionController:getPermissions', 'foo')!,
         ),
       ).toStrictEqual(['wallet_getSecretArray']);
 

diff --git a/src/permissions/PermissionController.ts b/src/permissions/PermissionController.ts
@@ -1,6 +1,6 @@
 /* eslint-enable @typescript-eslint/no-unused-vars */
-import deepFreeze from 'deep-freeze-strict';
 import { Mutable } from '@metamask/types';
+import deepFreeze from 'deep-freeze-strict';
 import { castDraft, Draft, Patch } from 'immer';
 import { nanoid } from 'nanoid';
 import {
@@ -9,7 +9,7 @@ import {
   HasApprovalRequest,
   RejectRequest as RejectApprovalRequest,
 } from '../approval/ApprovalController';
-import { Json, BaseController, StateMetadata } from '../BaseControllerV2';
+import { BaseController, Json, StateMetadata } from '../BaseControllerV2';
 import { RestrictedControllerMessenger } from '../ControllerMessenger';
 import {
   hasProperty,
@@ -220,6 +220,14 @@ export type RequestPermissions = {
   handler: GenericPermissionController['requestPermissions'];
 };
 
+/**
+ * Removes the specified permissions for each origin.
+ */
+export type RevokePermissions = {
+  type: `${typeof controllerName}:revokePermissions`;
+  handler: GenericPermissionController['revokePermissions'];
+};
+
 /**
  * Removes all permissions for a given origin
  */
@@ -255,6 +263,7 @@ export type PermissionControllerActions =
   | GetPermissions
   | HasPermission
   | HasPermissions
+  | RevokePermissions
   | RevokeAllPermissions
   | RequestPermissions;
 
@@ -671,6 +680,11 @@ export class PermissionController<
       (origin: OriginString) => this.hasPermissions(origin),
     );
 
+    this.messagingSystem.registerActionHandler(
+      `${controllerName}:revokePermissions` as const,
+      this.revokePermissions.bind(this),
+    );
+
     this.messagingSystem.registerActionHandler(
       `${controllerName}:revokeAllPermissions` as const,
       (origin: OriginString) => this.revokeAllPermissions(origin),
@@ -803,7 +817,13 @@ export class PermissionController<
    * @param origin - The origin of the subject.
    * @returns The permissions of the subject, if any.
    */
-  getPermissions(origin: OriginString) {
+  getPermissions(
+    origin: OriginString,
+  ):
+    | SubjectPermissions<
+        ValidPermission<string, ExtractCaveats<ControllerCaveatSpecification>>
+      >
+    | undefined {
     return this.state.subjects[origin]?.permissions;
   }