feat: Add new metadata to gator-permissions-controller (#6552)

## Explanation

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

## References

Fixes #6518

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: Gudahtt

packages/gator-permissions-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6552](https://github.com/MetaMask/core/pull/6552))
+
 ## [0.1.0]
 
 ### Added

packages/gator-permissions-controller/src/GatorPermissionContoller.test.ts

@@ -1,5 +1,5 @@
 import type { AccountSigner } from '@metamask/7715-permission-types';
-import { Messenger } from '@metamask/base-controller';
+import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
 import type { HandleSnapRequest, HasSnap } from '@metamask/snaps-controllers';
 import type { SnapId } from '@metamask/snaps-sdk';
 import type { Hex } from '@metamask/utils';
@@ -379,6 +379,80 @@ describe('GatorPermissionsController', () => {
       expect(controller.state.isGatorPermissionsEnabled).toBe(true);
     });
   });
+
+  describe('metadata', () => {
+    it('includes expected state in debug snapshots', () => {
+      const controller = new GatorPermissionsController({
+        messenger: getMessenger(),
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'anonymous',
+        ),
+      ).toMatchInlineSnapshot(`Object {}`);
+    });
+
+    it('includes expected state in state logs', () => {
+      const controller = new GatorPermissionsController({
+        messenger: getMessenger(),
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'includeInStateLogs',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "gatorPermissionsMapSerialized": "{\\"native-token-stream\\":{},\\"native-token-periodic\\":{},\\"erc20-token-stream\\":{},\\"erc20-token-periodic\\":{},\\"other\\":{}}",
+          "gatorPermissionsProviderSnapId": "@metamask/gator-permissions-snap",
+          "isFetchingGatorPermissions": false,
+          "isGatorPermissionsEnabled": false,
+        }
+      `);
+    });
+
+    it('persists expected state', () => {
+      const controller = new GatorPermissionsController({
+        messenger: getMessenger(),
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'persist',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "gatorPermissionsMapSerialized": "{\\"native-token-stream\\":{},\\"native-token-periodic\\":{},\\"erc20-token-stream\\":{},\\"erc20-token-periodic\\":{},\\"other\\":{}}",
+          "isGatorPermissionsEnabled": false,
+        }
+      `);
+    });
+
+    it('exposes expected state to UI', () => {
+      const controller = new GatorPermissionsController({
+        messenger: getMessenger(),
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'usedInUi',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "gatorPermissionsMapSerialized": "{\\"native-token-stream\\":{},\\"native-token-periodic\\":{},\\"erc20-token-stream\\":{},\\"erc20-token-periodic\\":{},\\"other\\":{}}",
+        }
+      `);
+    });
+  });
 });
 
 /**

packages/gator-permissions-controller/src/GatorPermissionsController.ts

@@ -76,20 +76,28 @@ export type GatorPermissionsControllerState = {
 
 const gatorPermissionsControllerMetadata = {
   isGatorPermissionsEnabled: {
+    includeInStateLogs: true,
     persist: true,
     anonymous: false,
+    usedInUi: false,
   },
   gatorPermissionsMapSerialized: {
+    includeInStateLogs: true,
     persist: true,
     anonymous: false,
+    usedInUi: true,
   },
   isFetchingGatorPermissions: {
+    includeInStateLogs: true,
     persist: false,
     anonymous: false,
+    usedInUi: false,
   },
   gatorPermissionsProviderSnapId: {
+    includeInStateLogs: true,
     persist: false,
     anonymous: false,
+    usedInUi: false,
   },
 } satisfies StateMetadata<GatorPermissionsControllerState>;