feat: refactor notification controller initialisation (#5504)

## Explanation

Separates out the controller constructor and initialisation. This makes
it easier to integrate with the Modular Initialisation approach in
extension and mobile.

**BREAKING** it would now require the controller to explicitly call init
after being constructed to be correctly setup. E.g.

```
const notificationServicesController = ...

// This needs to be done
notificationServicesController.init()
```

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/notification-services-controller`

- **REMOVED**: BREAKING - refactored out the
`NotificationServicesController` constructor initialisation methods. You
must explicitly call the `.init()` method to initialise controller
- **ADDED**: `init` method to initialise
`NotificationServicesController`

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: Prithpal-Sooriya

packages/notification-services-controller/src/NotificationServicesController/NotificationServicesController.test.ts

@@ -69,26 +69,6 @@ const mockErrorLog = () =>
 const mockWarnLog = () => jest.spyOn(log, 'warn').mockImplementation(jest.fn());
 
 describe('metamask-notifications - constructor()', () => {
-  const arrangeMocks = () => {
-    const messengerMocks = mockNotificationMessenger();
-    jest
-      .spyOn(ControllerUtils, 'toChecksumHexAddress')
-      .mockImplementation((x) => x);
-
-    return messengerMocks;
-  };
-
-  const actPublishKeyringStateChange = async (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    messenger: any,
-  ) => {
-    messenger.publish(
-      'KeyringController:stateChange',
-      {} as KeyringControllerState,
-      [],
-    );
-  };
-
   it('initializes state & override state', () => {
     const controller1 = new NotificationServicesController({
       messenger: mockNotificationMessenger().messenger,
@@ -108,6 +88,28 @@ describe('metamask-notifications - constructor()', () => {
     expect(controller2.state.isFeatureAnnouncementsEnabled).toBe(true);
     expect(controller2.state.isNotificationServicesEnabled).toBe(true);
   });
+});
+
+describe('metamask-notifications - init()', () => {
+  const arrangeMocks = () => {
+    const messengerMocks = mockNotificationMessenger();
+    jest
+      .spyOn(ControllerUtils, 'toChecksumHexAddress')
+      .mockImplementation((x) => x);
+
+    return messengerMocks;
+  };
+
+  const actPublishKeyringStateChange = async (
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    messenger: any,
+  ) => {
+    messenger.publish(
+      'KeyringController:stateChange',
+      {} as KeyringControllerState,
+      [],
+    );
+  };
 
   it('keyring Change Event but feature not enabled will not add or remove triggers', async () => {
     const { messenger, globalMessenger, mockWithKeyring } = arrangeMocks();
@@ -118,6 +120,7 @@ describe('metamask-notifications - constructor()', () => {
       messenger,
       env: { featureAnnouncements: featureAnnouncementsEnv },
     });
+    controller.init();
 
     const mockUpdate = jest
       .spyOn(controller, 'updateOnChainTriggersByAccount')
@@ -146,6 +149,7 @@ describe('metamask-notifications - constructor()', () => {
         subscriptionAccountsSeen: [ADDRESS_1],
       },
     });
+    controller.init();
 
     const mockUpdate = jest
       .spyOn(controller, 'updateOnChainTriggersByAccount')
@@ -199,12 +203,14 @@ describe('metamask-notifications - constructor()', () => {
     modifications?.(mocks);
 
     // Act
-    new NotificationServicesController({
+    const controller = new NotificationServicesController({
       messenger: mocks.messenger,
       env: { featureAnnouncements: featureAnnouncementsEnv },
       state: { isNotificationServicesEnabled: true },
     });
 
+    controller.init();
+
     return mocks;
   };
 
@@ -287,7 +293,7 @@ describe('metamask-notifications - constructor()', () => {
     modifications?.(mocks);
 
     // Act
-    new NotificationServicesController({
+    const controller = new NotificationServicesController({
       messenger: mocks.messenger,
       env: {
         featureAnnouncements: featureAnnouncementsEnv,
@@ -296,6 +302,8 @@ describe('metamask-notifications - constructor()', () => {
       state: { isNotificationServicesEnabled: true },
     });
 
+    controller.init();
+
     return mocks;
   };
 

packages/notification-services-controller/src/NotificationServicesController/NotificationServicesController.ts

@@ -545,7 +545,9 @@ export default class NotificationServicesController extends BaseController<
     this.#featureAnnouncementEnv = env.featureAnnouncements;
     this.#registerMessageHandlers();
     this.#clearLoadingStates();
+  }
 
+  init() {
     this.#keyringController.setupLockedStateSubscriptions(async () => {
       await this.#accounts.initialize();
       await this.#pushNotifications.initializePushNotifications();