persist client state in datastore

Author: cmonfortep

attributed-metrics/attributed-metrics-impl/build.gradle

@@ -46,6 +46,9 @@ dependencies {
 
     implementation Google.dagger
 
+    // DataStore
+    api AndroidX.dataStore.preferences
+
     // Room
     implementation AndroidX.room.ktx
     ksp AndroidX.room.compiler
@@ -97,4 +100,4 @@ android {
     buildFeatures {
         buildConfig = true
     }
-}
+}

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/AttributedMetricsConfigFeature.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 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
+
+import com.duckduckgo.anvil.annotations.ContributesRemoteFeature
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.feature.toggles.api.Toggle
+import com.duckduckgo.feature.toggles.api.Toggle.DefaultFeatureValue
+
+@ContributesRemoteFeature(
+    scope = AppScope::class,
+    featureName = "attributedMetrics",
+)
+interface AttributedMetricsConfigFeature {
+    @Toggle.DefaultValue(DefaultFeatureValue.INTERNAL)
+    fun self(): Toggle
+}

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/AttributedMetricsState.kt

@@ -0,0 +1,21 @@
+/*
+ * 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
+
+internal interface AttributedMetricsState {
+    fun isEnabled(): Boolean
+}

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/di/AttributedMetricsDataStoreModule.kt

@@ -0,0 +1,45 @@
+/*
+ * 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.datastore.core.DataStore
+import androidx.datastore.preferences.core.PreferenceDataStoreFactory
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.preferencesDataStoreFile
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesTo
+import dagger.Module
+import dagger.Provides
+import dagger.SingleInstanceIn
+import javax.inject.Qualifier
+
+@Module
+@ContributesTo(AppScope::class)
+object AttributedMetricsDataStoreModule {
+    @Provides
+    @SingleInstanceIn(AppScope::class)
+    @AttributedMetrics
+    fun provideDataStore(context: Context): DataStore<Preferences> =
+        PreferenceDataStoreFactory.create(
+            produceFile = { context.preferencesDataStoreFile("attributed_metrics_v1") },
+        )
+}
+
+@Qualifier
+@Retention(AnnotationRetention.BINARY)
+annotation class AttributedMetrics

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/impl/RealAttributedMetricClient.kt

@@ -16,19 +16,24 @@
 
 package com.duckduckgo.app.attributed.metrics.impl
 
+import com.duckduckgo.app.attributed.metrics.AttributedMetricsConfigFeature
 import com.duckduckgo.app.attributed.metrics.api.AttributedMetric
 import com.duckduckgo.app.attributed.metrics.api.AttributedMetricClient
 import com.duckduckgo.app.attributed.metrics.api.EventStats
+import com.duckduckgo.app.attributed.metrics.store.AttributedMetricsDataStore
+import com.duckduckgo.app.attributed.metrics.store.DateProvider
 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.duckduckgo.privacy.config.api.PrivacyConfigCallbackPlugin
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.SingleInstanceIn
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import javax.inject.Inject
@@ -41,21 +46,36 @@ class RealAttributedMetricClient @Inject constructor(
     private val dispatcherProvider: DispatcherProvider,
     private val appBuildConfig: AppBuildConfig,
     private val eventRepository: EventRepository,
+    private val dataStore: AttributedMetricsDataStore,
+    private val dateProvider: DateProvider,
+    private val attributedMetricsConfigFeature: AttributedMetricsConfigFeature,
 ) : AttributedMetricClient,
-    AtbLifecyclePlugin {
+    AtbLifecyclePlugin,
+    PrivacyConfigCallbackPlugin {
+
+    // We only want to enable Attributed Metrics for new installations
     override fun onAppAtbInitialized() {
-        appCoroutineScope.launch {
-            if (appBuildConfig.isAppReinstall()) {
-                // Do not start metrics for returning users
-                return@launch
-            } else {
-                // enable collecting events and emitting metrics
+        appCoroutineScope.launch(dispatcherProvider.io()) {
+            // atb happens after remote config is downloaded, here we should have the latest value
+            if (attributedMetricsConfigFeature.self().isEnabled().not()) return@launch
+
+            val initDate = dataStore.getInitializationDate()
+            if (initDate == null) {
+                val currentDate = dateProvider.getCurrentDate()
+                dataStore.setInitializationDate(currentDate)
+                if (appBuildConfig.isAppReinstall()) {
+                    // Do not start metrics for returning users
+                    return@launch
+                } else {
+                    dataStore.setEnabled(true)
+                }
             }
         }
     }
 
     override fun collectEvent(eventName: String) {
         appCoroutineScope.launch(dispatcherProvider.io()) {
+            if (!isEnabled()) return@launch
             eventRepository.collectEvent(eventName)
         }
     }
@@ -65,10 +85,26 @@ class RealAttributedMetricClient @Inject constructor(
         days: Int,
     ): EventStats =
         withContext(dispatcherProvider.io()) {
+            if (!isEnabled()) {
+                return@withContext EventStats(daysWithEvents = 0, rollingAverage = 0.0, totalEvents = 0)
+            }
             eventRepository.getEventStats(eventName, days)
         }
 
     override fun emitMetric(metric: AttributedMetric) {
-        TODO("Not yet implemented")
+        appCoroutineScope.launch(dispatcherProvider.io()) {
+            if (!isEnabled()) return@launch
+            val parameters = metric.getMetricParameters()
+            // Implement metric emission logic
+        }
+    }
+
+    // Check if Attributed Metrics is enabled (RemoteConfig) and initialization date is set
+    private suspend fun isEnabled(): Boolean = dataStore.isEnabled() && dataStore.getInitializationDate() != null
+
+    override fun onPrivacyConfigDownloaded() {
+        appCoroutineScope.launch(dispatcherProvider.io()) {
+            dataStore.setEnabled(attributedMetricsConfigFeature.self().isEnabled())
+        }
     }
 }

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/AttributedMetricsDataStore.kt

@@ -0,0 +1,83 @@
+/*
+ * 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.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.booleanPreferencesKey
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.core.stringPreferencesKey
+import com.duckduckgo.app.attributed.metrics.di.AttributedMetrics
+import com.duckduckgo.app.di.AppCoroutineScope
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesBinding
+import dagger.SingleInstanceIn
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.*
+import javax.inject.Inject
+
+interface AttributedMetricsDataStore {
+    suspend fun isEnabled(): Boolean
+
+    suspend fun setEnabled(enabled: Boolean)
+
+    suspend fun getInitializationDate(): String?
+
+    suspend fun setInitializationDate(date: String?)
+
+    fun observeEnabled(): Flow<Boolean>
+}
+
+@ContributesBinding(AppScope::class)
+@SingleInstanceIn(AppScope::class)
+class RealAttributedMetricsDataStore @Inject constructor(
+    @AttributedMetrics private val store: DataStore<Preferences>,
+    @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
+) : AttributedMetricsDataStore {
+    private object Keys {
+        val IS_ENABLED = booleanPreferencesKey("is_enabled")
+        val INIT_DATE = stringPreferencesKey("client_init_date")
+    }
+
+    private val enabledState: StateFlow<Boolean> =
+        store.data
+            .map { prefs -> prefs[Keys.IS_ENABLED] ?: false }
+            .distinctUntilChanged()
+            .stateIn(appCoroutineScope, SharingStarted.Eagerly, false)
+
+    override suspend fun isEnabled(): Boolean = store.data.firstOrNull()?.get(Keys.IS_ENABLED) ?: false
+
+    override suspend fun setEnabled(enabled: Boolean) {
+        store.edit { preferences ->
+            preferences[Keys.IS_ENABLED] = enabled
+        }
+    }
+
+    override suspend fun getInitializationDate(): String? = store.data.firstOrNull()?.get(Keys.INIT_DATE)
+
+    override suspend fun setInitializationDate(date: String?) {
+        store.edit { preferences ->
+            if (date != null) {
+                preferences[Keys.INIT_DATE] = date
+            } else {
+                preferences.remove(Keys.INIT_DATE)
+            }
+        }
+    }
+
+    override fun observeEnabled(): Flow<Boolean> = enabledState
+}