feat: Adding a new controller for Metametrics Data Deletion #24503
+1,496
−70
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. |
NiranjanaBinoy
changed the title
Builds ready [614ccfd]
Page Load Metrics (880 ± 596 ms)
Bundle size diffs
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #24503 +/- ##
===========================================
+ Coverage 65.70% 65.78% +0.08%
===========================================
Files 1366 1368 +2
Lines 54361 54478 +117
Branches 14141 14162 +21
===========================================
+ Hits 35715 35838 +123
+ Misses 18646 18640 -6 ☔ View full report in Codecov by Sentry. |
NiranjanaBinoy
changed the title
Builds ready [d1cdd73]
Page Load Metrics (786 ± 599 ms)
Bundle size diffs
|
danjm
reviewed
May 16, 2024
| @@ -5085,6 +5086,42 @@ export function setName( | |||
| }) as any; | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Can you add a unit test for each of these?
danjm
reviewed
May 16, 2024
app/scripts/controllers/metametrics-data-deletion/metametrics-data-deletion.ts
Outdated
Show resolved
Hide resolved
danjm
reviewed
May 16, 2024
| @@ -0,0 +1,138 @@ | |||
| import { ObservableStore } from '@metamask/obs-store'; | |||
There was a problem hiding this comment.
We should add some unit tests for this file.
danjm
reviewed
May 16, 2024
| } | ||
|
|
||
| async createMetaMetricsDataDeletionTask(): Promise<DataDeletionResponse> { | ||
| const segmentSourceId = process.env.SEGMENT_DELETE_API_SOURCE_ID; |
There was a problem hiding this comment.
The definition of these constant variables can happen outside of this method and outside of the class. We don't need to re-define them every time the method is called.
danjm
reviewed
May 16, 2024
| ); | ||
|
|
||
| this.store.updateState({ | ||
| metaMetricsDataDeletionId: data?.data?.regulateId as string, |
There was a problem hiding this comment.
If data?.data?.regulateId is undefined, should we return an error?
There was a problem hiding this comment.
I believe the api will return a regulate ID if the request did not error. So I have made the type to just string than string | undefined, and initiated the state variable to empty string.
danjm
reviewed
May 16, 2024
| const { data } = await fetchDeletionRegulationStatus( | ||
| this.store.getState().metaMetricsDataDeletionId as string, | ||
| ); | ||
| const regulation = data?.data?.regulation as Record<string, string>; |
There was a problem hiding this comment.
If data?.data?.regulation is undefined, should we return an error?
There was a problem hiding this comment.
I believe the api will return a regulation if we have a valid Id, otherwise, it would probably error. I have added an empty check for deleteRegulateId to make sure we have a value before we call the api..
danjm
reviewed
May 16, 2024
| const segmentSourceId = process.env.SEGMENT_DELETE_API_SOURCE_ID; | ||
| const segmentRegulationEndpoint = process.env.SEGMENT_REGULATIONS_ENDPOINT; | ||
|
|
||
| if (!segmentSourceId || !segmentRegulationEndpoint) { |
There was a problem hiding this comment.
Maybe this validation is unneeded here, and can just happen within the services?
danjm
reviewed
May 16, 2024
| ); | ||
| return response as DeleteRegulationAPIResponse; | ||
| } catch (error: unknown) { | ||
| throw new Error('Analytics Deletion Task Error'); |
There was a problem hiding this comment.
Any reason not to throw the error object received in the catch?
There was a problem hiding this comment.
Removed the try-catch in the service class, and it is being handled in the controller.
danjm
reviewed
May 16, 2024
| const segmentRegulationEndpoint = process.env.SEGMENT_REGULATIONS_ENDPOINT; | ||
|
|
||
| try { | ||
| const response: unknown = await fetchWithTimeout( |
There was a problem hiding this comment.
I wonder if we can type the response in a way other that unknown 🤔
There was a problem hiding this comment.
The type was explicitly mentioned as it is erroring while converting the Response type returned from fetchWithTimeout to DeleteRegulationAPIResponse. We can also typecast while returning the response like this response as unknown as DeleteRegulationAPIResponse
danjm
requested changes
May 16, 2024
Gudahtt
reviewed
May 21, 2024
.metamaskrc.dist
Outdated
| @@ -6,6 +6,8 @@ INFURA_PROJECT_ID=00000000000 | |||
|
|
|||
| ;PASSWORD=METAMASK PASSWORD | |||
| ;SEGMENT_WRITE_KEY= | |||
| ;SEGMENT_DELETE_API_SOURCE_ID= | |||
There was a problem hiding this comment.
Could you clarify what these environment variables are?
It was my understanding that we're using our own API for this, not using Segment directly. Our API will also be requesting deletion from more than just Segment. If that's the case, making these environment variables named SEGMENT_ seems inaccurate
Gudahtt
reviewed
May 21, 2024
app/scripts/controllers/metametrics-data-deletion/metametrics-data-deletion.ts
Outdated
Show resolved
Hide resolved
Gudahtt
reviewed
May 21, 2024
app/scripts/controllers/metametrics-data-deletion/metametrics-data-deletion.ts
Outdated
Show resolved
Hide resolved
Gudahtt
reviewed
May 21, 2024
| data: RegulationId | CurrentRegulationStatus; | ||
| }; | ||
|
|
||
| export enum DeleteRegulationStatus { |
There was a problem hiding this comment.
Are there API docs somewhere that can explain what status exist, and what they mean?
There was a problem hiding this comment.
The existing statuses are mentioned here:
https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/listRegulationsFromSource
There was a problem hiding this comment.
Could you update the comment to reference these docs?
Gudahtt
reviewed
May 21, 2024
| fetchDeletionRegulationStatus, | ||
| } from './services/services'; | ||
|
|
||
| export type DataDeleteDate = string; |
There was a problem hiding this comment.
Nit: Ideally each type would have a TSDoc block that explains what the type is for. This is especially useful because the descriptions show up in Intellisense tooltips in supporting editors such as VSCode
NiranjanaBinoy
force-pushed
the
delete-metametrics-data-controller
branch
from
00838c9
to
b540dfc
Compare
7 tasks
Gudahtt
added a commit
that referenced
this pull request
May 27, 2024
The `nock` library is not compatible with the fake timers we use in unit tests because it uses the Node.js `timers` API. This API is not mocked correctly by the version of Jest we are using. Jest uses `@sinon/fake-timers` internally, which didn't support mocking the Node.js `timers` API until v11.0.0 (see sinonjs/fake-timers#467) This package is updated in Jest as part of the v30 release, which is currently under development. To workaround this problem in the meantime, the `nock` package has been updated and patched to use global timers rather than the `timers` API. Global timers are mocked correctly. This was required for some unit tests that I will be submitting in a different PR, intended for #24503
This was referenced May 27, 2024
Gudahtt
added a commit
that referenced
this pull request
May 28, 2024
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** The `nock` library is not compatible with the fake timers we use in unit tests because it uses the Node.js `timers` API. This API is not mocked correctly by the version of Jest we are using. Jest uses `@sinon/fake-timers` internally, which didn't support mocking the Node.js `timers` API until v11.0.0 (see sinonjs/fake-timers#467) This package is updated in Jest as part of the v30 release, which is currently under development. To workaround this problem in the meantime, the `nock` package has been updated and patched to use global timers rather than the `timers` API. Global timers are mocked correctly. [](https://codespaces.new/MetaMask/metamask-extension/pull/24805?quickstart=1) ## **Related issues** This was required for some unit tests that I will be submitting in a different PR, intended for #24503 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.
](https://codespaces.new/MetaMask/metamask-extension/pull/24805?quickstart=1){kind=link}
7 tasks
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** The `circuitBreakDuration`, `degradedThreshold`, and `timeout` are now configurable for the `DataDeletionService`. This configuration is relied upon in the unit tests, to be added in a later PR. [](https://codespaces.new/MetaMask/metamask-extension/pull/24806?quickstart=1) ## **Related issues** This is an improvement for the PR #24503 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.
](https://codespaces.new/MetaMask/metamask-extension/pull/24806?quickstart=1){kind=link}
7 tasks
Builds ready [3ef9147]
Page Load Metrics (945 ± 578 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** The `DataDeletionService` has been moved to a `services` directory, independent of controllers. This was done to reinforce that services are independent of controllers, and can be used outside of them. [](https://codespaces.new/MetaMask/metamask-extension/pull/24863?quickstart=1) ## **Related issues** This is an improvement for the PR #24503 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.
](https://codespaces.new/MetaMask/metamask-extension/pull/24863?quickstart=1){kind=link}
Gudahtt
added a commit
that referenced
this pull request
May 29, 2024
The `DataDeletionController` has been decoupled from the `MetaMetricsController` by updating the constructor parameters to expect just a function for getting the MetaMetrics ID, rather than the entire `MetaMetricsController` state. This vastly simplifies the API surface, making it easier to audit and test. It also prevents the `DataDeletionController` from having the capability to make changes to the `MetaMetricsController` state. This is an improvement for #24503
7 tasks
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** The `DataDeletionController` has been decoupled from the `MetaMetricsController` by updating the constructor parameters to expect just a function for getting the MetaMetrics ID, rather than the entire `MetaMetricsController` state. This vastly simplifies the API surface, making it easier to audit and test. It also prevents the `DataDeletionController` from having the capability to make changes to the `MetaMetricsController` state. [](https://codespaces.new/MetaMask/metamask-extension/pull/24870?quickstart=1) ## **Related issues** This is an improvement for #24503 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.
](https://codespaces.new/MetaMask/metamask-extension/pull/24870?quickstart=1){kind=link}
7 tasks
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** A single test has been added, along with a helper setup function that is designed to be used for further unit tests as well. [](https://codespaces.new/MetaMask/metamask-extension/pull/24879?quickstart=1) ## **Related issues** This is an improvement for the PR #24503 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.
](https://codespaces.new/MetaMask/metamask-extension/pull/24879?quickstart=1){kind=link}
Builds ready [4a07c1a]
Page Load Metrics (119 ± 139 ms)
|
7 tasks
## **Description** Add unit tests for the `createDataDeletionRegulationTask` method of `DataDeletionService`. One of the two service methods is now fully tested. The remaining method will be tested in a later PR. [](https://codespaces.new/MetaMask/metamask-extension/pull/24816?quickstart=1) ## **Related issues** This is an improvement for the PR #24503 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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. --------- Co-authored-by: Niranjana Binoy <[email protected]>
](https://codespaces.new/MetaMask/metamask-extension/pull/24816?quickstart=1){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
We are adding a new controller,
MetaMetricsDataDeletionController,and a service class for MetaMetrics data deletion. The service class will have the API interaction for the data deletion, which will create the data deletion regulation and check the status of an existing relation. The controller handles the state update and service class interactions.The PR also initiates the controller by updating the metamask-controller and updating actions.ts with the new functions.
Related issues
Fixes:
fixes #24405
Manual testing steps
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist