refactor: migrate AnnouncementController to @metamask/messenger

packages/announcement-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` ([#6384](https://github.com/MetaMask/core/pull/6384))
+  - Previously, `AnnouncementController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
 - Bump `@metamask/base-controller` from `^8.0.0` to `^8.2.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))
 
 ## [7.0.3]

packages/announcement-controller/package.json

@@ -47,7 +47,8 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.2.0"
+    "@metamask/base-controller": "^8.2.0",
+    "@metamask/messenger": "^0.1.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",

packages/announcement-controller/src/AnnouncementController.test.ts

@@ -1,4 +1,4 @@
-import { Messenger } from '@metamask/base-controller';
+import { Messenger } from '@metamask/messenger';
 
 import type {
   AnnouncementControllerState,
@@ -16,15 +16,20 @@ const name = 'AnnouncementController';
  *
  * @returns A restricted controller messenger.
  */
-function getRestrictedMessenger() {
+function getMessenger() {
   const messenger = new Messenger<
+    'Root',
     AnnouncementControllerActions,
     AnnouncementControllerEvents
-  >();
-  return messenger.getRestricted({
-    name,
-    allowedActions: [],
-    allowedEvents: [],
+  >({ namespace: 'Root' });
+  return new Messenger<
+    typeof name,
+    AnnouncementControllerActions,
+    AnnouncementControllerEvents,
+    typeof messenger
+  >({
+    namespace: name,
+    parent: messenger,
   });
 }
 const allAnnouncements: AnnouncementMap = {
@@ -89,7 +94,7 @@ const state2: AnnouncementControllerState = {
 describe('announcement controller', () => {
   it('should add announcement to state', () => {
     const controller = new AnnouncementController({
-      messenger: getRestrictedMessenger(),
+      messenger: getMessenger(),
       allAnnouncements,
     });
     expect(Object.keys(controller.state.announcements)).toHaveLength(2);
@@ -110,7 +115,7 @@ describe('announcement controller', () => {
 
   it('should add new announcement to state and a new announcement should be created with isShown as false', () => {
     const controller = new AnnouncementController({
-      messenger: getRestrictedMessenger(),
+      messenger: getMessenger(),
       state: state1,
       allAnnouncements: allAnnouncements2,
     });
@@ -123,7 +128,7 @@ describe('announcement controller', () => {
   describe('resetViewed', () => {
     it('resets all announcement isShown states to false', () => {
       const controller = new AnnouncementController({
-        messenger: getRestrictedMessenger(),
+        messenger: getMessenger(),
         state: state2,
         allAnnouncements: allAnnouncements2,
       });
@@ -142,7 +147,7 @@ describe('announcement controller', () => {
   describe('update viewed announcements', () => {
     it('should update isShown status', () => {
       const controller = new AnnouncementController({
-        messenger: getRestrictedMessenger(),
+        messenger: getMessenger(),
         state: state2,
         allAnnouncements: allAnnouncements2,
       });
@@ -154,7 +159,7 @@ describe('announcement controller', () => {
 
     it('should update isShown of more than one announcement', () => {
       const controller = new AnnouncementController({
-        messenger: getRestrictedMessenger(),
+        messenger: getMessenger(),
         state: state2,
         allAnnouncements: allAnnouncements2,
       });

packages/announcement-controller/src/AnnouncementController.ts

@@ -1,9 +1,9 @@
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
 } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+import { BaseController } from '@metamask/base-controller/next';
+import type { Messenger } from '@metamask/messenger';
 
 type ViewedAnnouncement = {
   [id: number]: boolean;
@@ -66,12 +66,10 @@ const metadata = {
   },
 };
 
-export type AnnouncementControllerMessenger = RestrictedMessenger<
+export type AnnouncementControllerMessenger = Messenger<
   typeof controllerName,
   AnnouncementControllerActions,
-  AnnouncementControllerEvents,
-  never,
-  never
+  AnnouncementControllerEvents
 >;
 
 /**

yarn.lock

@@ -2507,6 +2507,7 @@ __metadata:
   dependencies:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.2.0"
+    "@metamask/messenger": "npm:^0.1.0"
     "@types/jest": "npm:^27.4.1"
     deepmerge: "npm:^4.2.2"
     jest: "npm:^27.5.1"