fix: notification services add new allowed events (#26987)

## **Description** This PR introduces a change to the `metamask-controller.js` file to add an allowed action to the list of permitted actions for the `NotificationServicesController`. Specifically, the action `subscribeToPushNotifications` has been added for the `NotificationServicesPushController`. This PR is necessary after the release of this update: MetaMask/core#4653 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26987?quickstart=1) ## **Related issues** N/A ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ### **Before** N/A ### **After**  N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [x] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [x] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.
MetaMask · Sep 13, 2024 · c5cfd1c · c5cfd1c
1 parent b01f0c9
commit c5cfd1c
Show file tree

Hide file tree

Showing 10 changed files with 97 additions and 252 deletions.
diff --git a/app/scripts/controllers/push-notifications/get-notification-message.ts b/app/scripts/controllers/push-notifications/get-notification-message.ts
@@ -1,70 +1,64 @@
 import type { NotificationServicesController } from '@metamask/notification-services-controller';
-import { NotificationsServicesPushController } from '@metamask/notification-services-controller';
+import { NotificationServicesPushController } from '@metamask/notification-services-controller';
 import { t as translate } from '../../translate';
 
 const t = (...args: Parameters<typeof translate>) => translate(...args) ?? '';
 
-const translations: NotificationsServicesPushController.Utils.TranslationKeys =
-  {
-    pushPlatformNotificationsFundsSentTitle: () =>
-      t('pushPlatformNotificationsFundsSentTitle'),
-    pushPlatformNotificationsFundsSentDescriptionDefault: () =>
-      t('pushPlatformNotificationsFundsSentDescriptionDefault'),
-    pushPlatformNotificationsFundsSentDescription: (amount, symbol) =>
-      t('pushPlatformNotificationsFundsSentDescription', amount, symbol),
-    pushPlatformNotificationsFundsReceivedTitle: () =>
-      t('pushPlatformNotificationsFundsReceivedTitle'),
-    pushPlatformNotificationsFundsReceivedDescriptionDefault: () =>
-      t('pushPlatformNotificationsFundsReceivedDescriptionDefault'),
-    pushPlatformNotificationsFundsReceivedDescription: (amount, symbol) =>
-      t('pushPlatformNotificationsFundsReceivedDescription', amount, symbol),
-    pushPlatformNotificationsSwapCompletedTitle: () =>
-      t('pushPlatformNotificationsSwapCompletedTitle'),
-    pushPlatformNotificationsSwapCompletedDescription: () =>
-      t('pushPlatformNotificationsSwapCompletedDescription'),
-    pushPlatformNotificationsNftSentTitle: () =>
-      t('pushPlatformNotificationsNftSentTitle'),
-    pushPlatformNotificationsNftSentDescription: () =>
-      t('pushPlatformNotificationsNftSentDescription'),
-    pushPlatformNotificationsNftReceivedTitle: () =>
-      t('pushPlatformNotificationsNftReceivedTitle'),
-    pushPlatformNotificationsNftReceivedDescription: () =>
-      t('pushPlatformNotificationsNftReceivedDescription'),
-    pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle: () =>
-      t('pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle'),
-    pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription: () =>
-      t('pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription'),
-    pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle: () =>
-      t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle'),
-    pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription: () =>
-      t(
-        'pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription',
-      ),
-    pushPlatformNotificationsStakingLidoStakeCompletedTitle: () =>
-      t('pushPlatformNotificationsStakingLidoStakeCompletedTitle'),
-    pushPlatformNotificationsStakingLidoStakeCompletedDescription: () =>
-      t('pushPlatformNotificationsStakingLidoStakeCompletedDescription'),
-    pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle: () =>
-      t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle'),
-    pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription:
-      () =>
-        t(
-          'pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription',
-        ),
-    pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle: () =>
-      t('pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle'),
-    pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription: () =>
-      t('pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription'),
-    pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle: () =>
-      t('pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle'),
-    pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription: () =>
-      t('pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription'),
-  };
+const translations: NotificationServicesPushController.Utils.TranslationKeys = {
+  pushPlatformNotificationsFundsSentTitle: () =>
+    t('pushPlatformNotificationsFundsSentTitle'),
+  pushPlatformNotificationsFundsSentDescriptionDefault: () =>
+    t('pushPlatformNotificationsFundsSentDescriptionDefault'),
+  pushPlatformNotificationsFundsSentDescription: (amount, symbol) =>
+    t('pushPlatformNotificationsFundsSentDescription', amount, symbol),
+  pushPlatformNotificationsFundsReceivedTitle: () =>
+    t('pushPlatformNotificationsFundsReceivedTitle'),
+  pushPlatformNotificationsFundsReceivedDescriptionDefault: () =>
+    t('pushPlatformNotificationsFundsReceivedDescriptionDefault'),
+  pushPlatformNotificationsFundsReceivedDescription: (amount, symbol) =>
+    t('pushPlatformNotificationsFundsReceivedDescription', amount, symbol),
+  pushPlatformNotificationsSwapCompletedTitle: () =>
+    t('pushPlatformNotificationsSwapCompletedTitle'),
+  pushPlatformNotificationsSwapCompletedDescription: () =>
+    t('pushPlatformNotificationsSwapCompletedDescription'),
+  pushPlatformNotificationsNftSentTitle: () =>
+    t('pushPlatformNotificationsNftSentTitle'),
+  pushPlatformNotificationsNftSentDescription: () =>
+    t('pushPlatformNotificationsNftSentDescription'),
+  pushPlatformNotificationsNftReceivedTitle: () =>
+    t('pushPlatformNotificationsNftReceivedTitle'),
+  pushPlatformNotificationsNftReceivedDescription: () =>
+    t('pushPlatformNotificationsNftReceivedDescription'),
+  pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle: () =>
+    t('pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle'),
+  pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription: () =>
+    t('pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription'),
+  pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle: () =>
+    t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle'),
+  pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription: () =>
+    t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription'),
+  pushPlatformNotificationsStakingLidoStakeCompletedTitle: () =>
+    t('pushPlatformNotificationsStakingLidoStakeCompletedTitle'),
+  pushPlatformNotificationsStakingLidoStakeCompletedDescription: () =>
+    t('pushPlatformNotificationsStakingLidoStakeCompletedDescription'),
+  pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle: () =>
+    t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle'),
+  pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription: () =>
+    t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription'),
+  pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle: () =>
+    t('pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle'),
+  pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription: () =>
+    t('pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription'),
+  pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle: () =>
+    t('pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle'),
+  pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription: () =>
+    t('pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription'),
+};
 
 export function createNotificationMessage(
   n: NotificationServicesController.Types.INotification,
 ) {
-  return NotificationsServicesPushController.Utils.createOnChainPushNotificationMessage(
+  return NotificationServicesPushController.Utils.createOnChainPushNotificationMessage(
     n,
     translations,
   );

diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
@@ -148,7 +148,7 @@ import {
   UserStorageController,
 } from '@metamask/profile-sync-controller';
 import {
-  NotificationsServicesPushController,
+  NotificationServicesPushController,
   NotificationServicesController,
 } from '@metamask/notification-services-controller';
 import {
@@ -1485,7 +1485,12 @@ export default class MetamaskController extends EventEmitter {
           'NotificationServicesController:disableNotificationServices',
           'NotificationServicesController:selectIsNotificationServicesEnabled',
         ],
-        allowedEvents: ['KeyringController:lock', 'KeyringController:unlock'],
+        allowedEvents: [
+          'KeyringController:lock',
+          'KeyringController:unlock',
+          'AccountsController:accountAdded',
+          'AccountsController:accountRenamed',
+        ],
       }),
     });
 
