@metamask/notification-services-controller 0.21.0 → 2.0.0

package/dist/NotificationServicesController/NotificationServicesController.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _NotificationServicesController_instances, _NotificationServicesController_isPushIntegrated, _NotificationServicesController_isPushNotificationsSetup, _NotificationServicesController_isUnlocked, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_storage, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_getValidStorageKeyAndBearerToken, _NotificationServicesController_assertUserStorage, _NotificationServicesController_getUserStorage, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
+var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_storage, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getValidStorageKeyAndBearerToken, _NotificationServicesController_assertUserStorage, _NotificationServicesController_getUserStorage, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
 function $importDefault(module) {
     if (module?.__esModule) {
         return module.default;
@@ -17,7 +17,7 @@ function $importDefault(module) {
     return module;
 }
 import { BaseController } from "@metamask/base-controller";
-import { toChecksumHexAddress } from "@metamask/controller-utils";
+import { isValidHexAddress, toChecksumHexAddress } from "@metamask/controller-utils";
 import { assert } from "@metamask/utils";
 import $log from "loglevel";
 const log = $importDefault($log);
@@ -108,26 +108,20 @@ class NotificationServicesController extends BaseController {
             state: { ...defaultState, ...state },
         });
         _NotificationServicesController_instances.add(this);
-        // Temporary boolean as push notifications are not yet enabled on mobile
-        _NotificationServicesController_isPushIntegrated.set(this, true);
-        // Flag to check is notifications have been setup when the browser/extension is initialized.
-        // We want to re-initialize push notifications when the browser/extension is refreshed
-        // To ensure we subscribe to the most up-to-date notifications
-        _NotificationServicesController_isPushNotificationsSetup.set(this, false);
-        _NotificationServicesController_isUnlocked.set(this, false);
         _NotificationServicesController_keyringController.set(this, {
+            isUnlocked: false,
             setupLockedStateSubscriptions: (onUnlock) => {
                 const { isUnlocked } = this.messagingSystem.call('KeyringController:getState');
-                __classPrivateFieldSet(this, _NotificationServicesController_isUnlocked, isUnlocked, "f");
+                __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = isUnlocked;
                 this.messagingSystem.subscribe('KeyringController:unlock', () => {
-                    __classPrivateFieldSet(this, _NotificationServicesController_isUnlocked, true, "f");
+                    __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = true;
                     // messaging system cannot await promises
                     // we don't need to wait for a result on this.
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     onUnlock();
                 });
                 this.messagingSystem.subscribe('KeyringController:lock', () => {
-                    __classPrivateFieldSet(this, _NotificationServicesController_isUnlocked, false, "f");
+                    __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = false;
                 });
             },
         });
@@ -154,13 +148,14 @@ class NotificationServicesController extends BaseController {
             },
         });
         _NotificationServicesController_pushNotifications.set(this, {
+            // Flag to check is notifications have been setup when the browser/extension is initialized.
+            // We want to re-initialize push notifications when the browser/extension is refreshed
+            // To ensure we subscribe to the most up-to-date notifications
+            isSetup: false,
             subscribeToPushNotifications: async () => {
                 await this.messagingSystem.call('NotificationServicesPushController:subscribeToPushNotifications');
             },
             enablePushNotifications: async (UUIDs) => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 try {
                     await this.messagingSystem.call('NotificationServicesPushController:enablePushNotifications', UUIDs);
                 }
@@ -168,21 +163,15 @@ class NotificationServicesController extends BaseController {
                     log.error('Silently failed to enable push notifications', e);
                 }
             },
-            disablePushNotifications: async (UUIDs) => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
+            disablePushNotifications: async () => {
                 try {
-                    await this.messagingSystem.call('NotificationServicesPushController:disablePushNotifications', UUIDs);
+                    await this.messagingSystem.call('NotificationServicesPushController:disablePushNotifications');
                 }
                 catch (e) {
                     log.error('Silently failed to disable push notifications', e);
                 }
             },
             updatePushNotifications: async (UUIDs) => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 try {
                     await this.messagingSystem.call('NotificationServicesPushController:updateTriggerPushNotifications', UUIDs);
                 }
@@ -191,37 +180,33 @@ class NotificationServicesController extends BaseController {
                 }
             },
             subscribe: () => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 this.messagingSystem.subscribe('NotificationServicesPushController:onNewNotifications', (notification) => {
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     this.updateMetamaskNotificationsList(notification);
                 });
             },
             initializePushNotifications: async () => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 if (!this.state.isNotificationServicesEnabled) {
                     return;
                 }
