Properly store and inject activeExperiments

Author: CrisBarreiro

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

@@ -70,7 +70,6 @@ import com.duckduckgo.common.utils.AppUrl.ParamKey.QUERY
 import com.duckduckgo.common.utils.CurrentTimeProvider
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.common.utils.plugins.PluginPoint
-import com.duckduckgo.contentscopescripts.api.contentscopeExperiments.ContentScopeExperiments
 import com.duckduckgo.cookies.api.CookieManagerProvider
 import com.duckduckgo.duckchat.api.DuckChat
 import com.duckduckgo.duckplayer.api.DuckPlayer
@@ -125,7 +124,6 @@ class BrowserWebViewClient @Inject constructor(
     private val uriLoadedManager: UriLoadedManager,
     private val androidFeaturesHeaderPlugin: AndroidFeaturesHeaderPlugin,
     private val duckChat: DuckChat,
-    private val contentScopeExperiments: ContentScopeExperiments,
 ) : WebViewClient() {
 
     var webViewClientListener: WebViewClientListener? = null
@@ -441,10 +439,10 @@ class BrowserWebViewClient @Inject constructor(
         val navigationList = webView.safeCopyBackForwardList() ?: return
 
         appCoroutineScope.launch(dispatcherProvider.main()) {
-            val activeExperiments = contentScopeExperiments.getActiveExperiments()
-            webViewClientListener?.pageStarted(WebViewNavigationState(navigationList), activeExperiments)
-            jsPlugins.getPlugins().forEach {
-                it.onPageStarted(webView, url, webViewClientListener?.getSite()?.isDesktopMode, activeExperiments)
+            jsPlugins.getPlugins().map {
+                it.onPageStarted(webView, url, webViewClientListener?.getSite()?.isDesktopMode)
+            }.flatten().distinct().let { activeExperiments ->
+                webViewClientListener?.pageStarted(WebViewNavigationState(navigationList), activeExperiments)
             }
         }
         if (url != null && url == lastPageStarted) {
@@ -464,11 +462,8 @@ class BrowserWebViewClient @Inject constructor(
     }
 
     fun triggerJSInit(webView: WebView) {
-        appCoroutineScope.launch(dispatcherProvider.main()) {
-            val activeExperiments = contentScopeExperiments.getActiveExperiments()
-            jsPlugins.getPlugins().forEach {
-                it.onInit(webView, activeExperiments)
-            }
+        jsPlugins.getPlugins().forEach {
+            it.onInit(webView)
         }
     }
 
@@ -480,11 +475,9 @@ class BrowserWebViewClient @Inject constructor(
         // See https://app.asana.com/0/0/1206159443951489/f (WebView limitations)
         if (webView.progress == 100) {
             jsPlugins.getPlugins().forEach {
-                val activeExperiments = webViewClientListener?.getSite()?.activeContentScopeExperiments ?: listOf()
                 it.onPageFinished(
                     webView,
                     url,
-                    activeExperiments,
                 )
             }
 

browser-api/src/main/java/com/duckduckgo/browser/api/JsInjectorPlugin.kt

@@ -26,7 +26,6 @@ interface JsInjectorPlugin {
      */
     fun onInit(
         webView: WebView,
-        activeExperiments: List<Toggle>,
     )
 
     /**
@@ -36,15 +35,13 @@ interface JsInjectorPlugin {
         webView: WebView,
         url: String?,
         isDesktopMode: Boolean?,
-        activeExperiments: List<Toggle> = listOf(),
-    )
+    ): List<Toggle>
 
     /**
      * This method is called during onPageFinished and receives a [webView] instance, the [url] of the website and the [site]
      */
     fun onPageFinished(
         webView: WebView,
         url: String?,
-        activeExperiments: List<Toggle>,
     )
 }

content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsJsInjectorPlugin.kt

@@ -20,64 +20,79 @@ import android.webkit.WebView
 import androidx.webkit.ScriptHandler
 import androidx.webkit.WebViewCompat
 import androidx.webkit.WebViewFeature
+import com.duckduckgo.app.di.AppCoroutineScope
 import com.duckduckgo.browser.api.JsInjectorPlugin
+import com.duckduckgo.common.utils.DispatcherProvider
+import com.duckduckgo.contentscopescripts.api.contentscopeExperiments.ContentScopeExperiments
 import com.duckduckgo.di.scopes.AppScope
 import com.duckduckgo.feature.toggles.api.Toggle
 import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 
 @ContributesMultibinding(AppScope::class)
 class ContentScopeScriptsJsInjectorPlugin @Inject constructor(
     private val coreContentScopeScripts: CoreContentScopeScripts,
     private val adsJsContentScopeScripts: AdsJsContentScopeScripts,
+    private val contentScopeExperiments: ContentScopeExperiments,
+    @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
+    private val dispatcherProvider: DispatcherProvider,
 ) : JsInjectorPlugin {
     private var script: ScriptHandler? = null
     private var currentScriptString: String? = null
 
+    private var activeExperiments: List<Toggle> = emptyList()
+
     private fun reloadJSIfNeeded(
         webView: WebView,
-        activeExperiments: List<Toggle>,
     ) {
-        if (!WebViewFeature.isFeatureSupported(WebViewFeature.DOCUMENT_START_SCRIPT)) {
-            return
-        }
-        val scriptString = adsJsContentScopeScripts.getScript(activeExperiments)
-        if (scriptString == currentScriptString) {
-            return
-        }
-        script?.let {
-            it.remove()
-            script = null
-        }
-        if (coreContentScopeScripts.isEnabled()) {
-            currentScriptString = scriptString
-            script = WebViewCompat.addDocumentStartJavaScript(webView, scriptString, setOf("*"))
+        appCoroutineScope.launch(dispatcherProvider.io()) {
+            activeExperiments = contentScopeExperiments.getActiveExperiments()
+
+            withContext(dispatcherProvider.main()) {
+                if (!WebViewFeature.isFeatureSupported(WebViewFeature.DOCUMENT_START_SCRIPT)) {
+                    return@withContext
+                }
+                val scriptString = adsJsContentScopeScripts.getScript(activeExperiments)
+                if (scriptString == currentScriptString) {
+                    return@withContext
+                }
+                script?.let {
+                    it.remove()
+                    script = null
+                }
+                if (coreContentScopeScripts.isEnabled()) {
+                    currentScriptString = scriptString
+                    script = WebViewCompat.addDocumentStartJavaScript(webView, scriptString, setOf("*"))
+                }
+            }
         }
     }
 
     override fun onInit(
         webView: WebView,
-        activeExperiments: List<Toggle>,
     ) {
-        reloadJSIfNeeded(webView, activeExperiments)
+        reloadJSIfNeeded(webView)
     }
 
     override fun onPageStarted(
         webView: WebView,
         url: String?,
         isDesktopMode: Boolean?,
-        activeExperiments: List<Toggle>,
-    ) {
+    ): List<Toggle> {
         if (coreContentScopeScripts.isEnabled()) {
             webView.evaluateJavascript("javascript:${coreContentScopeScripts.getScript(isDesktopMode, activeExperiments)}", null)
+            return activeExperiments
         }
+        return listOf()
     }
 
     override fun onPageFinished(
         webView: WebView,
         url: String?,
-        activeExperiments: List<Toggle>,
     ) {
-        reloadJSIfNeeded(webView, activeExperiments)
+        reloadJSIfNeeded(webView)
     }
 }