feat: register NetworkConnectionBannerController in metamask-controller

Author: cryptodev-2s

app/scripts/messenger-client-init/controller-list.ts

@@ -87,6 +87,7 @@ import {
 import { ClaimsController, ClaimsService } from '@metamask/claims-controller';
 import { ClientController } from '@metamask/client-controller';
 import { ConnectivityController } from '@metamask/connectivity-controller';
+import { NetworkConnectionBannerController } from '@metamask/network-connection-banner-controller';
 import {
   ProfileMetricsController,
   ProfileMetricsService,
@@ -233,7 +234,8 @@ export type MessengerClient =
   | StaticAssetsController
   | ProfileMetricsController
   | ProfileMetricsService
-  | ConnectivityController;
+  | ConnectivityController
+  | NetworkConnectionBannerController;
 
 /**
  * Flat state object for all messenger clients supporting or required by modular initialization.

app/scripts/messenger-client-init/messengers/index.ts

@@ -92,6 +92,7 @@ import {
   getSubscriptionControllerMessenger,
 } from './subscription';
 import { getConnectivityControllerMessenger } from './connectivity';
+import { getNetworkConnectionBannerControllerMessenger } from './network-connection-banner';
 import { getGatorPermissionsControllerMessenger } from './gator-permissions/gator-permissions-controller-messenger';
 import { getMetaMetricsControllerMessenger } from './metametrics-controller-messenger';
 import { getUserStorageControllerInitMessenger } from './identity/user-storage-controller-messenger';
@@ -402,6 +403,10 @@ export const MESSENGER_FACTORIES = {
     getMessenger: getConnectivityControllerMessenger,
     getInitMessenger: noop,
   },
+  NetworkConnectionBannerController: {
+    getMessenger: getNetworkConnectionBannerControllerMessenger,
+    getInitMessenger: noop,
+  },
   ClaimsController: {
     getMessenger: getClaimsControllerMessenger,
     getInitMessenger: getClaimsControllerInitMessenger,

app/scripts/messenger-client-init/messengers/network-connection-banner/index.ts

@@ -0,0 +1 @@
+export { getNetworkConnectionBannerControllerMessenger } from './network-connection-banner-controller-messenger';

app/scripts/messenger-client-init/messengers/network-connection-banner/network-connection-banner-controller-messenger.ts

@@ -0,0 +1,27 @@
+import {
+  Messenger,
+  type MessengerActions,
+  type MessengerEvents,
+} from '@metamask/messenger';
+import type { NetworkConnectionBannerControllerMessenger } from '@metamask/network-connection-banner-controller';
+import { RootMessenger } from '../../../lib/messenger';
+
+/**
+ * Get a messenger for the NetworkConnectionBannerController.
+ *
+ * @param messenger - The root messenger.
+ * @returns The messenger for NetworkConnectionBannerController.
+ */
+export function getNetworkConnectionBannerControllerMessenger(
+  messenger: RootMessenger<
+    MessengerActions<NetworkConnectionBannerControllerMessenger>,
+    MessengerEvents<NetworkConnectionBannerControllerMessenger>
+  >,
+): NetworkConnectionBannerControllerMessenger {
+  const controllerMessenger: NetworkConnectionBannerControllerMessenger =
+    new Messenger({
+      namespace: 'NetworkConnectionBannerController',
+      parent: messenger,
+    });
+  return controllerMessenger;
+}

app/scripts/messenger-client-init/network-connection-banner/index.ts

@@ -0,0 +1 @@
+export { NetworkConnectionBannerControllerInit } from './network-connection-banner-controller-init';

app/scripts/messenger-client-init/network-connection-banner/network-connection-banner-controller-init.ts

@@ -0,0 +1,34 @@
+import {
+  NetworkConnectionBannerController,
+  type NetworkConnectionBannerControllerMessenger,
+} from '@metamask/network-connection-banner-controller';
+
+import { MessengerClientInitFunction } from '../types';
+
+/**
+ * Initialize the NetworkConnectionBannerController.
+ *
+ * Encapsulates the show/hide rule and 5s/30s timer state machine for the
+ * "Still connecting" / "Unable to connect" banner. Subscribes to
+ * NetworkController, NetworkEnablementController, and ConnectivityController
+ * state via the messenger.
+ *
+ * @param request - The controller init request.
+ * @param request.controllerMessenger - The messenger for the controller.
+ * @returns The controller init result.
+ */
+export const NetworkConnectionBannerControllerInit: MessengerClientInitFunction<
+  NetworkConnectionBannerController,
+  NetworkConnectionBannerControllerMessenger
+> = (request) => {
+  const { controllerMessenger } = request;
+
+  const messengerClient = new NetworkConnectionBannerController({
+    messenger: controllerMessenger,
+  });
+
+  return {
+    messengerClient,
+    persistedStateKey: null,
+  };
+};

app/scripts/metamask-controller.js

@@ -404,6 +404,7 @@ import {
   SubscriptionServiceInit,
 } from './messenger-client-init/subscription';
 import { ConnectivityControllerInit } from './messenger-client-init/connectivity';
+import { NetworkConnectionBannerControllerInit } from './messenger-client-init/network-connection-banner';
 import { AccountTrackerControllerInit } from './messenger-client-init/account-tracker-controller-init';
 import { OnboardingControllerInit } from './messenger-client-init/onboarding-controller-init';
 import { RemoteFeatureFlagControllerInit } from './messenger-client-init/remote-feature-flag-controller-init';
@@ -699,6 +700,7 @@ export default class MetamaskController extends EventEmitter {
       SubscriptionController: SubscriptionControllerInit,
       SubscriptionService: SubscriptionServiceInit,
       ConnectivityController: ConnectivityControllerInit,
+      NetworkConnectionBannerController: NetworkConnectionBannerControllerInit,
       NetworkOrderController: NetworkOrderControllerInit,
       ShieldController: ShieldControllerInit,
       ClaimsController: ClaimsControllerInit,

package.json

@@ -161,6 +161,7 @@
     "yarn-binary:hydrate": "corepack hydrate .yarn/yarn-corepack.tgz --activate"
   },
   "resolutions": {
+    "@metamask/network-connection-banner-controller": "npm:@metamask-previews/network-connection-banner-controller@0.1.0-preview-7507a11",
     "@metamask/bridge-controller": "73.2.0",
     "@metamask/messenger@npm:^0.3.0": "^1.2.0",
     "@metamask/network-controller": "32.0.0",
@@ -399,6 +400,7 @@
     "@metamask/multichain-network-controller": "^3.1.0",
     "@metamask/multichain-transactions-controller": "^7.1.0",
     "@metamask/name-controller": "^9.1.0",
+    "@metamask/network-connection-banner-controller": "^0.1.0",
     "@metamask/network-controller": "^32.0.0",
     "@metamask/network-enablement-controller": "^5.3.0",
     "@metamask/notification-services-controller": "^23.1.0",

yarn.lock

@@ -7304,6 +7304,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@metamask/network-connection-banner-controller@npm:@metamask-previews/network-connection-banner-controller@0.1.0-preview-7507a11":
+  version: 0.1.0-preview-7507a11
+  resolution: "@metamask-previews/network-connection-banner-controller@npm:0.1.0-preview-7507a11"
+  dependencies:
+    "@metamask/base-controller": "npm:^9.1.0"
+    "@metamask/connectivity-controller": "npm:^0.2.0"
+    "@metamask/messenger": "npm:^1.2.0"
+    "@metamask/network-controller": "npm:^32.0.0"
+    "@metamask/network-enablement-controller": "npm:^5.3.0"
+    "@metamask/utils": "npm:^11.9.0"
+    ip-regex: "npm:^4.3.0"
+    psl: "npm:^1.15.0"
+  checksum: 10/a3a8bb5f0e14aa503c72ed4d0b16ebd1763817bbdf3fb04f5dc4c6156ca8c0f02284fe73989676043b48fc198c366b6171f369fbafd1ceb906b397ccc22dcd11
+  languageName: node
+  linkType: hard
+
 "@metamask/network-controller@npm:32.0.0":
   version: 32.0.0
   resolution: "@metamask/network-controller@npm:32.0.0"
@@ -33261,6 +33277,7 @@ __metadata:
     "@metamask/multichain-network-controller": "npm:^3.1.0"
     "@metamask/multichain-transactions-controller": "npm:^7.1.0"
     "@metamask/name-controller": "npm:^9.1.0"
+    "@metamask/network-connection-banner-controller": "npm:^0.1.0"
     "@metamask/network-controller": "npm:^32.0.0"
     "@metamask/network-enablement-controller": "npm:^5.3.0"
     "@metamask/notification-services-controller": "npm:^23.1.0"