@@ -1496,9 +1501,9 @@ export default class MetamaskController extends EventEmitter {
         allowedEvents: [],
       });
     this.notificationServicesPushController =
-      new NotificationsServicesPushController.Controller({
+      new NotificationServicesPushController.Controller({
         messenger: notificationServicesPushControllerMessenger,
-        state: initState.NotificationsServicesPushController,
+        state: initState.NotificationServicesPushController,
         env: {
           apiKey: process.env.FIREBASE_API_KEY ?? '',
           authDomain: process.env.FIREBASE_AUTH_DOMAIN ?? '',
@@ -1560,6 +1565,7 @@ export default class MetamaskController extends EventEmitter {
             'UserStorageController:performSetStorage',
             'NotificationServicesPushController:enablePushNotifications',
             'NotificationServicesPushController:disablePushNotifications',
+            'NotificationServicesPushController:subscribeToPushNotifications',
             'NotificationServicesPushController:updateTriggerPushNotifications',
           ],
           allowedEvents: [

diff --git a/lavamoat/browserify/beta/policy.json b/lavamoat/browserify/beta/policy.json
@@ -1903,9 +1903,9 @@
         "removeEventListener": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true,
         "@metamask/notification-services-controller>@contentful/rich-text-html-renderer": true,
-        "@metamask/notification-services-controller>@metamask/base-controller": true,
         "@metamask/notification-services-controller>firebase": true,
         "@metamask/profile-sync-controller": true,
         "bignumber.js": true,
@@ -1918,14 +1918,6 @@
         "SuppressedError": true
       }
     },
-    "@metamask/notification-services-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/notification-services-controller>firebase": {
       "packages": {
         "@metamask/notification-services-controller>firebase>@firebase/app": true,
@@ -2289,22 +2281,14 @@
         "setTimeout": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/message-signing-snap>@noble/ciphers": true,
-        "@metamask/profile-sync-controller>@metamask/base-controller": true,
         "@metamask/profile-sync-controller>siwe": true,
         "@noble/hashes": true,
         "browserify>buffer": true,
         "loglevel": true
       }
     },
-    "@metamask/profile-sync-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/profile-sync-controller>siwe": {
       "globals": {
         "console.error": true,

diff --git a/lavamoat/browserify/flask/policy.json b/lavamoat/browserify/flask/policy.json
@@ -1903,9 +1903,9 @@
         "removeEventListener": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true,
         "@metamask/notification-services-controller>@contentful/rich-text-html-renderer": true,
-        "@metamask/notification-services-controller>@metamask/base-controller": true,
         "@metamask/notification-services-controller>firebase": true,
         "@metamask/profile-sync-controller": true,
         "bignumber.js": true,
@@ -1918,14 +1918,6 @@
         "SuppressedError": true
       }
     },
-    "@metamask/notification-services-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/notification-services-controller>firebase": {
       "packages": {
         "@metamask/notification-services-controller>firebase>@firebase/app": true,
@@ -2289,22 +2281,14 @@
         "setTimeout": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/message-signing-snap>@noble/ciphers": true,
-        "@metamask/profile-sync-controller>@metamask/base-controller": true,
         "@metamask/profile-sync-controller>siwe": true,
         "@noble/hashes": true,
         "browserify>buffer": true,
         "loglevel": true
       }
     },
-    "@metamask/profile-sync-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/profile-sync-controller>siwe": {
       "globals": {
         "console.error": true,

diff --git a/lavamoat/browserify/main/policy.json b/lavamoat/browserify/main/policy.json
@@ -1903,9 +1903,9 @@
         "removeEventListener": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true,
         "@metamask/notification-services-controller>@contentful/rich-text-html-renderer": true,
-        "@metamask/notification-services-controller>@metamask/base-controller": true,
         "@metamask/notification-services-controller>firebase": true,
         "@metamask/profile-sync-controller": true,
         "bignumber.js": true,
@@ -1918,14 +1918,6 @@
         "SuppressedError": true
       }
     },
-    "@metamask/notification-services-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/notification-services-controller>firebase": {
       "packages": {
         "@metamask/notification-services-controller>firebase>@firebase/app": true,
@@ -2289,22 +2281,14 @@
         "setTimeout": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/message-signing-snap>@noble/ciphers": true,
-        "@metamask/profile-sync-controller>@metamask/base-controller": true,
         "@metamask/profile-sync-controller>siwe": true,
         "@noble/hashes": true,
         "browserify>buffer": true,
         "loglevel": true
       }
     },
-    "@metamask/profile-sync-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/profile-sync-controller>siwe": {
       "globals": {
         "console.error": true,

diff --git a/lavamoat/browserify/mmi/policy.json b/lavamoat/browserify/mmi/policy.json
@@ -1995,9 +1995,9 @@
         "removeEventListener": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true,
         "@metamask/notification-services-controller>@contentful/rich-text-html-renderer": true,
-        "@metamask/notification-services-controller>@metamask/base-controller": true,
         "@metamask/notification-services-controller>firebase": true,
         "@metamask/profile-sync-controller": true,
         "bignumber.js": true,
@@ -2010,14 +2010,6 @@
         "SuppressedError": true
       }
     },
-    "@metamask/notification-services-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/notification-services-controller>firebase": {
       "packages": {
         "@metamask/notification-services-controller>firebase>@firebase/app": true,
@@ -2381,22 +2373,14 @@
         "setTimeout": true
       },
       "packages": {
+        "@metamask/base-controller": true,
         "@metamask/message-signing-snap>@noble/ciphers": true,
-        "@metamask/profile-sync-controller>@metamask/base-controller": true,
         "@metamask/profile-sync-controller>siwe": true,
         "@noble/hashes": true,
         "browserify>buffer": true,
         "loglevel": true
       }
     },
-    "@metamask/profile-sync-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/profile-sync-controller>siwe": {
       "globals": {
         "console.error": true,

diff --git a/package.json b/package.json
@@ -336,15 +336,15 @@
     "@metamask/name-controller": "^8.0.0",
     "@metamask/network-controller": "patch:@metamask/network-controller@npm%3A20.2.0#~/.yarn/patches/@metamask-network-controller-npm-20.2.0-98b1a5ae59.patch",
     "@metamask/notification-controller": "^6.0.0",
-    "@metamask/notification-services-controller": "^0.2.1",
+    "@metamask/notification-services-controller": "^0.5.0",
     "@metamask/object-multiplex": "^2.0.0",
     "@metamask/obs-store": "^9.0.0",
     "@metamask/permission-controller": "^10.0.0",
     "@metamask/permission-log-controller": "^2.0.1",
     "@metamask/phishing-controller": "^12.0.1",
     "@metamask/post-message-stream": "^8.0.0",
     "@metamask/ppom-validator": "0.34.0",
-    "@metamask/profile-sync-controller": "^0.2.1",
+    "@metamask/profile-sync-controller": "^0.5.0",
     "@metamask/providers": "^14.0.2",
     "@metamask/queued-request-controller": "^2.0.0",
     "@metamask/rate-limit-controller": "^6.0.0",

diff --git a/test/e2e/mock-e2e.js b/test/e2e/mock-e2e.js
@@ -637,7 +637,7 @@ async function setupMocking(
     });
 
   // Notification APIs
-  mockNotificationServices(server);
+  await mockNotificationServices(server);
 
   await server.forGet(/^https:\/\/sourcify.dev\/(.*)/u).thenCallback(() => {
     return {