@metamask-previews/network-controller 33.0.0-preview-ba933fc1b → 33.0.0-preview-14cbc2873

package/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add optional `analytics` constructor option that makes `NetworkController` emit `RPC Service Unavailable` and `RPC Service Degraded` analytics events via the `AnalyticsController:trackEvent` action when an RPC endpoint becomes unavailable or degraded ([#9270](https://github.com/MetaMask/core/pull/9270))
+  - The option takes `isRpcEndpointUrlPublic` (decides whether an endpoint URL is safe to report verbatim or as `'custom'`) and `rpcServiceEventsSampleRate` (the proportion of events to emit, between `0` and `1`).
+  - No analytics are emitted when the option is omitted.
+  - Adds the `NetworkControllerAnalyticsOptions` and `RpcServiceEventName` types.
+
+### Changed
+
+- The `NetworkControllerMessenger` now allows the `AnalyticsController:getState` and `AnalyticsController:trackEvent` actions ([#9270](https://github.com/MetaMask/core/pull/9270))
+  - Consumers that pass the `analytics` option must delegate these actions to the network controller messenger.
+
 ## [33.0.0]
 
 ### Added

package/dist/NetworkController.cjs

@@ -36,12 +36,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_failoverUrls, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_getRpcServiceOptions, _NetworkController_getBlockTrackerOptions, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_isRpcFailoverEnabled, _NetworkController_updateRpcFailoverEnabled, _NetworkController_refreshNetwork, _NetworkController_determineNetworkMetadata, _NetworkController_lookupGivenNetwork, _NetworkController_lookupSelectedNetwork, _NetworkController_updateMetadataForNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
+var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_failoverUrls, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_getRpcServiceOptions, _NetworkController_getBlockTrackerOptions, _NetworkController_analytics, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_isRpcFailoverEnabled, _NetworkController_trackRpcServiceEvent, _NetworkController_updateRpcFailoverEnabled, _NetworkController_refreshNetwork, _NetworkController_determineNetworkMetadata, _NetworkController_lookupGivenNetwork, _NetworkController_lookupSelectedNetwork, _NetworkController_updateMetadataForNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NetworkController = exports.selectAvailableNetworkClientIds = exports.getAvailableNetworkClientIds = exports.selectNetworkConfigurations = exports.getNetworkConfigurations = exports.getDefaultNetworkControllerState = exports.knownKeysOf = exports.RpcEndpointType = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const eth_query_1 = __importDefault(require("@metamask/eth-query"));
+const remote_feature_flag_controller_1 = require("@metamask/remote-feature-flag-controller");
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const swappable_obj_proxy_1 = require("@metamask/swappable-obj-proxy");
 const utils_1 = require("@metamask/utils");
@@ -54,6 +55,8 @@ const uuid_1 = require("uuid");
 const constants_1 = require("./constants.cjs");
 const create_auto_managed_network_client_1 = require("./create-auto-managed-network-client.cjs");
 const logger_1 = require("./logger.cjs");
+const rpc_service_events_1 = require("./rpc-service-events.cjs");
+const rpc_service_1 = require("./rpc-service/rpc-service.cjs");
 const selectors_1 = require("./selectors.cjs");
 const types_1 = require("./types.cjs");
 const debugLog = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'NetworkController');
@@ -393,7 +396,7 @@ class NetworkController extends base_controller_1.BaseController {
      * @param options - The options; see {@link NetworkControllerOptions}.
      */
     constructor(options) {
-        const { messenger, state, infuraProjectId, failoverUrls, log, getRpcServiceOptions, getBlockTrackerOptions, } = options;
+        const { messenger, state, infuraProjectId, failoverUrls, log, getRpcServiceOptions, getBlockTrackerOptions, analytics, } = options;
         const initialState = {
             ...getDefaultNetworkControllerState(),
             ...state,
@@ -440,6 +443,7 @@ class NetworkController extends base_controller_1.BaseController {
         _NetworkController_log.set(this, void 0);
         _NetworkController_getRpcServiceOptions.set(this, void 0);
         _NetworkController_getBlockTrackerOptions.set(this, void 0);
+        _NetworkController_analytics.set(this, void 0);
         _NetworkController_networkConfigurationsByNetworkClientId.set(this, void 0);
         _NetworkController_isRpcFailoverEnabled.set(this, false);
         __classPrivateFieldSet(this, _NetworkController_infuraProjectId, infuraProjectId, "f");
@@ -447,6 +451,7 @@ class NetworkController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _NetworkController_log, log, "f");
         __classPrivateFieldSet(this, _NetworkController_getRpcServiceOptions, getRpcServiceOptions, "f");
         __classPrivateFieldSet(this, _NetworkController_getBlockTrackerOptions, getBlockTrackerOptions, "f");
+        __classPrivateFieldSet(this, _NetworkController_analytics, analytics, "f");
         __classPrivateFieldSet(this, _NetworkController_previouslySelectedNetworkClientId, this.state.selectedNetworkClientId, "f");
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
         this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
@@ -465,6 +470,28 @@ class NetworkController extends base_controller_1.BaseController {
                 networkStatus: constants_1.NetworkStatus.Available,
             });
         });
+        if (__classPrivateFieldGet(this, _NetworkController_analytics, "f")) {
+            const analyticsOptions = __classPrivateFieldGet(this, _NetworkController_analytics, "f");
+            this.messenger.subscribe(`${this.name}:rpcEndpointUnavailable`, ({ chainId, endpointUrl, error }) => {
+                __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_trackRpcServiceEvent).call(this, analyticsOptions, 'RPC Service Unavailable', {
+                    chainId,
+                    endpointUrl,
+                    error,
+                });
+            });
+            this.messenger.subscribe(`${this.name}:rpcEndpointDegraded`, ({ chainId, duration, endpointUrl, error, retryReason, rpcMethodName, traceId, type, }) => {
+                __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_trackRpcServiceEvent).call(this, analyticsOptions, 'RPC Service Degraded', {
+                    chainId,
+                    duration,
+                    endpointUrl,
+                    error,
+                    retryReason,
+                    rpcMethodName,
+                    traceId,
+                    type,
+                });
+            });
+        }
         this.messenger.subscribe(
         // eslint-disable-next-line no-restricted-syntax
         'RemoteFeatureFlagController:stateChange', (isRpcFailoverEnabled) => {
@@ -1063,7 +1090,36 @@ class NetworkController extends base_controller_1.BaseController {
     }
 }
 exports.NetworkController = NetworkController;
-_NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId = new WeakMap(), _NetworkController_failoverUrls = new WeakMap(), _NetworkController_previouslySelectedNetworkClientId = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_autoManagedNetworkClientRegistry = new WeakMap(), _NetworkController_autoManagedNetworkClient = new WeakMap(), _NetworkController_log = new WeakMap(), _NetworkController_getRpcServiceOptions = new WeakMap(), _NetworkController_getBlockTrackerOptions = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_isRpcFailoverEnabled = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_updateRpcFailoverEnabled = function _NetworkController_updateRpcFailoverEnabled(newIsRpcFailoverEnabled) {
+_NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId = new WeakMap(), _NetworkController_failoverUrls = new WeakMap(), _NetworkController_previouslySelectedNetworkClientId = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_autoManagedNetworkClientRegistry = new WeakMap(), _NetworkController_autoManagedNetworkClient = new WeakMap(), _NetworkController_log = new WeakMap(), _NetworkController_getRpcServiceOptions = new WeakMap(), _NetworkController_getBlockTrackerOptions = new WeakMap(), _NetworkController_analytics = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_isRpcFailoverEnabled = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_trackRpcServiceEvent = function _NetworkController_trackRpcServiceEvent(analytics, name, payload) {
+    try {
+        if ((0, rpc_service_1.isConnectionError)(payload.error)) {
+            return;
+        }
+        const { analyticsId } = this.messenger.call('AnalyticsController:getState');
+        if (!analyticsId) {
+            return;
+        }
+        if ((0, remote_feature_flag_controller_1.generateDeterministicRandomNumber)(analyticsId) >=
+            analytics.rpcServiceEventsSampleRate) {
+            return;
+        }
+        const properties = (0, rpc_service_events_1.buildRpcServiceEventProperties)({
+            chainId: payload.chainId,
+            endpointUrl: payload.endpointUrl,
+            error: payload.error,
+            isRpcEndpointUrlPublic: analytics.isRpcEndpointUrlPublic,
+            duration: payload.duration,
+            retryReason: payload.retryReason,
+            rpcMethodName: payload.rpcMethodName,
+            traceId: payload.traceId,
+            type: payload.type,
+        });
+        this.messenger.call('AnalyticsController:trackEvent', (0, rpc_service_events_1.toAnalyticsTrackingEvent)(name, properties));
+    }
+    catch (error) {
+        this.messenger.captureException?.(error);
+    }
+}, _NetworkController_updateRpcFailoverEnabled = function _NetworkController_updateRpcFailoverEnabled(newIsRpcFailoverEnabled) {
     if (__classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f") === newIsRpcFailoverEnabled) {
         return;
     }