feat: Add RPC Method Middleware params transform and tracking #23236
Conversation
This file contains 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
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
jiexi
changed the title
…-params-transform-whitelist
…-params-transform-whitelist
…-params-transform-whitelist
…-params-transform-whitelist
…-params-transform-whitelist
…-params-transform-whitelist
Builds ready [5ca60dc]
Page Load Metrics (1417 ± 426 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
…-params-transform-whitelist
…-params-transform-whitelist
…-params-transform-whitelist
Builds ready [26c03a1]
Page Load Metrics (587 ± 400 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
…-params-transform-whitelist
…-params-transform-whitelist
Builds ready [8722c2b]
Page Load Metrics (1199 ± 599 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
…-params-transform-whitelist
Builds ready [20e5158]
Page Load Metrics (1252 ± 567 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #23236 +/- ##
========================================
Coverage 67.42% 67.42%
========================================
Files 1295 1295
Lines 50378 50383 +5
Branches 13047 13049 +2
========================================
+ Hits 33964 33969 +5
Misses 16414 16414 ☔ View full report in Codecov by Sentry. |
…-params-transform-whitelist
…-params-transform-whitelist
adonesky1
reviewed
May 20, 2024
…-params-transform-whitelist
Builds ready [1dd2e46]
Page Load Metrics (1281 ± 580 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
…-params-transform-whitelist
Builds ready [db630ed]
Page Load Metrics (520 ± 436 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
…-params-transform-whitelist
shanejonas
approved these changes
May 22, 2024
Builds ready [004e189]
Page Load Metrics (1546 ± 581 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
adonesky1
deleted the
jl/MMP-2167/analytics-tracking-rpc-method-params-transform-whitelist
branch
gauthierpetetin
added
the
release-12.0.0
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Currently we track a sample of most RPC method calls, but we do not include params. This is for good reason of course since many param values are sensitive and may identify an otherwise anonymous MetaMask Metrics user. There are some param values that are not sensitive yet are not tracked as well. Our goal is to glean additional insight into the usage of our RPC methods by including non-sensitive params in the events that track them.
This PR achieves that by including a map of method to transformation functions which accepts a request's params object (or array) and transforms it something that is acceptable for analytics. By default no params are included.
Related issues
Fixes: https://github.com/MetaMask/MetaMask-planning/issues/2167
Manual testing steps
createRPCMethodTrackingMiddleware.jswindow.ethereum.requestto make some rpc method callswallet_watchAssetshould include thetypeparam. All other methods should not include any params.NOTE: I recommend breakpoint and debugger over the network tab because I don't believe the tracking requests actually fire on dev.
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist