Handle user settings logic through the status checker

Author: CrisBarreiro

ad-blocking/ad-blocking-impl/src/main/java/com/duckduckgo/adblocking/impl/AdBlockingSettingsRepository.kt

@@ -24,7 +24,8 @@ import kotlinx.coroutines.flow.Flow
 import javax.inject.Inject
 
 interface AdBlockingSettingsRepository {
-    fun isEnabledFlow(): Flow<Boolean>
+
+    fun isEnabledFlow(): Flow<Boolean?>
     suspend fun setEnabled(enabled: Boolean)
 }
 
@@ -34,7 +35,7 @@ class RealAdBlockingSettingsRepository @Inject constructor(
     private val userPreferences: AdBlockingUserPreferences,
 ) : AdBlockingSettingsRepository {
 
-    override fun isEnabledFlow(): Flow<Boolean> = userPreferences.isEnabledFlow()
+    override fun isEnabledFlow(): Flow<Boolean?> = userPreferences.isEnabledFlow()
 
     override suspend fun setEnabled(enabled: Boolean) {
         userPreferences.setEnabled(enabled)

ad-blocking/ad-blocking-impl/src/main/java/com/duckduckgo/adblocking/impl/domain/AdBlockingStatusChecker.kt

@@ -23,15 +23,19 @@ import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import dagger.SingleInstanceIn
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import logcat.logcat
 import javax.inject.Inject
 
 interface AdBlockingStatusChecker {
     fun canInject(): Boolean
     fun isShownInSettings(): Boolean
+
+    fun isUserEnabledFlow(): Flow<Boolean>
 }
 
 @SingleInstanceIn(AppScope::class)
@@ -43,6 +47,7 @@ class RealAdBlockingStatusChecker @Inject constructor(
 ) : AdBlockingStatusChecker {
 
     private val userEnabled: StateFlow<Boolean> = settingsRepository.isEnabledFlow()
+        .map { it ?: feature.enabledByDefault().isEnabled() }
         .stateIn(appScope, SharingStarted.Eagerly, initialValue = false)
 
     override fun canInject(): Boolean {
@@ -62,4 +67,6 @@ class RealAdBlockingStatusChecker @Inject constructor(
     }
 
     override fun isShownInSettings(): Boolean = feature.isDiscoverable().isEnabled()
+
+    override fun isUserEnabledFlow(): Flow<Boolean> = userEnabled
 }

ad-blocking/ad-blocking-impl/src/main/java/com/duckduckgo/adblocking/impl/store/AdBlockingUserPreferences.kt

@@ -21,7 +21,6 @@ import androidx.datastore.preferences.core.Preferences
 import androidx.datastore.preferences.core.booleanPreferencesKey
 import androidx.datastore.preferences.core.edit
 import com.duckduckgo.adblocking.impl.di.AdBlockingPreferences
-import com.duckduckgo.adblocking.impl.remoteconfig.AdBlockingExtensionFeature
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import dagger.SingleInstanceIn
@@ -31,23 +30,21 @@ import kotlinx.coroutines.flow.map
 import javax.inject.Inject
 
 interface AdBlockingUserPreferences {
-    fun isEnabledFlow(): Flow<Boolean>
-    suspend fun isEnabled(): Boolean
+
+    fun isEnabledFlow(): Flow<Boolean?>
+    suspend fun isEnabled(): Boolean?
     suspend fun setEnabled(enabled: Boolean)
 }
 
 @SingleInstanceIn(AppScope::class)
 @ContributesBinding(AppScope::class)
 class RealAdBlockingUserPreferences @Inject constructor(
     @AdBlockingPreferences private val dataStore: DataStore<Preferences>,
-    private val feature: AdBlockingExtensionFeature,
 ) : AdBlockingUserPreferences {
 
-    override fun isEnabledFlow(): Flow<Boolean> = dataStore.data.map { prefs ->
-        prefs[KEY_ENABLED] ?: feature.enabledByDefault().isEnabled()
-    }
+    override fun isEnabledFlow(): Flow<Boolean?> = dataStore.data.map { prefs -> prefs[KEY_ENABLED] }
 
-    override suspend fun isEnabled(): Boolean = isEnabledFlow().first()
+    override suspend fun isEnabled(): Boolean? = isEnabledFlow().first()
 
     override suspend fun setEnabled(enabled: Boolean) {
         dataStore.edit { prefs -> prefs[KEY_ENABLED] = enabled }

ad-blocking/ad-blocking-impl/src/main/java/com/duckduckgo/adblocking/impl/ui/AdBlockingSettingsViewModel.kt

@@ -19,6 +19,7 @@ package com.duckduckgo.adblocking.impl.ui
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.duckduckgo.adblocking.impl.AdBlockingSettingsRepository
+import com.duckduckgo.adblocking.impl.domain.AdBlockingStatusChecker
 import com.duckduckgo.anvil.annotations.ContributesViewModel
 import com.duckduckgo.di.scopes.ActivityScope
 import kotlinx.coroutines.channels.BufferOverflow
@@ -34,6 +35,7 @@ import javax.inject.Inject
 
 @ContributesViewModel(ActivityScope::class)
 class AdBlockingSettingsViewModel @Inject constructor(
+    private val statusChecker: AdBlockingStatusChecker,
     private val repository: AdBlockingSettingsRepository,
 ) : ViewModel() {
 
@@ -44,7 +46,7 @@ class AdBlockingSettingsViewModel @Inject constructor(
         data object OpenDuckPlayerSettings : Command()
     }
 
-    val viewState: StateFlow<ViewState> = repository.isEnabledFlow()
+    val viewState: StateFlow<ViewState> = statusChecker.isUserEnabledFlow()
         .map { ViewState(isEnabled = it) }
         .stateIn(
             viewModelScope,

ad-blocking/ad-blocking-impl/src/test/java/com/duckduckgo/adblocking/impl/domain/RealAdBlockingStatusCheckerTest.kt

@@ -24,7 +24,9 @@ import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.test.UnconfinedTestDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.After
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertTrue
@@ -38,21 +40,26 @@ class RealAdBlockingStatusCheckerTest {
 
     private var discoverableEnabled = true
     private var operationalEnabled = true
+    private var enabledByDefault = false
 
     private val isDiscoverableToggle: Toggle = mock {
         on { isEnabled() } doAnswer { discoverableEnabled }
     }
     private val selfToggle: Toggle = mock {
         on { isEnabled() } doAnswer { operationalEnabled }
     }
+    private val enabledByDefaultToggle: Toggle = mock {
+        on { isEnabled() } doAnswer { enabledByDefault }
+    }
     private val feature: AdBlockingExtensionFeature = mock {
         on { isDiscoverable() } doReturn isDiscoverableToggle
         on { self() } doReturn selfToggle
+        on { enabledByDefault() } doReturn enabledByDefaultToggle
     }
 
-    private val userEnabledFlow = MutableStateFlow(true)
+    private val userEnabledFlow = MutableStateFlow<Boolean?>(true)
     private val settingsRepository: AdBlockingSettingsRepository = object : AdBlockingSettingsRepository {
-        override fun isEnabledFlow(): Flow<Boolean> = userEnabledFlow
+        override fun isEnabledFlow(): Flow<Boolean?> = userEnabledFlow
         override suspend fun setEnabled(enabled: Boolean) {
             userEnabledFlow.value = enabled
         }
@@ -94,6 +101,45 @@ class RealAdBlockingStatusCheckerTest {
         assertFalse(checker.canInject())
     }
 
+    @Test
+    fun whenUserHasNoPreferenceAndEnabledByDefaultIsTrueThenCanInject() {
+        userEnabledFlow.value = null
+        enabledByDefault = true
+
+        assertTrue(checker.canInject())
+    }
+
+    @Test
+    fun whenUserHasNoPreferenceAndEnabledByDefaultIsFalseThenCannotInject() {
+        userEnabledFlow.value = null
+        enabledByDefault = false
+
+        assertFalse(checker.canInject())
+    }
+
+    @Test
+    fun whenUserHasSetTrueThenIsUserEnabledFlowEmitsTrue() = runTest {
+        userEnabledFlow.value = true
+
+        assertTrue(checker.isUserEnabledFlow().first())
+    }
+
+    @Test
+    fun whenUserHasSetFalseThenIsUserEnabledFlowEmitsFalseEvenIfDefaultIsTrue() = runTest {
+        userEnabledFlow.value = false
+        enabledByDefault = true
+
+        assertFalse(checker.isUserEnabledFlow().first())
+    }
+
+    @Test
+    fun whenUserHasNoPreferenceThenIsUserEnabledFlowEmitsDefault() = runTest {
+        userEnabledFlow.value = null
+        enabledByDefault = true
+
+        assertTrue(checker.isUserEnabledFlow().first())
+    }
+
     @Test
     fun whenDiscoverableFlagEnabledThenIsShownInSettings() {
         assertTrue(checker.isShownInSettings())