-                if (__classPrivateFieldGet(this, _NotificationServicesController_isPushNotificationsSetup, "f")) {
+                if (__classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").isSetup) {
                     return;
                 }
                 // If wallet is unlocked, we can create a fresh push subscription
                 // Otherwise we can subscribe to original subscription
-                if (__classPrivateFieldGet(this, _NotificationServicesController_isUnlocked, "f")) {
-                    const storage = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getUserStorage).call(this);
-                    if (!storage) {
-                        return;
+                try {
+                    if (!__classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked) {
+                        throw new Error('Keyring is locked');
                     }
-                    const uuids = Utils.getAllUUIDs(storage);
-                    await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(uuids);
-                    __classPrivateFieldSet(this, _NotificationServicesController_isPushNotificationsSetup, true, "f");
+                    await this.enablePushNotifications();
+                    __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").isSetup = true;
                 }
-                else {
-                    await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").subscribeToPushNotifications();
+                catch {
+                    await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f")
+                        .subscribeToPushNotifications()
+                        .catch(() => {
+                        // do nothing
+                    });
                 }
             },
         });
@@ -236,7 +221,9 @@ class NotificationServicesController extends BaseController {
             listAccounts: async () => {
                 // Get previous and current account sets
                 const nonChecksumAccounts = await this.messagingSystem.call('KeyringController:getAccounts');
-                const accounts = nonChecksumAccounts.map((a) => toChecksumHexAddress(a));
+                const accounts = nonChecksumAccounts
+                    .map((a) => toChecksumHexAddress(a))
+                    .filter((a) => isValidHexAddress(a));
                 const currentAccountsSet = new Set(accounts);
                 const prevAccountsSet = new Set(this.state.subscriptionAccountsSeen);
                 // Invalid value you cannot have zero accounts
@@ -267,7 +254,8 @@ class NotificationServicesController extends BaseController {
              * @returns result from list accounts
              */
             initialize: async () => {
-                if (__classPrivateFieldGet(this, _NotificationServicesController_isUnlocked, "f") && !__classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").isNotificationAccountsSetup) {
+                if (__classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked &&
+                    !__classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").isNotificationAccountsSetup) {
                     await __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
                     __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").isNotificationAccountsSetup = true;
                 }
@@ -295,7 +283,6 @@ class NotificationServicesController extends BaseController {
             },
         });
         _NotificationServicesController_featureAnnouncementEnv.set(this, void 0);
-        __classPrivateFieldSet(this, _NotificationServicesController_isPushIntegrated, env.isPushIntegrated ?? true, "f");
         __classPrivateFieldSet(this, _NotificationServicesController_featureAnnouncementEnv, env.featureAnnouncements, "f");
         __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_registerMessageHandlers).call(this);
         __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_clearLoadingStates).call(this);
@@ -311,15 +298,22 @@ class NotificationServicesController extends BaseController {
         __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").subscribe();
     }
     /**
-     * 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 method to expose enabling push notifications
+     */
+    async enablePushNotifications() {
+        await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_enableAuth).call(this);
+        const storage = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getUserStorage).call(this);
+        if (!storage) {
+            throw new Error('Unable to get triggers');
+        }
+        const uuids = Utils.getAllUUIDs(storage);
+        await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(uuids);
+    }
+    /**
+     * Public method to expose disabling push notifications
      */
