Migrate WidgetPrivacyConfigUpdateListener to PrivacyConfigCallbackPlugin (#4656)

aitorvs · web-flow · commit df917e2517e8 · 2024-06-29T15:39:38.000+01:00
Task/Issue URL: https://app.asana.com/0/1198194956794324/1207578217077935/f ### Description Remove PrivacyConfigUpdateListener and use PrivacyConfigCallbackPlugin instead ### Steps to test this PR Code review
diff --git a/app/src/main/java/com/duckduckgo/widget/WidgetPrivacyConfigUpdateListener.kt b/app/src/main/java/com/duckduckgo/widget/WidgetPrivacyConfigUpdateListener.kt
@@ -18,17 +18,20 @@ package com.duckduckgo.widget
 
 import android.content.Context
 import com.duckduckgo.di.scopes.AppScope
-import com.duckduckgo.privacy.config.impl.PrivacyConfigUpdateListener
-import com.squareup.anvil.annotations.ContributesBinding
+import com.duckduckgo.privacy.config.api.PrivacyConfigCallbackPlugin
+import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
 
-@ContributesBinding(AppScope::class)
+@ContributesMultibinding(
+    scope = AppScope::class,
+    boundType = PrivacyConfigCallbackPlugin::class,
+)
 class WidgetPrivacyConfigUpdateListener @Inject constructor(
     private val context: Context,
     private val widgetUpdater: WidgetUpdater,
-) : PrivacyConfigUpdateListener {
+) : PrivacyConfigCallbackPlugin {
 
-    override fun privacyConfigUpdated() {
+    override fun onPrivacyConfigDownloaded() {
         widgetUpdater.updateWidgets(context)
     }
 }
diff --git a/privacy-config/privacy-config-impl/src/main/java/com/duckduckgo/privacy/config/impl/PrivacyConfigPersister.kt b/privacy-config/privacy-config-impl/src/main/java/com/duckduckgo/privacy/config/impl/PrivacyConfigPersister.kt
@@ -63,7 +63,6 @@ class RealPrivacyConfigPersister @Inject constructor(
     private val unprotectedTemporaryRepository: UnprotectedTemporaryRepository,
     private val privacyConfigRepository: PrivacyConfigRepository,
     private val database: PrivacyConfigDatabase,
-    private val listener: PrivacyConfigUpdateListener,
     @ConfigPersisterPreferences private val persisterPreferences: SharedPreferences,
 ) : PrivacyConfigPersister {
 
@@ -121,7 +120,6 @@ class RealPrivacyConfigPersister @Inject constructor(
                     }
                 }
             }
-            listener.privacyConfigUpdated()
         }
     }
 
diff --git a/privacy-config/privacy-config-impl/src/main/java/com/duckduckgo/privacy/config/impl/PrivacyConfigUpdateListener.kt b/privacy-config/privacy-config-impl/src/main/java/com/duckduckgo/privacy/config/impl/PrivacyConfigUpdateListener.kt
diff --git a/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/RealPrivacyConfigPersisterTest.kt b/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/RealPrivacyConfigPersisterTest.kt
@@ -56,7 +56,6 @@ class RealPrivacyConfigPersisterTest {
 
     lateinit var testee: RealPrivacyConfigPersister
     private val mockTogglesRepository: PrivacyFeatureTogglesRepository = mock()
-    private val mockPrivacyConfigUpdateListener: PrivacyConfigUpdateListener = mock()
 
     private lateinit var db: PrivacyConfigDatabase
     private lateinit var privacyRepository: PrivacyConfigRepository
@@ -84,7 +83,6 @@ class RealPrivacyConfigPersisterTest {
                 unprotectedTemporaryRepository,
                 privacyRepository,
                 db,
-                mockPrivacyConfigUpdateListener,
                 sharedPreferences,
             )
     }
@@ -168,7 +166,6 @@ class RealPrivacyConfigPersisterTest {
                     unprotectedTemporaryRepository,
                     privacyRepository,
                     db,
-                    mockPrivacyConfigUpdateListener,
                     sharedPreferences,
                 )
             testee.persistPrivacyConfig(getJsonPrivacyConfig())
diff --git a/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigDisabledReferenceTest.kt b/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigDisabledReferenceTest.kt
@@ -20,7 +20,6 @@ import androidx.room.Room
 import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.test.FileUtilities
 import com.duckduckgo.common.test.api.InMemorySharedPreferences
