Rename executePoll -> _executePoll + stopPollingByNetworkClientId -> stopPollingByPollingToken

packages/assets-controllers/src/TokenListController.test.ts

@@ -1294,8 +1294,9 @@ describe('TokenListController', () => {
     });
   });
 
-  describe('executePoll', () => {
+  describe('startPollingByNetworkClient', () => {
     it('should call fetchTokenListByChainId with the correct chainId', async () => {
+      jest.useFakeTimers();
       nock(tokenService.TOKEN_END_POINT_API)
         .get(`/tokens/${convertHexToDecimal(ChainId.sepolia)}`)
         .reply(200, sampleSepoliaTokenList)
@@ -1315,28 +1316,27 @@ describe('TokenListController', () => {
           },
         }),
       );
+      const pollingIntervalTime = 1000;
       const messenger = getRestrictedMessenger(controllerMessenger);
       const controller = new TokenListController({
         chainId: ChainId.mainnet,
         preventPollingOnNetworkRestart: false,
         messenger,
         state: expiredCacheExistingState,
+        interval: pollingIntervalTime,
       });
       expect(controller.state.tokenList).toStrictEqual(
         expiredCacheExistingState.tokenList,
       );
 
-      await controller.executePoll('sepolia');
+      controller.startPollingByNetworkClientId('sepolia');
+      jest.advanceTimersByTime(pollingIntervalTime);
+      await flushPromises();
+
       expect(fetchTokenListByChainIdSpy.mock.calls[0]).toStrictEqual(
         expect.arrayContaining([ChainId.sepolia]),
       );
-      expect(controller.state.tokenList).toStrictEqual(
-        sampleSepoliaTokensChainCache,
-      );
     });
-  });
-
-  describe('startPollingByNetworkClient', () => {
     it('should start polling against the token list API at the interval passed to the constructor', async () => {
       jest.useFakeTimers();
       const pollingIntervalTime = 1000;

packages/assets-controllers/src/TokenListController.ts

@@ -234,10 +234,11 @@ export class TokenListController extends PollingController<
   /**
    * Fetching token list from the Token Service API.
    *
+   * @private
    * @param networkClientId - The ID of the network client triggering the fetch.
    * @returns A promise that resolves when this operation completes.
    */
-  async executePoll(networkClientId: string): Promise<void> {
+  async _executePoll(networkClientId: string): Promise<void> {
     return this.fetchTokenList(networkClientId);
   }
 

packages/gas-fee-controller/src/GasFeeController.test.ts

@@ -1,5 +1,10 @@
 import { ControllerMessenger } from '@metamask/base-controller';
-import { NetworkType, toHex } from '@metamask/controller-utils';
+import {
+  ChainId,
+  convertHexToDecimal,
+  NetworkType,
+  toHex,
+} from '@metamask/controller-utils';
 import EthQuery from '@metamask/eth-query';
 import { NetworkController, NetworkStatus } from '@metamask/network-controller';
 import type {
@@ -868,8 +873,10 @@ describe('GasFeeController', () => {
       });
     });
   });
-  describe('executePoll', () => {
-    it('should call determineGasFeeCalculations with a URL that contains the chain ID', async () => {
+
+  describe('polling (by networkClientId)', () => {
+    it('should call determineGasFeeCalculations (via _executePoll) with a URL that contains the chainId corresponding to the networkClientId after the interval passed via the constructor', async () => {
+      const pollingInterval = 10000;
       await setupGasFeeController({
         getIsEIP1559Compatible: jest.fn().mockResolvedValue(false),
         getCurrentNetworkLegacyGasAPICompatibility: jest
@@ -879,7 +886,7 @@ describe('GasFeeController', () => {
         EIP1559APIEndpoint: 'https://some-eip-1559-endpoint/<chain_id>',
         networkControllerState: {
           networksMetadata: {
-            mainnet: {
+            goerli: {
               EIPS: {
                 1559: true,
               },
@@ -894,50 +901,6 @@ describe('GasFeeController', () => {
           },
         },
         clientId: '99999',
-      });
-
-      await gasFeeController.executePoll('mainnet');
-      await gasFeeController.executePoll('sepolia');
-
-      expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledWith(
-        expect.objectContaining({
-          fetchGasEstimatesUrl: 'https://some-eip-1559-endpoint/1',
-        }),
-      );
-      expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledWith(
-        expect.objectContaining({
-          fetchGasEstimatesUrl: 'https://some-eip-1559-endpoint/11155111',
-        }),
-      );
-      expect(mockedDetermineGasFeeCalculations).not.toHaveBeenCalledWith(
-        expect.objectContaining({
-          fetchGasEstimatesUrl: 'https://some-eip-1559-endpoint/5',
-        }),
-      );
-    });
-  });
-
-  describe('polling (by networkClientId)', () => {
-    it('should call determineGasFeeCalculations (via executePoll) with a URL that contains the chain ID after the interval passed via the constructor', async () => {
-      const pollingInterval = 10000;
-      await setupGasFeeController({
-        getIsEIP1559Compatible: jest.fn().mockResolvedValue(false),
-        getCurrentNetworkLegacyGasAPICompatibility: jest
-          .fn()
-          .mockReturnValue(true),
-        legacyAPIEndpoint: 'https://some-legacy-endpoint/<chain_id>',
-        EIP1559APIEndpoint: 'https://some-eip-1559-endpoint/<chain_id>',
-        networkControllerState: {
-          networksMetadata: {
-            goerli: {
-              EIPS: {
-                1559: true,
-              },
-              status: NetworkStatus.Available,
-            },
-          },
-        },
-        clientId: '99999',
         interval: pollingInterval,
       });
 
@@ -947,12 +910,24 @@ describe('GasFeeController', () => {
       await clock.tickAsync(pollingInterval / 2);
       expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledWith(
         expect.objectContaining({
-          fetchGasEstimatesUrl: 'https://some-eip-1559-endpoint/5',
+          fetchGasEstimatesUrl: `https://some-eip-1559-endpoint/${convertHexToDecimal(
+            ChainId.goerli,
+          )}`,
         }),
       );
       expect(
         gasFeeController.state.gasFeeEstimatesByChainId?.['0x5'],
       ).toStrictEqual(buildMockGasFeeStateFeeMarket());
+
+      gasFeeController.startPollingByNetworkClientId('sepolia');
+      await clock.tickAsync(pollingInterval);
+      expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledWith(
+        expect.objectContaining({
+          fetchGasEstimatesUrl: `https://some-eip-1559-endpoint/${convertHexToDecimal(
+            ChainId.sepolia,
+          )}`,
+        }),
+      );
     });
   });
 });

packages/gas-fee-controller/src/GasFeeController.ts

@@ -400,7 +400,6 @@ export class GasFeeController extends PollingController<
       'NetworkController:getNetworkClientById',
       networkClientId,
     );
-
     const isLegacyGasAPICompatible =
       networkClient.configuration.chainId === '0x38';
 
@@ -548,7 +547,14 @@ export class GasFeeController extends PollingController<
     }, this.intervalDelay);
   }
 
-  async executePoll(networkClientId: string): Promise<void> {
+  /**
+   * Fetching token list from the Token Service API.
+   *
+   * @private
+   * @param networkClientId - The ID of the network client triggering the fetch.
+   * @returns A promise that resolves when this operation completes.
+   */
+  async _executePoll(networkClientId: string): Promise<void> {
     await this.#fetchGasFeeEstimateForNetworkClientId(networkClientId);
   }