@metamask/snaps-controllers 18.0.1 → 18.0.2

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [18.0.2]
+
+### Changed
+
+- Bump `@metamask/json-rpc-engine` from `10.2.2` to `10.2.3` ([#3884](https://github.com/MetaMask/snaps/pull/3884))
+
+### Fixed
+
+- Recover if preinstalled Snaps source code is missing ([#3886](https://github.com/MetaMask/snaps/pull/3886))
+
 ## [18.0.1]
 
 ### Changed
@@ -1053,7 +1063,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@18.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@18.0.2...HEAD
+[18.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@18.0.1...@metamask/snaps-controllers@18.0.2
 [18.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@18.0.0...@metamask/snaps-controllers@18.0.1
 [18.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@17.2.1...@metamask/snaps-controllers@18.0.0
 [17.2.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@17.2.0...@metamask/snaps-controllers@17.2.1

package/dist/snaps/SnapController.cjs

@@ -337,9 +337,16 @@ class SnapController extends base_controller_1.BaseController {
             const existingSnap = this.get(snapId);
             const isAlreadyInstalled = existingSnap !== undefined;
             const isUpdate = isAlreadyInstalled && (0, utils_1.gtVersion)(manifest.version, existingSnap.version);
+            const isPreinstalled = existingSnap?.preinstalled === true;
+            const isMissingSource = isAlreadyInstalled &&
+                isPreinstalled &&
+                !(await this.#hasSourceCode(snapId));
             // Disallow downgrades and overwriting non preinstalled snaps
+            // As a mitigation for state corruption on mobile, if the source code is missing
+            // we allow overwriting and potentially downgrading the current version of the preinstalled Snap.
             if (isAlreadyInstalled &&
-                (!isUpdate || existingSnap.preinstalled !== true)) {
+                !isMissingSource &&
+                (!isUpdate || !isPreinstalled)) {
                 continue;
             }
             const manifestFile = new snaps_utils_1.VirtualFile({
@@ -393,9 +400,13 @@ class SnapController extends base_controller_1.BaseController {
             if (isUpdate) {
                 this.messenger.publish('SnapController:snapUpdated', this.getTruncatedExpect(snapId), existingSnap.version, constants_1.METAMASK_ORIGIN, true);
             }
-            else {
+            else if (!isMissingSource) {
                 this.messenger.publish('SnapController:snapInstalled', this.getTruncatedExpect(snapId), constants_1.METAMASK_ORIGIN, true);
             }
+            if (isMissingSource) {
+                (0, snaps_utils_1.logWarning)(`The source code for "${snapId}" was missing and has been automatically restored. If you see this message, please file a bug report.`);
+                this.messenger.captureException?.(new Error(`The source code for "${snapId}" was missing and has been automatically restored. This could indicate persistence issues.`));
+            }
         }
         // Ensure all preinstalled Snaps have their expected permissions.
         for (const snap of Object.values(this.state.snaps).filter(({ preinstalled }) => preinstalled)) {
@@ -2572,6 +2583,16 @@ class SnapController extends base_controller_1.BaseController {
             runtime.state = undefined;
         }
     }
+    /**
+     * Check whether a Snap has valid source code in storage.
+     *
+     * @param snapId - The Snap ID.
+     * @returns True if the source code is valid, otherwise false.
+     */
+    async #hasSourceCode(snapId) {
+        const sourceCode = await this.#getSourceCode(snapId).catch(() => null);
+        return typeof sourceCode === 'string';
+    }
     /**
      * Retrieve the source code for a Snap from storage.
      *