feat: Add new metadata properties to AppMetadataController

The new metadata properties includeInStateLogs and usedInUi have been
added to the `AppMetadataController`.

Fixes #6515

Author: Gudahtt

packages/app-metadata-controller/src/AppMetadataController.test.ts

@@ -1,4 +1,4 @@
-import { Messenger } from '@metamask/base-controller';
+import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
 
 import {
   AppMetadataController,
@@ -120,6 +120,77 @@ describe('AppMetadataController', () => {
       );
     });
   });
+
+  describe('metadata', () => {
+    it('includes expected state in debug snapshots', () => {
+      withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'anonymous',
+          ),
+        ).toMatchInlineSnapshot(`
+          Object {
+            "currentAppVersion": "",
+            "currentMigrationVersion": 0,
+            "previousAppVersion": "",
+            "previousMigrationVersion": 0,
+          }
+        `);
+      });
+    });
+
+    it('includes expected state in state logs', () => {
+      withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'includeInStateLogs',
+          ),
+        ).toMatchInlineSnapshot(`
+          Object {
+            "currentAppVersion": "",
+            "currentMigrationVersion": 0,
+            "previousAppVersion": "",
+            "previousMigrationVersion": 0,
+          }
+        `);
+      });
+    });
+
+    it('persists expected state', () => {
+      withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'persist',
+          ),
+        ).toMatchInlineSnapshot(`
+          Object {
+            "currentAppVersion": "",
+            "currentMigrationVersion": 0,
+            "previousAppVersion": "",
+            "previousMigrationVersion": 0,
+          }
+        `);
+      });
+    });
+
+    it('exposes expected state to UI', () => {
+      withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'usedInUi',
+          ),
+        ).toMatchInlineSnapshot(`Object {}`);
+      });
+    });
+  });
 });
 
 type WithControllerOptions = Partial<AppMetadataControllerOptions>;

packages/app-metadata-controller/src/AppMetadataController.ts

@@ -103,20 +103,28 @@ export type AppMetadataControllerMessenger = RestrictedMessenger<
  */
 const controllerMetadata = {
   currentAppVersion: {
+    includeInStateLogs: true,
     persist: true,
     anonymous: true,
+    usedInUi: false,
   },
   previousAppVersion: {
+    includeInStateLogs: true,
     persist: true,
     anonymous: true,
+    usedInUi: false,
   },
   previousMigrationVersion: {
+    includeInStateLogs: true,
     persist: true,
     anonymous: true,
+    usedInUi: false,
   },
   currentMigrationVersion: {
+    includeInStateLogs: true,
     persist: true,
     anonymous: true,
+    usedInUi: false,
   },
 } satisfies StateMetadata<AppMetadataControllerState>;