Skip to content

Add web3 usage metrics, prepare for web3 removal#9144

Merged
rekmarks merged 3 commits intodevelopfrom
web3-deprecation-metrics
Aug 7, 2020
Merged

Add web3 usage metrics, prepare for web3 removal#9144
rekmarks merged 3 commits intodevelopfrom
web3-deprecation-metrics

Conversation

@rekmarks
Copy link
Copy Markdown
Member

@rekmarks rekmarks commented Aug 6, 2020 •
edited
Loading

This PR adds window.web3 usage metrics for users that opted in to metrics. It also consolidates some web3-related functionality, and adds a method and a middleware to perform the metrics-sending work.

  • Add window.web3 usage metrics via new RPC method: metamask_logInjectedWeb3Usage
  • Send window.web3 usage metrics on window.web3 property access and assignment, via proxy handlers
  • Consolidate inpage web3-related code into auto-reload.js; rename file to setupWeb3.js
  • Create new, top-level RPC method middleware for the metamask_logInjectedWeb3Usage implementation
  • Create new, top-level metamask-controller method for sending backend metrics
    • For great DRYness
  • Rename permissions controller methodMiddleware.js to permissionsMethodMiddleware.js to distinguish from new top-level methodMiddleware

@rekmarks rekmarks force-pushed the web3-deprecation-metrics branch from 71ccb60 to 44298af Compare August 6, 2020 20:23
rekmarks
rekmarks commented Aug 6, 2020
View reviewed changes
@rekmarks rekmarks changed the title Add web3 usage metrics Add web3 usage metrics, prepare for web3 removal Aug 6, 2020
@rekmarks rekmarks marked this pull request as ready for review August 6, 2020 20:36
@rekmarks rekmarks requested a review from a team as a code owner August 6, 2020 20:36
@rekmarks rekmarks requested a review from whymarrh August 6, 2020 20:36
@metamaskbot
Copy link
Copy Markdown
Collaborator

metamaskbot commented Aug 6, 2020

