Add requestAccepted and requestRejected events

Author: rekmarks

src/approval/ApprovalController.test.ts

@@ -509,12 +509,37 @@ describe('approval controller', () => {
   });
 
   describe('accept and reject', () => {
-    it('accepts and rejects multiple approval promises out of order', async () => {
+    it('accepts and rejects multiple approval promises out of order, and emits events', async () => {
+      const messenger = new ControllerMessenger<
+        ApprovalControllerActions,
+        ApprovalControllerEvents
+      >();
+
+      const restrictedMessenger = messenger.getRestricted<
+        typeof controllerName,
+        never,
+        never
+      >({
+        name: 'ApprovalController',
+      });
+
       const approvalController = new ApprovalController({
-        messenger: getRestrictedMessenger(),
+        messenger: restrictedMessenger,
         showApprovalRequest: sinon.spy(),
       });
 
+      const acceptListener = jest.fn();
+      const rejectListener = jest.fn();
+
+      messenger.subscribe(
+        `${controllerName}:requestAccepted` as const,
+        acceptListener,
+      );
+      messenger.subscribe(
+        `${controllerName}:requestRejected` as const,
+        rejectListener,
+      );
+
       const promise1 = approvalController.add({
         id: 'foo1',
         origin: 'bar.baz',
@@ -560,6 +585,56 @@ describe('approval controller', () => {
       expect(approvalController.has({ origin: 'bar.baz' })).toStrictEqual(
         false,
       );
+
+      expect(acceptListener).toHaveBeenCalledTimes(2);
+      expect(acceptListener).toHaveBeenNthCalledWith(
+        1,
+        {
+          id: expect.any(String),
+          time: expect.any(Number),
+          origin: 'bar.baz',
+          type: 'myType2',
+          requestData: null,
+        },
+        'success2',
+      );
+
+      expect(acceptListener).toHaveBeenNthCalledWith(
+        2,
+        {
+          id: expect.any(String),
+          time: expect.any(Number),
+          origin: 'bar.baz',
+          type: TYPE,
+          requestData: null,
+        },
+        'success1',
+      );
+
+      expect(rejectListener).toHaveBeenCalledTimes(2);
+      expect(rejectListener).toHaveBeenNthCalledWith(
+        1,
+        {
+          id: expect.any(String),
+          time: expect.any(Number),
+          origin: 'bar.baz',
+          type: 'myType4',
+          requestData: null,
+        },
+        new Error('failure4'),
+      );
+
+      expect(rejectListener).toHaveBeenNthCalledWith(
+        2,
+        {
+          id: expect.any(String),
+          time: expect.any(Number),
+          origin: 'fizz.buzz',
+          type: TYPE,
+          requestData: null,
+        },
+        new Error('failure3'),
+      );
     });
   });
 

src/approval/ApprovalController.ts

@@ -120,7 +120,20 @@ export type ApprovalStateChange = {
   payload: [ApprovalControllerState, Patch[]];
 };
 
-export type ApprovalControllerEvents = ApprovalStateChange;
+export type ApprovalRequestAccepted = {
+  type: `${typeof controllerName}:requestAccepted`;
+  payload: [ApprovalRequest<Record<string, Json>>, unknown];
+};
+
+export type ApprovalRequestRejected = {
+  type: `${typeof controllerName}:requestRejected`;
+  payload: [ApprovalRequest<Record<string, Json>>, Error];
+};
+
+export type ApprovalControllerEvents =
+  | ApprovalStateChange
+  | ApprovalRequestAccepted
+  | ApprovalRequestRejected;
 
 export type ApprovalControllerMessenger = RestrictedControllerMessenger<
   typeof controllerName,
@@ -421,7 +434,13 @@ export class ApprovalController extends BaseController<
    * @param value - The value to resolve the approval promise with.
    */
   accept(id: string, value?: unknown): void {
-    this._deleteApprovalAndGetCallbacks(id).resolve(value);
+    const [approvalRequest, callbacks] = this._deleteApprovalAndGetData(id);
+    callbacks.resolve(value);
+    this.messagingSystem.publish(
+      `${controllerName}:requestAccepted` as const,
+      approvalRequest,
+      value,
+    );
   }
 
   /**
@@ -432,7 +451,13 @@ export class ApprovalController extends BaseController<
    * @param error - The error to reject the approval promise with.
    */
   reject(id: string, error: Error): void {
-    this._deleteApprovalAndGetCallbacks(id).reject(error);
+    const [approvalRequest, callbacks] = this._deleteApprovalAndGetData(id);
+    callbacks.reject(error);
+    this.messagingSystem.publish(
+      `${controllerName}:requestRejected` as const,
+      approvalRequest,
+      error,
+    );
   }
 
   /**
@@ -564,6 +589,29 @@ export class ApprovalController extends BaseController<
     });
   }
 
+  /**
+   * Gets the approval callbacks for the given id, deletes the entry, and then
+   * returns the callbacks for promise resolution.
+   * Throws an error if no approval is found for the given id.
+   *
+   * @param id - The id of the approval request.
+   * @returns The promise callbacks associated with the approval request.
+   */
+  private _deleteApprovalAndGetData(
+    id: string,
+  ): [ApprovalRequest<Record<string, Json>>, ApprovalCallbacks] {
+    const callbacks = this._approvals.get(id);
+    if (!callbacks) {
+      throw new Error(`Approval request with id '${id}' not found.`);
+    }
+
+    // We've already verified that the approval exists.
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const approvalRequest = this.state.pendingApprovals[id]!;
+    this._delete(id);
+    return [approvalRequest, callbacks];
+  }
+
   /**
    * Deletes the approval with the given id. The approval promise must be
    * resolved or reject before this method is called.
@@ -593,24 +641,6 @@ export class ApprovalController extends BaseController<
     });
   }
 
-  /**
-   * Gets the approval callbacks for the given id, deletes the entry, and then
-   * returns the callbacks for promise resolution.
-   * Throws an error if no approval is found for the given id.
-   *
-   * @param id - The id of the approval request.
-   * @returns The promise callbacks associated with the approval request.
-   */
-  private _deleteApprovalAndGetCallbacks(id: string): ApprovalCallbacks {
-    const callbacks = this._approvals.get(id);
-    if (!callbacks) {
-      throw new Error(`Approval request with id '${id}' not found.`);
-    }
-
-    this._delete(id);
-    return callbacks;
-  }
-
   /**
    * Checks whether there are any approvals associated with the given
    * origin.