breaking: Remove deprecated messenger-related exports and aliases

packages/base-controller/CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Remove deprecated messenger-related exports and simplify `RestrictedMessenger` constructor ([#5260](https://github.com/MetaMask/core/pull/5260))
+  - Remove `ControllerMessenger` export which was an alias for `Messenger`. Consumers should import `Messenger` directly
+  - Remove `RestrictedControllerMessenger` export which was an alias for `RestrictedMessenger`. Consumers should import `RestrictedMessenger` directly
+  - Remove `RestrictedControllerMessengerConstraint` type export which was an alias for `RestrictedMessengerConstraint`. Consumers should use `RestrictedMessengerConstraint` type directly
+  - Simplify `RestrictedMessenger` constructor by removing deprecated `controllerMessenger` parameter. The messenger instance should now be passed using only the `messenger` parameter instead of supporting both options
 - Widen input parameter for type guard `isBaseController` from `ControllerInstance` to `unknown` ([#5018](https://github.com/MetaMask/core/pull/5018/))
 
 ### Removed

packages/base-controller/src/Messenger.ts

@@ -458,5 +458,3 @@ export class Messenger<
     });
   }
 }
-
-export { Messenger as ControllerMessenger };

packages/base-controller/src/RestrictedMessenger.test.ts

@@ -16,23 +16,6 @@ describe('RestrictedMessenger', () => {
       ).toThrow('Messenger not provided');
     });
 
-    it('should throw if both controllerMessenger and messenger are provided', () => {
-      const messenger = new Messenger<never, never>();
-
-      expect(
-        () =>
-          new RestrictedMessenger({
-            controllerMessenger: messenger,
-            messenger,
-            name: 'Test',
-            allowedActions: [],
-            allowedEvents: [],
-          }),
-      ).toThrow(
-        `Both messenger properties provided. Provide message using only 'messenger' option, 'controllerMessenger' is deprecated`,
-      );
-    });
-
     it('should accept messenger parameter', () => {
       type CountAction = {
         type: 'CountController:count';
@@ -63,37 +46,6 @@ describe('RestrictedMessenger', () => {
 
       expect(count).toBe(1);
     });
-
-    it('should accept controllerMessenger parameter', () => {
-      type CountAction = {
-        type: 'CountController:count';
-        handler: (increment: number) => void;
-      };
-      const messenger = new Messenger<CountAction, never>();
-      const restrictedMessenger = new RestrictedMessenger<
-        'CountController',
-        CountAction,
-        never,
-        never,
-        never
-      >({
-        controllerMessenger: messenger,
-        name: 'CountController',
-        allowedActions: [],
-        allowedEvents: [],
-      });
-
-      let count = 0;
-      restrictedMessenger.registerActionHandler(
-        'CountController:count',
-        (increment: number) => {
-          count += increment;
-        },
-      );
-      restrictedMessenger.call('CountController:count', 1);
-
-      expect(count).toBe(1);
-    });
   });
 
   it('should allow registering and calling an action handler', () => {

packages/base-controller/src/RestrictedMessenger.ts

@@ -29,18 +29,6 @@ export type RestrictedMessengerConstraint<Namespace extends string = string> =
     string
   >;
 
-/**
- * A universal supertype of all `RestrictedMessenger` instances. This type can be assigned to any
- * `RestrictedMessenger` type.
- *
- * @template Namespace - Name of the module this messenger is for. Optionally can be used to
- * narrow this type to a constraint for the messenger of a specific module.
- * @deprecated This has been renamed to `RestrictedMessengerConstraint`.
- */
-export type RestrictedControllerMessengerConstraint<
-  Namespace extends string = string,
-> = RestrictedMessengerConstraint<Namespace>;
-
 /**
  * A restricted messenger.
  *
@@ -81,7 +69,6 @@ export class RestrictedMessenger<
    * unregistering actions and clearing event subscriptions.
    *
    * @param options - Options.
-   * @param options.controllerMessenger - The messenger instance that is being wrapped. (deprecated)
    * @param options.messenger - The messenger instance that is being wrapped.
    * @param options.name - The name of the thing this messenger will be handed to (e.g. the
    * controller name). This grants "ownership" of actions and events under this namespace to the
@@ -92,28 +79,21 @@ export class RestrictedMessenger<
    * allowed to subscribe to.
    */
   constructor({
-    controllerMessenger,
     messenger,
     name,
     allowedActions,
     allowedEvents,
   }: {
-    controllerMessenger?: Messenger<ActionConstraint, EventConstraint>;
     messenger?: Messenger<ActionConstraint, EventConstraint>;
     name: Namespace;
     allowedActions: NotNamespacedBy<Namespace, AllowedAction>[];
     allowedEvents: NotNamespacedBy<Namespace, AllowedEvent>[];
   }) {
-    if (messenger && controllerMessenger) {
-      throw new Error(
-        `Both messenger properties provided. Provide message using only 'messenger' option, 'controllerMessenger' is deprecated`,
-      );
-    } else if (!messenger && !controllerMessenger) {
+    if (!messenger) {
       throw new Error('Messenger not provided');
     }
     // The above condition guarantees that one of these options is defined.
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    this.#messenger = (messenger ?? controllerMessenger)!;
+    this.#messenger = messenger;
     this.#namespace = name;
     this.#allowedActions = allowedActions;
     this.#allowedEvents = allowedEvents;
@@ -429,5 +409,3 @@ export class RestrictedMessenger<
     return name.startsWith(`${this.#namespace}:`);
   }
 }
-
-export { RestrictedMessenger as RestrictedControllerMessenger };

packages/base-controller/src/index.ts

@@ -31,12 +31,6 @@ export type {
   NotNamespacedBy,
   NamespacedName,
 } from './Messenger';
-export { ControllerMessenger, Messenger } from './Messenger';
-export type {
-  RestrictedControllerMessengerConstraint,
-  RestrictedMessengerConstraint,
-} from './RestrictedMessenger';
-export {
-  RestrictedControllerMessenger,
-  RestrictedMessenger,
-} from './RestrictedMessenger';
+export { Messenger } from './Messenger';
+export type { RestrictedMessengerConstraint } from './RestrictedMessenger';
+export { RestrictedMessenger } from './RestrictedMessenger';