Ensure networksMetadata never references old network client IDs (#7047)

In debugging a long-standing issue where SelectedNetworkController
sometimes requests invalid network client IDs from NetworkController,
one bug was discovered in NetworkController. Namely, when a network is
removed, its data is removed from `networkConfigurationsByChainId`, but
not `networksMetadata`. This commit fixes `removeNetwork` to do this,
and ensures that when the controller is initialized, if
`networksMetadata` contains invalid network client IDs, they are
removed.

Author: mcmire

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

@@ -63,7 +63,16 @@ type AllEvents = AllGasFeeControllerEvents | AllNetworkControllerEvents;
 type RootMessenger = Messenger<MockAnyNamespace, AllActions, AllEvents>;
 
 const getRootMessenger = (): RootMessenger => {
-  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
+  const rootMessenger = new Messenger<
+    MockAnyNamespace,
+    MessengerActions<NetworkControllerMessenger>,
+    MessengerEvents<NetworkControllerMessenger>
+  >({ namespace: MOCK_ANY_NAMESPACE });
+  rootMessenger.registerActionHandler(
+    'ErrorReportingService:captureException',
+    jest.fn(),
+  );
+  return rootMessenger;
 };
 
 const setupNetworkController = async ({
@@ -86,6 +95,10 @@ const setupNetworkController = async ({
     namespace: 'NetworkController',
     parent: rootMessenger,
   });
+  rootMessenger.delegate({
+    messenger: networkControllerMessenger,
+    actions: ['ErrorReportingService:captureException'],
+  });
 
   const infuraProjectId = '123';
 

packages/network-controller/CHANGELOG.md

@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Providers accessible either via network clients or global proxies no longer emit events (or inherit from EventEmitter, for that matter).
 - Bump `@metamask/controller-utils` from `^11.14.1` to `^11.15.0` ([#7003](https://github.com/MetaMask/core/pull/7003))
 
+### Fixed
+
+- Ensure `networksMetadata` never references old network client IDs ([#7047](https://github.com/MetaMask/core/pull/7047))
+  - When removing a network configuration, ensure that metadata for all RPC endpoints in the network configuration are also removed from `networksMetadata`
+  - When initializing the controller, remove metadata for RPC endpoints in `networksMetadata` that are not present in a network configuration
+
 ## [25.0.0]
 
 ### Changed

packages/network-controller/src/NetworkController.ts

@@ -1082,12 +1082,17 @@ function correctInitialState(
   const networkConfigurationsSortedByChainId = getNetworkConfigurations(
     state,
   ).sort((a, b) => a.chainId.localeCompare(b.chainId));
-  const networkClientIds = getAvailableNetworkClientIds(
+  const availableNetworkClientIds = getAvailableNetworkClientIds(
     networkConfigurationsSortedByChainId,
   );
+  const invalidNetworkClientIdsWithMetadata = Object.keys(
+    state.networksMetadata,
+  ).filter(
+    (networkClientId) => !availableNetworkClientIds.includes(networkClientId),
+  );
 
   return produce(state, (newState) => {
-    if (!networkClientIds.includes(state.selectedNetworkClientId)) {
+    if (!availableNetworkClientIds.includes(state.selectedNetworkClientId)) {
       const firstNetworkConfiguration = networkConfigurationsSortedByChainId[0];
       const newSelectedNetworkClientId =
         firstNetworkConfiguration.rpcEndpoints[
@@ -1101,6 +1106,18 @@ function correctInitialState(
       );
       newState.selectedNetworkClientId = newSelectedNetworkClientId;
     }
+
+    if (invalidNetworkClientIdsWithMetadata.length > 0) {
+      for (const invalidNetworkClientId of invalidNetworkClientIdsWithMetadata) {
+        delete newState.networksMetadata[invalidNetworkClientId];
+      }
+      messenger.call(
+        'ErrorReportingService:captureException',
+        new Error(
+          '`networksMetadata` had invalid network client IDs, which have been removed',
+        ),
+      );
+    }
   });
 }
 
@@ -2401,6 +2418,10 @@ export class NetworkController extends BaseController<
         mode: 'remove',
         existingNetworkConfiguration,
       });
+
+      for (const rpcEndpoint of existingNetworkConfiguration.rpcEndpoints) {
+        delete state.networksMetadata[rpcEndpoint.networkClientId];
+      }
     });
 
     this.messenger.publish(