refactor: migrate ErrorReportingService to @metamask/messenger

packages/error-reporting-service/CHANGELOG.md

@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6462](https://github.com/MetaMask/core/pull/6462))
+  - Previously, `ErrorReportingService` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
 - Bump `@metamask/base-controller` from `^8.0.1` to `^8.4.0` ([#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465), [#6632](https://github.com/MetaMask/core/pull/6632))
 
 ## [2.0.0]

packages/error-reporting-service/package.json

@@ -47,7 +47,8 @@
     "since-latest-release": "../../scripts/since-latest-release.sh"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.4.1"
+    "@metamask/base-controller": "^8.4.1",
+    "@metamask/messenger": "^0.3.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",

packages/error-reporting-service/src/error-reporting-service.test.ts

@@ -1,4 +1,8 @@
-import { Messenger } from '@metamask/base-controller';
+import {
+  Messenger,
+  type MessengerActions,
+  type MessengerEvents,
+} from '@metamask/messenger';
 import { captureException as sentryCaptureException } from '@sentry/core';
 
 import type { ErrorReportingServiceMessenger } from './error-reporting-service';
@@ -68,9 +72,11 @@ describe('ErrorReportingService', () => {
  * @returns The messenger.
  */
 function buildMessenger(): ErrorReportingServiceMessenger {
-  return new Messenger().getRestricted({
-    name: 'ErrorReportingService',
-    allowedActions: [],
-    allowedEvents: [],
+  return new Messenger<
+    'ErrorReportingService',
+    MessengerActions<ErrorReportingServiceMessenger>,
+    MessengerEvents<ErrorReportingServiceMessenger>
+  >({
+    namespace: 'ErrorReportingService',
   });
 }

packages/error-reporting-service/src/error-reporting-service.ts

@@ -1,4 +1,4 @@
-import type { RestrictedMessenger } from '@metamask/base-controller';
+import type { Messenger } from '@metamask/messenger';
 
 /**
  * The action which can be used to report an error.
@@ -37,12 +37,10 @@ type AllowedEvents = never;
  * The messenger restricted to actions and events that
  * {@link ErrorReportingService} needs to access.
  */
-export type ErrorReportingServiceMessenger = RestrictedMessenger<
+export type ErrorReportingServiceMessenger = Messenger<
   'ErrorReportingService',
   ErrorReportingServiceActions | AllowedActions,
-  ErrorReportingServiceEvents | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  ErrorReportingServiceEvents | AllowedEvents
 >;
 
 /**
@@ -69,12 +67,10 @@ type ErrorReportingServiceOptions = {
  *
  * // Define the messenger type for the controller.
  * type AllowedActions = ErrorReportingServiceCaptureExceptionAction;
- * type ExampleControllerMessenger = RestrictedMessenger<
+ * type ExampleControllerMessenger = Messenger<
  *   'ExampleController',
  *   AllowedActions,
  *   never,
- *   AllowedActions['type'],
- *   never
  * >;
  *
  * // Define the controller.
@@ -86,7 +82,7 @@ type ErrorReportingServiceOptions = {
  *   doSomething() {
  *     // Imagine that we do something that produces an error and we want to
  *     // report the error.
- *     this.messagingSystem.call(
+ *     this.messenger.call(
  *       'ErrorReportingService:captureException',
  *       new Error('Something went wrong'),
  *     );
@@ -99,23 +95,43 @@ type ErrorReportingServiceOptions = {
  * import { ErrorReportingService } from '@metamask/error-reporting-service';
  * import { ExampleController } from './example-controller';
  *
+ * type AllActions = MessengerActions<ErrorReportingServiceMessenger>;
+ *
+ * type AllEvents = MessengerEvents<ErrorReportingServiceMessenger>;
+ *
+ * type RootMessenger = Messenger<'Root', AllActions, AllEvents>;
+ *
  * // Create a global messenger.
  * const globalMessenger = new Messenger();
  *
  * // Register handler for the `ErrorReportingService:captureException`
  * // action in the global messenger.
- * const errorReportingServiceMessenger = globalMessenger.getRestricted({
- *   allowedActions: [],
- *   allowedEvents: [],
+ * const errorReportingServiceMessenger = new Messenger<
+ *   'ErrorReportingService',
+ *   MessengerActions<ErrorReportingServiceMessenger>,
+ *   MessengerEvents<ErrorReportingServiceMessenger>,
+ *   RootMessenger
+ * >({
+ *   namespace: 'ErrorReportingService',
+ *   parent: globalMessenger,
  * });
  * const errorReportingService = new ErrorReportingService({
  *   messenger: errorReportingServiceMessenger,
  *   captureException,
  * });
  *
- * const exampleControllerMessenger = globalMessenger.getRestricted({
- *   allowedActions: ['ErrorReportingService:captureException'],
- *   allowedEvents: [],
+ * const exampleControllerMessenger = new Messenger<
+ *  'ExampleController',
+ *  MessengerActions<ExampleControllerMessenger>,
+ *  MessengerEvents<ExampleControllerMessenger>,
+ *  RootMessenger
+ * >({
+ *   namespace: 'ExampleController',
+ *   parent: globalMessenger,
+ * });
+ * globalMessenger.delegate({
+ *   messenger: exampleControllerMessenger,
+ *   actions: ['ErrorReportingService:captureException'],
  * });
  * const exampleController = new ExampleController({
  *   messenger: exampleControllerMessenger,

yarn.lock

@@ -3339,6 +3339,7 @@ __metadata:
   dependencies:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.1"
+    "@metamask/messenger": "npm:^0.3.0"
     "@sentry/core": "npm:^9.22.0"
     "@types/jest": "npm:^27.4.1"
     deepmerge: "npm:^4.2.2"