feat(network-controller): connect NetworkController to ConnectivityController

README.md

@@ -313,6 +313,7 @@ linkStyle default opacity:0.5
   name_controller --> controller_utils;
   name_controller --> messenger;
   network_controller --> base_controller;
+  network_controller --> connectivity_controller;
   network_controller --> controller_utils;
   network_controller --> eth_block_tracker;
   network_controller --> eth_json_rpc_middleware;

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

@@ -113,6 +113,7 @@ async function setupAssetContractControllers({
     getRpcServiceOptions: () => ({
       fetch,
       btoa,
+      isOffline: (): boolean => false,
     }),
   });
   if (useNetworkControllerProvider) {

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

@@ -102,6 +102,7 @@ const setupNetworkController = async ({
     getRpcServiceOptions: () => ({
       fetch,
       btoa,
+      isOffline: (): boolean => false,
     }),
   });
 

packages/network-controller/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** NetworkController now requires `ConnectivityController:getState` action handler to be registered on the messenger ([#7627](https://github.com/MetaMask/core/pull/7627))
+  - The `NetworkController` now depends on the `ConnectivityController` to prevent retries and suppress events when the user is offline.
+  - When offline, `NetworkController:rpcEndpointUnavailable` and `NetworkController:rpcEndpointDegraded` events are suppressed since retries don't occur and circuit breakers don't trigger.
+  - You must register a `ConnectivityController:getState` action handler on your root messenger that returns an object with a `connectivityStatus` property (`'online'` or `'offline'`).
+  - You must delegate the `ConnectivityController:getState` action from your root messenger to the `NetworkControllerMessenger` using `rootMessenger.delegate({ messenger: networkControllerMessenger, actions: ['ConnectivityController:getState'] })`.
+
 ## [28.0.0]
 
 ### Changed

packages/network-controller/package.json

@@ -49,6 +49,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^9.0.0",
+    "@metamask/connectivity-controller": "^0.0.0",
     "@metamask/controller-utils": "^11.18.0",
     "@metamask/eth-block-tracker": "^15.0.0",
     "@metamask/eth-json-rpc-infura": "^10.3.0",

packages/network-controller/src/NetworkController.ts

@@ -3,6 +3,7 @@ import type {
   ControllerStateChangeEvent,
 } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
+import type { ConnectivityControllerGetStateAction } from '@metamask/connectivity-controller';
 import type { Partialize } from '@metamask/controller-utils';
 import {
   InfuraNetworkType,
@@ -729,7 +730,7 @@ export type NetworkControllerActions =
 /**
  * All actions that {@link NetworkController} calls internally.
  */
-type AllowedActions = never;
+type AllowedActions = ConnectivityControllerGetStateAction;
 
 export type NetworkControllerMessenger = Messenger<
   typeof controllerName,

packages/network-controller/src/create-auto-managed-network-client.test.ts

@@ -42,6 +42,7 @@ describe('createAutoManagedNetworkClient', () => {
           getRpcServiceOptions: () => ({
             fetch,
             btoa,
+            isOffline: (): boolean => false,
           }),
           messenger: buildNetworkControllerMessenger(),
           isRpcFailoverEnabled: false,
@@ -59,6 +60,7 @@ describe('createAutoManagedNetworkClient', () => {
             getRpcServiceOptions: () => ({
               fetch,
               btoa,
+              isOffline: (): boolean => false,
             }),
             messenger: buildNetworkControllerMessenger(),
             isRpcFailoverEnabled: false,
@@ -73,6 +75,7 @@ describe('createAutoManagedNetworkClient', () => {
           getRpcServiceOptions: () => ({
             fetch,
             btoa,
+            isOffline: (): boolean => false,
           }),
           messenger: buildNetworkControllerMessenger(),
           isRpcFailoverEnabled: false,
@@ -107,6 +110,7 @@ describe('createAutoManagedNetworkClient', () => {
             getRpcServiceOptions: () => ({
               fetch,
               btoa,
+              isOffline: (): boolean => false,
             }),
             messenger: buildNetworkControllerMessenger(),
             isRpcFailoverEnabled: false,
@@ -147,6 +151,7 @@ describe('createAutoManagedNetworkClient', () => {
           > => ({
             btoa,
             fetch,
+            isOffline: (): boolean => false,
           });
           const getBlockTrackerOptions = (): PollingBlockTrackerOptions => ({
             pollingInterval: 5000,
@@ -211,6 +216,7 @@ describe('createAutoManagedNetworkClient', () => {
           > => ({
             btoa,
             fetch,
+            isOffline: (): boolean => false,
           });
           const getBlockTrackerOptions = (): PollingBlockTrackerOptions => ({
             pollingInterval: 5000,
@@ -285,6 +291,7 @@ describe('createAutoManagedNetworkClient', () => {
           > => ({
             btoa,
             fetch,
+            isOffline: (): boolean => false,
           });
           const getBlockTrackerOptions = (): PollingBlockTrackerOptions => ({
             pollingInterval: 5000,
@@ -341,6 +348,7 @@ describe('createAutoManagedNetworkClient', () => {
           getRpcServiceOptions: () => ({
             fetch,
             btoa,
+            isOffline: (): boolean => false,
           }),
           messenger: buildNetworkControllerMessenger(),
           isRpcFailoverEnabled: false,
@@ -401,6 +409,7 @@ describe('createAutoManagedNetworkClient', () => {
             getRpcServiceOptions: () => ({
               fetch,
               btoa,
+              isOffline: (): boolean => false,
             }),
             messenger: buildNetworkControllerMessenger(),
             isRpcFailoverEnabled: false,
@@ -464,6 +473,7 @@ describe('createAutoManagedNetworkClient', () => {
           > => ({
             btoa,
             fetch,
+            isOffline: (): boolean => false,
           });
           const getBlockTrackerOptions = (): PollingBlockTrackerOptions => ({
             pollingInterval: 5000,
@@ -524,6 +534,7 @@ describe('createAutoManagedNetworkClient', () => {
           > => ({
             btoa,
             fetch,
+            isOffline: (): boolean => false,
           });
           const getBlockTrackerOptions = (): PollingBlockTrackerOptions => ({
             pollingInterval: 5000,
@@ -592,6 +603,7 @@ describe('createAutoManagedNetworkClient', () => {
           > => ({
             btoa,
             fetch,
+            isOffline: (): boolean => false,
           });
           const getBlockTrackerOptions = (): PollingBlockTrackerOptions => ({
             pollingInterval: 5000,
@@ -657,6 +669,7 @@ describe('createAutoManagedNetworkClient', () => {
         getRpcServiceOptions: () => ({
           fetch,
           btoa,
+          isOffline: (): boolean => false,
         }),
         messenger: buildNetworkControllerMessenger(),
         isRpcFailoverEnabled: false,