-    selectIsNotificationServicesEnabled() {
-        return this.state.isNotificationServicesEnabled;
+    async disablePushNotifications() {
+        await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications();
     }
     async checkAccountsPresence(accounts) {
         try {
@@ -391,9 +385,12 @@ class NotificationServicesController extends BaseController {
             // Create the triggers
             const triggers = Utils.traverseUserStorageTriggers(userStorage);
             await OnChainNotifications.createOnChainTriggers(userStorage, storageKey, bearerToken, triggers);
-            // Create push notifications triggers
+            // Create push notifications triggers in background
             const allUUIDS = Utils.getAllUUIDs(userStorage);
-            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(allUUIDS);
+            // We do not want to wait for this request as it may take a while (e.g. for Firebase to setup)
+            __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(allUUIDS).catch(() => {
+                // Do Nothing
+            });
             // Write the new userStorage (triggers are now "enabled")
             await __classPrivateFieldGet(this, _NotificationServicesController_storage, "f").setNotificationStorage(JSON.stringify(userStorage));
             // Update the state of the controller
@@ -425,10 +422,7 @@ class NotificationServicesController extends BaseController {
     async enableMetamaskNotifications() {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
-            const isSignedIn = __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").isSignedIn();
-            if (!isSignedIn) {
-                await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").signIn();
-            }
+            await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_enableAuth).call(this);
             await this.createOnChainTriggers();
         }
         catch (e) {
@@ -448,30 +442,25 @@ class NotificationServicesController extends BaseController {
      * @throws {Error} If the user is not authenticated or if there is an error during the process.
      */
     async disableNotificationServices() {
+        __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
+        // Attempt Disable Push Notifications
         try {
-            __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
-            // Disable Push Notifications
-            const userStorage = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getUserStorage).call(this);
-            __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_assertUserStorage).call(this, userStorage);
-            const UUIDs = Utils.getAllUUIDs(userStorage);
-            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications(UUIDs);
-            const snapNotifications = this.state.metamaskNotificationsList.filter((notification) => notification.type === TRIGGER_TYPES.SNAP);
-            // Clear Notification States (toggles and list)
-            this.update((state) => {
-                state.isNotificationServicesEnabled = false;
-                state.isFeatureAnnouncementsEnabled = false;
-                // reassigning the notifications list with just snaps
-                // since the disable shouldn't affect snaps notifications
-                state.metamaskNotificationsList = snapNotifications;
-            });
-        }
-        catch (e) {
-            log.error('Unable to disable notifications', e);
-            throw new Error('Unable to disable notifications');
+            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications();
         }
-        finally {
-            __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, false);
+        catch {
+            // Do nothing
         }
+        // Update State: remove non-permitted notifications & disable flags
+        const snapNotifications = this.state.metamaskNotificationsList.filter((notification) => notification.type === TRIGGER_TYPES.SNAP);
+        this.update((state) => {
+            state.isNotificationServicesEnabled = false;
+            state.isFeatureAnnouncementsEnabled = false;
+            // reassigning the notifications list with just snaps
+            // since the disable shouldn't affect snaps notifications
+            state.metamaskNotificationsList = snapNotifications;
+        });
+        // Finish Updating State
+        __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, false);
     }
     /**
      * Deletes on-chain triggers associated with a specific account.
@@ -504,8 +493,9 @@ class NotificationServicesController extends BaseController {
             }
             // Delete these UUIDs (Mutates User Storage)
             await OnChainNotifications.deleteOnChainTriggers(userStorage, storageKey, bearerToken, UUIDs);
-            // Delete these UUIDs from the push notifications
-            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications(UUIDs);
+            // Update Push Notifications with new list of IDs
+            const remainingTriggerIds = Utils.getAllUUIDs(userStorage);
+            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").updatePushNotifications(remainingTriggerIds);
             // Update User Storage
             await __classPrivateFieldGet(this, _NotificationServicesController_storage, "f").setNotificationStorage(JSON.stringify(userStorage));
             return userStorage;
@@ -796,10 +786,9 @@ class NotificationServicesController extends BaseController {
         }
     }
 }
-_NotificationServicesController_isPushIntegrated = new WeakMap(), _NotificationServicesController_isPushNotificationsSetup = new WeakMap(), _NotificationServicesController_isUnlocked = new WeakMap(), _NotificationServicesController_keyringController = new WeakMap(), _NotificationServicesController_auth = new WeakMap(), _NotificationServicesController_storage = new WeakMap(), _NotificationServicesController_pushNotifications = new WeakMap(), _NotificationServicesController_accounts = new WeakMap(), _NotificationServicesController_featureAnnouncementEnv = new WeakMap(), _NotificationServicesController_instances = new WeakSet(), _NotificationServicesController_registerMessageHandlers = function _NotificationServicesController_registerMessageHandlers() {
+_NotificationServicesController_keyringController = new WeakMap(), _NotificationServicesController_auth = new WeakMap(), _NotificationServicesController_storage = new WeakMap(), _NotificationServicesController_pushNotifications = new WeakMap(), _NotificationServicesController_accounts = new WeakMap(), _NotificationServicesController_featureAnnouncementEnv = new WeakMap(), _NotificationServicesController_instances = new WeakSet(), _NotificationServicesController_registerMessageHandlers = function _NotificationServicesController_registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${controllerName}:updateMetamaskNotificationsList`, this.updateMetamaskNotificationsList.bind(this));
     this.messagingSystem.registerActionHandler(`${controllerName}:disableNotificationServices`, this.disableNotificationServices.bind(this));
-    this.messagingSystem.registerActionHandler(`${controllerName}:selectIsNotificationServicesEnabled`, this.selectIsNotificationServicesEnabled.bind(this));
     this.messagingSystem.registerActionHandler(`${controllerName}:getNotificationsByType`, this.getNotificationsByType.bind(this));
     this.messagingSystem.registerActionHandler(`${controllerName}:deleteNotificationsById`, this.deleteNotificationsById.bind(this));
 }, _NotificationServicesController_clearLoadingStates = function _NotificationServicesController_clearLoadingStates() {
@@ -816,6 +805,11 @@ _NotificationServicesController_isPushIntegrated = new WeakMap(), _NotificationS
         });
         throw new Error('User is not signed in.');
     }
+}, _NotificationServicesController_enableAuth = async function _NotificationServicesController_enableAuth() {
+    const isSignedIn = __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").isSignedIn();
+    if (!isSignedIn) {
+        await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").signIn();
+    }
 }, _NotificationServicesController_getValidStorageKeyAndBearerToken = async function _NotificationServicesController_getValidStorageKeyAndBearerToken() {
     __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_assertAuthEnabled).call(this);
     const bearerToken = await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").getBearerToken();
@@ -845,6 +839,7 @@ async function _NotificationServicesController_getUserStorage() {
     }
     try {
         const userStorage = JSON.parse(userStorageString);
+        Utils.cleanUserStorage(userStorage);
         return userStorage;
     }
     catch {