-import com.duckduckgo.privacy.config.impl.PrivacyConfigUpdateListener
 import com.duckduckgo.privacy.config.impl.RealPrivacyConfigPersister
 import com.duckduckgo.privacy.config.impl.ReferenceTestUtilities
 import com.duckduckgo.privacy.config.impl.features.privacyFeatureValueOf
@@ -49,7 +48,6 @@ class PrivacyConfigDisabledReferenceTest(private val testCase: TestCase) {
 
     lateinit var testee: RealPrivacyConfigPersister
     private val mockTogglesRepository: PrivacyFeatureTogglesRepository = mock()
-    private val mockPrivacyConfigUpdateListener: PrivacyConfigUpdateListener = mock()
 
     private lateinit var db: PrivacyConfigDatabase
     private lateinit var referenceTestUtilities: ReferenceTestUtilities
@@ -87,7 +85,6 @@ class PrivacyConfigDisabledReferenceTest(private val testCase: TestCase) {
             referenceTestUtilities.unprotectedTemporaryRepository,
             referenceTestUtilities.privacyRepository,
             db,
-            mockPrivacyConfigUpdateListener,
             InMemorySharedPreferences(),
         )
     }
diff --git a/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigEnabledReferenceTest.kt b/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigEnabledReferenceTest.kt
@@ -20,7 +20,6 @@ import androidx.room.Room
 import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.test.FileUtilities
 import com.duckduckgo.common.test.api.InMemorySharedPreferences
-import com.duckduckgo.privacy.config.impl.PrivacyConfigUpdateListener
 import com.duckduckgo.privacy.config.impl.RealPrivacyConfigPersister
 import com.duckduckgo.privacy.config.impl.ReferenceTestUtilities
 import com.duckduckgo.privacy.config.impl.features.privacyFeatureValueOf
@@ -49,7 +48,6 @@ class PrivacyConfigEnabledReferenceTest(private val testCase: TestCase) {
 
     lateinit var testee: RealPrivacyConfigPersister
     private val mockTogglesRepository: PrivacyFeatureTogglesRepository = mock()
-    private val mockPrivacyConfigUpdateListener: PrivacyConfigUpdateListener = mock()
 
     private lateinit var db: PrivacyConfigDatabase
     private lateinit var referenceTestUtilities: ReferenceTestUtilities
@@ -86,7 +84,6 @@ class PrivacyConfigEnabledReferenceTest(private val testCase: TestCase) {
             referenceTestUtilities.unprotectedTemporaryRepository,
             referenceTestUtilities.privacyRepository,
             db,
-            mockPrivacyConfigUpdateListener,
             InMemorySharedPreferences(),
         )
     }
diff --git a/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigGlobalExceptionsReferenceTest.kt b/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigGlobalExceptionsReferenceTest.kt
@@ -21,7 +21,6 @@ import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.test.FileUtilities
 import com.duckduckgo.common.test.api.InMemorySharedPreferences
 import com.duckduckgo.feature.toggles.api.FeatureToggle
-import com.duckduckgo.privacy.config.impl.PrivacyConfigUpdateListener
 import com.duckduckgo.privacy.config.impl.RealPrivacyConfigPersister
 import com.duckduckgo.privacy.config.impl.ReferenceTestUtilities
 import com.duckduckgo.privacy.config.impl.features.contentblocking.RealContentBlocking
@@ -54,7 +53,6 @@ class PrivacyConfigGlobalExceptionsReferenceTest(private val testCase: TestCase)
     private lateinit var privacyConfigPersister: RealPrivacyConfigPersister
     private val mockTogglesRepository: PrivacyFeatureTogglesRepository = mock()
     private val mockFeatureToggle: FeatureToggle = mock()
-    private val mockPrivacyConfigUpdateListener: PrivacyConfigUpdateListener = mock()
 
     private lateinit var db: PrivacyConfigDatabase
     private lateinit var referenceTestUtilities: ReferenceTestUtilities
@@ -125,7 +123,6 @@ class PrivacyConfigGlobalExceptionsReferenceTest(private val testCase: TestCase)
             referenceTestUtilities.unprotectedTemporaryRepository,
             referenceTestUtilities.privacyRepository,
             db,
