feat: migrate all tracking calls to Segment by NicolasMassart · Pull Request #8387 · MetaMask/metamask-mobile

NicolasMassart · 2024-01-24T20:13:56Z

Description

Important

This PR will be split into smaller PRs. No way I ask you to review this many files at once.

This PR is migrating all analytics events tracking calls to new Segment MetaMetrics.

There's 3 cases:

File is a class component
File is a functional component
File is not a component

Common changes are:

remove InteractionManager.runAfterInteractions as it's handled in the hook now.
call trackAnonymousEvent where it was previously done by two calls
remove unused Analytics and trackEventV2 imports
update tests if needed

File is a class component

add prop
add withMetricsAwareness HOC
destructure this.props

import withMetricsAwareness from '../../hooks/useMetrics/withMetricsAwareness';
...
/**
 * Metrics injected by withMetricsAwareness HOC
 */
metrics: PropTypes.object,
...
const { metrics } = this.props;
metrics.trackEvent(
  MetaMetricsEvents.APPROVAL_STARTED,
  this.getAnalyticsParams(),
);

File is a functional component

import hook
destructure it in constants for each useful function (at least trackEvent usually)
add dependency to hooks (useEffect, useCallback, ...)

import { useMetrics } from '../../../../components/hooks/useMetrics';
...
const { trackEvent } = useMetrics();
...
trackEvent(MetaMetricsEvents.ACTIONS_BUTTON_CLICKED, {
  text: '',
  chain_id: chainId,
});

File is utils

use the class directly as you can't use hooks
make sure to pass a string for event name (add .category)

import { MetaMetrics, MetaMetricsEvents } from '../../core/Analytics';
...
MetaMetrics.getInstance().trackEvent(
  confirmation
    ? MetaMetricsEvents.SIGNATURE_APPROVED.category
    : MetaMetricsEvents.SIGNATURE_REJECTED.category,
  getAnalyticsParams(messageParams, signType, securityAlertResponse),
);

Related issues

Fixes: https://github.com/MetaMask/mobile-planning/issues/1461

Manual testing steps

test all features that can send an event and check they are actually sent and received on Segment debugger

Screenshots/Recordings

Before

No change with previous app behaviour

After

No change with previous app behaviour

Pre-merge author checklist

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

