refactor: base controller migration

packages/snaps-controllers/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#3611](https://github.com/MetaMask/snaps/pull/3611))
+  - Previously, `SnapController`, `CronjobController`, `SnapInsightsController`, `SnapInterfaceController`, `MultichainRouter`, `ExecutionService` and `WebSocketService` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#3611](https://github.com/MetaMask/snaps/pull/3611))
+- Bump `@metamask/approval-controller` from `^7.2.0` to `^8.0.0`(([#3611](https://github.com/MetaMask/snaps/pull/3611))
+- Bump `@metamask/base-controller` from `^8.4.1` to `^9.0.0`(([#3611](https://github.com/MetaMask/snaps/pull/3611))
+- Bump `@metamask/permission-controller` from `^11.0.6` to `^12.0.0`(([#3611](https://github.com/MetaMask/snaps/pull/3611))
+
 ## [15.0.2]
 
 ### Fixed

packages/snaps-controllers/coverage.json

@@ -1,6 +1,6 @@
 {
-  "branches": 95.23,
-  "functions": 99,
-  "lines": 98.74,
-  "statements": 98.58
+  "branches": 94.87,
+  "functions": 98.03,
+  "lines": 98.63,
+  "statements": 98.43
 }

packages/snaps-controllers/package.json

@@ -79,13 +79,14 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/approval-controller": "^7.2.0",
-    "@metamask/base-controller": "^8.4.1",
+    "@metamask/approval-controller": "^8.0.0",
+    "@metamask/base-controller": "^9.0.0",
     "@metamask/json-rpc-engine": "^10.1.0",
     "@metamask/json-rpc-middleware-stream": "^8.0.8",
     "@metamask/key-tree": "^10.1.1",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/object-multiplex": "^2.1.0",
-    "@metamask/permission-controller": "^11.0.6",
+    "@metamask/permission-controller": "^12.0.0",
     "@metamask/phishing-controller": "^13.1.0",
     "@metamask/post-message-stream": "^10.0.0",
     "@metamask/rpc-errors": "^7.0.3",

packages/snaps-controllers/src/cronjob/CronjobController.test.ts

@@ -72,14 +72,14 @@ describe('CronjobController', () => {
 
     cronjobController.register(MOCK_SNAP_ID);
 
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'PermissionController:getPermissions',
       MOCK_SNAP_ID,
     );
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Minute));
 
-    expect(rootMessenger.call).toHaveBeenNthCalledWith(
+    expect(controllerMessenger.call).toHaveBeenNthCalledWith(
       2,
       'SnapController:handleRequest',
       {
@@ -121,14 +121,14 @@ describe('CronjobController', () => {
 
     cronjobController.register(MOCK_SNAP_ID);
 
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'PermissionController:getPermissions',
       MOCK_SNAP_ID,
     );
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Minute));
 
-    expect(rootMessenger.call).toHaveBeenNthCalledWith(
+    expect(controllerMessenger.call).toHaveBeenNthCalledWith(
       2,
       'SnapController:handleRequest',
       {
@@ -162,7 +162,7 @@ describe('CronjobController', () => {
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Minute));
 
-    expect(rootMessenger.call).not.toHaveBeenCalledWith(
+    expect(controllerMessenger.call).not.toHaveBeenCalledWith(
       'SnapController:handleRequest',
       {
         snapId: MOCK_SNAP_ID,
@@ -212,7 +212,7 @@ describe('CronjobController', () => {
 
     jest.advanceTimersByTime(inMilliseconds(24, Duration.Hour));
 
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'SnapController:handleRequest',
       {
         snapId: MOCK_SNAP_ID,
@@ -263,7 +263,7 @@ describe('CronjobController', () => {
     cronjobController.init();
 
     await new Promise((resolve) => originalProcessNextTick(resolve));
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'SnapController:handleRequest',
       {
         snapId: MOCK_SNAP_ID,
@@ -312,13 +312,13 @@ describe('CronjobController', () => {
     cronjobController.register(MOCK_SNAP_ID);
     jest.runOnlyPendingTimers();
 
-    expect(rootMessenger.call).toHaveBeenCalledTimes(1);
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(1);
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'PermissionController:getPermissions',
       MOCK_SNAP_ID,
     );
 
-    expect(rootMessenger.call).not.toHaveBeenCalledWith(
+    expect(controllerMessenger.call).not.toHaveBeenCalledWith(
       'SnapController:handleRequest',
       {
         snapId: MOCK_SNAP_ID,
@@ -360,18 +360,18 @@ describe('CronjobController', () => {
     cronjobController.register(MOCK_SNAP_ID);
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
-    expect(rootMessenger.call).toHaveBeenCalledTimes(1);
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(1);
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'PermissionController:getPermissions',
       MOCK_SNAP_ID,
     );
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
-    expect(rootMessenger.call).toHaveBeenCalledTimes(1);
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(1);
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
-    expect(rootMessenger.call).toHaveBeenCalledTimes(2);
-    expect(rootMessenger.call).toHaveBeenNthCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(2);
+    expect(controllerMessenger.call).toHaveBeenNthCalledWith(
       2,
       'SnapController:handleRequest',
       {
@@ -451,7 +451,7 @@ describe('CronjobController', () => {
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
 
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'SnapController:handleRequest',
       {
         snapId: MOCK_SNAP_ID,
@@ -514,7 +514,7 @@ describe('CronjobController', () => {
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Minute));
 
-    expect(rootMessenger.call).toHaveBeenNthCalledWith(
+    expect(controllerMessenger.call).toHaveBeenNthCalledWith(
       2,
       'SnapController:handleRequest',
       {
@@ -528,7 +528,7 @@ describe('CronjobController', () => {
       },
     );
 
-    expect(rootMessenger.call).toHaveBeenCalledTimes(2);
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(2);
 
     cronjobController.destroy();
   });
@@ -623,8 +623,8 @@ describe('CronjobController', () => {
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
 
-    expect(rootMessenger.call).toHaveBeenCalledTimes(3);
-    expect(rootMessenger.call).toHaveBeenNthCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(3);
+    expect(controllerMessenger.call).toHaveBeenNthCalledWith(
       2,
       'SnapController:handleRequest',
       {
@@ -638,7 +638,7 @@ describe('CronjobController', () => {
       },
     );
 
-    expect(rootMessenger.call).toHaveBeenNthCalledWith(
+    expect(controllerMessenger.call).toHaveBeenNthCalledWith(
       3,
       'SnapController:handleRequest',
       {
@@ -817,8 +817,8 @@ describe('CronjobController', () => {
 
     jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
 
-    expect(rootMessenger.call).toHaveBeenCalledTimes(1);
-    expect(rootMessenger.call).toHaveBeenCalledWith(
+    expect(controllerMessenger.call).toHaveBeenCalledTimes(1);
+    expect(controllerMessenger.call).toHaveBeenCalledWith(
       'PermissionController:getPermissions',
       MOCK_SNAP_ID,
     );
@@ -905,7 +905,7 @@ describe('CronjobController', () => {
 
       jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
 
-      expect(rootMessenger.call).toHaveBeenCalledWith(
+      expect(controllerMessenger.call).toHaveBeenCalledWith(
         'SnapController:handleRequest',
         {
           snapId: MOCK_SNAP_ID,
@@ -1111,7 +1111,7 @@ describe('CronjobController', () => {
 
       jest.advanceTimersByTime(inMilliseconds(1, Duration.Day));
 
-      expect(rootMessenger.call).toHaveBeenCalledWith(
+      expect(controllerMessenger.call).toHaveBeenCalledWith(
         'SnapController:handleRequest',
         {
           snapId: MOCK_SNAP_ID,

packages/snaps-controllers/src/cronjob/CronjobController.ts

@@ -1,9 +1,9 @@
 import type {
-  RestrictedMessenger,
   ControllerGetStateAction,
   ControllerStateChangeEvent,
 } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
+import type { Messenger } from '@metamask/messenger';
 import type { GetPermissions } from '@metamask/permission-controller';
 import {
   getCronjobCaveatJobs,
@@ -83,12 +83,10 @@ export type CronjobControllerEvents =
   | SnapEnabled
   | SnapDisabled;
 
-export type CronjobControllerMessenger = RestrictedMessenger<
+export type CronjobControllerMessenger = Messenger<
   typeof controllerName,
   CronjobControllerActions,
-  CronjobControllerEvents,
-  CronjobControllerActions['type'],
-  CronjobControllerEvents['type']
+  CronjobControllerEvents
 >;
 
 export const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);
@@ -181,7 +179,7 @@ export class CronjobController extends BaseController<
         events: {
           includeInStateLogs: false,
           persist: false,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: false,
         },
       },
@@ -196,49 +194,47 @@ export class CronjobController extends BaseController<
     this.#timers = new Map();
     this.#stateManager = stateManager;
 
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'SnapController:snapInstalled',
       this.#handleSnapInstalledEvent,
     );
 
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'SnapController:snapUninstalled',
       this.#handleSnapUninstalledEvent,
     );
 
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'SnapController:snapEnabled',
       this.#handleSnapEnabledEvent,
     );
 
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'SnapController:snapDisabled',
       this.#handleSnapDisabledEvent,
     );
 
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'SnapController:snapUpdated',
       this.#handleSnapUpdatedEvent,
     );
 
-    this.messagingSystem.registerActionHandler(
-      `${controllerName}:init`,
-      (...args) => this.init(...args),
+    this.messenger.registerActionHandler(`${controllerName}:init`, (...args) =>
+      this.init(...args),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:schedule`,
       (...args) => this.schedule(...args),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:cancel`,
       (...args) => this.cancel(...args),
     );
 
-    this.messagingSystem.registerActionHandler(
-      `${controllerName}:get`,
-      (...args) => this.get(...args),
+    this.messenger.registerActionHandler(`${controllerName}:get`, (...args) =>
+      this.get(...args),
     );
   }
 
@@ -336,27 +332,27 @@ export class CronjobController extends BaseController<
   destroy() {
     super.destroy();
 
-    this.messagingSystem.unsubscribe(
+    this.messenger.unsubscribe(
       'SnapController:snapInstalled',
       this.#handleSnapInstalledEvent,
     );
 
-    this.messagingSystem.unsubscribe(
+    this.messenger.unsubscribe(
       'SnapController:snapUninstalled',
       this.#handleSnapUninstalledEvent,
     );
 
-    this.messagingSystem.unsubscribe(
+    this.messenger.unsubscribe(
       'SnapController:snapEnabled',
       this.#handleSnapEnabledEvent,
     );
 
-    this.messagingSystem.unsubscribe(
+    this.messenger.unsubscribe(
       'SnapController:snapDisabled',
       this.#handleSnapDisabledEvent,
     );
 
-    this.messagingSystem.unsubscribe(
+    this.messenger.unsubscribe(
       'SnapController:snapUpdated',
       this.#handleSnapUpdatedEvent,
     );
@@ -473,7 +469,7 @@ export class CronjobController extends BaseController<
    * @param event - The event to execute.
    */
   #execute(event: InternalBackgroundEvent) {
-    this.messagingSystem
+    this.messenger
       .call('SnapController:handleRequest', {
         snapId: event.snapId,
         origin: METAMASK_ORIGIN,
@@ -529,7 +525,7 @@ export class CronjobController extends BaseController<
    * @returns Array of cronjob specifications.
    */
   #getSnapCronjobs(snapId: SnapId): SchedulableBackgroundEvent[] {
-    const permissions = this.messagingSystem.call(
+    const permissions = this.messenger.call(
       'PermissionController:getPermissions',
       snapId,
     );