remove matomo and route to segment (MetaMask#9646)

Author: brad-decker

Diff for: app/scripts/lib/background-metametrics.js

@@ -25,6 +25,7 @@ import {
   PhishingController,
 } from '@metamask/controllers'
 import { getTrackMetaMetricsEvent } from '../../shared/modules/metametrics'
+import { getBackgroundMetaMetricState } from '../../ui/app/selectors'
 import ComposableObservableStore from './lib/ComposableObservableStore'
 import AccountTracker from './lib/account-tracker'
 import createLoggerMiddleware from './lib/createLoggerMiddleware'
@@ -56,8 +57,6 @@ import getRestrictedMethods from './controllers/permissions/restrictedMethods'
 import nodeify from './lib/nodeify'
 import accountImporter from './account-import-strategies'
 import seedPhraseVerifier from './lib/seed-phrase-verifier'
-
-import backgroundMetaMetricsEvent from './lib/background-metametrics'
 import { ENVIRONMENT_TYPE_BACKGROUND } from './lib/enums'
 
 export default class MetamaskController extends EventEmitter {
@@ -1893,19 +1892,18 @@ export default class MetamaskController extends EventEmitter {
     }
 
     const metamaskState = await this.getState()
-    const version = this.platform.getVersion()
-    backgroundMetaMetricsEvent(
-      metamaskState,
-      version,
-      {
-        customVariables,
-        eventOpts: {
-          action,
-          category: 'Background',
-          name,
-        },
+    const additionalProperties = getBackgroundMetaMetricState(metamaskState)
+
+    this.trackMetaMetricsEvent({
+      event: name,
+      category: 'Background',
+      matomoEvent: true,
+      properties: {
+        action,
+        ...additionalProperties,
+        ...customVariables,
       },
-    )
+    })
   }
 
   /**

Diff for: app/scripts/metamask-controller.js

@@ -18,6 +18,7 @@ const { makeStringTransform } = require('browserify-transform-tools')
 const conf = require('rc')('metamask', {
   INFURA_PROJECT_ID: process.env.INFURA_PROJECT_ID,
   SEGMENT_WRITE_KEY: process.env.SEGMENT_WRITE_KEY,
+  SEGMENT_LEGACY_WRITE_KEY: process.env.SEGMENT_LEGACY_WRITE_KEY,
 })
 
 const packageJSON = require('../../package.json')
@@ -324,6 +325,7 @@ function createScriptTasks ({ browserPlatforms, livereload }) {
     // inflating event volume.
     const SEGMENT_PROD_WRITE_KEY = opts.testing ? undefined : process.env.SEGMENT_PROD_WRITE_KEY
     const SEGMENT_DEV_WRITE_KEY = opts.testing ? undefined : conf.SEGMENT_WRITE_KEY
+    const SEGMENT_LEGACY_WRITE_KEY = opts.testing ? undefined : conf.SEGMENT_LEGACY_WRITE_KEY
 
     // Inject variables into bundle
     bundler.transform(envify({
@@ -343,6 +345,7 @@ function createScriptTasks ({ browserPlatforms, livereload }) {
           : conf.INFURA_PROJECT_ID
       ),
       SEGMENT_WRITE_KEY: environment === 'production' ? SEGMENT_PROD_WRITE_KEY : SEGMENT_DEV_WRITE_KEY,
+      SEGMENT_LEGACY_WRITE_KEY: environment === 'production' ? process.env.SEGMENT_LEGACY_WRITE_KEY : SEGMENT_LEGACY_WRITE_KEY,
     }), {
       global: true,
     })

Diff for: development/build/scripts.js

@@ -198,6 +198,7 @@
     "@storybook/storybook-deployer": "^2.8.6",
     "@testing-library/react": "^10.4.8",
     "@testing-library/react-hooks": "^3.2.1",
+    "@types/react": "^16.9.53",
     "addons-linter": "1.14.0",
     "babel-loader": "^8.0.6",
     "babelify": "^10.0.0",

Diff for: docs/creating-metrics-events.md

@@ -57,6 +57,10 @@ export const segment = process.env.SEGMENT_WRITE_KEY
   ? new Analytics(process.env.SEGMENT_WRITE_KEY, { flushAt })
   : segmentNoop
 
+export const segmentLegacy = process.env.SEGMENT_LEGACY_WRITE_KEY
+  ? new Analytics(process.env.SEGMENT_LEGACY_WRITE_KEY, { flushAt })
+  : segmentNoop
+
 /**
  * We attach context to every meta metrics event that help to qualify our analytics.
  * This type has all optional values because it represents a returned object from a
@@ -111,6 +115,12 @@ export const segment = process.env.SEGMENT_WRITE_KEY
  * @property {string}  [currency] - ISO 4127 format currency for events with revenue, defaults to US dollars
  * @property {number}  [value] - Abstract "value" that this event has for MetaMask.
  * @property {boolean} [excludeMetaMetricsId] - whether to exclude the user's metametrics id for anonymity
+ * @property {string}  [metaMetricsId] - an override for the metaMetricsId in the event one is created as part
+ *  of an asynchronous workflow, such as awaiting the result of the metametrics opt-in function that generates the
+ *  user's metametrics id.
+ * @property {boolean} [matomoEvent] - is this event a holdover from matomo that needs further migration?
+ *  when true, sends the data to a special segment source that marks the event data as not conforming to our
+ *  ideal schema
  * @property {MetaMetricsDynamicContext} [eventContext] - additional context to attach to event
  */
 
@@ -137,7 +147,9 @@ export function getTrackMetaMetricsEvent (
     revenue,
     currency,
     value,
+    metaMetricsId: metaMetricsIdOverride,
     excludeMetaMetricsId: excludeId,
+    matomoEvent = false,
     eventContext = {},
   }) {
     if (!event || !category) {
@@ -199,8 +211,20 @@ export function getTrackMetaMetricsEvent (
       context,
     }
 
+    // If we are tracking sensitive data we will always use the anonymousId property
+    // as well as our METAMETRICS_ANONYMOUS_ID. This prevents us from associating potentially
+    // identifiable information with a specific id. During the opt in flow we will track all
+    // events, but do so with the anonymous id. The one exception to that rule is after the
+    // user opts in to MetaMetrics. When that happens we receive back the user's new MetaMetrics
+    // id before it is fully persisted to state. To avoid a race condition we explicitly pass the
+    // new id to the track method. In that case we will track the opt in event to the user's id.
+    // In all other cases we use the metaMetricsId from state.
     if (excludeMetaMetricsId) {
       trackOptions.anonymousId = METAMETRICS_ANONYMOUS_ID
+    } else if (isOptIn && metaMetricsIdOverride) {
+      trackOptions.userId = metaMetricsIdOverride
+    } else if (isOptIn) {
+      trackOptions.anonymousId = METAMETRICS_ANONYMOUS_ID
     } else {
       trackOptions.userId = metaMetricsId
     }
@@ -210,12 +234,18 @@ export function getTrackMetaMetricsEvent (
       // If flushAt is greater than one the callback won't be triggered until after a number
       // of events have been queued equal to the flushAt value OR flushInterval passes. The
       // default flushInterval is ten seconds
-      segment.track(trackOptions, (err) => {
+      const callback = (err) => {
         if (err) {
           return reject(err)
         }
         return resolve()
-      })
+      }
+
+      if (matomoEvent === true) {
+        segmentLegacy.track(trackOptions, callback)
+      } else {
+        segment.track(trackOptions, callback)
+      }
     })
   }
 }

