feat: add tests and utils

Author: Prithpal-Sooriya

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

@@ -206,7 +206,7 @@ describe('metamask-notifications - constructor()', () => {
     return mocks;
   };
 
-  it('initializes push notifications', async () => {
+  it('initialises push notifications', async () => {
     const { mockEnablePushNotifications } =
       arrangeActInitialisePushNotifications();
 

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

@@ -198,12 +198,6 @@ export type NotificationServicesControllerDisableNotificationServices = {
   handler: NotificationServicesController['disableNotificationServices'];
 };
 
-export type NotificationServicesControllerSelectIsNotificationServicesEnabled =
-  {
-    type: `${typeof controllerName}:selectIsNotificationServicesEnabled`;
-    handler: NotificationServicesController['selectIsNotificationServicesEnabled'];
-  };
-
 export type NotificationServicesControllerGetNotificationsByType = {
   type: `${typeof controllerName}:getNotificationsByType`;
   handler: NotificationServicesController['getNotificationsByType'];
@@ -219,7 +213,6 @@ export type Actions =
   | NotificationServicesControllerGetStateAction
   | NotificationServicesControllerUpdateMetamaskNotificationsList
   | NotificationServicesControllerDisableNotificationServices
-  | NotificationServicesControllerSelectIsNotificationServicesEnabled
   | NotificationServicesControllerGetNotificationsByType
   | NotificationServicesControllerDeleteNotificationsById;
 
@@ -582,11 +575,6 @@ export default class NotificationServicesController extends BaseController<
       this.disableNotificationServices.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
-      `${controllerName}:selectIsNotificationServicesEnabled`,
-      this.selectIsNotificationServicesEnabled.bind(this),
-    );
-
     this.messagingSystem.registerActionHandler(
       `${controllerName}:getNotificationsByType`,
       this.getNotificationsByType.bind(this),
@@ -664,18 +652,6 @@ export default class NotificationServicesController extends BaseController<
     }
   }
 
-  /**
-   * Retrieves the current enabled state of MetaMask notifications.
-   *
-   * This method directly returns the boolean value of `isMetamaskNotificationsEnabled`
-   * from the controller's state, indicating whether MetaMask notifications are currently enabled.
-   *
-   * @returns The enabled state of MetaMask notifications.
-   */
-  public selectIsNotificationServicesEnabled(): boolean {
-    return this.state.isNotificationServicesEnabled;
-  }
-
   /**
    * Sets the state of notification creation process.
    *

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

@@ -12,4 +12,4 @@ export * as Constants from './constants';
 export * from './constants';
 export * as Mocks from './__fixtures__';
 export * as UI from './ui';
-export * from '../shared/to-raw-notification';
+export * from '../shared';

packages/notification-services-controller/src/NotificationServicesController/processors/process-notifications.test.ts

@@ -1,4 +1,7 @@
-import { processNotification } from './process-notifications';
+import {
+  processNotification,
+  safeProcessNotification,
+} from './process-notifications';
 import { createMockFeatureAnnouncementRaw } from '../__fixtures__/mock-feature-announcements';
 import { createMockNotificationEthSent } from '../__fixtures__/mock-raw-notifications';
 import { createMockSnapNotification } from '../__fixtures__/mock-snap-notification';
@@ -34,3 +37,20 @@ describe('process-notifications - processNotification()', () => {
     );
   });
 });
+
+describe('process-notifications - safeProcessNotification()', () => {
+  // More thorough tests are found in the specific process
+  it('maps On Chain Notification to shared Notification Type', () => {
+    const result = safeProcessNotification(createMockNotificationEthSent());
+    expect(result).toBeDefined();
+  });
+
+  it('returns undefined for a notification unable to process', () => {
+    const rawNotification = createMockNotificationEthSent();
+
+    // Testing Mock with invalid notification type
+    rawNotification.type = 'FAKE_NOTIFICATION_TYPE' as TRIGGER_TYPES.ETH_SENT;
+    const result = safeProcessNotification(rawNotification);
+    expect(result).toBeUndefined();
+  });
+});

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

@@ -41,6 +41,18 @@ describe('metamask-notifications/utils - initializeUserStorage()', () => {
     );
     assertEmptyStorage(userStorageTest2);
   });
+
+  it('cleans User Storage if there are erroneous accounts', () => {
+    const mockAddress = ADDRESS_1;
+    const badAddress = '0xtb1qkw6c6f9lql679spp8qjfg3u6qrcdp5a6wqe35y';
+    const userStorage = Utils.initializeUserStorage(
+      [{ address: mockAddress }, { address: badAddress }],
+      true,
+    );
+
+    expect(userStorage[mockAddress.toLowerCase()]).toBeDefined();
+    expect(userStorage[badAddress.toLowerCase()]).toBeUndefined(); // Removed bad address
+  });
 });
 
 describe('metamask-notifications/utils - traverseUserStorageTriggers()', () => {

packages/notification-services-controller/src/NotificationServicesPushController/constants.ts

@@ -238,27 +238,6 @@ function getChainSymbol(chainId: number) {
   return Constants.CHAIN_SYMBOLS[chainId] ?? null;
 }
 
-/**
- * Checks if the given value is an OnChainRawNotification object.
- *
- * @param n - The value to check.
- * @returns True if the value is an OnChainRawNotification object, false otherwise.
- */
-export function isOnChainNotification(
-  n: unknown,
-): n is Types.OnChainRawNotification {
-  const assumed = n as Types.OnChainRawNotification;
-
-  // We don't have a validation/parsing library to check all possible types of an on chain notification
-  // It is safe enough just to check "some" fields, and catch any errors down the line if the shape is bad.
-  const isValidEnoughToBeOnChainNotification = [
-    assumed?.id,
-    assumed?.data,
-    assumed?.trigger_id,
-  ].every((field) => field !== undefined);
-  return isValidEnoughToBeOnChainNotification;
-}
-
 /**
  * Creates a push notification message based on the given on-chain raw notification.
  *

packages/notification-services-controller/src/NotificationServicesPushController/utils/get-notification-message.ts

@@ -0,0 +1,2 @@
+export * from './is-onchain-notification';
+export * from './to-raw-notification';

packages/notification-services-controller/src/shared/index.ts

@@ -0,0 +1,18 @@
+import { isOnChainRawNotification } from '.';
+import {
+  createMockFeatureAnnouncementRaw,
+  createMockNotificationEthSent,
+} from '../NotificationServicesController/__fixtures__';
+
+describe('is-onchain-notification - isOnChainRawNotification()', () => {
+  it('returns true if OnChainRawNotification', () => {
+    const notification = createMockNotificationEthSent();
+    const result = isOnChainRawNotification(notification);
+    expect(result).toBe(true);
+  });
+  it('returns false if not OnChainRawNotification', () => {
+    const notification = createMockFeatureAnnouncementRaw();
+    const result = isOnChainRawNotification(notification);
+    expect(result).toBe(false);
+  });
+});

packages/notification-services-controller/src/shared/is-onchain-notification.test.ts

@@ -0,0 +1,22 @@
+import type { OnChainRawNotification } from '../NotificationServicesController';
+
+/**
+ * Checks if the given value is an OnChainRawNotification object.
+ *
+ * @param n - The value to check.
+ * @returns True if the value is an OnChainRawNotification object, false otherwise.
+ */
+export function isOnChainRawNotification(
+  n: unknown,
+): n is OnChainRawNotification {
+  const assumed = n as OnChainRawNotification;
+
+  // We don't have a validation/parsing library to check all possible types of an on chain notification
+  // It is safe enough just to check "some" fields, and catch any errors down the line if the shape is bad.
+  const isValidEnoughToBeOnChainNotification = [
+    assumed?.id,
+    assumed?.data,
+    assumed?.trigger_id,
+  ].every((field) => field !== undefined);
+  return isValidEnoughToBeOnChainNotification;
+}