@metamask/snaps-controllers 20.0.6 → 21.0.0

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [21.0.0]
+
+### Added
+
+- **BREAKING:** Track Snap lifecycle analytics events in `SnapController` ([#4048](https://github.com/MetaMask/snaps/pull/4048))
+  - This logic was previously in the clients, but can now be removed there.
+  - The `SnapController` messenger now requires the following actions and events:
+    - `AnalyticsController:trackEvent`
+    - `SnapController:snapInstallStarted`
+    - `SnapController:snapInstallFailed`
+    - `SnapController:snapInstalled`
+    - `SnapController:snapUpdated`
+    - `SnapController:snapUninstalled`
+- **BREAKING:** Track analytics for OTA Snap updates ([#4049](https://github.com/MetaMask/snaps/pull/4049))
+  - The `SnapController` constructor now requires a `clientConfig` parameter.
+- Add `requestPeriodicUpdate` method to `SnapRegistryController` ([#4043](https://github.com/MetaMask/snaps/pull/4043))
+
+### Changed
+
+- Bump `@metamask/storage-service` from `1.0.1` to `1.0.2` ([#4035](https://github.com/MetaMask/snaps/pull/4035))
+- Bump `@metamask/approval-controller` from `9.0.1` to `9.0.2` ([#4026](https://github.com/MetaMask/snaps/pull/4026))
+
 ## [20.0.6]
 
 ### Changed
@@ -1234,7 +1256,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@20.0.6...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@21.0.0...HEAD
+[21.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@20.0.6...@metamask/snaps-controllers@21.0.0
 [20.0.6]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@20.0.5...@metamask/snaps-controllers@20.0.6
 [20.0.5]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@20.0.4...@metamask/snaps-controllers@20.0.5
 [20.0.4]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@20.0.3...@metamask/snaps-controllers@20.0.4

package/dist/snaps/SnapController.cjs

@@ -103,13 +103,13 @@ class SnapController extends base_controller_1.BaseController {
     #getMnemonicSeed;
     #getFeatureFlags;
     #clientCryptography;
+    #clientConfig;
     #detectSnapLocation;
     #snapsRuntimeData;
     #rollbackSnapshots;
     #timeoutForLastRequestStatus;
     #statusMachine;
     #preinstalledSnaps;
-    #trackEvent;
     #trackSnapExport;
     #ensureOnboardingComplete;
     // A promise that resolves when the controller has finished setting up.
@@ -117,7 +117,7 @@ class SnapController extends base_controller_1.BaseController {
     // It is resolved when the controller has finished setting up and the platform is ready.
     // It is rejected if there is an error during setup.
     #controllerSetup = (0, utils_1.createDeferredPromise)();
-    constructor({ messenger, state, dynamicPermissions = ['endowment:caip25', 'wallet_snap'], environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = (0, utils_1.inMilliseconds)(5, utils_1.Duration.Second), maxIdleTime = (0, utils_1.inMilliseconds)(30, utils_1.Duration.Second), maxRequestTime = (0, utils_1.inMilliseconds)(60, utils_1.Duration.Second), fetchFunction = globalThis.fetch.bind(undefined), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = location_1.detectSnapLocation, preinstalledSnaps = null, encryptor, getMnemonicSeed, getFeatureFlags = () => ({}), clientCryptography, trackEvent, ensureOnboardingComplete, }) {
+    constructor({ messenger, state, dynamicPermissions = ['endowment:caip25', 'wallet_snap'], environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = (0, utils_1.inMilliseconds)(5, utils_1.Duration.Second), maxIdleTime = (0, utils_1.inMilliseconds)(30, utils_1.Duration.Second), maxRequestTime = (0, utils_1.inMilliseconds)(60, utils_1.Duration.Second), fetchFunction = globalThis.fetch.bind(undefined), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = location_1.detectSnapLocation, preinstalledSnaps = null, encryptor, getMnemonicSeed, getFeatureFlags = () => ({}), clientCryptography, ensureOnboardingComplete, clientConfig, }) {
         super({
             messenger,
             metadata: {
@@ -191,13 +191,13 @@ class SnapController extends base_controller_1.BaseController {
         this.#getMnemonicSeed = getMnemonicSeed;
         this.#getFeatureFlags = getFeatureFlags;
         this.#clientCryptography = clientCryptography;
+        this.#clientConfig = clientConfig;
         this.#preinstalledSnaps = preinstalledSnaps;
         this._onUnhandledSnapError = this._onUnhandledSnapError.bind(this);
         this._onOutboundRequest = this._onOutboundRequest.bind(this);
         this._onOutboundResponse = this._onOutboundResponse.bind(this);
         this.#rollbackSnapshots = new Map();
         this.#snapsRuntimeData = new Map();
-        this.#trackEvent = trackEvent;
         this.#ensureOnboardingComplete = ensureOnboardingComplete;
         this.#pollForLastRequestStatus();
         /* eslint-disable @typescript-eslint/unbound-method */
@@ -205,14 +205,117 @@ class SnapController extends base_controller_1.BaseController {
         this.messenger.subscribe('ExecutionService:outboundRequest', this._onOutboundRequest);
         this.messenger.subscribe('ExecutionService:outboundResponse', this._onOutboundResponse);
         /* eslint-enable @typescript-eslint/unbound-method */
-        this.messenger.subscribe('SnapController:snapInstalled', ({ id }, origin) => {
-            this.#callLifecycleHook(origin, id, snaps_utils_1.HandlerType.OnInstall).catch((error) => {
-                (0, snaps_utils_1.logError)(`Error when calling \`onInstall\` lifecycle hook for snap "${id}": ${(0, snaps_sdk_1.getErrorMessage)(error)}`);
+        this.messenger.subscribe('SnapController:snapInstalled', (snap, origin, preinstalled) => {
+            this.#callLifecycleHook(origin, snap.id, snaps_utils_1.HandlerType.OnInstall).catch((error) => {
+                (0, snaps_utils_1.logError)(`Error when calling \`onInstall\` lifecycle hook for snap "${snap.id}": ${(0, snaps_sdk_1.getErrorMessage)(error)}`);
+            });
+            if (preinstalled) {
+                return;
+            }
+            const snapMetadata = this.messenger.call('SnapRegistryController:getMetadata', snap.id);
+            this.messenger.call('AnalyticsController:trackEvent', {
+                name: 'Snap Installed',
+                properties: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_id: snap.id,
+                    version: snap.version,
+                    origin,
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_category: snapMetadata?.category ?? null,
+                },
+                sensitiveProperties: {},
+                saveDataRecording: false,
+                hasProperties: true,
+            });
+        });
+        this.messenger.subscribe('SnapController:snapUpdated', (snap, oldVersion, origin, preinstalled, ota) => {
+            this.#callLifecycleHook(origin, snap.id, snaps_utils_1.HandlerType.OnUpdate).catch((error) => {
+                (0, snaps_utils_1.logError)(`Error when calling \`onUpdate\` lifecycle hook for snap "${snap.id}": ${(0, snaps_sdk_1.getErrorMessage)(error)}`);
+            });
+            if (preinstalled && !ota) {
+                return;
+            }
+            const snapMetadata = this.messenger.call('SnapRegistryController:getMetadata', snap.id);
+            this.messenger.call('AnalyticsController:trackEvent', {
+                name: 'Snap Updated',
+                /* eslint-disable @typescript-eslint/naming-convention */
+                properties: {
+                    snap_id: snap.id,
+                    old_version: oldVersion,
+                    new_version: snap.version,
+                    origin,
+                    snap_category: snapMetadata?.category ?? null,
+                    ota,
+                    client_version: this.#clientConfig.version,
+                    client_type: this.#clientConfig.type,
+                },
+                /* eslint-enable @typescript-eslint/naming-convention */
+                sensitiveProperties: {},
+                saveDataRecording: false,
+                hasProperties: true,
+            });
+        });
+        this.messenger.subscribe('SnapController:snapInstallStarted', (snapId, origin, isUpdate, preinstalled) => {
+            if (preinstalled) {
+                return;
+            }
+            const snapMetadata = this.messenger.call('SnapRegistryController:getMetadata', snapId);
+            this.messenger.call('AnalyticsController:trackEvent', {
+                name: isUpdate ? 'Snap Update Started' : 'Snap Install Started',
+                properties: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_id: snapId,
+                    origin,
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_category: snapMetadata?.category ?? null,
+                },
+                sensitiveProperties: {},
+                saveDataRecording: false,
+                hasProperties: true,
+            });
+        });
+        this.messenger.subscribe('SnapController:snapInstallFailed', (snapId, origin, isUpdate, error, preinstalled) => {
+            if (preinstalled) {
+                return;
+            }
+            const isRejected = error.includes('User rejected the request.');
+            const snapMetadata = this.messenger.call('SnapRegistryController:getMetadata', snapId);
+            // eslint-disable-next-line no-nested-ternary
+            const name = isUpdate
+                ? isRejected
+                    ? 'Snap Update Rejected'
+                    : 'Snap Update Failed'
+                : isRejected
+                    ? 'Snap Install Rejected'
+                    : 'Snap Install Failed';
+            this.messenger.call('AnalyticsController:trackEvent', {
+                name,
+                properties: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_id: snapId,
+                    origin,
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_category: snapMetadata?.category ?? null,
+                },
+                sensitiveProperties: {},
+                saveDataRecording: false,
+                hasProperties: true,
             });
         });
-        this.messenger.subscribe('SnapController:snapUpdated', ({ id }, _oldVersion, origin) => {
-            this.#callLifecycleHook(origin, id, snaps_utils_1.HandlerType.OnUpdate).catch((error) => {
-                (0, snaps_utils_1.logError)(`Error when calling \`onUpdate\` lifecycle hook for snap "${id}": ${(0, snaps_sdk_1.getErrorMessage)(error)}`);
+        this.messenger.subscribe('SnapController:snapUninstalled', (snap) => {
+            const snapMetadata = this.messenger.call('SnapRegistryController:getMetadata', snap.id);
+            this.messenger.call('AnalyticsController:trackEvent', {
+                name: 'Snap Uninstalled',
+                properties: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_id: snap.id,
+                    version: snap.version,
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    snap_category: snapMetadata?.category ?? null,
+                },
+                sensitiveProperties: {},
+                saveDataRecording: false,
+                hasProperties: true,
             });
         });
         this.messenger.subscribe('KeyringController:lock', this.#handleLock.bind(this));
@@ -226,18 +329,20 @@ class SnapController extends base_controller_1.BaseController {
         Object.values(this.state?.snaps ?? {}).forEach((snap) => this.#setupRuntime(snap.id));
         this.#trackSnapExport = (0, utils_2.throttleTracking)((snapId, handler, success, origin) => {
             const snapMetadata = this.messenger.call('SnapRegistryController:getMetadata', snapId);
-            this.#trackEvent({
-                event: 'Snap Export Used',
-                category: 'Snaps',
+            this.messenger.call('AnalyticsController:trackEvent', {
+                name: 'Snap Export Used',
                 properties: {
                     // eslint-disable-next-line @typescript-eslint/naming-convention
                     snap_id: snapId,
                     export: handler,
                     // eslint-disable-next-line @typescript-eslint/naming-convention
-                    snap_category: snapMetadata?.category,
+                    snap_category: snapMetadata?.category ?? null,
                     success,
                     origin,
                 },
+                sensitiveProperties: {},
+                saveDataRecording: false,
+                hasProperties: true,
             });
         });
     }
@@ -424,7 +529,7 @@ class SnapController extends base_controller_1.BaseController {
             this.#setupRuntime(snapId);
             // Emit events
             if (isUpdate) {
-                this.messenger.publish('SnapController:snapUpdated', this.#getTruncatedSnapExpect(snapId), existingSnap.version, constants_1.METAMASK_ORIGIN, true);
+                this.messenger.publish('SnapController:snapUpdated', this.#getTruncatedSnapExpect(snapId), existingSnap.version, constants_1.METAMASK_ORIGIN, true, false);
             }
             else if (!isMissingSource) {
                 this.messenger.publish('SnapController:snapInstalled', this.#getTruncatedSnapExpect(snapId), constants_1.METAMASK_ORIGIN, true);
@@ -516,6 +621,7 @@ class SnapController extends base_controller_1.BaseController {
             const resolvedVersion = await this.#resolveAllowlistVersion(snap.id, preinstalledVersionRange, true);
             if (resolvedVersion !== preinstalledVersionRange &&
                 (0, utils_1.gtVersion)(resolvedVersion, snap.version)) {
+                const oldVersion = snap.version;
                 const location = this.#detectSnapLocation(snap.id, {
                     versionRange: resolvedVersion,
                     fetch: this.#fetchFunction,
@@ -529,6 +635,7 @@ class SnapController extends base_controller_1.BaseController {
                     versionRange: resolvedVersion,
                     automaticUpdate: true,
                 });
+                this.messenger.publish('SnapController:snapUpdated', this.#getTruncatedSnapExpect(snap.id), oldVersion, approval_controller_1.ORIGIN_METAMASK, true, true);
             }
         }));
     }
@@ -1373,7 +1480,7 @@ class SnapController extends base_controller_1.BaseController {
             }
             // Once we finish all installs / updates, emit events.
             pendingInstalls.forEach((snapId) => this.messenger.publish(`SnapController:snapInstalled`, this.#getTruncatedSnapExpect(snapId), origin, false));
-            pendingUpdates.forEach(({ snapId, oldVersion }) => this.messenger.publish(`SnapController:snapUpdated`, this.#getTruncatedSnapExpect(snapId), oldVersion, origin, false));
+            pendingUpdates.forEach(({ snapId, oldVersion }) => this.messenger.publish(`SnapController:snapUpdated`, this.#getTruncatedSnapExpect(snapId), oldVersion, origin, false, false));
             snapIds.forEach((snapId) => this.#rollbackSnapshots.delete(snapId));
         }
         catch (error) {
@@ -1418,7 +1525,7 @@ class SnapController extends base_controller_1.BaseController {
             snapId,
             type: exports.SNAP_APPROVAL_INSTALL,
         });
-        this.messenger.publish('SnapController:snapInstallStarted', snapId, origin, false);
+        this.messenger.publish('SnapController:snapInstallStarted', snapId, origin, false, false);
         // Existing snaps must be stopped before overwriting
         if (existingSnap && this.isSnapRunning(snapId)) {
             await this.stopSnap(snapId, snaps_utils_1.SnapStatusEvents.Stop);
@@ -1459,7 +1566,7 @@ class SnapController extends base_controller_1.BaseController {
                 type: exports.SNAP_APPROVAL_INSTALL,
                 error: errorString,
             });
-            this.messenger.publish('SnapController:snapInstallFailed', snapId, origin, false, errorString);
+            this.messenger.publish('SnapController:snapInstallFailed', snapId, origin, false, errorString, false);
             throw error;
         }
     }
@@ -1530,7 +1637,7 @@ class SnapController extends base_controller_1.BaseController {
                 type: exports.SNAP_APPROVAL_UPDATE,
             });
         try {
-            this.messenger.publish('SnapController:snapInstallStarted', snapId, origin, true);
+            this.messenger.publish('SnapController:snapInstallStarted', snapId, origin, true, preinstalled ?? false);
             const oldManifest = snap.manifest;
             const newSnap = await (0, utils_2.fetchSnap)(snapId, location);
             const { sourceCode: sourceCodeFile, manifest: manifestFile } = newSnap;
@@ -1638,7 +1745,7 @@ class SnapController extends base_controller_1.BaseController {
                     type: exports.SNAP_APPROVAL_UPDATE,
                 });
             }
-            this.messenger.publish('SnapController:snapInstallFailed', snapId, origin, true, errorString);
+            this.messenger.publish('SnapController:snapInstallFailed', snapId, origin, true, errorString, preinstalled ?? false);
             throw error;
         }
     }