feat(api-gateway): add registration-to-activity retention analytics to report

packages/api-gateway/bin/report.ts

@@ -16,6 +16,7 @@ import {
   AnalyticsActivity,
   AnalyticsStoreInterface,
   Period,
+  PeriodKeyGeneratorInterface,
   StatisticsMeasure,
   StatisticsStoreInterface,
 } from '@standardnotes/analytics'
@@ -24,6 +25,7 @@ const requestReport = async (
   analyticsStore: AnalyticsStoreInterface,
   statisticsStore: StatisticsStoreInterface,
   domainEventPublisher: DomainEventPublisherInterface,
+  periodKeyGenerator: PeriodKeyGeneratorInterface,
 ): Promise<void> => {
   const analyticsOverTime = []
 
@@ -103,6 +105,24 @@ const requestReport = async (
     }
   }
 
+  const periodKeys = periodKeyGenerator.getDiscretePeriodKeys(Period.Last7Days)
+  const registerToActivityRetention = new Map<string, Map<string, number>>()
+  for (let i = 0; i < periodKeys.length; i++) {
+    const retentionOverDays = new Map<string, number>()
+    for (let j = 0; j < periodKeys.length - i; j++) {
+      const dailyRetention = await analyticsStore.calculateActivitiesRetention({
+        firstActivity: AnalyticsActivity.Register,
+        firstActivityPeriodKey: periodKeys[i],
+        secondActivity: AnalyticsActivity.GeneralActivity,
+        secondActivityPeriodKey: periodKeys[i + j],
+      })
+
+      retentionOverDays.set(periodKeys[i + j], dailyRetention)
+    }
+
+    registerToActivityRetention.set(periodKeys[i], retentionOverDays)
+  }
+
   const event: DailyAnalyticsReportGeneratedEvent = {
     type: 'DAILY_ANALYTICS_REPORT_GENERATED',
     createdAt: new Date(),
@@ -120,6 +140,13 @@ const requestReport = async (
       activityStatistics: yesterdayActivityStatistics,
       activityStatisticsOverTime: analyticsOverTime,
       statisticMeasures,
+      retentionStatistics: [
+        {
+          firstActivity: AnalyticsActivity.Register,
+          secondActivity: AnalyticsActivity.GeneralActivity,
+          retention: registerToActivityRetention,
+        },
+      ],
     },
   }
 
@@ -138,8 +165,9 @@ void container.load().then((container) => {
   const analyticsStore: AnalyticsStoreInterface = container.get(TYPES.AnalyticsStore)
   const statisticsStore: StatisticsStoreInterface = container.get(TYPES.StatisticsStore)
   const domainEventPublisher: DomainEventPublisherInterface = container.get(TYPES.DomainEventPublisher)
+  const periodKeyGenerator: PeriodKeyGeneratorInterface = container.get(TYPES.PeriodKeyGenerator)
 
-  Promise.resolve(requestReport(analyticsStore, statisticsStore, domainEventPublisher))
+  Promise.resolve(requestReport(analyticsStore, statisticsStore, domainEventPublisher, periodKeyGenerator))
     .then(() => {
       logger.info('Usage report generation complete')
 

packages/api-gateway/src/Bootstrap/Container.ts

@@ -6,6 +6,7 @@ import * as AWS from 'aws-sdk'
 import {
   AnalyticsStoreInterface,
   PeriodKeyGenerator,
+  PeriodKeyGeneratorInterface,
   RedisAnalyticsStore,
   RedisStatisticsStore,
   StatisticsStoreInterface,
@@ -91,13 +92,13 @@ export class ContainerConfigLoader {
 
     // Services
     container.bind<HttpServiceInterface>(TYPES.HTTPService).to(HttpService)
-    const periodKeyGenerator = new PeriodKeyGenerator()
+    container.bind<PeriodKeyGeneratorInterface>(TYPES.PeriodKeyGenerator).toConstantValue(new PeriodKeyGenerator())
     container
       .bind<AnalyticsStoreInterface>(TYPES.AnalyticsStore)
-      .toConstantValue(new RedisAnalyticsStore(periodKeyGenerator, container.get(TYPES.Redis)))
+      .toConstantValue(new RedisAnalyticsStore(container.get(TYPES.PeriodKeyGenerator), container.get(TYPES.Redis)))
     container
       .bind<StatisticsStoreInterface>(TYPES.StatisticsStore)
-      .toConstantValue(new RedisStatisticsStore(periodKeyGenerator, container.get(TYPES.Redis)))
+      .toConstantValue(new RedisStatisticsStore(container.get(TYPES.PeriodKeyGenerator), container.get(TYPES.Redis)))
     container.bind<CrossServiceTokenCacheInterface>(TYPES.CrossServiceTokenCache).to(RedisCrossServiceTokenCache)
     container.bind<TimerInterface>(TYPES.Timer).toConstantValue(new Timer())
 

packages/api-gateway/src/Bootstrap/Types.ts

@@ -26,6 +26,7 @@ const TYPES = {
   StatisticsStore: Symbol.for('StatisticsStore'),
   DomainEventPublisher: Symbol.for('DomainEventPublisher'),
   Timer: Symbol.for('Timer'),
+  PeriodKeyGenerator: Symbol.for('PeriodKeyGenerator'),
 }
 
 export default TYPES

packages/domain-events/src/Domain/Event/DailyAnalyticsReportGeneratedEventPayload.ts

@@ -28,4 +28,9 @@ export interface DailyAnalyticsReportGeneratedEventPayload {
     totalCount: number
   }>
   outOfSyncIncidents: number
+  retentionStatistics: Array<{
+    firstActivity: string
+    secondActivity: string
+    retention: Map<string, Map<string, number>>
+  }>
 }