test: fix mocha vs jest type conflicts in test files (#31049)

## **Description**
This PR resolves conflicting types between jest and mocha that were
causing [issues with the type of
"it"](https://github.com/search?q=org%3AMetaMask%20repo%3AMetaMask%2Fmetamask-extension%20it.each%20&type=code)
in unit tests which were masking type errors. It also fixes type issues
that were masked by previously disregarding type errors.


In particular, this PR creates an [isolated TypeScript configuration for
the e2e
tests](https://github.com/MetaMask/metamask-extension/pull/31049/files#diff-bfc1581736f7b790e103572bf8e349eab3346aaa0d29b505f8f9707bfd603e7e)
where they get their own type checking context. Since mocha is only
needed in e2e tests, Mocha types will not be considered for files
outside of that folder.
<!--
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/31049?quickstart=1)

## **Related issues**

Fixes:

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

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

### **Before**

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

### **After**

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

## **Pre-merge author checklist**

- [ ] 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).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] 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.

## **Pre-merge reviewer checklist**

- [ ] 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.

Author: dbrans

app/scripts/controllers/bridge-status/validators.test.ts

@@ -218,7 +218,6 @@ const BridgeTxStatusResponses = {
 
 describe('validators', () => {
   describe('bridgeStatusValidator', () => {
-    // @ts-expect-error - it.each is a function
     it.each([
       {
         input: BridgeTxStatusResponses.STATUS_PENDING_VALID,

app/scripts/controllers/encryption-public-key.test.ts

@@ -191,7 +191,6 @@ describe('EncryptionPublicKeyController', () => {
   });
 
   describe('newRequestEncryptionPublicKey', () => {
-    // @ts-expect-error This function is missing from the Mocha type definitions
     it.each([
       ['Ledger', KeyringType.ledger],
       ['Trezor', KeyringType.trezor],

app/scripts/controllers/metametrics-controller.test.ts

@@ -873,7 +873,6 @@ describe('MetaMetricsController', function () {
   });
 
   describe('Change Signature XXX anonymous event names', function () {
-    // @ts-expect-error This function is missing from the Mocha type definitions
     it.each([
       ['Signature Requested', 'Signature Requested Anon'],
       ['Signature Rejected', 'Signature Rejected Anon'],

app/scripts/lib/AccountIdentitiesPetnamesBridge.test.ts

@@ -204,7 +204,6 @@ describe('AccountIdentitiesPetnamesBridge', () => {
   });
 
   describe('shouldSyncPetname', () => {
-    // @ts-expect-error This is missing from the Mocha type definitions
     it.each([
       {
         origin: NameOrigin.ACCOUNT_IDENTITY,

app/scripts/lib/approval/utils.test.ts

@@ -48,7 +48,6 @@ describe('Approval Utils', () => {
       );
     });
 
-    // @ts-expect-error This function is missing from the Mocha type definitions
     it.each([
       ApprovalType.SnapDialogAlert,
       ApprovalType.SnapDialogPrompt,
@@ -64,7 +63,6 @@ describe('Approval Utils', () => {
       expect(approvalController.accept).toHaveBeenCalledWith(ID_MOCK, null);
     });
 
-    // @ts-expect-error This function is missing from the Mocha type definitions
     it.each([
       ApprovalType.SnapDialogConfirmation,
       SNAP_MANAGE_ACCOUNTS_CONFIRMATION_TYPES.confirmAccountCreation,
@@ -81,7 +79,6 @@ describe('Approval Utils', () => {
       expect(approvalController.accept).toHaveBeenCalledWith(ID_MOCK, false);
     });
 
-    // @ts-expect-error This function is missing from the Mocha type definitions
     it.each([
       ApprovalType.SnapDialogAlert,
       ApprovalType.SnapDialogPrompt,

app/scripts/lib/createEvmMethodsToNonEvmAccountReqFilterMiddleware.test.ts

@@ -5,15 +5,17 @@ import createEvmMethodsToNonEvmAccountReqFilterMiddleware, {
 } from './createEvmMethodsToNonEvmAccountReqFilterMiddleware';
 
 describe('createEvmMethodsToNonEvmAccountReqFilterMiddleware', () => {
-  const getMockRequest = (method: string, params: Record<string, Json>) => ({
+  const getMockRequest = (
+    method: string,
+    params: Record<string, Json>[] | undefined,
+  ) => ({
     jsonrpc: jsonrpc2,
     id: 1,
     method,
     params,
   });
   const getMockResponse = () => ({ jsonrpc: jsonrpc2, id: 'foo' });
 
-  // @ts-expect-error This function is missing from the Mocha type definitions
   it.each([
     // EVM requests
     {
@@ -285,8 +287,8 @@ describe('createEvmMethodsToNonEvmAccountReqFilterMiddleware', () => {
     }: {
       accountType: EthAccountType | BtcAccountType;
       method: string;
-      params: Record<string, Json>;
-      calledNext: number;
+      params: Record<string, Json>[] | undefined;
+      calledNext: boolean;
     }) => {
       const filterFn = createEvmMethodsToNonEvmAccountReqFilterMiddleware({
         messenger: {

app/scripts/lib/multichain/address.test.ts

@@ -4,91 +4,73 @@ import {
   normalizeSafeAddress,
 } from './address';
 
-type TestAddress = {
-  address: string;
-  normalizedAddress: string;
-  checksumAddress: string;
-};
-
-const ETH_ADDRESSES = [
-  // Lower-case address
-  {
-    address: '0x6431726eee67570bf6f0cf892ae0a3988f03903f',
-    normalizedAddress: '0x6431726eee67570bf6f0cf892ae0a3988f03903f',
-    checksumAddress: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F',
-  },
-  // Checksum address
-  {
-    address: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F',
-    normalizedAddress: '0x6431726eee67570bf6f0cf892ae0a3988f03903f',
-    checksumAddress: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F',
-  },
-];
+describe('address', () => {
+  const TEST_CASES_EVM_ADDRESSES = [
+    {
+      address: '0x6431726eee67570bf6f0cf892ae0a3988f03903f', // Lower-case address
+      normalizedAddress: '0x6431726eee67570bf6f0cf892ae0a3988f03903f',
+      checksumAddress: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F',
+    },
+    {
+      address: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F', // Checksum address
+      normalizedAddress: '0x6431726eee67570bf6f0cf892ae0a3988f03903f',
+      checksumAddress: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F',
+    },
+  ];
 
-const NON_EVM_ADDRESSES = [
-  {
-    address: '0xdeadbeef',
-  },
-  {
-    address: 'bc1ql49ydapnjafl5t2cp9zqpjwe6pdgmxy98859v2',
-  },
-];
+  const TEST_CASES_NON_EVM_ADDRESSES = [
+    '0xdeadbeef',
+    'bc1ql49ydapnjafl5t2cp9zqpjwe6pdgmxy98859v2',
+  ];
 
-describe('address', () => {
   describe('isEthAddress', () => {
-    // @ts-expect-error This is missing from the Mocha type definitions
-    it.each(ETH_ADDRESSES)(
+    it.each(TEST_CASES_EVM_ADDRESSES)(
       'returns true if address is an ethereum address: $address',
-      ({ address }: TestAddress) => {
+      ({ address }) => {
         expect(isEthAddress(address)).toBe(true);
         expect(isEthAddress(address.toLowerCase())).toBe(true);
       },
     );
 
-    // @ts-expect-error This is missing from the Mocha type definitions
-    it.each(NON_EVM_ADDRESSES)(
+    it.each(TEST_CASES_NON_EVM_ADDRESSES)(
       'returns false if address is not an ethereum address: $address',
-      ({ address }: TestAddress) => {
+      (address) => {
         expect(isEthAddress(address)).toBe(false);
       },
     );
   });
 
   describe('normalizeAddress', () => {
-    // @ts-expect-error This is missing from the Mocha type definitions
-    it.each(ETH_ADDRESSES)(
+    it.each(TEST_CASES_EVM_ADDRESSES)(
       'normalizes address: $address',
-      ({ address, normalizedAddress }: TestAddress) => {
+      ({ address, normalizedAddress }) => {
         expect(normalizeAddress(address)).toBe(normalizedAddress);
         expect(normalizeAddress(address.toLowerCase())).toBe(normalizedAddress);
       },
     );
 
-    // @ts-expect-error This is missing from the Mocha type definitions
-    it.each(NON_EVM_ADDRESSES)(
+    it.each(TEST_CASES_NON_EVM_ADDRESSES)(
       'returns the original address if its a non-EVM address',
-      ({ address }: TestAddress) => {
+      (address) => {
         expect(normalizeAddress(address)).toBe(address);
       },
     );
   });
 
   describe('normalizeSafeAddress', () => {
-    // @ts-expect-error This is missing from the Mocha type definitions
-    it.each(ETH_ADDRESSES)(
+    it.each(TEST_CASES_EVM_ADDRESSES)(
       'normalizes address to its "safe" form: $address to: $checksumAddress',
-      ({ address, checksumAddress }: TestAddress) => {
+      ({ address, checksumAddress }) => {
         expect(normalizeSafeAddress(address)).toBe(checksumAddress);
         expect(normalizeSafeAddress(address.toLowerCase())).toBe(
           checksumAddress,
         );
       },
     );
 
-    // @ts-expect-error This is missing from the Mocha type definitions
-    it.each(NON_EVM_ADDRESSES)(
+    it.each(TEST_CASES_NON_EVM_ADDRESSES)(
       'returns the original address if its a non-EVM address',
-      ({ address }: TestAddress) => {
+      (address) => {
         expect(normalizeSafeAddress(address)).toBe(address);
       },
     );

app/scripts/lib/ppom/ppom-util.test.ts

@@ -261,7 +261,6 @@ describe('PPOM Utils', () => {
       );
     });
 
-    // @ts-expect-error This is missing from the Mocha type definitions
     it.each([METHOD_SIGN_TYPED_DATA_V3, METHOD_SIGN_TYPED_DATA_V4])(
       'sanitizes request params if method is %s',
       async (method: string) => {

app/scripts/lib/rpc-method-middleware/createUnsupportedMethodMiddleware.test.ts

@@ -21,7 +21,6 @@ describe('createUnsupportedMethodMiddleware', () => {
     expect(endMock).not.toHaveBeenCalled();
   });
 
-  // @ts-expect-error This function is missing from the Mocha type definitions
   it.each([...UNSUPPORTED_RPC_METHODS])(
     'ends requests for default unsupported rpc methods when no list is provided: %s',
     (method: string) => {
@@ -40,7 +39,6 @@ describe('createUnsupportedMethodMiddleware', () => {
 
   const unsupportedMethods = new Set(['foo', 'bar']);
 
-  // @ts-expect-error This function is missing from the Mocha type definitions
   it.each([...unsupportedMethods])(
     'ends requests for methods that are in the provided list of unsupported methods: %s',
     (method: string) => {

app/scripts/lib/rpc-method-middleware/handlers/ethereum-chain-utils.test.ts

@@ -253,7 +253,6 @@ describe('Ethereum Chain Utils', () => {
       });
     });
 
-    // @ts-expect-error This function is missing from the Mocha type definitions
     describe.each([
       ['legacy', false],
       ['multichain', true],