Gracefully handle requesting gas fee estimates for nonexistent network

Currently, when GasFeeController tries to fetch gas fee estimates for a
network that has been removed, it consults NetworkController for the
corresponding network client, and NetworkController throws an error.
This commit gracefully handles this situation by returning an empty set
of estimates.

Author: mcmire

packages/gas-fee-controller/CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bump `@metamask/base-controller` from `^7.0.0` to `^7.1.0` ([#5079](https://github.com/MetaMask/core/pull/5079))
 
+### Fixed
+
+- Fix `fetchGasFeeEstimates` so that it no longer throws an error if given a reference to a network that does not exist ([#5084](https://github.com/MetaMask/core/pull/5084))
+
 ## [22.0.2]
 
 ### Changed

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

@@ -999,6 +999,7 @@ describe('GasFeeController', () => {
         );
       });
     });
+
     describe('when passed a networkClientId in options object', () => {
       const getDefaultOptions = () => ({
         getIsEIP1559Compatible: jest.fn().mockResolvedValue(true),
@@ -1033,6 +1034,35 @@ describe('GasFeeController', () => {
         );
       });
 
+      it("should not update state if the network client doesn't exist", async () => {
+        await setupGasFeeController({
+          ...getDefaultOptions(),
+        });
+        const initialState = gasFeeController.state;
+
+        await gasFeeController.fetchGasFeeEstimates({
+          networkClientId: 'nonexistent',
+        });
+
+        expect(gasFeeController.state).toBe(initialState);
+      });
+
+      it("should return an empty set of estimates if the network client doesn't exist", async () => {
+        await setupGasFeeController({
+          ...getDefaultOptions(),
+        });
+
+        const estimates = await gasFeeController.fetchGasFeeEstimates({
+          networkClientId: 'nonexistent',
+        });
+
+        expect(estimates).toStrictEqual({
+          gasFeeEstimates: {},
+          estimatedGasFeeTimeBounds: {},
+          gasEstimateType: 'none',
+        });
+      });
+
       it('should call determineGasFeeCalculations correctly', async () => {
         await setupGasFeeController({
           ...getDefaultOptions(),

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

@@ -9,14 +9,15 @@ import {
   toHex,
 } from '@metamask/controller-utils';
 import EthQuery from '@metamask/eth-query';
-import type {
-  NetworkClientId,
-  NetworkControllerGetEIP1559CompatibilityAction,
-  NetworkControllerGetNetworkClientByIdAction,
-  NetworkControllerGetStateAction,
-  NetworkControllerNetworkDidChangeEvent,
-  NetworkState,
-  ProviderProxy,
+import {
+  NoNetworkClientFoundError,
+  type NetworkClientId,
+  type NetworkControllerGetEIP1559CompatibilityAction,
+  type NetworkControllerGetNetworkClientByIdAction,
+  type NetworkControllerGetStateAction,
+  type NetworkControllerNetworkDidChangeEvent,
+  type NetworkState,
+  type ProviderProxy,
 } from '@metamask/network-controller';
 import { StaticIntervalPollingController } from '@metamask/polling-controller';
 import type { Hex } from '@metamask/utils';
@@ -29,6 +30,9 @@ import {
   fetchEthGasPriceEstimate,
   calculateTimeEstimate,
 } from './gas-util';
+import { createModuleLogger, projectLogger } from './logger';
+
+const log = createModuleLogger(projectLogger, 'GasFeeController');
 
 export const LEGACY_GAS_PRICES_API_URL = `https://api.metaswap.codefi.network/gasPrices`;
 
@@ -443,10 +447,23 @@ export class GasFeeController extends StaticIntervalPollingController<GasFeePoll
       decimalChainId: number;
 
     if (networkClientId !== undefined) {
-      const networkClient = this.messagingSystem.call(
-        'NetworkController:getNetworkClientById',
-        networkClientId,
-      );
+      let networkClient;
+      try {
+        networkClient = this.messagingSystem.call(
+          'NetworkController:getNetworkClientById',
+          networkClientId,
+        );
+      } catch (error) {
+        if (error instanceof NoNetworkClientFoundError) {
+          log(error.message);
+          return {
+            gasFeeEstimates: {},
+            estimatedGasFeeTimeBounds: {},
+            gasEstimateType: GAS_ESTIMATE_TYPES.NONE,
+          };
+        }
+        throw error;
+      }
       isLegacyGasAPICompatible = networkClient.configuration.chainId === '0x38';
 
       decimalChainId = convertHexToDecimal(networkClient.configuration.chainId);

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

@@ -0,0 +1,7 @@
+/* istanbul ignore file */
+
+import { createProjectLogger, createModuleLogger } from '@metamask/utils';
+
+export const projectLogger = createProjectLogger('gas-fee-controller');
+
+export { createModuleLogger };

packages/network-controller/src/NetworkController.ts

@@ -33,6 +33,7 @@ import type {
   ProxyWithAccessibleTarget,
 } from './create-auto-managed-network-client';
 import { createAutoManagedNetworkClient } from './create-auto-managed-network-client';
+import { NoNetworkClientFoundError } from './errors';
 import { projectLogger, createModuleLogger } from './logger';
 import { NetworkClientType } from './types';
 import type {
@@ -41,6 +42,9 @@ import type {
   CustomNetworkClientConfiguration,
   InfuraNetworkClientConfiguration,
   NetworkClientConfiguration,
+  NetworkClientId,
+  BuiltInNetworkClientId,
+  CustomNetworkClientId,
 } from './types';
 
 const debugLog = createModuleLogger(projectLogger, 'NetworkController');
@@ -294,21 +298,6 @@ function isErrorWithCode(error: unknown): error is { code: string | number } {
   return typeof error === 'object' && error !== null && 'code' in error;
 }
 
-/**
- * The string that uniquely identifies an Infura network client.
- */
-export type BuiltInNetworkClientId = InfuraNetworkType;
-
-/**
- * The string that uniquely identifies a custom network client.
- */
-export type CustomNetworkClientId = string;
-
-/**
- * The string that uniquely identifies a network client.
- */
-export type NetworkClientId = BuiltInNetworkClientId | CustomNetworkClientId;
-
 /**
  * Extra information about each network, such as whether it is accessible or
  * blocked and whether it supports EIP-1559, keyed by network client ID.
@@ -1107,11 +1096,7 @@ export class NetworkController extends BaseController<
       // This is impossible to reach
       /* istanbul ignore if */
       if (!infuraNetworkClient) {
-        throw new Error(
-          // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-          // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-          `No Infura network client was found with the ID "${networkClientId}".`,
-        );
+        throw NoNetworkClientFoundError.create(networkClientId);
       }
       return infuraNetworkClient;
     }
@@ -1121,11 +1106,7 @@ export class NetworkController extends BaseController<
         networkClientId
       ];
     if (!customNetworkClient) {
-      throw new Error(
-        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-        `No custom network client was found with the ID "${networkClientId}".`,
-      );
+      throw NoNetworkClientFoundError.create(networkClientId);
     }
     return customNetworkClient;
   }

packages/network-controller/src/errors.ts

@@ -0,0 +1,9 @@
+import type { NetworkClientId } from './types';
+
+export class NoNetworkClientFoundError extends Error {
+  static create(networkClientId: NetworkClientId) {
+    // ESLint is confused here; this is guaranteed to be a string.
+    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+    return new this(`No network client found with the ID "${networkClientId}"`);
+  }
+}

packages/network-controller/src/index.ts

@@ -3,9 +3,6 @@ export type {
   Block,
   NetworkMetadata,
   NetworkConfiguration,
-  BuiltInNetworkClientId,
-  CustomNetworkClientId,
-  NetworkClientId,
   NetworksMetadata,
   NetworkState,
   BlockTrackerProxy,
@@ -44,11 +41,16 @@ export {
   RpcEndpointType,
 } from './NetworkController';
 export * from './constants';
-export type { BlockTracker, Provider } from './types';
 export type {
+  BlockTracker,
+  Provider,
   NetworkClientConfiguration,
   InfuraNetworkClientConfiguration,
   CustomNetworkClientConfiguration,
+  BuiltInNetworkClientId,
+  CustomNetworkClientId,
+  NetworkClientId,
 } from './types';
 export { NetworkClientType } from './types';
 export type { NetworkClient } from './create-network-client';
+export { NoNetworkClientFoundError } from './errors';

packages/network-controller/src/types.ts

@@ -46,3 +46,18 @@ export type InfuraNetworkClientConfiguration = {
 export type NetworkClientConfiguration =
   | CustomNetworkClientConfiguration
   | InfuraNetworkClientConfiguration;
+
+/**
+ * The string that uniquely identifies an Infura network client.
+ */
+export type BuiltInNetworkClientId = InfuraNetworkType;
+
+/**
+ * The string that uniquely identifies a custom network client.
+ */
+export type CustomNetworkClientId = string;
+
+/**
+ * The string that uniquely identifies a network client.
+ */
+export type NetworkClientId = BuiltInNetworkClientId | CustomNetworkClientId;