@metamask/notification-services-controller 21.0.0 → 22.1.0

package/CHANGELOG.md

@@ -7,6 +7,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [22.1.0]
+
+### Changed
+
+- Debounce `KeyringController:stateChange` handler to reduce redundant notification subscription calls during rapid account syncing ([#7980](https://github.com/MetaMask/core/pull/7980))
+- Filter out Product Account announcements notifications older than 3 months ([#7884](https://github.com/MetaMask/core/pull/7884))
+- Bump `@metamask/controller-utils` from `^11.18.0` to `^11.19.0` ([#7995](https://github.com/MetaMask/core/pull/7995))
+- Bump `@metamask/profile-sync-controller` from `^27.1.0` to `^28.0.0` ([#8162](https://github.com/MetaMask/core/pull/8162))
+
+## [22.0.0]
+
+### Changed
+
+- Upgrade `@metamask/utils` from `^11.8.1` to `^11.9.0` ([#7511](https://github.com/MetaMask/core/pull/7511))
+- Move peer dependencies for controller and service packages to direct dependencies ([#7209](https://github.com/MetaMask/core/pull/7209), [#7713](https://github.com/MetaMask/core/pull/7713), [#7849](https://github.com/MetaMask/core/pull/7849))
+  - The dependencies moved are:
+    - `@metamask/keyring-controller` (^25.1.0)
+    - `@metamask/profile-sync-controller` (^27.1.0)
+  - In clients, it is now possible for multiple versions of these packages to exist in the dependency tree.
+    - For example, this scenario would be valid: a client relies on `@metamask/controller-a` 1.0.0 and `@metamask/controller-b` 1.0.0, and `@metamask/controller-b` depends on `@metamask/controller-a` 1.1.0.
+  - Note, however, that the versions specified in the client's `package.json` always "win", and you are expected to keep them up to date so as not to break controller and service intercommunication.
+- Modified background push utilities to handle more edgecases and not throw errors ([#7275](https://github.com/MetaMask/core/pull/7275))
+- Bump `@metamask/controller-utils` from `^11.16.0` to `^11.18.0` ([#7534](https://github.com/MetaMask/core/pull/7534), [#7583](https://github.com/MetaMask/core/pull/7583))
+- Filter feature announcements older than 3 months ([#7884](https://github.com/MetaMask/core/pull/7884))
+- Move notifications networks metadata to backend ([#7840](https://github.com/MetaMask/core/pull/7840))
+
+### Removed
+
+- **BREAKING:** Removed the `"./notification-services/ui"` subpath export from `package.json` ([#7840](https://github.com/MetaMask/core/pull/7840))
+  - Consumers that import from `@metamask/notification-services-controller/notification-services/ui` must switch to network config provided by the backend.
+
+### Fixed
+
+- Remove non-actionable internal `log.error` calls for expected silent-failure notification paths, while preserving thrown errors where propagation is required ([#7885](https://github.com/MetaMask/core/pull/7885))
+- Fix `createOnChainTriggers` to preserve user preferences on notification re-subscriptions ([#7423](https://github.com/MetaMask/core/pull/7423))
+  - Previously, `isFeatureAnnouncementsEnabled` was unconditionally set to `true` on every re-subscription, overriding user preferences
+  - Now, existing preferences are preserved when `isNotificationServicesEnabled` is already `true`
+
 ## [21.0.0]
 
 ### Changed
@@ -629,7 +667,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@21.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@22.1.0...HEAD
+[22.1.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@22.0.0...@metamask/notification-services-controller@22.1.0
+[22.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@21.0.0...@metamask/notification-services-controller@22.0.0
 [21.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@20.0.0...@metamask/notification-services-controller@21.0.0
 [20.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@19.0.0...@metamask/notification-services-controller@20.0.0
 [19.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@18.3.1...@metamask/notification-services-controller@19.0.0

package/dist/NotificationServicesController/NotificationServicesController.cjs

@@ -15,11 +15,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_locale, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_env, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getBearerToken, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultState = void 0;
+exports.defaultState = exports.ACCOUNTS_UPDATE_DEBOUNCE_TIME_MS = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const keyring_controller_1 = require("@metamask/keyring-controller");
 const utils_1 = require("@metamask/utils");
+const lodash_1 = require("lodash");
 const loglevel_1 = __importDefault(require("loglevel"));
 const notification_schema_1 = require("./constants/notification-schema.cjs");
 const process_notifications_1 = require("./processors/process-notifications.cjs");
@@ -28,6 +29,7 @@ const feature_announcements_1 = require("./services/feature-announcements.cjs");
 const perp_notifications_1 = require("./services/perp-notifications.cjs");
 // Unique name for the controller
 const controllerName = 'NotificationServicesController';
+exports.ACCOUNTS_UPDATE_DEBOUNCE_TIME_MS = 1000;
 const metadata = {
     subscriptionAccountsSeen: {
         includeInStateLogs: true,
@@ -168,16 +170,16 @@ class NotificationServicesController extends base_controller_1.BaseController {
                 try {
                     await this.messenger.call('NotificationServicesPushController:enablePushNotifications', addresses);
                 }
-                catch (e) {
-                    loglevel_1.default.error('Silently failed to enable push notifications', e);
+                catch {
+                    // Do nothing, failing silently.
                 }
             },
             disablePushNotifications: async () => {
                 try {
                     await this.messenger.call('NotificationServicesPushController:disablePushNotifications');
                 }
-                catch (e) {
-                    loglevel_1.default.error('Silently failed to disable push notifications', e);
+                catch {
+                    // Do nothing, failing silently.
                 }
             },
             subscribe: () => {
@@ -216,7 +218,7 @@ class NotificationServicesController extends base_controller_1.BaseController {
             isNotificationAccountsSetup: false,
             getNotificationAccounts: () => {
                 const { keyrings } = this.messenger.call('KeyringController:getState');
-                const firstHDKeyring = keyrings.find((k) => k.type === keyring_controller_1.KeyringTypes.hd.toString());
+                const firstHDKeyring = keyrings.find((keyring) => keyring.type === keyring_controller_1.KeyringTypes.hd.toString());
                 const keyringAccounts = firstHDKeyring?.accounts ?? null;
                 return keyringAccounts;
             },
@@ -236,8 +238,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
                     };
                 }
                 const accounts = nonChecksumAccounts
-                    .map((a) => (0, controller_utils_1.toChecksumHexAddress)(a))
-                    .filter((a) => (0, controller_utils_1.isValidHexAddress)(a));
+                    .map((address) => (0, controller_utils_1.toChecksumHexAddress)(address))
+                    .filter((address) => (0, controller_utils_1.isValidHexAddress)(address));
                 const currentAccountsSet = new Set(accounts);
                 const prevAccountsSet = new Set(this.state.subscriptionAccountsSeen);
                 // Invalid value you cannot have zero accounts
@@ -250,8 +252,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
                     };
                 }
                 // Calculate added and removed addresses
-                const accountsAdded = accounts.filter((a) => !prevAccountsSet.has(a));
-                const accountsRemoved = [...prevAccountsSet.values()].filter((a) => !currentAccountsSet.has(a));
+                const accountsAdded = accounts.filter((account) => !prevAccountsSet.has(account));
+                const accountsRemoved = [...prevAccountsSet.values()].filter((account) => !currentAccountsSet.has(account));
                 // Update accounts seen
                 this.update((state) => {
                     state.subscriptionAccountsSeen = [...currentAccountsSet];
@@ -278,7 +280,7 @@ class NotificationServicesController extends base_controller_1.BaseController {
              * And call effects to subscribe/unsubscribe to notifications.
              */
             subscribe: () => {
-                this.messenger.subscribe('KeyringController:stateChange', async (totalAccounts, prevTotalAccounts) => {
+                const debouncedUpdateAccountNotifications = (0, lodash_1.debounce)(async (totalAccounts, prevTotalAccounts) => {
                     const hasTotalAccountsChanged = totalAccounts !== prevTotalAccounts;
                     if (!this.state.isNotificationServicesEnabled ||
                         !hasTotalAccountsChanged) {
@@ -293,7 +295,11 @@ class NotificationServicesController extends base_controller_1.BaseController {
                         promises.push(this.disableAccounts(accountsRemoved));
                     }
                     await Promise.allSettled(promises);
-                }, (state) => {
+                }, exports.ACCOUNTS_UPDATE_DEBOUNCE_TIME_MS);
+                this.messenger.subscribe('KeyringController:stateChange', 
+                // Using void return for async callback - result is intentionally ignored
+                // eslint-disable-next-line @typescript-eslint/no-misused-promises
+                debouncedUpdateAccountNotifications, (state) => {
                     return (state?.keyrings?.flatMap?.((keyring) => keyring.accounts)?.length ??
                         0);
                 });
@@ -328,14 +334,14 @@ class NotificationServicesController extends base_controller_1.BaseController {
             const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
             const addressesWithNotifications = await (0, api_notifications_1.getNotificationsApiConfigCached)(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
             const addresses = addressesWithNotifications
-                .filter((a) => Boolean(a.enabled))
-                .map((a) => a.address);
+                .filter((addressConfig) => Boolean(addressConfig.enabled))
+                .map((addressConfig) => addressConfig.address);
             if (addresses.length > 0) {
                 await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(addresses);
             }
         }
-        catch (e) {
-            loglevel_1.default.error('Failed to enable push notifications', e);
+        catch {
+            // Do nothing, failing silently.
         }
     }
     /**
@@ -375,12 +381,12 @@ class NotificationServicesController extends base_controller_1.BaseController {
      */
     async setFeatureAnnouncementsEnabled(featureAnnouncementsEnabled) {
         try {
-            this.update((s) => {
-                s.isFeatureAnnouncementsEnabled = featureAnnouncementsEnabled;
+            this.update((state) => {
+                state.isFeatureAnnouncementsEnabled = featureAnnouncementsEnabled;
             });
         }
-        catch (e) {
-            loglevel_1.default.error('Unable to toggle feature announcements', e);
+        catch (error) {
+            loglevel_1.default.error('Unable to toggle feature announcements', error);
             throw new Error('Unable to toggle feature announcements');
         }
     }
@@ -405,8 +411,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
             // Notifications API can return array with addresses set to false
             // So assert that at least one address is enabled
             let accountsWithNotifications = addressesWithNotifications
-                .filter((a) => Boolean(a.enabled))
-                .map((a) => a.address);
+                .filter((addressConfig) => Boolean(addressConfig.enabled))
+                .map((addressConfig) => addressConfig.address);
             // 2. Enable Notifications (if no accounts subscribed or we are resetting)
             if (accountsWithNotifications.length === 0 || opts?.resetNotifications) {
                 await (0, api_notifications_1.updateOnChainNotifications)(bearerToken, accounts.map((address) => ({ address, enabled: true })), __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
@@ -420,13 +426,21 @@ class NotificationServicesController extends base_controller_1.BaseController {
             });
             // Update the state of the controller
             this.update((state) => {
-                state.isNotificationServicesEnabled = true;
-                state.isFeatureAnnouncementsEnabled = true;
-                state.isMetamaskNotificationsFeatureSeen = true;
+                // User is re-subscribing (daily resub to get latest notifications)
+                if (state.isNotificationServicesEnabled) {
+                    // Keep their existing preferences on re-subscribe
+                    // No state updates needed - preserving user's current settings
+                }
+                else {
+                    // User is turning on notifications from a disabled state
+                    state.isNotificationServicesEnabled = true;
+                    state.isFeatureAnnouncementsEnabled = true;
+                    state.isMetamaskNotificationsFeatureSeen = true;
+                }
             });
         }
-        catch (err) {
-            loglevel_1.default.error('Failed to create On Chain triggers', err);
+        catch (error) {
+            loglevel_1.default.error('Failed to create On Chain triggers', error);
             throw new Error('Failed to create On Chain triggers');
         }
         finally {
@@ -445,8 +459,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
             await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_enableAuth).call(this);
             await this.createOnChainTriggers();
         }
-        catch (e) {
-            loglevel_1.default.error('Unable to enable notifications', e);
+        catch (error) {
+            loglevel_1.default.error('Unable to enable notifications', error);
             throw new Error('Unable to enable notifications');
         }
         finally {
@@ -503,8 +517,7 @@ class NotificationServicesController extends base_controller_1.BaseController {
             // Delete these UUIDs (Mutates User Storage)
             await (0, api_notifications_1.updateOnChainNotifications)(bearerToken, accounts.map((address) => ({ address, enabled: false })), __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
         }
-        catch (err) {
-            loglevel_1.default.error('Failed to delete OnChain triggers', err);
+        catch {
             throw new Error('Failed to delete OnChain triggers');
         }
         finally {
@@ -532,8 +545,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
             await (0, api_notifications_1.updateOnChainNotifications)(bearerToken, accounts.map((address) => ({ address, enabled: true })), __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
         }
-        catch (err) {
-            loglevel_1.default.error('Failed to update OnChain triggers', err);
+        catch (error) {
+            loglevel_1.default.error('Failed to update OnChain triggers', error);
             throw new Error('Failed to update OnChain triggers');
         }
         finally {
@@ -567,8 +580,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
                     const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
                     const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
                     const addressesWithNotifications = (await (0, api_notifications_1.getNotificationsApiConfigCached)(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f")))
-                        .filter((a) => Boolean(a.enabled))
-                        .map((a) => a.address);
+                        .filter((addressConfig) => Boolean(addressConfig.enabled))
+                        .map((addressConfig) => addressConfig.address);
                     const notifications = await (0, api_notifications_1.getAPINotifications)(bearerToken, addressesWithNotifications, __classPrivateFieldGet(this, _NotificationServicesController_locale, "f").call(this), __classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f").platform, __classPrivateFieldGet(this, _NotificationServicesController_env, "f")).catch(() => []);
                     rawOnChainNotifications.push(...notifications);
                 }
@@ -587,7 +600,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
                 ...snapNotifications,
             ];
             // Sort Notifications
-            metamaskNotifications.sort((a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime());
+            metamaskNotifications.sort((notificationA, notificationB) => new Date(notificationB.createdAt).getTime() -
+                new Date(notificationA.createdAt).getTime());
             // Update State
             this.update((state) => {
                 state.metamaskNotificationsList = metamaskNotifications;
@@ -596,9 +610,9 @@ class NotificationServicesController extends base_controller_1.BaseController {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsFetchingMetamaskNotifications).call(this, false);
             return metamaskNotifications;
         }
-        catch (err) {
+        catch (error) {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsFetchingMetamaskNotifications).call(this, false);
-            loglevel_1.default.error('Failed to fetch notifications', err);
+            loglevel_1.default.error('Failed to fetch notifications', error);
             throw new Error('Failed to fetch notifications');
         }
     }
@@ -694,8 +708,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
                 snapNotificationIds = snapNotifications.map((notification) => notification.id);
             }
         }
-        catch (err) {
-            loglevel_1.default.warn('Something failed when marking notifications as read', err);
+        catch (error) {
+            loglevel_1.default.warn('Something failed when marking notifications as read', error);
         }
         // Update the state (state is also used on counter & badge)
         this.update((state) => {
@@ -732,13 +746,13 @@ class NotificationServicesController extends base_controller_1.BaseController {
      * @returns A promise that resolves when the notification list has been successfully updated.
      */
     async updateMetamaskNotificationsList(notification) {
-        if (this.state.metamaskNotificationsList.some((n) => n.id === notification.id)) {
+        if (this.state.metamaskNotificationsList.some((existingNotification) => existingNotification.id === notification.id)) {
             return;
         }
         const processedNotification = (0, process_notifications_1.safeProcessNotification)(notification);
         if (processedNotification) {
             this.update((state) => {
-                const existingNotificationIds = new Set(state.metamaskNotificationsList.map((n) => n.id));
+                const existingNotificationIds = new Set(state.metamaskNotificationsList.map((existingNotification) => existingNotification.id));
                 // Add the new notification only if its ID is not already present in the list
                 if (!existingNotificationIds.has(processedNotification.id)) {
                     state.metamaskNotificationsList = [