feat: Schedule daily metrics deletion (#5807)

Unleash · Jan 10, 2024 · 2c0c4e7 · 2c0c4e7
1 parent 920e80c
commit 2c0c4e7
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 0 deletions.
diff --git a/src/lib/db/client-metrics-store-v2.test.ts b/src/lib/db/client-metrics-store-v2.test.ts
@@ -17,6 +17,11 @@ afterAll(async () => {
     await db.destroy();
 });
 
+beforeEach(async () => {
+    await clientMetricsStore.clearMetrics(0);
+    await clientMetricsStore.clearDailyMetrics(0);
+});
+
 test('aggregate daily metrics from previous day', async () => {
     const yesterday = subDays(new Date(), 1);
     await clientMetricsStore.batchInsertMetrics([
@@ -84,3 +89,46 @@ test('aggregate daily metrics from previous day', async () => {
         },
     ]);
 });
+
+test('clear daily metrics', async () => {
+    const yesterday = subDays(new Date(), 1);
+    const twoDaysAgo = subDays(new Date(), 2);
+    await clientMetricsStore.batchInsertMetrics([
+        {
+            appName: 'irrelevant',
+            featureName: 'irrelevant',
+            environment: 'irrelevant',
+            timestamp: yesterday,
+            no: 0,
+            yes: 1,
+            variants: {
+                a: 0,
+                b: 1,
+            },
+        },
+        {
+            appName: 'irrelevant',
+            featureName: 'irrelevant',
+            environment: 'irrelevant',
+            timestamp: twoDaysAgo,
+            no: 0,
+            yes: 2,
+            variants: {
+                a: 1,
+                b: 1,
+            },
+        },
+    ]);
+    await clientMetricsStore.aggregateDailyMetrics();
+
+    await clientMetricsStore.clearDailyMetrics(2);
+
+    const results = await db.rawDatabase
+        .table('client_metrics_env_daily')
+        .select('*');
+    expect(results.length).toBe(1);
+    const variantResults = await db.rawDatabase
+        .table('client_metrics_env_variants_daily')
+        .select('*');
+    expect(variantResults.length).toBe(2);
+});
diff --git a/src/lib/db/client-metrics-store-v2.ts b/src/lib/db/client-metrics-store-v2.ts
@@ -256,6 +256,12 @@ export class ClientMetricsStoreV2 implements IClientMetricsStoreV2 {
             .del();
     }
 
+    async clearDailyMetrics(daysAgo: number): Promise<void> {
+        return this.db(DAILY_TABLE)
+            .whereRaw(`date <= CURRENT_DATE - INTERVAL '${daysAgo} days'`)
+            .del();
+    }
+
     // aggregates all hourly metrics from a previous day into daily metrics
     async aggregateDailyMetrics(): Promise<void> {
         const rawQuery: string = `

diff --git a/src/lib/features/scheduler/schedule-services.ts b/src/lib/features/scheduler/schedule-services.ts
@@ -145,6 +145,14 @@ export const scheduleServices = async (
         'clearMetrics',
     );
 
+    schedulerService.schedule(
+        () => {
+            clientMetricsServiceV2.clearDailyMetrics(92).catch(console.error);
+        },
+        hoursToMilliseconds(24),
+        'clearDailyMetrics',
+    );
+
     schedulerService.schedule(
         () => {
             clientMetricsServiceV2.aggregateDailyMetrics().catch(console.error);

diff --git a/src/lib/services/client-metrics/metrics-service-v2.ts b/src/lib/services/client-metrics/metrics-service-v2.ts
@@ -49,6 +49,12 @@ export default class ClientMetricsServiceV2 {
         return this.clientMetricsStoreV2.clearMetrics(hoursAgo);
     }
 
+    async clearDailyMetrics(daysAgo: number) {
+        if (this.flagResolver.isEnabled('extendedUsageMetrics')) {
+            return this.clientMetricsStoreV2.clearDailyMetrics(daysAgo);
+        }
+    }
+
     async aggregateDailyMetrics() {
         if (this.flagResolver.isEnabled('extendedUsageMetrics')) {
             await this.clientMetricsStoreV2.aggregateDailyMetrics();

diff --git a/src/lib/types/stores/client-metrics-store-v2.ts b/src/lib/types/stores/client-metrics-store-v2.ts
@@ -34,5 +34,6 @@ export interface IClientMetricsStoreV2
         hoursBack?: number,
     ): Promise<string[]>;
     clearMetrics(hoursAgo: number): Promise<void>;
+    clearDailyMetrics(daysAgo: number): Promise<void>;
     aggregateDailyMetrics(): Promise<void>;
 }
diff --git a/src/test/fixtures/fake-client-metrics-store-v2.ts b/src/test/fixtures/fake-client-metrics-store-v2.ts
@@ -26,6 +26,9 @@ export default class FakeClientMetricsStoreV2
     clearMetrics(hoursBack: number): Promise<void> {
         return Promise.resolve();
     }
+    clearDailyMetrics(daysBack: number): Promise<void> {
+        return Promise.resolve();
+    }
     aggregateDailyMetrics(): Promise<void> {
         return Promise.resolve();
     }