Builds ready [44298af]
Page Load Metrics (605 ± 18 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint28433542
domContentLoaded5577196033718
load5587206053718
domInteractive5577196033718

Gudahtt
Gudahtt reviewed Aug 7, 2020
View reviewed changes
@rekmarks rekmarks force-pushed the web3-deprecation-metrics branch from 44298af to 9c64bb4 Compare August 7, 2020 18:16
rekmarks added 2 commits August 7, 2020 11:36
@rekmarks
add web3 usage metrics
a922219 
* move web3 metrics method to new middleware
@rekmarks
backend -> background
004adc8
@rekmarks rekmarks force-pushed the web3-deprecation-metrics branch from 7a68f35 to 004adc8 Compare August 7, 2020 18:38
rekmarks
rekmarks commented Aug 7, 2020
View reviewed changes
app/scripts/controllers/permissions/permissionsMethodMiddleware.js
* Create middleware for handling certain methods and preprocessing permissions requests.
*/
export default function createMethodMiddleware ({
export default function createPermissionsMethodMiddleware ({
Copy link
Copy Markdown
Member Author

@rekmarks rekmarks Aug 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file and all references to its export were renamed to disambiguate it from the new top-level methodMiddleware.

Gudahtt
Gudahtt reviewed Aug 7, 2020
View reviewed changes
@rekmarks rekmarks force-pushed the web3-deprecation-metrics branch from 14f6452 to 70b50a0 Compare August 7, 2020 19:03
@rekmarks rekmarks requested a review from Gudahtt August 7, 2020 19:04
Gudahtt
Gudahtt reviewed Aug 7, 2020
View reviewed changes
app/scripts/lib/setupWeb3.js
import 'web3/dist/web3.min.js'

const shouldLogUsage = !([
'docs.metamask.io',
Copy link
Copy Markdown
Member

@Gudahtt Gudahtt Aug 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting - are these sites using web3?

Copy link
Copy Markdown
Member

@Gudahtt Gudahtt Aug 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right, the test dapp definitely is. For the others, it might be useful to know if they're using the injected web3 instance though. That would be something we should fix.

Copy link
Copy Markdown
Member Author

@rekmarks rekmarks Aug 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I swear to verify this manually 😄

Gudahtt
Gudahtt approved these changes Aug 7, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Though I did have one outstanding suggestion, of relatively low importance.

@rekmarks rekmarks merged commit e5cb63e into develop Aug 7, 2020
@rekmarks rekmarks deleted the web3-deprecation-metrics branch August 7, 2020 19:28
@metamaskbot
Copy link
Copy Markdown
Collaborator

metamaskbot commented Aug 7, 2020

Builds ready [70b50a0]
Page Load Metrics (677 ± 48 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint31105502210
domContentLoaded32582467610148
load32982667710048
domInteractive32582467510148

Gudahtt pushed a commit that referenced this pull request Aug 7, 2020
@rekmarks @Gudahtt
Add web3 usage metrics, prepare for web3 removal (#9144)
500dbf7 
* add web3 usage metrics

* move web3 metrics method to new middleware

* rename some methods, files, and exports
@Gudahtt Gudahtt mentioned this pull request Aug 7, 2020
Merged
@metamaskbot metamaskbot mentioned this pull request Aug 7, 2020
Merged
Gudahtt added a commit that referenced this pull request Aug 10, 2020
@Gudahtt
Merge remote-tracking branch 'origin/master' into sync-master
3d9b545 
* origin/master: (44 commits)
  Add category in eventOpts (#9164)
  Update changelog for v8.0.7 (#9161)
  Version v8.0.7
  Remove web3 e2e tests (#9159)
  Add web3 usage metrics, prepare for web3 removal (#9144)
  Use `pathname` instead of URL for `currentPath` metrics parameter (#9158)
  Remove `url` parameter from `metricsEvent` (#9157)
  Change MetaMetrics category for background events (#9155)
  remove .network-name height
  Use luxon@1.24.1 (#9154)
  Update 'react-devtools' to ^4.8.0 (#9140)
  Fix connection removal bug (#9137)
  Add source map validator to CI (#9135)
  Update source map validator target files (#9133)
  Improve sourcemap validator console report (#9131)
  Add `validate-source-maps` npm script (#9134)
  Non-zero exit code upon failure to validate source maps (#9132)
  Update `brfs` from v1.6.1 to v2.0.2 (#9115)
  Factor out `getEnvironment` function in build script (#9114)
  Update `browserify` from v16.2.3 to v16.5.1 (#9113)
  ...
Gudahtt added a commit that referenced this pull request Aug 18, 2020
@Gudahtt
Handle non-String web3 property access
7ff6754 
The web3 usage metrics added in #9144 assumed that all web3 properties
were strings. When a `Symbol` property is accessed, our `inpage.js`
script crashes because the `Symbol` cannot be serialized correctly.

A check has been added for non-string property access. The metric event
in these cases is set to the string "typeof ", followed by the type of
the key. (e.g. `typeof symbol` for a `Symbol` property).

Fixes #9234
@Gudahtt Gudahtt mentioned this pull request Aug 18, 2020
Merged
Gudahtt added a commit that referenced this pull request Aug 18, 2020
@Gudahtt
Handle non-String web3 property access
8197349 
The web3 usage metrics added in #9144 assumed that all web3 properties
were strings. When a `Symbol` property is accessed, our `inpage.js`
script crashes because the `Symbol` cannot be serialized correctly.

A check has been added for non-string property access. The metric event
in these cases is set to the string "typeof ", followed by the type of
the key. (e.g. `typeof symbol` for a `Symbol` property).

Fixes #9234
Gudahtt added a commit that referenced this pull request Aug 18, 2020
@Gudahtt
Handle non-String web3 property access (#9256)
27e1189 
The web3 usage metrics added in #9144 assumed that all web3 properties
were strings. When a `Symbol` property is accessed, our `inpage.js`
script crashes because the `Symbol` cannot be serialized correctly.

A check has been added for non-string property access. The metric event
in these cases is set to the string "typeof ", followed by the type of
the key. (e.g. `typeof symbol` for a `Symbol` property).

Fixes #9234
Gudahtt added a commit that referenced this pull request Aug 19, 2020
@Gudahtt
Handle non-String web3 property access (#9256)
de35475 
The web3 usage metrics added in #9144 assumed that all web3 properties
were strings. When a `Symbol` property is accessed, our `inpage.js`
script crashes because the `Symbol` cannot be serialized correctly.

A check has been added for non-string property access. The metric event
in these cases is set to the string "typeof ", followed by the type of
the key. (e.g. `typeof symbol` for a `Symbol` property).

Fixes #9234
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Gudahtt Gudahtt Gudahtt approved these changes

@whymarrh whymarrh Awaiting requested review from whymarrh

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rekmarks @metamaskbot @Gudahtt