feat: Add new metadata properties to TokenSearchDiscoveryController (#6586)

## Explanation

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

## References

* Fixes #6512
* Related to #6443

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] 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
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: GuillaumeRx

packages/token-search-discovery-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` ([#6586](https://github.com/MetaMask/core/pull/6586))
+
 ### Changed
 
 - Bump `@metamask/utils` from `^11.2.0` to `^11.4.2` ([#6054](https://github.com/MetaMask/core/pull/6054))

packages/token-search-discovery-controller/src/token-search-discovery-controller.test.ts

@@ -1,4 +1,4 @@
-import { Messenger } from '@metamask/base-controller';
+import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
 
 import { AbstractTokenDiscoveryApiService } from './token-discovery-api-service/abstract-token-discovery-api-service';
 import { AbstractTokenSearchApiService } from './token-search-api-service/abstract-token-search-api-service';
@@ -274,4 +274,61 @@ describe('TokenSearchDiscoveryController', () => {
       expect(results).toStrictEqual([]);
     });
   });
+
+  describe('metadata', () => {
+    it('includes expected state in debug snapshots', () => {
+      expect(
+        deriveStateFromMetadata(
+          mainController.state,
+          mainController.metadata,
+          'anonymous',
+        ),
+      ).toMatchInlineSnapshot(`Object {}`);
+    });
+
+    it('includes expected state in state logs', () => {
+      expect(
+        deriveStateFromMetadata(
+          mainController.state,
+          mainController.metadata,
+          'includeInStateLogs',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "lastSearchTimestamp": null,
+          "recentSearches": Array [],
+        }
+      `);
+    });
+
+    it('persists expected state', () => {
+      expect(
+        deriveStateFromMetadata(
+          mainController.state,
+          mainController.metadata,
+          'persist',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "lastSearchTimestamp": null,
+          "recentSearches": Array [],
+        }
+      `);
+    });
+
+    it('includes expected state in UI', () => {
+      expect(
+        deriveStateFromMetadata(
+          mainController.state,
+          mainController.metadata,
+          'usedInUi',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "lastSearchTimestamp": null,
+          "recentSearches": Array [],
+        }
+      `);
+    });
+  });
 });

packages/token-search-discovery-controller/src/token-search-discovery-controller.ts

@@ -2,6 +2,7 @@ import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
   RestrictedMessenger,
+  StateMetadata,
 } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
 
@@ -30,10 +31,21 @@ export type TokenSearchDiscoveryControllerState = {
   lastSearchTimestamp: number | null;
 };
 
-const tokenSearchDiscoveryControllerMetadata = {
-  recentSearches: { persist: true, anonymous: false },
-  lastSearchTimestamp: { persist: true, anonymous: false },
-} as const;
+const tokenSearchDiscoveryControllerMetadata: StateMetadata<TokenSearchDiscoveryControllerState> =
+  {
+    recentSearches: {
+      includeInStateLogs: true,
+      persist: true,
+      anonymous: false,
+      usedInUi: true,
+    },
+    lastSearchTimestamp: {
+      includeInStateLogs: true,
+      persist: true,
+      anonymous: false,
+      usedInUi: true,
+    },
+  };
 
 // === MESSENGER ===