Diff for: package.json

@@ -1,4 +1,4 @@
-import React, { Component, createContext, useEffect, useCallback, useState } from 'react'
+import React, { Component, createContext, useEffect, useCallback, useState, useMemo } from 'react'
 import { useSelector } from 'react-redux'
 import PropTypes from 'prop-types'
 import { useHistory } from 'react-router-dom'
@@ -9,16 +9,15 @@ import {
   getAccountType,
   getNumberOfAccounts,
   getNumberOfTokens,
+  getCurrentChainId,
 } from '../selectors/selectors'
 import { getSendToken } from '../selectors/send'
 import {
   txDataSelector,
 } from '../selectors/confirm-transaction'
 import { getEnvironmentType } from '../../../app/scripts/lib/util'
-import {
-  sendMetaMetricsEvent,
-} from '../helpers/utils/metametrics.util'
-import { sendCountIsTrackable } from '../../../shared/modules/metametrics'
+import { getTrackMetaMetricsEvent } from '../../../shared/modules/metametrics'
+import { getCurrentLocale } from '../ducks/metamask/metamask'
 
 export const MetaMetricsContext = createContext(() => {
   captureException(
@@ -30,6 +29,8 @@ export function MetaMetricsProvider ({ children }) {
   const txData = useSelector(txDataSelector) || {}
   const network = useSelector(getCurrentNetworkId)
   const environmentType = getEnvironmentType()
+  const chainId = useSelector(getCurrentChainId)
+  const locale = useSelector(getCurrentLocale)
   const activeCurrency = useSelector(getSendToken)?.symbol
   const accountType = useSelector(getAccountType)
   const confirmTransactionOrigin = txData.origin
@@ -44,7 +45,7 @@ export function MetaMetricsProvider ({ children }) {
     previousPath: '',
   }))
 
-  const { previousPath, currentPath } = state
+  const { currentPath } = state
 
   useEffect(() => {
     const unlisten = history.listen(() => setState((prevState) => ({
@@ -55,45 +56,63 @@ export function MetaMetricsProvider ({ children }) {
     return unlisten
   }, [history])
 
+  /**
+   * track a metametrics event
+   *
+   * @param {import('../../../shared/modules/metametrics').MetaMetricsEventPayload} - payload for event
+   * @returns undefined
+   */
+  const trackEvent = useMemo(() => {
+    const referrer = confirmTransactionOrigin ? { url: confirmTransactionOrigin } : undefined
+    const page = {
+      path: currentPath,
+    }
+    return getTrackMetaMetricsEvent(global.platform.getVersion(), () => ({
+      context: {
+        referrer,
+        page,
+      },
+      environmentType,
+      locale: locale.replace('_', '-'),
+      network,
+      chainId,
+      participateInMetaMetrics,
+      metaMetricsId,
+      metaMetricsSendCount,
+    }))
+  }, [network, chainId, locale, environmentType, participateInMetaMetrics, currentPath, confirmTransactionOrigin, metaMetricsId, metaMetricsSendCount])
+
   const metricsEvent = useCallback((config = {}, overrides = {}) => {
     const { eventOpts = {} } = config
-    const { name = '' } = eventOpts
-    const { currentPath: overrideCurrentPath = '' } = overrides
-    const isSendFlow = Boolean(name.match(/^send|^confirm/u) || overrideCurrentPath.match(/send|confirm/u))
-
-    if (participateInMetaMetrics || config.isOptIn) {
-      return sendMetaMetricsEvent({
-        network,
-        environmentType,
-        activeCurrency,
-        accountType,
-        confirmTransactionOrigin,
-        metaMetricsId,
-        numberOfTokens,
-        numberOfAccounts,
-        version: global.platform.getVersion(),
-        ...config,
-        previousPath,
-        currentPath,
-        excludeMetaMetricsId: isSendFlow && !sendCountIsTrackable(metaMetricsSendCount + 1),
-        ...overrides,
-      })
-    }
 
-    return undefined
+    return trackEvent({
+      event: eventOpts.name,
+      category: eventOpts.category,
+      isOptIn: config.isOptIn,
+      excludeMetaMetricsId: eventOpts.excludeMetaMetricsId ?? overrides.excludeMetaMetricsId ?? false,
+      metaMetricsId: config.metaMetricsId,
+      matomoEvent: true,
+      properties: {
+        action: eventOpts.action,
+        number_of_tokens: numberOfTokens,
+        number_of_accounts: numberOfAccounts,
+        active_currency: activeCurrency,
+        account_type: accountType,
+        is_new_visit: config.is_new_visit,
+        // the properties coming from this key will not match our standards for
+        // snake_case on properties, and they may be redundant and/or not in the
+        // proper location (origin not as a referrer, for example). This is a temporary
+        // solution to not lose data, and the entire event system will be reworked in
+        // forthcoming PRs to deprecate the old Matomo events in favor of the new schema.
+        ...config.customVariables,
+      },
+    })
   }, [
-    network,
-    environmentType,
-    activeCurrency,
     accountType,
-    confirmTransactionOrigin,
-    participateInMetaMetrics,
-    previousPath,
-    metaMetricsId,
+    activeCurrency,
     numberOfTokens,
     numberOfAccounts,
-    currentPath,
-    metaMetricsSendCount,
+    trackEvent,
   ])
 
   return (