Fix misaligned mock eth query types in controller tests (#2037)

## Explanation Fixes `// @ts-expect-error Mock eth query does not fulfill type requirements` annotations throughout core repo. ## References - Builds upon - MetaMask/eth-query#21 - #2028 - Related #1823 - Closes #2036 ## Changelog N/A ## 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 highlighted breaking changes using the "BREAKING" category above as appropriate
MetaMask · Nov 15, 2023 · 5f62ad4 · 5f62ad4
1 parent 4e8558e
commit 5f62ad4
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 89 deletions.
diff --git a/packages/controller-utils/src/util.test.ts b/packages/controller-utils/src/util.test.ts
@@ -1,6 +1,8 @@
+import EthQuery from '@metamask/eth-query';
 import { BN } from 'ethereumjs-util';
 import nock from 'nock';
 
+import { FakeProvider } from '../../../tests/fake-provider';
 import { MAX_SAFE_CHAIN_ID } from './constants';
 import * as util from './util';
 
@@ -436,57 +438,63 @@ describe('util', () => {
   describe('query', () => {
     describe('when the given method exists directly on the EthQuery', () => {
       it('should call the method on the EthQuery and, if it is successful, return a promise that resolves to the result', async () => {
-        class EthQuery {
+        class MockEthQuery extends EthQuery {
           getBlockByHash(blockId: any, cb: any) {
             cb(null, { id: blockId });
           }
         }
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        const result = await util.query(new EthQuery(), 'getBlockByHash', [
-          '0x1234',
-        ]);
+        const result = await util.query(
+          new MockEthQuery(new FakeProvider()),
+          'getBlockByHash',
+          ['0x1234'],
+        );
         expect(result).toStrictEqual({ id: '0x1234' });
       });
 
       it('should call the method on the EthQuery and, if it errors, return a promise that is rejected with the error', async () => {
-        class EthQuery {
+        class MockEthQuery extends EthQuery {
           getBlockByHash(_blockId: any, cb: any) {
             cb(new Error('uh oh'), null);
           }
         }
         await expect(
-          // @ts-expect-error Mock eth query does not fulfill type requirements
-          util.query(new EthQuery(), 'getBlockByHash', ['0x1234']),
+          util.query(new MockEthQuery(new FakeProvider()), 'getBlockByHash', [
+            '0x1234',
+          ]),
         ).rejects.toThrow('uh oh');
       });
     });
 
     describe('when the given method does not exist directly on the EthQuery', () => {
       it('should use sendAsync to call the RPC endpoint and, if it is successful, return a promise that resolves to the result', async () => {
-        class EthQuery {
+        class MockEthQuery extends EthQuery {
           sendAsync({ method, params }: any, cb: any) {
             if (method === 'eth_getBlockByHash') {
               return cb(null, { id: params[0] });
             }
             throw new Error(`Unsupported method ${method}`);
           }
         }
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        const result = await util.query(new EthQuery(), 'eth_getBlockByHash', [
-          '0x1234',
-        ]);
+        const result = await util.query(
+          new MockEthQuery(new FakeProvider()),
+          'eth_getBlockByHash',
+          ['0x1234'],
+        );
         expect(result).toStrictEqual({ id: '0x1234' });
       });
 
       it('should use sendAsync to call the RPC endpoint and, if it errors, return a promise that is rejected with the error', async () => {
-        class EthQuery {
+        class MockEthQuery extends EthQuery {
           sendAsync(_args: any, cb: any) {
             cb(new Error('uh oh'), null);
           }
         }
         await expect(
-          // @ts-expect-error Mock eth query does not fulfill type requirements
-          util.query(new EthQuery(), 'eth_getBlockByHash', ['0x1234']),
+          util.query(
+            new MockEthQuery(new FakeProvider()),
+            'eth_getBlockByHash',
+            ['0x1234'],
+          ),
         ).rejects.toThrow('uh oh');
       });
     });

diff --git a/packages/gas-fee-controller/src/fetchBlockFeeHistory.test.ts b/packages/gas-fee-controller/src/fetchBlockFeeHistory.test.ts
@@ -1,7 +1,9 @@
 import { query, fromHex, toHex } from '@metamask/controller-utils';
+import EthQuery from '@metamask/eth-query';
 import { BN } from 'ethereumjs-util';
 import { when } from 'jest-when';
 
+import { FakeProvider } from '../../../tests/fake-provider';
 import fetchBlockFeeHistory from './fetchBlockFeeHistory';
 
 jest.mock('@metamask/controller-utils', () => {
@@ -33,23 +35,20 @@ function times<T>(n: number, fn: (n: number) => T): T[] {
 }
 
 describe('fetchBlockFeeHistory', () => {
-  const ethQuery = { eth: 'query' };
-
+  const mockEthQuery = new EthQuery(new FakeProvider());
   describe('with a minimal set of arguments', () => {
     const latestBlockNumber = 3;
     const numberOfRequestedBlocks = 3;
 
     beforeEach(() => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'blockNumber')
+        .calledWith(mockEthQuery, 'blockNumber')
         .mockResolvedValue(new BN(latestBlockNumber));
     });
 
     it('should return a representation of fee history from the Ethereum network, organized by block rather than type of data', async () => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(latestBlockNumber),
           [],
@@ -70,7 +69,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
       });
 
@@ -98,8 +97,7 @@ describe('fetchBlockFeeHistory', () => {
 
     it('should be able to handle an "empty" response from eth_feeHistory', async () => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(latestBlockNumber),
           [],
@@ -111,7 +109,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
       });
 
@@ -120,8 +118,7 @@ describe('fetchBlockFeeHistory', () => {
 
     it('should be able to handle an response with undefined baseFeePerGas from eth_feeHistory', async () => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(latestBlockNumber),
           [],
@@ -132,7 +129,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
       });
 
@@ -158,8 +155,7 @@ describe('fetchBlockFeeHistory', () => {
       });
 
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'blockNumber')
+        .calledWith(mockEthQuery, 'blockNumber')
         .mockResolvedValue(new BN(latestBlockNumber));
 
       expectedChunks.forEach(({ startBlockNumber, endBlockNumber }) => {
@@ -171,8 +167,7 @@ describe('fetchBlockFeeHistory', () => {
           .map((block) => block.gasUsedRatio);
 
         when(mockedQuery)
-          // @ts-expect-error Mock eth query does not fulfill type requirements
-          .calledWith(ethQuery, 'eth_feeHistory', [
+          .calledWith(mockEthQuery, 'eth_feeHistory', [
             toHex(endBlockNumber - startBlockNumber + 1),
             toHex(endBlockNumber),
             [],
@@ -185,7 +180,7 @@ describe('fetchBlockFeeHistory', () => {
       });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
       });
 
@@ -208,8 +203,7 @@ describe('fetchBlockFeeHistory', () => {
       const numberOfRequestedBlocks = 3;
       const endBlock = new BN(latestBlockNumber);
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(endBlock),
           [],
@@ -221,7 +215,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
         endBlock,
       });
@@ -236,15 +230,13 @@ describe('fetchBlockFeeHistory', () => {
 
     beforeEach(() => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'blockNumber')
+        .calledWith(mockEthQuery, 'blockNumber')
         .mockResolvedValue(new BN(latestBlockNumber));
     });
 
     it('should match each item in the "reward" key from the response to its percentile', async () => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(latestBlockNumber),
           [10, 20, 30],
@@ -278,7 +270,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
         percentiles: [10, 20, 30],
       });
@@ -319,8 +311,7 @@ describe('fetchBlockFeeHistory', () => {
 
     it('should be able to handle an "empty" response from eth_feeHistory including an empty "reward" array', async () => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(latestBlockNumber),
           [10, 20, 30],
@@ -333,7 +324,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
         percentiles: [10, 20, 30],
       });
@@ -348,8 +339,7 @@ describe('fetchBlockFeeHistory', () => {
 
     it('includes an extra block with an estimated baseFeePerGas', async () => {
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(numberOfRequestedBlocks),
           toHex(latestBlockNumber),
           [],
@@ -370,7 +360,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       const feeHistory = await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
         includeNextBlock: true,
       });
@@ -415,8 +405,7 @@ describe('fetchBlockFeeHistory', () => {
       const endBlock = new BN(latestBlockNumber);
 
       when(mockedQuery)
-        // @ts-expect-error Mock eth query does not fulfill type requirements
-        .calledWith(ethQuery, 'eth_feeHistory', [
+        .calledWith(mockEthQuery, 'eth_feeHistory', [
           toHex(latestBlockNumber),
           toHex(latestBlockNumber),
           [],
@@ -429,7 +418,7 @@ describe('fetchBlockFeeHistory', () => {
         });
 
       await fetchBlockFeeHistory({
-        ethQuery,
+        ethQuery: mockEthQuery,
         numberOfBlocks: numberOfRequestedBlocks,
         endBlock,
       });

diff --git a/packages/gas-fee-controller/src/fetchGasEstimatesViaEthFeeHistory.test.ts b/packages/gas-fee-controller/src/fetchGasEstimatesViaEthFeeHistory.test.ts
@@ -1,3 +1,4 @@
+import EthQuery from '@metamask/eth-query';
 import { BN } from 'ethereumjs-util';
 import { when } from 'jest-when';
 
@@ -31,7 +32,8 @@ describe('fetchGasEstimatesViaEthFeeHistory', () => {
     number: new BN(1),
     baseFeePerGas: new BN(100_000_000_000),
   };
-  const ethQuery = {
+  const mockEthQuery = {
+    sendAsync: EthQuery.prototype.sendAsync,
     blockNumber: async () => latestBlock.number,
     getBlockByNumber: async () => latestBlock,
   };
@@ -73,7 +75,7 @@ describe('fetchGasEstimatesViaEthFeeHistory', () => {
     mockedFetchLatestBlock.mockResolvedValue(latestBlock);
     when(mockedFetchBlockFeeHistory)
       .calledWith({
-        ethQuery,
+        ethQuery: mockEthQuery,
         endBlock: latestBlock.number,
         numberOfBlocks: 5,
         percentiles: [10, 20, 30],
@@ -84,8 +86,9 @@ describe('fetchGasEstimatesViaEthFeeHistory', () => {
       .calledWith(blocks)
       .mockReturnValue(levelSpecificEstimates);
 
-    // @ts-expect-error Mock eth query does not fulfill type requirements
-    const gasFeeEstimates = await fetchGasEstimatesViaEthFeeHistory(ethQuery);
+    const gasFeeEstimates = await fetchGasEstimatesViaEthFeeHistory(
+      mockEthQuery,
+    );
 
     expect(gasFeeEstimates).toStrictEqual({
       ...levelSpecificEstimates,