feat: Adding delete metametrics data to security and privacy tab #24571

NiranjanaBinoy · 2024-05-17T01:17:52Z

This PR is dependant on #24503

Description

Added a new functional component as an entry to the Security & Privacy tab with the Delete MetaMetrics Data button.
A new Delete MetaMetrics Data model will open when you click the button.
Clicking the Clear button in the modal will create a data deletion regulation, update the state, and close the modal, deactivating the Delete MetaMetrics Data button.
The Erroring on the Clear button click opens a new error modal.

Scenarios to disable the DeleteMetaMetrics button:

Metametrics ID not created / not available
Just performed a deletion independent on participate in metametrics toggle
Participate in metric opt-out & no data is recorded after deletion.
Status of current delete regulation as INITIALIZED, RUNNING, or FINISHED and (Participate in metric opt-out/no data recorded after deletion)

Related issues

Fixes #24406, #24407, https://github.com/MetaMask/MetaMask-planning/issues/2523

Manual testing steps

Perquisite:
Provide the following details in the .metamaskrc file:

ANALYTICS_DATA_DELETION_SOURCE_ID="wygFTooEUUtcckty9kaMc"
ANALYTICS_DATA_DELETION_ENDPOINT="https://proxy.dev-api.cx.metamask.io/segment/v1"

Make a build(yarn, yarn dist) against the code.
Load the extension in any browser.
Navigate to the "Security & privacy" in the Settings
Click on the "Delete MetaMetrics data" button which enables when the "Participate in MetaMetrics" is selected.
Validate the post request is made in the service worker with the id - wygFTooEUUtcckty9kaMc.

Screenshots/Recordings

Before

After

Pre-merge author checklist

I’ve followed MetaMask 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 · 2024-05-17T01:18:05Z

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.

Gudahtt · 2024-05-22T22:54:57Z

ui/components/app/clear-metametrics-data/ClearMetaMetricsData.tsx

+  JustifyContent,
+  TextVariant,
+} from '../../../helpers/constants/design-system';
+import { createMetaMetricsDataDeletionTask } from '../../../store/actions';


Perhaps this PR should stay in draft until the controller exists? As-is this is not mergable because this function does not exist.

codecov · 2024-07-03T20:02:33Z

Codecov Report

Attention: Patch coverage is 68.23529% with 27 lines in your changes missing coverage. Please review.

Project coverage is 70.19%. Comparing base (ba04af8) to head (cfd4a7c).

Files with missing lines	Patch %	Lines
ui/ducks/app/app.ts	12.50%	14 Missing ⚠️
.../clear-metametrics-data/clear-metametrics-data.tsx	53.85%	6 Missing ⚠️
...deletion-error-modal/data-deletion-error-modal.tsx	66.67%	2 Missing ⚠️
ui/helpers/constants/settings.js	33.33%	2 Missing ⚠️
...es/settings/security-tab/security-tab.container.js	0.00%	2 Missing ⚠️
...es/settings/security-tab/security-tab.component.js	66.67%	1 Missing ⚠️

Additional details and impacted files

@@                          Coverage Diff                           @@
##           delete-metametrics-data-controller   #24571      +/-   ##
======================================================================
- Coverage                               70.19%   70.19%   -0.00%     
======================================================================
  Files                                    1427     1430       +3     
  Lines                                   49745    49829      +84     
  Branches                                13921    13936      +15     
======================================================================
+ Hits                                    34916    34974      +58     
- Misses                                  14829    14855      +26

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

metamaskbot · 2024-07-03T20:13:53Z

