chore: refactor metametrics events

NicolasMassart commented 3 weeks ago

What is this about?

As MetaMetrics system evolved, we stacked multiple ways to define events. We even have a Legacy section in the events list. Even on the new events, there's multiple ways to track events because they are structured differently. This forced us to build "conversion" functions.

Scenario

No response

Design

No response

Technical Details

clarify the events and cleanup the list to align with extension (when possible as some events don't exist on both platforms) (see Segment tracking plan for Mobile)
get rid of legacy events
remove all legacy related code (conversion functions and tests)
Align mobile and extension metrics use
consider simplifying devs experience by having simpler function calls (see @wachunei comment https://github.com/MetaMask/metamask-mobile/pull/10545#issuecomment-2310285135)

Threat Modeling Framework

What are we working on?

event tracking cleanup and alignment with extension

What can go wrong?

too many events tracked (not enough cleanup)
not enough events tracked (too much cleanup)
data tracked when they should not be (privacy)
data analytics broken (dashboards and data store not updated accordingly)

What are we going to do about it?

sync with data team and PMs of each feature (ext and mobile)
clearly define the Segment tracking plan
write unit tests
review code and QA test all critical features

Did we do a good job?

so far yes, but we will do even better

Acceptance Criteria

events list clarified and simplified, consistent and cleaned our of legacy
all changes tested and test passes
events properly received and usable on the analytics side (Segment/Mixpanel)

Stakeholder review needed before the work gets merged

[X] Engineering (needed in most cases)
[ ] Design
[X] Product
[X] QA (automation tests are required to pass before merging PRs but not all changes are covered by automation tests - please review if QA is needed beyond automation tests)
[ ] Security
[ ] Legal
[ ] Marketing
[ ] Management (please specify)
[ ] Other (please specify)

References

No response

gauthierpetetin commented 2 weeks ago

Linking this ticket here as well, to make sure that we adopt a similar approach in Extension and Mobile, whatever we agree on. https://github.com/MetaMask/mobile-planning/issues/1898

NicolasMassart commented 2 weeks ago

Also related to https://github.com/MetaMask/mobile-planning/issues/1905 for aligning mobile and extension on this topic

MetaMask / metamask-mobile