adds internal event repository and database

cmonfortep · cmonfortep · commit 82c7dfe6172b · 2025-10-07T14:46:02.000+02:00
diff --git a/attributed-metrics/attributed-metrics-api/src/main/java/com/duckduckgo/app/attributed/metrics/api/AttributedMetricsClient.kt b/attributed-metrics/attributed-metrics-api/src/main/java/com/duckduckgo/app/attributed/metrics/api/AttributedMetricsClient.kt
@@ -25,7 +25,10 @@ interface AttributedMetricClient {
     fun collectEvent(eventName: String)
 
     // return events stored in the last days, and precalculated stats
-    suspend fun getEventStats(eventName: String, days: Int): EventStats
+    suspend fun getEventStats(
+        eventName: String,
+        days: Int,
+    ): EventStats
 
     // if in monitoring window will emit the metric
     // this part owns adding common params to all metrics (e.g. origin, removing default params)
@@ -39,13 +42,14 @@ data class EventStats(
     // rolling average of events based on days timeframe
     val rollingAverage: Double,
     // total number of events in the timeframe
-    val totalEvents: Int
+    val totalEvents: Int,
 )
 
 // interface for each metric
 interface AttributedMetric {
     // Metric owns the pixel name value
     fun getPixelName(): String
+
     // Metric owns adding metric specific parameters
     suspend fun getMetricParameters(): Map<String, String>
 }
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/di/AttributedMetricsDatabaseModule.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/di/AttributedMetricsDatabaseModule.kt
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.di
+
+import android.content.Context
+import androidx.room.Room
+import com.duckduckgo.app.attributed.metrics.store.AttributedMetricsDatabase
+import com.duckduckgo.app.attributed.metrics.store.EventDao
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesTo
+import dagger.Module
+import dagger.Provides
+import dagger.SingleInstanceIn
+
+@Module
+@ContributesTo(AppScope::class)
+class AttributedMetricsDatabaseModule {
+    @Provides
+    @SingleInstanceIn(AppScope::class)
+    fun provideAttributedMetricsDatabase(context: Context): AttributedMetricsDatabase =
+        Room
+            .databaseBuilder(
+                context = context,
+                klass = AttributedMetricsDatabase::class.java,
+                name = "attributed_metrics.db",
+            ).fallbackToDestructiveMigration()
+            .build()
+
+    @Provides
+    @SingleInstanceIn(AppScope::class)
+    fun provideEventDao(db: AttributedMetricsDatabase): EventDao = db.eventDao()
+}
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/impl/RealAttributedMetricClient.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/impl/RealAttributedMetricClient.kt
@@ -18,26 +18,31 @@ package com.duckduckgo.app.attributed.metrics.impl
 
 import com.duckduckgo.app.attributed.metrics.api.AttributedMetric
 import com.duckduckgo.app.attributed.metrics.api.AttributedMetricClient
-import com.duckduckgo.app.statistics.api.AtbLifecyclePlugin
 import com.duckduckgo.app.attributed.metrics.api.EventStats
+import com.duckduckgo.app.attributed.metrics.store.EventRepository
 import com.duckduckgo.app.di.AppCoroutineScope
+import com.duckduckgo.app.statistics.api.AtbLifecyclePlugin
 import com.duckduckgo.appbuildconfig.api.AppBuildConfig
+import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.SingleInstanceIn
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 import javax.inject.Inject
 
 @ContributesMultibinding(AppScope::class, AtbLifecyclePlugin::class)
 @ContributesBinding(AppScope::class, AttributedMetricClient::class)
 @SingleInstanceIn(AppScope::class)
 class RealAttributedMetricClient @Inject constructor(
     @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
+    private val dispatcherProvider: DispatcherProvider,
     private val appBuildConfig: AppBuildConfig,
-): AttributedMetricClient, AtbLifecyclePlugin {
-
+    private val eventRepository: EventRepository,
+) : AttributedMetricClient,
+    AtbLifecyclePlugin {
     override fun onAppAtbInitialized() {
         appCoroutineScope.launch {
             if (appBuildConfig.isAppReinstall()) {
@@ -50,15 +55,18 @@ class RealAttributedMetricClient @Inject constructor(
     }
 
     override fun collectEvent(eventName: String) {
-        TODO("Not yet implemented")
+        appCoroutineScope.launch(dispatcherProvider.io()) {
+            eventRepository.collectEvent(eventName)
+        }
     }
 
     override suspend fun getEventStats(
         eventName: String,
-        days: Int
-    ): EventStats {
-        TODO("Not yet implemented")
-    }
+        days: Int,
+    ): EventStats =
+        withContext(dispatcherProvider.io()) {
+            eventRepository.getEventStats(eventName, days)
+        }
 
     override fun emitMetric(metric: AttributedMetric) {
         TODO("Not yet implemented")
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/AttributedMetricsDatabase.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/AttributedMetricsDatabase.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.store
+
+import androidx.room.Database
+import androidx.room.RoomDatabase
+
+@Database(
+    version = 1,
+    entities = [
+        EventEntity::class,
+    ],
+    exportSchema = true,
+)
+abstract class AttributedMetricsDatabase : RoomDatabase() {
+    abstract fun eventDao(): EventDao
+}
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/DateProvider.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/DateProvider.kt
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.store
+
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesBinding
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+import javax.inject.Inject
+
+interface DateProvider {
+    fun getCurrentDate(): String
+
+    fun getDateMinusDays(days: Int): String
+}
+
+@ContributesBinding(AppScope::class)
+class RealDateProvider @Inject constructor() : DateProvider {
+    override fun getCurrentDate(): String = LocalDate.now().format(DATE_FORMATTER)
+
+    override fun getDateMinusDays(days: Int): String = LocalDate.now().minusDays(days.toLong()).format(DATE_FORMATTER)
+
+    companion object {
+        private val DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd")
+    }
+}
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventDao.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventDao.kt
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.store
+
+import androidx.room.*
+
+@Dao
+interface EventDao {
+    @Transaction
+    @Query("SELECT * FROM event_metrics WHERE eventName = :eventName AND day >= :startDay ORDER BY day DESC")
+    suspend fun getEventsByNameAndTimeframe(
+        eventName: String,
+        startDay: String,
+    ): List<EventEntity>
+
+    @Query("SELECT COUNT(DISTINCT day) FROM event_metrics WHERE eventName = :eventName AND day >= :startDay")
+    suspend fun getDaysWithEvents(
+        eventName: String,
+        startDay: String,
+    ): Int
+
+    @Query("SELECT SUM(count) FROM event_metrics WHERE eventName = :eventName AND day >= :startDay")
+    suspend fun getTotalEvents(
+        eventName: String,
+        startDay: String,
+    ): Int
+
+    @Insert(onConflict = OnConflictStrategy.REPLACE)
+    suspend fun insertEvent(event: EventEntity)
+
+    @Query(
+        """
+        UPDATE event_metrics
+        SET count = count + 1
+        WHERE eventName = :eventName AND day = :day
+    """,
+    )
+    suspend fun incrementEventCount(
+        eventName: String,
+        day: String,
+    )
+
+    @Query("SELECT count FROM event_metrics WHERE eventName = :eventName AND day = :day")
+    suspend fun getEventCount(
+        eventName: String,
+        day: String,
+    ): Int?
+
+    @Query("DELETE FROM event_metrics WHERE day < :day")
+    suspend fun deleteEventsOlderThan(day: String)
+}
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventEntity.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventEntity.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.store
+
+import androidx.room.Entity
+import androidx.room.Index
+
+@Entity(
+    tableName = "event_metrics",
+    primaryKeys = ["eventName", "day"],
+    indices = [Index("eventName"), Index("day")],
+)
+data class EventEntity(
+    val eventName: String,
+    val count: Int,
+    // Format: YYYY-MM-DD
+    val day: String,
+)
diff --git a/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventRepository.kt b/attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventRepository.kt
@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.store
+
+import com.duckduckgo.app.attributed.metrics.api.EventStats
+import com.duckduckgo.app.di.AppCoroutineScope
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesBinding
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+import javax.inject.Inject
+
+interface EventRepository {
+    suspend fun collectEvent(eventName: String)
+
+    suspend fun getEventStats(
+        eventName: String,
+        days: Int,
+    ): EventStats
+
+    suspend fun deleteOldEvents(olderThanDays: Int)
+}
+
+@ContributesBinding(AppScope::class)
+class RealEventRepository @Inject constructor(
+    private val eventDao: EventDao,
+    private val dateProvider: DateProvider,
+    @AppCoroutineScope private val coroutineScope: CoroutineScope,
+) : EventRepository {
+    override suspend fun collectEvent(eventName: String) {
+        val today = dateProvider.getCurrentDate()
+        val currentCount = eventDao.getEventCount(eventName, today)
+
+        if (currentCount == null) {
+            eventDao.insertEvent(EventEntity(eventName = eventName, count = 1, day = today))
+        } else {
+            eventDao.incrementEventCount(eventName, today)
+        }
+    }
+
+    override suspend fun getEventStats(
+        eventName: String,
+        days: Int,
+    ): EventStats {
+        val startDay = dateProvider.getDateMinusDays(days)
+
+        val daysWithEvents = eventDao.getDaysWithEvents(eventName, startDay)
+        val totalEvents = eventDao.getTotalEvents(eventName, startDay) ?: 0
+        val rollingAverage = if (days > 0) totalEvents.toDouble() / days else 0.0
+
+        return EventStats(
+            daysWithEvents = daysWithEvents,
+            rollingAverage = rollingAverage,
+            totalEvents = totalEvents,
+        )
+    }
+
+    override suspend fun deleteOldEvents(olderThanDays: Int) {
+        coroutineScope.launch {
+            val cutoffDay = dateProvider.getDateMinusDays(olderThanDays)
+            eventDao.deleteEventsOlderThan(cutoffDay)
+        }
+    }
+}
diff --git a/attributed-metrics/attributed-metrics-impl/src/test/java/com/duckduckgo/app/attributed/metrics/store/RealEventRepositoryTest.kt b/attributed-metrics/attributed-metrics-impl/src/test/java/com/duckduckgo/app/attributed/metrics/store/RealEventRepositoryTest.kt