-            mockPrivacyConfigUpdateListener,
             InMemorySharedPreferences(),
         )
         privacyConfigPersister.persistPrivacyConfig(
diff --git a/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigLocalExceptionsReferenceTest.kt b/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigLocalExceptionsReferenceTest.kt
@@ -21,7 +21,6 @@ import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.test.FileUtilities
 import com.duckduckgo.common.test.api.InMemorySharedPreferences
 import com.duckduckgo.feature.toggles.api.FeatureToggle
-import com.duckduckgo.privacy.config.impl.PrivacyConfigUpdateListener
 import com.duckduckgo.privacy.config.impl.RealPrivacyConfigPersister
 import com.duckduckgo.privacy.config.impl.ReferenceTestUtilities
 import com.duckduckgo.privacy.config.impl.features.contentblocking.RealContentBlocking
@@ -53,7 +52,6 @@ class PrivacyConfigLocalExceptionsReferenceTest(private val testCase: TestCase)
     private lateinit var privacyConfigPersister: RealPrivacyConfigPersister
     private val mockTogglesRepository: PrivacyFeatureTogglesRepository = mock()
     private val mockFeatureToggle: FeatureToggle = mock()
-    private val mockPrivacyConfigUpdateListener: PrivacyConfigUpdateListener = mock()
 
     private lateinit var db: PrivacyConfigDatabase
     private lateinit var referenceTestUtilities: ReferenceTestUtilities
@@ -123,7 +121,6 @@ class PrivacyConfigLocalExceptionsReferenceTest(private val testCase: TestCase)
             referenceTestUtilities.unprotectedTemporaryRepository,
             referenceTestUtilities.privacyRepository,
             db,
-            mockPrivacyConfigUpdateListener,
             InMemorySharedPreferences(),
         )
         privacyConfigPersister.persistPrivacyConfig(
diff --git a/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigMissingReferenceTest.kt b/privacy-config/privacy-config-impl/src/test/java/com/duckduckgo/privacy/config/impl/referencetests/privacyconfig/PrivacyConfigMissingReferenceTest.kt
@@ -20,7 +20,6 @@ import androidx.room.Room
 import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.test.FileUtilities
 import com.duckduckgo.common.test.api.InMemorySharedPreferences
-import com.duckduckgo.privacy.config.impl.PrivacyConfigUpdateListener
 import com.duckduckgo.privacy.config.impl.RealPrivacyConfigPersister
 import com.duckduckgo.privacy.config.impl.ReferenceTestUtilities
 import com.duckduckgo.privacy.config.impl.features.privacyFeatureValueOf
@@ -50,7 +49,6 @@ class PrivacyConfigMissingReferenceTest(private val testCase: TestCase) {
 
     lateinit var testee: RealPrivacyConfigPersister
     private val mockTogglesRepository: PrivacyFeatureTogglesRepository = mock()
-    private val mockPrivacyConfigUpdateListener: PrivacyConfigUpdateListener = mock()
 
     private lateinit var db: PrivacyConfigDatabase
     private lateinit var referenceTestUtilities: ReferenceTestUtilities
@@ -88,7 +86,6 @@ class PrivacyConfigMissingReferenceTest(private val testCase: TestCase) {
             referenceTestUtilities.unprotectedTemporaryRepository,
             referenceTestUtilities.privacyRepository,
             db,
-            mockPrivacyConfigUpdateListener,
             InMemorySharedPreferences(),
         )
     }

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@ class RealPrivacyConfigPersister @Inject constructor(`
`63`	`63`	`private val unprotectedTemporaryRepository: UnprotectedTemporaryRepository,`
`64`	`64`	`private val privacyConfigRepository: PrivacyConfigRepository,`
`65`	`65`	`private val database: PrivacyConfigDatabase,`
`66`		`- private val listener: PrivacyConfigUpdateListener,`
`67`	`66`	`@ConfigPersisterPreferences private val persisterPreferences: SharedPreferences,`
`68`	`67`	`) : PrivacyConfigPersister {`
`69`	`68`
`@@ -121,7 +120,6 @@ class RealPrivacyConfigPersister @Inject constructor(`
`121`	`120`	`}`
`122`	`121`	`}`
`123`	`122`	`}`
`124`		`- listener.privacyConfigUpdated()`
`125`	`123`	`}`
`126`	`124`	`}`
`127`	`125`