-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add retry policy to the data deletion service
The data deletion service now uses a retry policy. It has been refactored into a class so that the retry state may be stored as an instance variable. The service is now injected as well, rather than imported, to keep it decoupled from the controller and make testing easier.
- Loading branch information
Showing
5 changed files
with
210 additions
and
39 deletions.
There are no files selected for viewing
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
223 changes: 190 additions & 33 deletions
223
app/scripts/controllers/metametrics-data-deletion/services/services.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,204 @@ | ||
| import { hasProperty, isObject } from '@metamask/utils'; | ||
| import { | ||
| circuitBreaker, | ||
| ConsecutiveBreaker, | ||
| ExponentialBackoff, | ||
| handleAll, | ||
| type IPolicy, | ||
| retry, | ||
| wrap, | ||
| CircuitState, | ||
| } from 'cockatiel'; | ||
| import getFetchWithTimeout from '../../../../../shared/modules/fetch-with-timeout'; | ||
| import { CurrentRegulationStatus, RegulationId } from '../types'; | ||
|
|
||
| const analyticsDataDeletionSourceId = | ||
| const DEFAULT_ANALYTICS_DATA_DELETION_SOURCE_ID = | ||
| process.env.ANALYTICS_DATA_DELETION_SOURCE_ID; | ||
| const analyticsDataDeletionEndpoint = | ||
| const DEFAULT_ANALYTICS_DATA_DELETION_ENDPOINT = | ||
| process.env.ANALYTICS_DATA_DELETION_ENDPOINT; | ||
|
|
||
| const fetchWithTimeout = getFetchWithTimeout(); | ||
|
|
||
| export async function createDataDeletionRegulationTask( | ||
| metaMetricsId: string, | ||
| ): Promise<RegulationId> { | ||
| if (!analyticsDataDeletionEndpoint || !analyticsDataDeletionSourceId) { | ||
| throw new Error('Segment API source ID or endpoint not found'); | ||
| } | ||
| const RETRIES = 3; | ||
| // Each update attempt will result (1 + retries) calls if the server is down | ||
| const MAX_CONSECUTIVE_FAILURES = (1 + RETRIES) * 3; | ||
|
|
||
| const DEFAULT_DEGRADED_THRESHOLD = 5_000; | ||
|
|
||
| const CIRCUIT_BREAK_DURATION = 30 * 60 * 1000; | ||
|
|
||
| const response = await fetchWithTimeout( | ||
| `${analyticsDataDeletionEndpoint}/regulations/sources/${analyticsDataDeletionSourceId}`, | ||
| { | ||
| method: 'POST', | ||
| headers: { 'Content-Type': 'application/vnd.segment.v1+json' }, | ||
| body: JSON.stringify({ | ||
| regulationType: 'DELETE_ONLY', | ||
| subjectType: 'USER_ID', | ||
| subjectIds: [metaMetricsId], | ||
| }), | ||
| }, | ||
| /** | ||
| * Type guard for Fetch network responses with a `statusCode` property. | ||
| * | ||
| * @param response - A suspected Fetch network response. | ||
| * @returns A type checked Fetch network response. | ||
| */ | ||
| function isValidResponse( | ||
| response: unknown, | ||
| ): response is { statusCode: number } { | ||
| return ( | ||
| isObject(response) && | ||
| hasProperty(response, 'statusCode') && | ||
| typeof response.statusCode === 'number' | ||
| ); | ||
| return response.json(); | ||
| } | ||
|
|
||
| export async function fetchDeletionRegulationStatus( | ||
| deleteRegulationId: string, | ||
| ): Promise<CurrentRegulationStatus> { | ||
| if (!analyticsDataDeletionEndpoint) { | ||
| throw new Error('Segment API source ID or endpoint not found'); | ||
| /** | ||
| * Returns `true` if the parameter is a Fetch network response with a status code that indiciates | ||
| * server failure. | ||
| * | ||
| * @param response - The response to check. | ||
| * @returns `true` if the response indicates a server failure, `false` otherwise. | ||
| */ | ||
| function onServerFailure(response: unknown) { | ||
| return isValidResponse(response) && response.statusCode >= 500; | ||
| } | ||
|
|
||
| /** | ||
| * Create a Cockatiel retry policy. | ||
| * | ||
| * This policy uses a retry and circuit breaker strategy. Callbacks are accepted for circuit breaks | ||
| * and degraded responses as well. | ||
| * | ||
| * @param args - Arguments | ||
| * @param args.circuitBreakDuration - The amount of time to wait when the circuit breaks | ||
| * from too many consecutive failures. | ||
| * @param args.degradedThreshold - The threshold between "normal" and "degrated" service, | ||
| * in milliseconds. | ||
| * @param args.maximumConsecutiveFailures - The maximum number of consecutive failures | ||
| * allowed before breaking the circuit and pausing further updates. | ||
| * @param args.onBreak - An event handler for when the circuit breaks, useful for capturing | ||
| * metrics about network failures. | ||
| * @param args.onDegraded - An event handler for when the circuit remains closed, but requests | ||
| * are failing or resolving too slowly (i.e. resolving more slowly than the `degradedThreshold`). | ||
| * @param args.retries - Number of retry attempts. | ||
| * @returns A Cockatiel retry policy. | ||
| */ | ||
| function createRetryPolicy({ | ||
| circuitBreakDuration, | ||
| degradedThreshold, | ||
| maximumConsecutiveFailures, | ||
| onBreak, | ||
| onDegraded, | ||
| retries, | ||
| }: { | ||
| circuitBreakDuration: number; | ||
| degradedThreshold: number; | ||
| maximumConsecutiveFailures: number; | ||
| onBreak?: () => void; | ||
| onDegraded?: () => void; | ||
| retries: number; | ||
| }) { | ||
| const retryPolicy = retry(handleAll.orWhenResult(onServerFailure), { | ||
| maxAttempts: retries, | ||
| backoff: new ExponentialBackoff(), | ||
| }); | ||
| const circuitBreakerPolicy = circuitBreaker(handleAll, { | ||
| halfOpenAfter: circuitBreakDuration, | ||
| breaker: new ConsecutiveBreaker(maximumConsecutiveFailures), | ||
| }); | ||
| if (onBreak) { | ||
| circuitBreakerPolicy.onBreak(onBreak); | ||
| } | ||
| if (onDegraded) { | ||
| retryPolicy.onGiveUp(() => { | ||
| if (circuitBreakerPolicy.state === CircuitState.Closed) { | ||
| onDegraded(); | ||
| } | ||
| }); | ||
| retryPolicy.onSuccess(({ duration }) => { | ||
| if ( | ||
| circuitBreakerPolicy.state === CircuitState.Closed && | ||
| duration > degradedThreshold | ||
| ) { | ||
| onDegraded(); | ||
| } | ||
| }); | ||
| } | ||
| return wrap(retryPolicy, circuitBreakerPolicy); | ||
| } | ||
|
|
||
| export class DataDeletionService { | ||
| #analyticsDataDeletionEndpoint: string; | ||
|
|
||
| #analyticsDataDeletionSourceId: string; | ||
|
|
||
| #fetchStatusPolicy: IPolicy; | ||
|
|
||
| #createDataDeletionTaskPolicy: IPolicy; | ||
|
|
||
| constructor({ | ||
| analyticsDataDeletionEndpoint = DEFAULT_ANALYTICS_DATA_DELETION_ENDPOINT, | ||
| analyticsDataDeletionSourceId = DEFAULT_ANALYTICS_DATA_DELETION_SOURCE_ID, | ||
| onBreak, | ||
| onDegraded, | ||
| }: { | ||
| analyticsDataDeletionEndpoint?: string; | ||
| analyticsDataDeletionSourceId?: string; | ||
| onBreak?: () => void; | ||
| onDegraded?: () => void; | ||
| } = {}) { | ||
| if (!analyticsDataDeletionEndpoint) { | ||
| throw new Error('Missing ANALYTICS_DATA_DELETION_ENDPOINT'); | ||
| } else if (!analyticsDataDeletionSourceId) { | ||
| throw new Error('Missing ANALYTICS_DATA_DELETION_SOURCE_ID'); | ||
| } | ||
| this.#analyticsDataDeletionEndpoint = analyticsDataDeletionEndpoint; | ||
| this.#analyticsDataDeletionSourceId = analyticsDataDeletionSourceId; | ||
| this.#createDataDeletionTaskPolicy = createRetryPolicy({ | ||
| circuitBreakDuration: CIRCUIT_BREAK_DURATION, | ||
| degradedThreshold: DEFAULT_DEGRADED_THRESHOLD, | ||
| maximumConsecutiveFailures: MAX_CONSECUTIVE_FAILURES, | ||
| onBreak, | ||
| onDegraded, | ||
| retries: RETRIES, | ||
| }); | ||
| this.#fetchStatusPolicy = createRetryPolicy({ | ||
| circuitBreakDuration: CIRCUIT_BREAK_DURATION, | ||
| degradedThreshold: DEFAULT_DEGRADED_THRESHOLD, | ||
| maximumConsecutiveFailures: MAX_CONSECUTIVE_FAILURES, | ||
| onBreak, | ||
| onDegraded, | ||
| retries: RETRIES, | ||
| }); | ||
| } | ||
|
|
||
| async createDataDeletionRegulationTask( | ||
| metaMetricsId: string, | ||
| ): Promise<RegulationId> { | ||
| const response = await this.#createDataDeletionTaskPolicy.execute(() => | ||
| fetchWithTimeout( | ||
| `${this.#analyticsDataDeletionEndpoint}/regulations/sources/${ | ||
| this.#analyticsDataDeletionSourceId | ||
| }`, | ||
| { | ||
| method: 'POST', | ||
| headers: { 'Content-Type': 'application/vnd.segment.v1+json' }, | ||
| body: JSON.stringify({ | ||
| regulationType: 'DELETE_ONLY', | ||
| subjectType: 'USER_ID', | ||
| subjectIds: [metaMetricsId], | ||
| }), | ||
| }, | ||
| ), | ||
| ); | ||
| return response.json(); | ||
| } | ||
|
|
||
| async fetchDeletionRegulationStatus( | ||
| deleteRegulationId: string, | ||
| ): Promise<CurrentRegulationStatus> { | ||
| const response = await this.#fetchStatusPolicy.execute(() => | ||
| fetchWithTimeout( | ||
| `${ | ||
| this.#analyticsDataDeletionEndpoint | ||
| }/regulations/${deleteRegulationId}`, | ||
| { | ||
| method: 'GET', | ||
| headers: { 'Content-Type': 'application/vnd.segment.v1+json' }, | ||
| }, | ||
| ), | ||
| ); | ||
| return response.json(); | ||
| } | ||
| const response = await fetchWithTimeout( | ||
| `${analyticsDataDeletionEndpoint}/regulations/${deleteRegulationId}`, | ||
| { | ||
| method: 'GET', | ||
| headers: { 'Content-Type': 'application/vnd.segment.v1+json' }, | ||
| }, | ||
| ); | ||
| return response.json(); | ||
| } |
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
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
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