Builds ready [39130bb]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (158 ± 192 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	59	134	93	23	11
		domContentLoaded	9	60	26	18	9
		load	40	1894	158	399	192
		domInteractive	9	60	26	18	9

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

background: 7.5 KiB (0.22%)
ui: 12.75 KiB (0.18%)
common: 3.66 KiB (0.06%)

app/_locales/en/messages.json

danjm · 2024-07-10T15:28:30Z

ui/components/app/clear-metametrics-data/clear-metametrics-data.tsx

+      } else {
+        await setHasMetaMetricsDataRecorded(false);
+      }
+    } catch (error: unknown) {


Should we also track an error event here? e.g. MetaMetricsEventName.MetricsDataDeletionRequestError

cc @gauthierpetetin

Hi @danjm ,

In Mobile, we've started to track expected errors as Analytics in order to reduce the noise in Sentry (which shall be kept for unexpected errors).
To achieve that we've introduced a generic Error occured event that we want to use for all our errors.

Do we have an equivalent generic event for errors in Extension?

If yes we could use it

If not, it might be a good occasion to introduce such an event in Extension as well, wdyt?

cc @worldlyjohn @Cal-L for visibility

@NiranjanaBinoy Can you add an 'Error Occured' metrics event, and then track that event here?

metamaskbot · 2024-09-18T21:28:45Z

Builds ready [f0083a1]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1931 ± 114 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	284	2268	1775	527	253
		domContentLoaded	1394	2197	1899	224	108
		load	1402	2271	1931	238	114
		domInteractive	14	181	49	36	17

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

background: 0 Bytes (0.00%)
ui: 12.47 KiB (0.17%)
common: 2.98 KiB (0.04%)

legobeat · 2024-09-19T05:44:26Z

privacy-snapshot.json

@@ -6,6 +6,7 @@
  "api.web3modal.com",
  "app.ens.domains",
  "arbitrum-mainnet.infura.io",
+  "authentication.api.cx.metamask.io",


Suggested change

"authentication.api.cx.metamask.io",

Duplicate (line 59)

legobeat · 2024-09-19T05:44:53Z

privacy-snapshot.json

  "min-api.cryptocompare.com",
  "nft.api.cx.metamask.io",
+  "oidc.api.cx.metamask.io",


Suggested change

"oidc.api.cx.metamask.io",

Duplicate

sonarcloud · 2024-09-19T05:53:15Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

metamaskbot · 2024-09-19T06:16:13Z

Builds ready [ce675f0]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1834 ± 110 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	313	2477	1766	402	193
		domContentLoaded	1454	2468	1807	226	109
		load	1462	2479	1834	230	110
		domInteractive	16	100	46	21	10

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

background: 0 Bytes (0.00%)
ui: 12.47 KiB (0.17%)
common: 2.98 KiB (0.04%)

danjm · 2024-09-19T09:13:20Z

app/_locales/en/messages.json

@@ -1547,6 +1547,29 @@
  "deleteContact": {


danjm · 2024-09-19T09:14:40Z

shared/constants/metametrics.ts

@@ -550,6 +550,7 @@ export enum MetaMetricsEventName {
  MarkAllNotificationsRead = 'Notifications Marked All as Read',


danjm · 2024-09-19T09:16:20Z

ui/helpers/constants/settings.js

@@ -324,6 +324,13 @@ const SETTINGS_CONSTANTS = [
    route: `${SECURITY_ROUTE}#dataCollectionForMarketing`,


danjm · 2024-09-19T09:16:25Z

ui/helpers/utils/settings-search.test.js

@@ -170,7 +170,7 @@ describe('Settings Search Utils', () => {
    it('returns "Security & privacy" section count', () => {


danjm · 2024-09-19T09:49:35Z

test/e2e/tests/metrics/delete-metametrics-data.spec.ts

+          selectors.deleteMetaMetricsDataButton,
+        );
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        await (deleteMetaMetricsDataButton as any).waitForElementState(


Let's find a way to not use any here. What is the type error that you saw that made it necessary to use any?

Same for the other cases

danjm · 2024-09-19T09:54:23Z

ui/components/app/clear-metametrics-data/clear-metametrics-data.test.tsx

+
+import ClearMetaMetricsData from './clear-metametrics-data';
+
+describe('ClearMetaMetricsData', () => {


Can we also add a unit test that checks if there is a button and that createMetaMetricsDataDeletionTask is called if the button is clicked?

danjm · 2024-09-19T09:55:37Z

ui/components/app/data-deletion-error-modal/data-deletion-error-modal.test.tsx

@@ -0,0 +1,21 @@
+import * as React from 'react';


Can we also add a unit test that checks if there is a button and that hideDataDeletionErrorModal is called if the button is clicked?

danjm · 2024-09-19T09:56:07Z

ui/components/app/data-deletion-error-modal/data-deletion-error-modal.tsx

@@ -0,0 +1,99 @@
+import React from 'react';


danjm · 2024-09-19T09:56:28Z

ui/ducks/app/app.ts

@@ -98,6 +98,8 @@ type AppState = {
  customTokenAmount: string;


danjm · 2024-09-19T09:56:40Z

ui/pages/settings/security-tab/__snapshots__/security-tab.test.js.snap

@@ -1818,6 +1818,59 @@ exports[`Security Tab should match snapshot 1`] = `
          </label>


danjm · 2024-09-19T09:57:17Z

...settings/security-tab/delete-metametrics-data-button/delete-metametrics-data-button.test.tsx

@@ -0,0 +1,207 @@
+import * as React from 'react';


danjm · 2024-09-19T09:57:55Z

...ages/settings/security-tab/delete-metametrics-data-button/delete-metametrics-data-button.tsx

+const DeleteMetaMetricsDataButton = ({
+  wrapperRef,
+}: {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any


Let's find a way to remove the use of any. What is the error you see that caused you use any?

danjm · 2024-09-19T09:58:34Z

ui/pages/settings/security-tab/security-tab.component.js

@@ -50,8 +50,10 @@ import {
 } from '../../../helpers/utils/settings-search';


danjm · 2024-09-19T09:58:45Z

ui/pages/settings/security-tab/security-tab.container.js

@@ -20,10 +20,12 @@ import {
  setUseExternalNameSources,


danjm · 2024-09-19T09:59:55Z

ui/pages/settings/security-tab/security-tab.test.js

@@ -11,6 +11,8 @@ import { renderWithProvider } from '../../../../test/lib/render-helpers';
 import { getIsSecurityAlertsEnabled } from '../../../selectors';


NiranjanaBinoy self-assigned this May 17, 2024

NiranjanaBinoy added team-extension-platform marketing-consent labels May 17, 2024

NiranjanaBinoy marked this pull request as ready for review May 22, 2024 21:33

NiranjanaBinoy requested a review from a team as a code owner May 22, 2024 21:33

Gudahtt reviewed May 22, 2024

View reviewed changes

legobeat marked this pull request as draft May 23, 2024 00:11

NiranjanaBinoy force-pushed the delete-metametrics-data-modal branch from cd7937d to 7660d88 Compare May 24, 2024 19:19

NiranjanaBinoy marked this pull request as ready for review June 1, 2024 04:06

NiranjanaBinoy marked this pull request as draft June 3, 2024 17:27

NiranjanaBinoy force-pushed the delete-metametrics-data-modal branch from 93ae0f6 to 1aa81db Compare June 13, 2024 21:34

NiranjanaBinoy changed the base branch from develop to delete-metametrics-data-controller June 26, 2024 14:50

NiranjanaBinoy changed the base branch from delete-metametrics-data-controller to develop June 26, 2024 14:50

NiranjanaBinoy force-pushed the delete-metametrics-data-modal branch from 586ac89 to cd4aba8 Compare June 26, 2024 15:11

NiranjanaBinoy changed the base branch from develop to delete-metametrics-data-controller June 26, 2024 15:11

NiranjanaBinoy force-pushed the delete-metametrics-data-modal branch 2 times, most recently from 1941496 to 6a4d150 Compare June 27, 2024 14:38

NiranjanaBinoy force-pushed the delete-metametrics-data-controller branch from cb4f42a to 429a444 Compare June 27, 2024 20:10

NiranjanaBinoy marked this pull request as ready for review July 3, 2024 20:54

NiranjanaBinoy requested a review from a team as a code owner July 3, 2024 20:54

NiranjanaBinoy force-pushed the delete-metametrics-data-controller branch from fc6b061 to e2509b6 Compare July 4, 2024 15:40

NiranjanaBinoy requested review from a team as code owners July 4, 2024 15:40

Gudahtt mentioned this pull request Jul 5, 2024

feat: Adding a new controller for Metametrics Data Deletion #24503

Merged

7 tasks

Gudahtt reviewed Jul 5, 2024

View reviewed changes

app/_locales/en/messages.json Show resolved Hide resolved

NiranjanaBinoy marked this pull request as draft July 5, 2024 18:54

danjm reviewed Jul 10, 2024

View reviewed changes

NiranjanaBinoy added 3 commits September 18, 2024 16:54

fixing settings search

09eb480

updates after rebaseing

eeb406f

updaing the DeleteRegulationStatus enum

f0083a1

NiranjanaBinoy force-pushed the delete-metametrics-data-modal branch from 27e64d1 to f0083a1 Compare September 18, 2024 20:54

legobeat reviewed Sep 19, 2024

View reviewed changes