feat(network-controller): emit RPC service analytics via AnalyticsController#9270
Draft
cryptodev-2s wants to merge 7 commits into
Draft
feat(network-controller): emit RPC service analytics via AnalyticsController#9270cryptodev-2s wants to merge 7 commits into
cryptodev-2s wants to merge 7 commits into
Conversation
…troller NetworkController now emits "RPC Service Unavailable" and "RPC Service Degraded" analytics events itself through the AnalyticsController:trackEvent action, instead of relying on each client app to translate its rpcEndpointUnavailable/rpcEndpointDegraded events into MetaMetrics. The feature is opt in via a new optional `analytics` constructor option. When omitted, no analytics are emitted and AnalyticsController is never called. The two client specific pieces stay injected because core cannot know them: `isRpcEndpointUrlPublic` (depends on the client network lists) and `rpcServiceEventsSampleRate` (depends on the build environment). The generic property building, event naming, connection error skipping and delivery now live in core (src/rpc-service-events.ts), so both clients can drop their duplicated handlers in follow up PRs.
cryptodev-2s
temporarily deployed
to
default-branch
GitHub Actions
Inactive
The build tsconfig flagged passing the `unknown` catch variable to `captureException`, which expects an `Error`. Cast it, matching the other captureException call sites. Also regenerate the root README dependency graph to include the new analytics-controller edge.
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
Draft
7 tasks
cryptodev-2s
temporarily deployed
to
default-branch
GitHub Actions
Inactive
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
Today
NetworkControlleremits no analytics. It publishesrpcEndpointUnavailableandrpcEndpointDegradedevents, and each client app independently subscribes to them and turns them into theRPC Service Unavailable/RPC Service DegradedSegment events. The extension still routes those throughMetaMetricsController; mobile already routes them throughAnalyticsController. The handlers are near identical duplication across both repos.This moves that translation into
NetworkControllerso it is written once and delivered through theAnalyticsController:trackEventaction over the messenger (which is the whole reasonAnalyticsControllerexists). Clients can then delete their duplicated handlers and just wire the new option.The feature is fully opt in via a new optional
analyticsconstructor option. When omitted, no analytics are emitted andAnalyticsControlleris never called, so existing consumers are unaffected. The two genuinely client specific pieces are injected because core cannot know them:isRpcEndpointUrlPublic(url): whether an endpoint URL is safe to report verbatim (depends on the client network lists, Quicknode URLs, Infura key)rpcServiceEventsSampleRate: the proportion of events to emit (depends on the build environment, typically 1% in production and 100% in dev)Core reads
analyticsIdviaAnalyticsController:getState, applies the sample rate withgenerateDeterministicRandomNumber, skips local connection errors, builds the properties, and delivers the event.AnalyticsControllerkeeps owning consent gating.What changed
src/rpc-service-events.ts: pure helpers (sanitizeRpcEndpointUrl,buildRpcServiceEventProperties,toAnalyticsTrackingEvent) plus theNetworkControllerAnalyticsOptionsandRpcServiceEventNametypessrc/NetworkController.ts: new optionalanalyticsoption, widenedAllowedActionswithAnalyticsController:getState+AnalyticsController:trackEvent, two guarded self subscriptions, and a private#trackRpcServiceEvent@metamask/analytics-controllerdependency and tsconfig references (no dependency cycle)index.ts,tests/helpers.ts,CHANGELOG.md, and a newtests/NetworkController.analytics.test.tsOpen question
AnalyticsTrackingEventhas nocategoryfield, so the oldcategory: 'Network'is not carried for now. Confirming with the analytics owners how they want category mapped before relying on it downstream.Follow ups (separate repos)
messenger-action-handlers.ts+utils.ts, pass theanalyticsoption, delegate the two AnalyticsController actions. This is where the extension stops usingMetaMetricsControllerfor these events.References
N/A
Checklist
Note
Medium Risk
Opt-in analytics wiring touches the network controller messenger contract (breaking for adopters) and emits RPC endpoint metadata, though private URLs are redacted and consent still flows through AnalyticsController.
Overview
NetworkControllergains an opt-inanalyticsconstructor option. When set, it listens to existingrpcEndpointUnavailableandrpcEndpointDegradedevents and emitsRPC Service Unavailable/RPC Service DegradedthroughAnalyticsController:trackEvent, with URL sanitization, deterministic sampling, and skips for local connection errors and missinganalyticsId.A new
rpc-service-eventsmodule holds property builders and exportedNetworkControllerAnalyticsOptions/RpcServiceEventNametypes. The package adds@metamask/analytics-controllerand documents a breaking requirement: messengers must delegateAnalyticsController:getStateandAnalyticsController:trackEventwhen usinganalytics. Omitting the option leaves behavior unchanged.Reviewed by Cursor Bugbot for commit e0ee14d. Bugbot is set up for automated code reviews on this repo. Configure here.