chore: Refactor event tracking method

[NicolasMassart]

Description

• introduces a tracking event Builder to help dev on creation of complex events
• removes dependency to Segment SDK JsonMap by implementing our own
• updates to useMetrics hook
• deprecates legacy trackEvent function signature
• updates app/components/UI/NetworkModal/index.tsx file using the builder instead of trackEvent as an example
• updates unit tests that were checking for hook trackEvent params: the hook is now just a bypass and does no processing so metametrics trackEvent is called with same params.
• updates code doc

Note

These changes are made in order to preserve existing mechanisms in parallel.
This leads to strange naming like ITrackingEvent as the ideal IMetaMetricsEvent already exists.
This can be dealt with later as it's well documented and following guidelines.

Related issues

fixes #11319

Manual testing steps

NA

Screenshots/Recordings

NA

Before

NA

After

NA

Pre-merge author checklist

• I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

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.

[github-actions]

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.

[wachunei]

With @NicolasMassart we had a call and aligned on the API this Event Builder can have, here are some examples of the expected behavior:

// Event Builder interface
const eventBuilder = createEventBuilder(EVENT_NAME)
  .addProperties({ ...})
  .addSensitiveProperties({ ... })
  .addProperties({ ... }) // These can be added multiple times

if (condition) {
  eventBuilder.addProperties({ ... })
  eventBuilder.removeProperties(['prop1', 'prop2'])
  // or inline
  // eventBuilder.addProperties({ ... }).removeProperties(['prop1', 'prop2'])
}

const event = eventBuilder.build();

// Suggested way to track this event
// We pass the built event to the trackEvent function
trackEvent(event);

// or inline
trackEvent(createEventBuilder(EVENT).addProperties({ ... }).build());

// And backwards compatible (for now?? deprecate it in the future).
trackEvent({ name: EVENT, properties: { ... }, sensitiveProperties: { ... } });

// What if I want to modify an already built event?
// We can revert it to a Builder state if we create a new builder from the event
createEventBuilder(event).addProperties({ ... }).build();

// ———

// Another way (initial suggestion) was to have a track method in the event object
// THIS WILL NOT BE SUPPORTED
event.track();

If there's a use case we detect, in the future the builder can be extended to support new features, for example:

eventBuilder.makeSensitive(['prop1', 'prop2']);
eventBuilder.makeNonSensitive(['prop1', 'prop2']);

[github-actions]

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 0c964b4
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/1af5cc2e-b561-47bf-92ba-48c29006c5df

Note

• You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

• Check the documentation if you have any doubts on how to understand the failure on bitrise

[github-actions]

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 0aa75cf
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/866e6b89-6a57-47eb-9d66-d23e0677eb8d

Note

• You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
90.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 9b72ec5
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/e5319801-cf93-467d-8520-52f46c47c3be

Note

• You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

[gambinish]

LGTM! Thanks for those explanations.

Fyi I am not a codeowner on this, so looks like you'll still need to get that as well.

[wachunei]

Looks good to me