SERP Settings Sync: Implement subscription event data channel in BrowserTabFragment and ViewModel

We create a new channel so subscriptionEventData events are not lost

Author: mikescamell

app/src/androidTest/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt

@@ -43,6 +43,7 @@ import androidx.lifecycle.Observer
 import androidx.room.Room
 import androidx.test.filters.SdkSuppress
 import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
+import app.cash.turbine.test
 import com.duckduckgo.adclick.api.AdClickManager
 import com.duckduckgo.app.ValueCaptorObserver
 import com.duckduckgo.app.accessibility.data.AccessibilitySettingsDataStore
@@ -233,6 +234,7 @@ import com.duckduckgo.common.utils.baseHost
 import com.duckduckgo.common.utils.device.DeviceInfo
 import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.common.utils.plugins.headers.CustomHeadersProvider
+import com.duckduckgo.contentscopescripts.api.ContentScopeScriptsSubscriptionEventPlugin
 import com.duckduckgo.downloads.api.DownloadStateListener
 import com.duckduckgo.downloads.api.FileDownloader
 import com.duckduckgo.downloads.api.FileDownloader.PendingFileDownload
@@ -259,12 +261,8 @@ import com.duckduckgo.feature.toggles.api.Toggle
 import com.duckduckgo.feature.toggles.api.Toggle.State
 import com.duckduckgo.history.api.HistoryEntry.VisitedPage
 import com.duckduckgo.history.api.NavigationHistory
-import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptPlugin
 import com.duckduckgo.js.messaging.api.JsCallbackData
-import com.duckduckgo.js.messaging.api.PostMessageWrapperPlugin
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
-import com.duckduckgo.js.messaging.api.WebMessagingPlugin
-import com.duckduckgo.js.messaging.api.WebViewCompatMessageCallback
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.MALWARE
 import com.duckduckgo.newtabpage.impl.pixels.NewTabPixels
@@ -290,6 +288,7 @@ import com.duckduckgo.savedsites.api.models.SavedSite.Favorite
 import com.duckduckgo.savedsites.impl.SavedSitesPixelName
 import com.duckduckgo.serp.logos.api.SerpEasterEggLogosToggles
 import com.duckduckgo.serp.logos.api.SerpLogo
