Add preinstalled and removable flags

Author: FrederikBolding

packages/snaps-controllers/coverage.json

@@ -1,6 +1,6 @@
 {
-  "branches": 89.83,
-  "functions": 96.4,
+  "branches": 89.86,
+  "functions": 96.41,
   "lines": 97.36,
-  "statements": 97.04
+  "statements": 97.05
 }

packages/snaps-controllers/src/snaps/SnapController.test.ts

@@ -3370,7 +3370,9 @@ describe('SnapController', () => {
         preinstalledSnaps,
         rootMessenger,
         state: {
-          snaps: getPersistedSnapsState(),
+          snaps: getPersistedSnapsState(
+            getPersistedSnapObject({ preinstalled: true }),
+          ),
         },
       });
       const [snapController] = getSnapControllerWithEES(snapControllerOptions);

packages/snaps-controllers/src/snaps/SnapController.ts

@@ -153,7 +153,7 @@ export interface PreinstalledSnap {
   snapId: SnapId;
   manifest: SnapManifest;
   files: PreinstalledSnapFile[];
-  // removable: boolean;
+  removable?: boolean;
 }
 
 /**
@@ -640,6 +640,8 @@ type AddSnapArgs = {
 type SetSnapArgs = Omit<AddSnapArgs, 'location' | 'versionRange'> & {
   files: FetchedSnapFiles;
   isUpdate?: boolean;
+  removable?: boolean;
+  preinstalled?: boolean;
 };
 
 const defaultState: SnapControllerState = {
@@ -1011,14 +1013,17 @@ export class SnapController extends BaseController<
   }
 
   #handlePreinstalledSnaps(preinstalledSnaps: PreinstalledSnap[]) {
-    for (const { snapId, manifest, files } of preinstalledSnaps) {
+    for (const { snapId, manifest, files, removable } of preinstalledSnaps) {
       const existingSnap = this.get(snapId);
       const isAlreadyInstalled = existingSnap !== undefined;
       const isUpdate =
         isAlreadyInstalled && gtVersion(manifest.version, existingSnap.version);
 
-      // Disallow downgrades
-      if (isAlreadyInstalled && !isUpdate) {
+      // Disallow downgrades and overwriting non preinstalled snaps
+      if (
+        isAlreadyInstalled &&
+        (!isUpdate || existingSnap.preinstalled !== true)
+      ) {
         continue;
       }
 
@@ -1058,7 +1063,13 @@ export class SnapController extends BaseController<
       };
 
       // Add snap to the SnapController state
-      this.#set({ id: snapId, origin: 'MetaMask', files: filesObject });
+      this.#set({
+        id: snapId,
+        origin: 'MetaMask',
+        files: filesObject,
+        removable,
+        preinstalled: true,
+      });
 
       // Setup permissions
       const processedPermissions = processSnapPermissions(
@@ -1585,6 +1596,11 @@ export class SnapController extends BaseController<
       throw new Error('Expected array of snap ids.');
     }
 
+    snapIds.forEach((snapId) => {
+      const snap = this.getExpect(snapId);
+      assert(snap.removable !== false, `${snapId} is not removable.`);
+    });
+
     await Promise.all(
       snapIds.map(async (snapId) => {
         const snap = this.getExpect(snapId);
@@ -2370,7 +2386,14 @@ export class SnapController extends BaseController<
    * @returns The resulting snap object.
    */
   #set(args: SetSnapArgs): PersistedSnap {
-    const { id: snapId, origin, files, isUpdate = false } = args;
+    const {
+      id: snapId,
+      origin,
+      files,
+      isUpdate = false,
+      removable,
+      preinstalled,
+    } = args;
 
     const {
       manifest,
@@ -2421,6 +2444,9 @@ export class SnapController extends BaseController<
       blocked: false,
       enabled: true,
 
+      removable,
+      preinstalled,
+
       id: snapId,
       initialPermissions: manifest.result.initialPermissions,
       manifest: manifest.result,

packages/snaps-utils/src/snaps.ts

@@ -126,6 +126,20 @@ export type Snap = TruncatedSnap & {
    * Localization files which are used to translate the manifest.
    */
   localizationFiles?: LocalizationFile[];
+
+  /**
+   * Flag to signal whether this snap was preinstalled or not.
+   *
+   * A lack of specifying this option will be deemed as not preinstalled.
+   */
+  preinstalled?: boolean;
+
+  /**
+   * Flag to signal whether this snap is removable or not.
+   *
+   * A lack of specifying this option will be deemed as removable.
+   */
+  removable?: boolean;
 };
 
 export type TruncatedSnapFields =

packages/snaps-utils/src/test-utils/snap.ts

@@ -32,6 +32,8 @@ export const getPersistedSnapObject = ({
   ],
   auxiliaryFiles = [],
   localizationFiles = [],
+  removable = undefined,
+  preinstalled = undefined,
 }: GetPersistedSnapObjectOptions = {}): PersistedSnap => {
   return {
     blocked,
@@ -45,6 +47,8 @@ export const getPersistedSnapObject = ({
     versionHistory,
     auxiliaryFiles,
     localizationFiles,
+    removable,
+    preinstalled,
   } as const;
 };
 
@@ -62,6 +66,8 @@ export const getSnapObject = ({
   ],
   auxiliaryFiles = [],
   localizationFiles = [],
+  removable = undefined,
+  preinstalled = undefined,
 }: GetSnapObjectOptions = {}): Snap => {
   return {
     blocked,
@@ -75,6 +81,8 @@ export const getSnapObject = ({
     versionHistory,
     auxiliaryFiles,
     localizationFiles,
+    removable,
+    preinstalled,
   } as const;
 };