…proxy (Batch 2 of 4) (#7520) # What is the reason for the change? - Implement a new metrics system for the Segment SDK. - Make it work alongside the old one so that we can remove the old one progressively. # What is the improvement/solution? - Create a new class to handle metrics with segment - abstract all segment SDK calls - provide our own user and anonymous Ids for improved privacy - Reuse the Mixpanel user id it available, otherwise generates a new one with the same format - patch Segment SDK to allow the privacy aware user and anonymous Ids - No event sent at all if user haven't accepted to send metrics info - Total reset of the infos in case user asks to reset (in settings) - Ability to disable all metrics - Ability to ask for deletion of all data Fixes MetaMask/mobile-planning#1222

…4) (#7990) - Initialise MetaMetrics on app start without removing Analytics yet as we still uses it outside of onboarding - create a `trackAfterInteractions` utility function to reduce code when tracking events. - Replace calls to Analytics with calls to `trackAfterInteractions` in all components involved in onboarding screens (see [`OnboardingNav`](https://github.com/MetaMask/metamask-mobile/blob/feat%2F1275_segment_onboarding_impl/app/components/Nav/App/index.js#L122-L175) in `app/components/Nav/App/index.js`) - Fix onboarding events queue usage in `app/components/UI/OptinMetrics/index.js` - Update Opt-on/Opt-out in onboarding - Extract Analytics User profil properties in UserProfileMetaData util and inject it in MetaMetrics identify request alongside device metadata Fixes MetaMask/mobile-planning#1275

- rename Segment env vars: - `SEGMENT_WRITE_KEY` - `SEGMENT_PROXY_URL` - add env var placeholders in example file Fixes missing variables naming change in MetaMask/mobile-planning#1222

…k-mobile into feat/batch_1129_segment

# Conflicts: # app/components/Views/AccountBackupStep1/index.js # app/components/Views/AccountBackupStep1B/index.js # app/components/Views/ChoosePassword/index.js # app/components/Views/ManualBackupStep1/index.js # app/components/Views/ManualBackupStep2/index.js # app/components/Views/ManualBackupStep3/index.js

# Conflicts: # app/components/Views/Settings/SecuritySettings/SecuritySettings.tsx

# Conflicts: # yarn.lock

- adds `createDataDeletionTask` to `MetaMetrics` to call the deletion API in MetaMetrics class for method [create source regulation](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/createSourceRegulation) - adds the `checkDataDeletionTaskStatus` to `MetaMetrics` to call deletion API [get regulation method](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/getRegulation) - calls the `createDataDeletionTask` and `checkDataDeletionTaskStatus` from `DeleteMetaMetricsData.tsx` when user touches the delete button. - extract the settings section logic to display allow deletion to a well tested hook. - Remove `Analytics.js` implementation of these features and point only to the new `MetaMetrics` ones. - update unit tests - rename in `storage.js`: - `METAMETRICS_SEGMENT_REGULATION_ID` -> `METAMETRICS_DELETION_REGULATION_ID` Fixes MetaMask/mobile-planning#1403

# Conflicts: # ios/Podfile.lock

-adds error handling on async `DefaultPreference.get` and `DefaultPreference.set` - makes building instance stronger by using the Config type to prevent config mistakes completes MetaMask/mobile-planning#1403

github-actions · 2024-01-24T20:14:10Z

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.

# Conflicts: # yarn.lock

- make MetaMetrics.getInstance synchronous and add an async init function + readiness check - destructurable object hook return value to use metrics in components without having to use useRef and useEffect to set the instance - interface for the destructurable object - HOC (High Order Component) wrapper for class components - new and updated unit tests

remove trackAfterInteraction as now taken into account in the hook

and fix snapshot tests

NicolasMassart · 2024-02-28T13:32:44Z

Closed as this was reworked and split differently in smaller PRs for the migration

NicolasMassart and others added 22 commits December 6, 2023 11:14

Merge branch 'main' into feat/batch_1129_segment

886a8b1

Merge branch 'main' into feat/batch_1129_segment

e6dcad4

Merge branch 'main' into feat/batch_1129_segment

e457b27

fix: rename Segment env vars and add in example file (#8059)

92c5dc9

- rename Segment env vars: - `SEGMENT_WRITE_KEY` - `SEGMENT_PROXY_URL` - add env var placeholders in example file Fixes missing variables naming change in MetaMask/mobile-planning#1222

Merge branch 'main' into feat/batch_1129_segment

6cac642

Merge branch 'feat/batch_1129_segment' of github.com:MetaMask/metamas…

c2af79a

…k-mobile into feat/batch_1129_segment

Merge branch 'main' into feat/batch_1129_segment

265d1a9

Merge branch 'main' into feat/batch_1129_segment

e34d62e

Merge branch 'main' into feat/batch_1129_segment

b43425f

Merge branch 'main' into feat/batch_1129_segment

ad1022d

# Conflicts: # app/components/Views/Settings/SecuritySettings/SecuritySettings.tsx

Merge branch 'main' into feat/batch_1129_segment

da3f72d

Merge branch 'main' into feat/batch_1129_segment

054b3b6

Merge branch 'main' into feat/batch_1129_segment

df791dd

Merge branch 'main' into feat/batch_1129_segment

8e795c6

# Conflicts: # yarn.lock

Merge branch 'main' into feat/batch_1129_segment

88dfddd

Merge branch 'main' into feat/batch_1129_segment

f199acc

Merge branch 'main' into feat/batch_1129_segment

723ff5d

# Conflicts: # ios/Podfile.lock

feat: Segment instance error handling (#8218)

5e871ce

-adds error handling on async `DefaultPreference.get` and `DefaultPreference.set` - makes building instance stronger by using the Config type to prevent config mistakes completes MetaMask/mobile-planning#1403

NicolasMassart self-assigned this Jan 24, 2024

NicolasMassart added the team-mobile-client label Jan 24, 2024

NicolasMassart mentioned this pull request Jan 24, 2024

feat: use Segment (batch 1) #8067

Merged

13 tasks

NicolasMassart and others added 4 commits January 24, 2024 21:19

Merge branch 'main' into feat/batch_1129_segment

ad72be1

Merge branch 'main' into feat/batch_1129_segment

23b4675

# Conflicts: # yarn.lock

update lockfile

e2440c3

Merge branch 'main' into feat/batch_1129_segment

06a526e

gauthierpetetin added the team-mobile-platform Mobile Platform team label Jan 30, 2024

NicolasMassart and others added 2 commits February 2, 2024 12:32

Merge branch 'main' into feat/batch_1129_segment

99194b0

NicolasMassart closed this Feb 2, 2024

NicolasMassart force-pushed the 1461_migrate_all_track_events branch from ef6aa36 to 99194b0 Compare February 2, 2024 11:38

github-actions Bot locked and limited conversation to collaborators Feb 2, 2024

init metrics

9a5b189

NicolasMassart reopened this Feb 2, 2024

batch 1 + update HOC

4fff707

gauthierpetetin removed the team-mobile-client label Feb 2, 2024

NicolasMassart added 11 commits February 2, 2024 19:22

batch 2

7c75ca1

move trackErrors to it's own util func

9958782

remove trackAfterInteraction as now taken into account in the hook

update hook and export events form hook dep

b6b1ee5

type update

075cd20

restore delayed onboarding tracking func

754fdb7

batch 3

9d56bed

batch 4

875226a

batch 5

ab68739

and fix snapshot tests

add getMetaMetricsId function

4e36cf5

batch 6

145335f

and fix snapshot tests

fix test

ffe2355

NicolasMassart added the DO-NOT-MERGE Pull requests that should not be merged label Feb 16, 2024

Base automatically changed from feat/batch_1129_segment to main February 20, 2024 14:36

NicolasMassart added the blocked label Feb 26, 2024

NicolasMassart closed this Feb 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: migrate all tracking calls to Segment#8387

feat: migrate all tracking calls to Segment#8387
NicolasMassart wants to merge 41 commits into
mainfrom
1461_migrate_all_track_events

NicolasMassart commented Jan 24, 2024 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 24, 2024

Uh oh!

NicolasMassart commented Feb 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

NicolasMassart commented Jan 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

File is a class component

File is a functional component

File is utils

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions Bot commented Jan 24, 2024

Uh oh!

NicolasMassart commented Feb 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NicolasMassart commented Jan 24, 2024 •

edited

Loading