fix: Ensure has_marketing_consent user trait are correctly set and sent after participateInMetaMetrics is set to true

[danjm]

Description

It was observed in production metrics that the has_marketing_consent user trait was not set (either null or undefined) for 40-50% of users. Meanwhile, another ~40% of users had it set to false, and the remainder had it set to true.

The problem was in the metametrics controller. The controller sets state.previousUserTraits in the _buildUserTraitsObject function, which gets called when there are state updates. That function also uses state.previousUserTraits to determine which values need to be returned, by comparing it to the new currentTraits.

The problem is that if a trait is set while participateInMetaMetrics is false, then the trait will not be sent in a request to Segment, BUT the trait will be saved in state.previousUserTraits. Later, if participateInMetaMetrics is set to true, _buildUserTraitsObject will not return a trait currently matches state.previousUserTraits

The has_marketing_consent trait is set to true when the user checks the associated checkbox on the metametrics screen of the onboarding flow, but then if the user clicks confirm/yes on that screen to opt-in to metametrics, the aforementioned problem is hit.

To solve this, we just ensure that state.previousUserTraits is not saved if participateInMetaMetrics is false.

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3932

Manual testing steps

1. Install a build from this branch
2. Open the background console and the network tab
3. Start onboarding. On the metametrics screen, click the checkbox and then "I agree"
4. The network tab should now include a request to segment with user traits, where has_marketing_consent is set to true

--

1. Follow the above steps on the v12.9.3 build (step 4 will fail)
2. Update the version of that install to the build from this branch
3. Log in.
4. The network tab should now include a request to segment with user traits, where has_marketing_consent is set to true

--

1. Install a build from this branch
2. Open the background console and the network tab
3. Start onboarding. On the metametrics screen, DO NOT click the checkbox and then click "No thanks"
4. The network tab should not include a request to segment
5. Complete onboarding and go to settings and toggle "Participate in MetaMetrics" to true
6. The network tab tab should now include a request to segment with user traits, where has_marketing_consent is set to false. If the marketing consent toggle is turned on, there should then be a network request where the user trait is true

Important

This requires manual test from QA.

• Create a new user and click both "I agree" and "we'll use this data... " when user is on "help us improve Metamask" page
• There should be 1 request to segment with user traits, where both has_marketing_consent and participate_in_metametrics set to true.
• Proceed on onboarding
• Head to privacy page in settings
• Opt out "participate in metametrics"
• There's no more request to segment after

Screenshots/Recordings

Copy.text.Untitled.Project.mp4

Pre-merge author checklist

• I've followed MetaMask Contributor Docs and MetaMask Extension 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.

[metamaskbot]

Builds ready [a7887e3]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1721 ± 86 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1492	2010	1722	176	84
		domContentLoaded	1476	1994	1698	175	84
		load	1488	2017	1721	179	86
		domInteractive	24	69	39	13	6
		backgroundConnect	8	66	22	13	6
		firstReactRender	15	76	38	23	11
		getState	5	58	18	19	9
		initialActions	0	1	0	0	0
		loadScripts	1028	1506	1247	146	70
		setupStore	5	56	12	14	7
		uiStartup	1667	2296	1975	201	96

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 56 Bytes (0.00%)
• ui: 0 Bytes (0.00%)
• common: 0 Bytes (0.00%)

[metamaskbot]

Builds ready [2d5dd49]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1794 ± 71 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1531	2147	1790	148	71
		domContentLoaded	1519	2055	1763	137	66
		load	1531	2148	1794	149	71
		domInteractive	25	142	42	28	13
		backgroundConnect	10	86	30	22	10
		firstReactRender	16	100	45	27	13
		getState	4	96	19	25	12
		initialActions	0	1	0	0	0
		loadScripts	1069	1517	1284	118	57
		setupStore	8	84	30	25	12
		uiStartup	1757	2887	2089	257	123

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 56 Bytes (0.00%)
• ui: 102 Bytes (0.00%)
• common: 0 Bytes (0.00%)

[metamaskbot]

Builds ready [a4a3cb0]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1847 ± 94 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	403	2439	1777	377	181
		domContentLoaded	1580	2338	1824	186	89
		load	1585	2354	1847	196	94
		domInteractive	25	103	56	28	13
		backgroundConnect	9	81	25	21	10
		firstReactRender	19	96	51	24	12
		getState	4	78	25	26	12
		initialActions	0	1	0	0	0
		loadScripts	1144	1827	1344	168	81
		setupStore	8	89	17	20	10
		uiStartup	1839	2699	2190	257	124

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 56 Bytes (0.00%)
• ui: 102 Bytes (0.00%)
• common: 0 Bytes (0.00%)

[metamaskbot]

Builds ready [e7f67d5]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1749 ± 97 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	422	2240	1687	355	170
		domContentLoaded	1426	2207	1712	204	98
		load	1487	2240	1749	203	97
		domInteractive	25	92	42	21	10
		backgroundConnect	10	65	38	21	10
		firstReactRender	16	96	38	27	13
		getState	6	54	15	15	7
		initialActions	0	1	0	0	0
		loadScripts	1003	1711	1244	165	79
		setupStore	8	54	14	13	6
		uiStartup	1728	2558	2011	235	113

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 56 Bytes (0.00%)
• ui: 102 Bytes (0.00%)
• common: 0 Bytes (0.00%)

[metamaskbot]

Builds ready [95087c2]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
  • ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1497 ± 49 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1357	1756	1498	103	49
		domContentLoaded	1348	1667	1476	92	44
		load	1356	1725	1497	102	49
		domInteractive	22	72	28	11	5
		backgroundConnect	8	64	20	18	8
		firstReactRender	14	97	25	22	10
		getState	3	71	15	19	9
		initialActions	0	1	0	0	0
		loadScripts	920	1241	1043	85	41
		setupStore	6	52	16	16	7
		uiStartup	1512	2218	1705	158	76

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 56 Bytes (0.00%)
• ui: 102 Bytes (0.00%)
• common: 0 Bytes (0.00%)

[chloeYue]

QA manual testing passed !