+import com.duckduckgo.settings.api.SettingsPageFeature
 import com.duckduckgo.site.permissions.api.SitePermissionsManager
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.LocationPermissionRequest
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.SitePermissionQueryResponse
@@ -619,6 +618,9 @@ class BrowserTabViewModelTest {
 
     private val mockDeviceAppLookup: DeviceAppLookup = mock()
 
+    private lateinit var fakeContentScopeScriptsSubscriptionEventPluginPoint: FakeContentScopeScriptsSubscriptionEventPluginPoint
+    private var fakeSettingsPageFeature = FakeFeatureToggleFactory.create(SettingsPageFeature::class.java)
+
     @Before
     fun before() =
         runTest {
@@ -849,6 +851,8 @@ class BrowserTabViewModelTest {
                     addressBarTrackersAnimationFeatureToggle = mockAddressBarTrackersAnimationFeatureToggle,
                     autoconsentPixelManager = mockAutoconsentPixelManager,
                     omnibarFeatureRepository = mockOmnibarFeatureRepository,
+                    contentScopeScriptsSubscriptionEventPluginPoint = fakeContentScopeScriptsSubscriptionEventPluginPoint,
+                    settingsPageFeature = fakeSettingsPageFeature,
                 )
 
             testee.loadData("abc", null, false, false)
@@ -7944,6 +7948,104 @@ class BrowserTabViewModelTest {
         override fun getPlugins(): Collection<PostMessageWrapperPlugin> = listOf(plugin)
     }
 
+    class FakeContentScopeScriptsSubscriptionEventPlugin(
+        private val eventData: SubscriptionEventData,
+    ) : ContentScopeScriptsSubscriptionEventPlugin {
+        override fun getSubscriptionEventData(): SubscriptionEventData = eventData
+    }
+
+    class FakeContentScopeScriptsSubscriptionEventPluginPoint() : PluginPoint<ContentScopeScriptsSubscriptionEventPlugin> {
+
+        private val plugins: MutableList<ContentScopeScriptsSubscriptionEventPlugin> = mutableListOf()
+
+        fun addPlugins(plugins: List<ContentScopeScriptsSubscriptionEventPlugin>) {
+            this.plugins.addAll(plugins)
+        }
+
+        override fun getPlugins(): Collection<ContentScopeScriptsSubscriptionEventPlugin> = plugins
+    }
+
+    @Test
+    fun whenOnViewResumedWithNoPluginsThenNoSubscriptionEventsSent() = runTest {
+        fakeSettingsPageFeature.serpSettingsSync().setRawStoredState(State(enable = true))
+
+        testee.onViewResumed()
+
+        testee.subscriptionEventDataFlow.test {
+            expectNoEvents()
+            cancelAndIgnoreRemainingEvents()
+        }
+    }
+
+    @Test
+    fun whenOnViewResumedWithPluginsThenSubscriptionEventsSent() = runTest {
+        fakeSettingsPageFeature.serpSettingsSync().setRawStoredState(State(enable = true))
+        val events = mutableListOf<SubscriptionEventData>().apply {
+            add(
+                SubscriptionEventData(
+                    featureName = "event1",
+                    subscriptionName = "subscription1",
+                    params = JSONObject().put("param1", "value1"),
+                ),
+            )
+            add(
+                SubscriptionEventData(
+                    featureName = "event2",
+                    subscriptionName = "subscription2",
+                    params = JSONObject().put("param2", "value2"),
+                ),
+            )
+        }
+
+        fakeContentScopeScriptsSubscriptionEventPluginPoint.addPlugins(
+            events.map { FakeContentScopeScriptsSubscriptionEventPlugin(it) },
+        )
+
+        testee.onViewResumed()
+
+        testee.subscriptionEventDataFlow.test {
+            for (expectedEvent in events) {
+                val emittedEvent = awaitItem()
+                assertEquals(expectedEvent.featureName, emittedEvent.featureName)
+                assertEquals(expectedEvent.subscriptionName, emittedEvent.subscriptionName)
+                assertEquals(expectedEvent.params.toString(), emittedEvent.params.toString())
+            }
+            cancelAndIgnoreRemainingEvents()
+        }
+    }
+
+    @Test
+    fun whenOnViewResumedWithPluginsAndSerpSettingsFeatureFlagOffThenNoEventsSent() = runTest {
+        fakeSettingsPageFeature.serpSettingsSync().setRawStoredState(State(enable = false))
+        val events = mutableListOf<SubscriptionEventData>().apply {
+            add(
+                SubscriptionEventData(
+                    featureName = "event1",
+                    subscriptionName = "subscription1",
+                    params = JSONObject().put("param1", "value1"),
+                ),
+            )
+            add(
+                SubscriptionEventData(
+                    featureName = "event2",
+                    subscriptionName = "subscription2",
+                    params = JSONObject().put("param2", "value2"),
+                ),
+            )
+        }
+
+        fakeContentScopeScriptsSubscriptionEventPluginPoint.addPlugins(
+            events.map { FakeContentScopeScriptsSubscriptionEventPlugin(it) },
+        )
+
+        testee.onViewResumed()
+
+        testee.subscriptionEventDataFlow.test {
+            expectNoEvents()
+            cancelAndIgnoreRemainingEvents()
+        }
+    }
+
     @Test
     fun whenVpnMenuClickedWithNotSubscribedStateThenPixelFiredWithPillStatus() {
         testee.browserViewState.value = browserViewState().copy(

app/src/main/java/com/duckduckgo/app/browser/BrowserTabFragment.kt

@@ -992,6 +992,15 @@ class BrowserTabFragment :
             pendingUploadTask = null
         }
         viewModel.handleExternalLaunch(isLaunchedFromExternalApp)
+
+        observeSubscriptionEventDataChannel()
+    }
+
+    private fun observeSubscriptionEventDataChannel() {
+        viewModel.subscriptionEventDataFlow.onEach { subscriptionEventData ->
+            logcat { "SERP-Settings: Sending subscription event data to content scope scripts: $subscriptionEventData" }
+            contentScopeScripts.sendSubscriptionEvent(subscriptionEventData)
+        }.launchIn(lifecycleScope)
     }
 
     private fun resumeWebView() {

app/src/main/java/com/duckduckgo/app/browser/BrowserTabViewModel.kt

@@ -308,6 +308,7 @@ import com.duckduckgo.common.utils.isMobileSite
 import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.common.utils.plugins.headers.CustomHeadersProvider
 import com.duckduckgo.common.utils.toDesktopUri
+import com.duckduckgo.contentscopescripts.api.ContentScopeScriptsSubscriptionEventPlugin
 import com.duckduckgo.di.scopes.FragmentScope
 import com.duckduckgo.downloads.api.DownloadCommand
 import com.duckduckgo.downloads.api.DownloadStateListener
@@ -323,6 +324,7 @@ import com.duckduckgo.duckplayer.api.DuckPlayer.DuckPlayerState.ENABLED
 import com.duckduckgo.feature.toggles.api.Toggle
 import com.duckduckgo.history.api.NavigationHistory
 import com.duckduckgo.js.messaging.api.JsCallbackData
+import com.duckduckgo.js.messaging.api.SubscriptionEventData
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.MALWARE
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.PHISHING
@@ -350,6 +352,7 @@ import com.duckduckgo.savedsites.impl.dialogs.EditSavedSiteDialogFragment.Delete
 import com.duckduckgo.savedsites.impl.dialogs.EditSavedSiteDialogFragment.EditSavedSiteListener
 import com.duckduckgo.serp.logos.api.SerpEasterEggLogosToggles
 import com.duckduckgo.serp.logos.api.SerpLogo
+import com.duckduckgo.settings.api.SettingsPageFeature
 import com.duckduckgo.site.permissions.api.SitePermissionsManager
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.LocationPermissionRequest
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.SitePermissionQueryResponse
@@ -365,6 +368,7 @@ import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.async
+import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -383,6 +387,7 @@ import kotlinx.coroutines.flow.flowOn
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.flow.receiveAsFlow
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
@@ -490,6 +495,8 @@ class BrowserTabViewModel @Inject constructor(
     private val addressBarTrackersAnimationFeatureToggle: AddressBarTrackersAnimationFeatureToggle,
     private val autoconsentPixelManager: AutoconsentPixelManager,
     private val omnibarFeatureRepository: OmnibarFeatureRepository,
+    private val contentScopeScriptsSubscriptionEventPluginPoint: PluginPoint<ContentScopeScriptsSubscriptionEventPlugin>,
+    private val settingsPageFeature: SettingsPageFeature,
 ) : ViewModel(),
     WebViewClientListener,
     EditSavedSiteListener,
@@ -539,6 +546,9 @@ class BrowserTabViewModel @Inject constructor(
 
     private var activeExperiments: List<Toggle>? = null
 
+    private val _subscriptionEventDataChannel = Channel<SubscriptionEventData>(capacity = Channel.BUFFERED)
+    val subscriptionEventDataFlow: Flow<SubscriptionEventData> = _subscriptionEventDataChannel.receiveAsFlow()
+
     data class HiddenBookmarksIds(
         val favorites: List<String> = emptyList(),
         val bookmarks: List<String> = emptyList(),
@@ -941,6 +951,14 @@ class BrowserTabViewModel @Inject constructor(
             lastFullSiteUrlEnabled = settingsDataStore.isFullUrlEnabled
             command.value = Command.RefreshOmnibar
         }
+
+        if (settingsPageFeature.serpSettingsSync().isEnabled()) {
+            viewModelScope.launch {
+                contentScopeScriptsSubscriptionEventPluginPoint.getPlugins().forEach { plugin ->
+                    _subscriptionEventDataChannel.send(plugin.getSubscriptionEventData())
+                }
+            }
+        }
     }
 
     fun onViewVisible() {