fix: Add migration to remove tokens with null decimals and log affect…

…ed tokens (#29245)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

This PR introduces a new migration (version 135) to remove tokens with
decimals === null from the following properties within the
TokensController state:

- `allTokens`
- `allDetectedTokens`
- `tokens`
- `detectedTokens`

Additionally, it logs the addresses of the affected tokens using
global.sentry?.captureMessage before removing them from the state.

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29245?quickstart=1)

Fixes:

1. mock tokens on the state and set decimals to null on the main branch
2. switch branch , the token should be hidden

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

<!-- [screenshots/recordings] -->

<!-- [screenshots/recordings] -->

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

app/scripts/migrations/133.1.test.ts

@@ -0,0 +1,224 @@
+import { cloneDeep } from 'lodash';
+import { TokensControllerState } from '@metamask/assets-controllers';
+import { migrate, version } from './133.1';
+
+const sentryCaptureExceptionMock = jest.fn();
+const sentryCaptureMessageMock = jest.fn();
+
+global.sentry = {
+  captureException: sentryCaptureExceptionMock,
+  captureMessage: sentryCaptureMessageMock,
+};
+
+const oldVersion = 133;
+
+const mockStateWithNullDecimals = {
+  meta: { version: oldVersion },
+  data: {
+    TokensController: {
+      allTokens: {
+        '0x1': {
+          '0x123': [
+            { address: '0x1', symbol: 'TOKEN1', decimals: null },
+            { address: '0x2', symbol: 'TOKEN2', decimals: 18 },
+          ],
+        },
+      },
+      allDetectedTokens: {
+        '0x1': {
+          '0x123': [
+            { address: '0x5', symbol: 'TOKEN5', decimals: null },
+            { address: '0x6', symbol: 'TOKEN6', decimals: 6 },
+          ],
+        },
+      },
+      tokens: [
+        { address: '0x7', symbol: 'TOKEN7', decimals: null },
+        { address: '0x8', symbol: 'TOKEN8', decimals: 18 },
+      ],
+      detectedTokens: [
+        { address: '0x9', symbol: 'TOKEN9', decimals: null },
+        { address: '0xA', symbol: 'TOKEN10', decimals: 6 },
+      ],
+    },
+  },
+};
+
+describe(`migration #${version}`, () => {
+  afterEach(() => jest.resetAllMocks());
+
+  it('updates the version metadata', async () => {
+    const oldStorage = cloneDeep(mockStateWithNullDecimals);
+
+    const newStorage = await migrate(oldStorage);
+
+    expect(newStorage.meta).toStrictEqual({ version });
+  });
+
+  it('removes tokens with null decimals from allTokens', async () => {
+    const oldStorage = cloneDeep(mockStateWithNullDecimals);
+
+    const newStorage = await migrate(oldStorage);
+
+    const tokensControllerState = newStorage.data
+      .TokensController as TokensControllerState;
+    const { allTokens } = tokensControllerState;
+
+    expect(allTokens).toEqual({
+      '0x1': {
+        '0x123': [{ address: '0x2', symbol: 'TOKEN2', decimals: 18 }],
+      },
+    });
+  });
+
+  it('removes tokens with null decimals from allDetectedTokens', async () => {
+    const oldStorage = cloneDeep(mockStateWithNullDecimals);
+
+    const newStorage = await migrate(oldStorage);
+
+    const tokensControllerState = newStorage.data
+      .TokensController as TokensControllerState;
+    const { allDetectedTokens } = tokensControllerState;
+
+    expect(allDetectedTokens).toEqual({
+      '0x1': {
+        '0x123': [{ address: '0x6', symbol: 'TOKEN6', decimals: 6 }],
+      },
+    });
+  });
+
+  it('removes tokens with null decimals from tokens array', async () => {
+    const oldStorage = cloneDeep(mockStateWithNullDecimals);
+
+    const newStorage = await migrate(oldStorage);
+
+    const tokensControllerState = newStorage.data
+      .TokensController as TokensControllerState;
+    const { tokens } = tokensControllerState;
+
+    expect(tokens).toEqual([
+      { address: '0x8', symbol: 'TOKEN8', decimals: 18 },
+    ]);
+  });
+
+  it('removes tokens with null decimals from detectedTokens array', async () => {
+    const oldStorage = cloneDeep(mockStateWithNullDecimals);
+
+    const newStorage = await migrate(oldStorage);
+
+    const tokensControllerState = newStorage.data
+      .TokensController as TokensControllerState;
+    const { detectedTokens } = tokensControllerState;
+
+    expect(detectedTokens).toEqual([
+      { address: '0xA', symbol: 'TOKEN10', decimals: 6 },
+    ]);
+  });
+
+  it('logs tokens with null decimals before removing them', async () => {
+    const oldStorage = cloneDeep(mockStateWithNullDecimals);
+
+    await migrate(oldStorage);
+
+    expect(sentryCaptureMessageMock).toHaveBeenCalledTimes(4);
+    expect(sentryCaptureMessageMock).toHaveBeenCalledWith(
+      `Migration ${version}: Removed token with decimals === null in allTokens. Address: 0x1`,
+    );
+    expect(sentryCaptureMessageMock).toHaveBeenCalledWith(
+      `Migration ${version}: Removed token with decimals === null in allDetectedTokens. Address: 0x5`,
+    );
+    expect(sentryCaptureMessageMock).toHaveBeenCalledWith(
+      `Migration ${version}: Removed token with decimals === null in tokens. Address: 0x7`,
+    );
+    expect(sentryCaptureMessageMock).toHaveBeenCalledWith(
+      `Migration ${version}: Removed token with decimals === null in detectedTokens. Address: 0x9`,
+    );
+  });
+
+  it('does nothing if all tokens have valid decimals', async () => {
+    const validState = {
+      meta: { version: oldVersion },
+      data: {
+        TokensController: {
+          allTokens: {
+            '0x1': {
+              '0x123': [{ address: '0x2', symbol: 'TOKEN2', decimals: 18 }],
+            },
+          },
+          allDetectedTokens: {
+            '0x1': {
+              '0x123': [{ address: '0x6', symbol: 'TOKEN6', decimals: 6 }],
+            },
+          },
+          tokens: [{ address: '0x8', symbol: 'TOKEN8', decimals: 18 }],
+          detectedTokens: [{ address: '0xA', symbol: 'TOKEN10', decimals: 6 }],
+        },
+      },
+    };
+
+    const oldStorage = cloneDeep(validState);
+    const newStorage = await migrate(oldStorage);
+
+    expect(newStorage.data).toStrictEqual(oldStorage.data);
+    expect(sentryCaptureMessageMock).not.toHaveBeenCalled();
+  });
+
+  it('does nothing if TokensController is missing', async () => {
+    const oldStorage = {
+      meta: { version: oldVersion },
+      data: {},
+    };
+
+    const newStorage = await migrate(cloneDeep(oldStorage));
+
+    expect(newStorage.data).toStrictEqual(oldStorage.data);
+    expect(sentryCaptureMessageMock).not.toHaveBeenCalled();
+  });
+
+  const invalidState = [
+    {
+      errorMessage: `Migration ${version}: Invalid allTokens state of type 'string'`,
+      label: 'Invalid allTokens',
+      state: { TokensController: { allTokens: 'invalid' } },
+    },
+    {
+      errorMessage: `Migration ${version}: Invalid allDetectedTokens state of type 'string'`,
+      label: 'Invalid allDetectedTokens',
+      state: { TokensController: { allDetectedTokens: 'invalid' } },
+    },
+    {
+      errorMessage: `Migration ${version}: Invalid tokens state of type 'string'`,
+      label: 'Invalid tokens',
+      state: { TokensController: { tokens: 'invalid' } },
+    },
+    {
+      errorMessage: `Migration ${version}: Invalid detectedTokens state of type 'string'`,
+      label: 'Invalid detectedTokens',
+      state: { TokensController: { detectedTokens: 'invalid' } },
+    },
+  ];
+
+  // @ts-expect-error 'each' function is not recognized by TypeScript types
+  it.each(invalidState)(
+    'captures error when state is invalid due to: $label',
+    async ({
+      errorMessage,
+      state,
+    }: {
+      errorMessage: string;
+      state: Record<string, unknown>;
+    }) => {
+      const oldStorage = {
+        meta: { version: oldVersion },
+        data: state,
+      };
+
+      const newStorage = await migrate(cloneDeep(oldStorage));
+
+      expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
+        new Error(errorMessage),
+      );
+      expect(newStorage.data).toStrictEqual(oldStorage.data);
+    },
+  );
+});