feat: added notification snap to methods-snap #137

src/metamask/index.ts

@@ -4,7 +4,7 @@ import { Dappeteer } from "..";
 
 import { acceptDialog } from "../snap/acceptDialog";
 import { rejectDialog } from "../snap/rejectDialog";
-import { installSnap, invokeSnap } from "../snap";
+import { getAllNotifications, installSnap, invokeSnap } from "../snap";
 import { addNetwork } from "./addNetwork";
 import { addToken } from "./addToken";
 import { approve } from "./approve";
@@ -53,6 +53,7 @@ export const getMetaMask = (page: Page): Promise<Dappeteer> => {
         deleteNetwork: deleteNetwork(page),
       },
       snaps: {
+        getAllNotifications: getAllNotifications(page),
         acceptDialog: acceptDialog(page),
         rejectDialog: rejectDialog(page),
         invokeSnap,

src/snap/getAllNotifications.ts

@@ -0,0 +1,17 @@
+import { Page } from "puppeteer";
+import { clickOnElement, openProfileDropdown } from "../helpers";
+import { NotificationList } from "./types";
+
+export const getAllNotifications =
+  (page: Page) => async (): Promise<NotificationList> => {
+    await page.bringToFront();
+    await openProfileDropdown(page);
+    await clickOnElement(page, "Notifications");
+    await page.waitForTimeout(300);
+
+    return await page.$$eval(
+      ".notifications__item__details__message",
+      (elements) =>
+        elements.map((element) => ({ message: element.textContent }))
+    );
+  };

src/snap/index.ts

@@ -1,3 +1,4 @@
 export { flaskOnly } from "./utils";
 export { installSnap } from "./install";
 export { invokeSnap } from "./invokeSnap";
+export { getAllNotifications } from "./getAllNotifications";

src/snap/types.ts

@@ -18,3 +18,5 @@ export interface InstallSnapResult {
     };
   };
 }
+
+export type NotificationList = { message: string }[];

src/types.ts

@@ -5,7 +5,7 @@ import { Page, Serializable } from "puppeteer";
 import { Path } from "./setup/metaMaskDownloader";
 
 import { InstallStep } from "./snap/install";
-import { InstallSnapResult } from "./snap/types";
+import { InstallSnapResult, NotificationList } from "./snap/types";
 import { RECOMMENDED_METAMASK_VERSION } from "./index";
 
 declare global {
@@ -80,6 +80,7 @@ export type Dappeteer = {
     deleteNetwork: (name: string) => Promise<void>;
   };
   snaps: {
+    getAllNotifications: () => Promise<NotificationList>;
     invokeSnap: <R = unknown, P extends Serializable = Serializable>(
       page: Page,
       snapId: string,

test/flask/methods-snap/snap.manifest.json

@@ -3,7 +3,7 @@
   "description": "An example Snap written in TypeScript.",
   "proposedName": "Methods Snap\n",
   "source": {
-    "shasum": "BCwqoDyQltaL0dh0IrzN1A66D1jPMLAseJOHmqI1faU=",
+    "shasum": "lHBPubadQ9IHZuFZkp77Vp7lrnZFW0J0OcGZvrn3NHc=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

test/flask/methods-snap/src/index.ts

@@ -15,6 +15,26 @@ export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
           },
         ],
       });
+    case "notify_inApp":
+      return wallet.request({
+        method: "snap_notify",
+        params: [
+          {
+            type: "inApp",
+            message: `Hello, in App notification`,
+          },
+        ],
+      });
+    case "notify_inApp_update":
+      return wallet.request({
+        method: "snap_notify",
+        params: [
+          {
+            type: "inApp",
+            message: `Update notification`,
+          },
+        ],
+      });
     default:
       throw new Error("Method not found.");
   }

test/flask/snaps.spec.ts

@@ -97,5 +97,26 @@ describe("snaps", function () {
 
       expect(await invokeAction).to.equal(false);
     });
+
+    it("should invoke IN APP NOTIFICATIONS and check for a text", async function (this: TestContext) {
+      await metamask.snaps.invokeSnap(
+        testPage,
+        getSnapIdByName(this, Snaps.METHODS_SNAP),
+        "notify_inApp"
+      );
+      // Metamask doesn't allow to invoke two notifications in a row,
+      // so some delay should persist before calling the next notification
+      await metamask.page.waitForTimeout(5000);
+      await metamask.snaps.invokeSnap(
+        testPage,
+        getSnapIdByName(this, Snaps.METHODS_SNAP),
+        "notify_inApp_update"
+      );
+
+      const notifications = await metamask.snaps.getAllNotifications();
+
+      expect(notifications[0].message).to.equal("Update notification");
+      expect(notifications[1].message).to.equal("Hello, in App notification");
+    });
   });
 });