feat: Emit snapInstalled and snapUpdated for preinstalled Snaps

MetaMask · Nov 21, 2024 · e67b8a5 · e67b8a5
1 parent 406f7a2
commit e67b8a5
Show file tree

Hide file tree

Showing 3 changed files with 123 additions and 6 deletions.
diff --git a/packages/snaps-controllers/coverage.json b/packages/snaps-controllers/coverage.json
@@ -1,6 +1,6 @@
 {
-  "branches": 92.85,
+  "branches": 92.89,
   "functions": 96.71,
   "lines": 98,
-  "statements": 97.7
+  "statements": 97.71
 }
diff --git a/packages/snaps-controllers/src/snaps/SnapController.test.tsx b/packages/snaps-controllers/src/snaps/SnapController.test.tsx
@@ -966,6 +966,7 @@ describe('SnapController', () => {
       'SnapController:snapInstalled',
       getTruncatedSnap(),
       MOCK_ORIGIN,
+      false,
     );
 
     snapController.destroy();
@@ -4665,6 +4666,7 @@ describe('SnapController', () => {
     it('supports preinstalled snaps', async () => {
       const rootMessenger = getControllerMessenger();
       jest.spyOn(rootMessenger, 'call');
+      jest.spyOn(rootMessenger, 'publish');
 
       // The snap should not have permission initially
       rootMessenger.registerActionHandler(
@@ -4711,6 +4713,13 @@ describe('SnapController', () => {
         },
       );
 
+      expect(rootMessenger.publish).toHaveBeenCalledWith(
+        'SnapController:snapInstalled',
+        getTruncatedSnap(),
+        'metamask',
+        true,
+      );
+
       // After install the snap should have permissions
       rootMessenger.registerActionHandler(
         'PermissionController:getPermissions',
@@ -4880,6 +4889,7 @@ describe('SnapController', () => {
     it('supports updating preinstalled snaps', async () => {
       const rootMessenger = getControllerMessenger();
       jest.spyOn(rootMessenger, 'call');
+      jest.spyOn(rootMessenger, 'publish');
 
       const preinstalledSnaps = [
         {
@@ -4934,6 +4944,21 @@ describe('SnapController', () => {
         },
       );
 
+      expect(rootMessenger.publish).toHaveBeenCalledWith(
+        'SnapController:snapUpdated',
+        getTruncatedSnap({
+          version: '1.2.3',
+          initialPermissions: {
+            'endowment:rpc': { dapps: false, snaps: true },
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            snap_getEntropy: {},
+          },
+        }),
+        '1.0.0',
+        'metamask',
+        true,
+      );
+
       // After install the snap should have permissions
       rootMessenger.registerActionHandler(
         'PermissionController:getPermissions',
@@ -5092,6 +5117,66 @@ describe('SnapController', () => {
       snapController.destroy();
     });
 
+    it('disallows manual updates of preinstalled snaps', async () => {
+      const rootMessenger = getControllerMessenger();
+      jest.spyOn(rootMessenger, 'call');
+
+      // The snap should not have permissions initially
+      rootMessenger.registerActionHandler(
+        'PermissionController:getPermissions',
+        () => ({}),
+      );
+
+      const preinstalledSnaps = [
+        {
+          snapId: MOCK_SNAP_ID,
+          manifest: getSnapManifest(),
+          files: [
+            {
+              path: DEFAULT_SOURCE_PATH,
+              value: stringToBytes(DEFAULT_SNAP_BUNDLE),
+            },
+            {
+              path: DEFAULT_ICON_PATH,
+              value: stringToBytes(DEFAULT_SNAP_ICON),
+            },
+          ],
+        },
+      ];
+
+      const snapControllerOptions = getSnapControllerWithEESOptions({
+        preinstalledSnaps,
+        rootMessenger,
+      });
+      const [snapController] = getSnapControllerWithEES(snapControllerOptions);
+
+      // After install the snap should have permissions
+      rootMessenger.registerActionHandler(
+        'PermissionController:getPermissions',
+        () => MOCK_SNAP_PERMISSIONS,
+      );
+
+      const { manifest } = await getMockSnapFilesWithUpdatedChecksum({
+        manifest: getSnapManifest({
+          version: '1.1.0' as SemVerVersion,
+        }),
+      });
+
+      const detectSnapLocation = loopbackDetect({
+        manifest: manifest.result,
+      });
+
+      await expect(
+        snapController.updateSnap(
+          MOCK_ORIGIN,
+          MOCK_SNAP_ID,
+          detectSnapLocation(),
+        ),
+      ).rejects.toThrow('Preinstalled Snaps cannot be manually updated.');
+
+      snapController.destroy();
+    });
+
     it('supports preinstalled Snaps specifying the hidden flag', async () => {
       const rootMessenger = getControllerMessenger();
       jest.spyOn(rootMessenger, 'call');
@@ -6772,6 +6857,7 @@ describe('SnapController', () => {
         newSnapTruncated,
         '1.0.0',
         MOCK_ORIGIN,
+        false,
       );
 
       controller.destroy();

diff --git a/packages/snaps-controllers/src/snaps/SnapController.ts b/packages/snaps-controllers/src/snaps/SnapController.ts
@@ -476,7 +476,7 @@ export type SnapInstallFailed = {
  */
 export type SnapInstalled = {
   type: `${typeof controllerName}:snapInstalled`;
-  payload: [snap: TruncatedSnap, origin: string];
+  payload: [snap: TruncatedSnap, origin: string, preinstalled: boolean];
 };
 
 /**
@@ -500,7 +500,12 @@ export type SnapUnblocked = {
  */
 export type SnapUpdated = {
   type: `${typeof controllerName}:snapUpdated`;
-  payload: [snap: TruncatedSnap, oldVersion: string, origin: string];
+  payload: [
+    snap: TruncatedSnap,
+    oldVersion: string,
+    origin: string,
+    preinstalled: boolean,
+  ];
 };
 
 /**
@@ -1229,6 +1234,24 @@ export class SnapController extends BaseController<
       this.update((state) => {
         state.snaps[snapId].status = SnapStatus.Stopped;
       });
+
+      // Emit events
+      if (isUpdate) {
+        this.messagingSystem.publish(
+          'SnapController:snapUpdated',
+          this.getTruncatedExpect(snapId),
+          existingSnap.version,
+          'metamask',
+          true,
+        );
+      } else {
+        this.messagingSystem.publish(
+          'SnapController:snapInstalled',
+          this.getTruncatedExpect(snapId),
+          'metamask',
+          true,
+        );
+      }
     }
   }
 
@@ -2323,6 +2346,7 @@ export class SnapController extends BaseController<
           `SnapController:snapInstalled`,
           this.getTruncatedExpect(snapId),
           origin,
+          false,
         ),
       );
 
@@ -2332,6 +2356,7 @@ export class SnapController extends BaseController<
           this.getTruncatedExpect(snapId),
           oldVersion,
           origin,
+          false,
         ),
       );
 
@@ -2537,6 +2562,13 @@ export class SnapController extends BaseController<
   ): Promise<TruncatedSnap> {
     this.#assertCanInstallSnaps();
     this.#assertCanUsePlatform();
+
+    const snap = this.getExpect(snapId);
+
+    if (snap.preinstalled) {
+      throw new Error('Preinstalled Snaps cannot be manually updated.');
+    }
+
     if (!isValidSemVerRange(newVersionRange)) {
       throw new Error(
         `Received invalid snap version range: "${newVersionRange}".`,
@@ -2557,8 +2589,6 @@ export class SnapController extends BaseController<
         true,
       );
 
-      const snap = this.getExpect(snapId);
-
       const oldManifest = snap.manifest;
 
       const newSnap = await fetchSnap(snapId, location);
@@ -2679,6 +2709,7 @@ export class SnapController extends BaseController<
           truncatedSnap,
           snap.version,
           origin,
+          false,
         );
       }