Add plugins at the browser level

Author: CrisBarreiro

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

@@ -84,7 +84,7 @@ import com.duckduckgo.duckplayer.api.DuckPlayer.OpenDuckPlayerInNewTab.On
 import com.duckduckgo.duckplayer.api.DuckPlayer.OpenDuckPlayerInNewTab.Unavailable
 import com.duckduckgo.feature.toggles.api.Toggle
 import com.duckduckgo.history.api.NavigationHistory
-import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptPlugin
+import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScript
 import com.duckduckgo.js.messaging.api.PostMessageWrapperPlugin
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
 import com.duckduckgo.js.messaging.api.WebMessagingPlugin
@@ -1330,7 +1330,7 @@ class BrowserWebViewClientTest {
         const val EXAMPLE_URL = "https://example.com"
     }
 
-    class FakeAddDocumentStartJavaScriptPlugin : AddDocumentStartJavaScriptPlugin {
+    class FakeAddDocumentStartJavaScript : AddDocumentStartJavaScript {
 
         var countInitted = 0
             private set
@@ -1342,9 +1342,9 @@ class BrowserWebViewClientTest {
         }
     }
 
-    class FakeAddDocumentStartJavaScriptPluginPoint : PluginPoint<AddDocumentStartJavaScriptPlugin> {
+    class FakeAddDocumentStartJavaScriptPluginPoint : PluginPoint<AddDocumentStartJavaScript> {
 
-        val plugin = FakeAddDocumentStartJavaScriptPlugin()
+        val plugin = FakeAddDocumentStartJavaScript()
 
         override fun getPlugins() = listOf(plugin)
     }

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

@@ -65,6 +65,7 @@ import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.autoconsent.api.Autoconsent
 import com.duckduckgo.autofill.api.BrowserAutofill
 import com.duckduckgo.autofill.api.InternalTestUserChecker
+import com.duckduckgo.browser.api.AddDocumentStartJavaScriptPlugin
 import com.duckduckgo.browser.api.JsInjectorPlugin
 import com.duckduckgo.common.utils.AppUrl.ParamKey.QUERY
 import com.duckduckgo.common.utils.CurrentTimeProvider
@@ -79,7 +80,6 @@ import com.duckduckgo.duckplayer.api.DuckPlayer.DuckPlayerState.ENABLED
 import com.duckduckgo.duckplayer.api.DuckPlayer.OpenDuckPlayerInNewTab.On
 import com.duckduckgo.duckplayer.impl.DUCK_PLAYER_OPEN_IN_YOUTUBE_PATH
 import com.duckduckgo.history.api.NavigationHistory
-import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptPlugin
 import com.duckduckgo.js.messaging.api.PostMessageWrapperPlugin
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
 import com.duckduckgo.js.messaging.api.WebMessagingPlugin
@@ -473,7 +473,7 @@ class BrowserWebViewClient @Inject constructor(
 
     fun configureWebView(webView: DuckDuckGoWebView, callback: WebViewCompatMessageCallback?) {
         addDocumentStartJavascriptPlugins.getPlugins().forEach { plugin ->
-            plugin.addDocumentStartJavaScript(webView)
+            plugin.addDocumentStartJavaScript().addDocumentStartJavaScript(webView)
         }
 
         callback?.let {
@@ -497,7 +497,7 @@ class BrowserWebViewClient @Inject constructor(
                 )
             }
             addDocumentStartJavascriptPlugins.getPlugins().forEach {
-                it.addDocumentStartJavaScript(
+                it.addDocumentStartJavaScript().addDocumentStartJavaScript(
                     webView,
                 )
             }

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

@@ -0,0 +1,33 @@
+/*
+ * 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.browser
+
+import com.duckduckgo.browser.api.AddDocumentStartJavaScriptPlugin
+import com.duckduckgo.contentscopescripts.impl.ContentScopeScriptsAddDocumentStartJavaScript
+import com.duckduckgo.di.scopes.FragmentScope
+import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScript
+import com.squareup.anvil.annotations.ContributesMultibinding
+import javax.inject.Inject
+
+@ContributesMultibinding(FragmentScope::class)
+class ContentScopeScriptsAddDocumentStartJavaScriptPlugin @Inject constructor(
+    private val contentScopeScriptsAddDocumentStartJavaScript: ContentScopeScriptsAddDocumentStartJavaScript,
+) : AddDocumentStartJavaScriptPlugin {
+    override fun addDocumentStartJavaScript(): AddDocumentStartJavaScript {
+        return contentScopeScriptsAddDocumentStartJavaScript
+    }
+}

app/src/main/java/com/duckduckgo/app/plugins/AddDocumentStartJavaScriptPluginPoint.kt

@@ -17,8 +17,8 @@
 package com.duckduckgo.app.plugins
 
 import com.duckduckgo.anvil.annotations.ContributesPluginPoint
+import com.duckduckgo.browser.api.AddDocumentStartJavaScriptPlugin
 import com.duckduckgo.di.scopes.AppScope
-import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptPlugin
 
 @ContributesPluginPoint(
     scope = AppScope::class,

browser-api/build.gradle

@@ -26,6 +26,7 @@ dependencies {
     implementation project(path: ':design-system')
     implementation project(path: ':common-utils')
     implementation project(':feature-toggles-api')
+    implementation project(':js-messaging-api')
     implementation AndroidX.core.ktx
     implementation AndroidX.webkit
     implementation KotlinX.coroutines.core

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

@@ -0,0 +1,23 @@
+/*
+ * 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.browser.api
+
+import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScript
+
+interface AddDocumentStartJavaScriptPlugin {
+    fun addDocumentStartJavaScript(): AddDocumentStartJavaScript
+}

content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsAddDocumentStartJavaScriptPlugin.kt renamed to content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsAddDocumentStartJavaScript.kt

@@ -18,20 +18,18 @@ package com.duckduckgo.contentscopescripts.impl
 
 import com.duckduckgo.contentscopescripts.api.contentscopeExperiments.ContentScopeExperiments
 import com.duckduckgo.di.scopes.FragmentScope
-import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptPlugin
+import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScript
 import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptScriptStrategy
 import com.duckduckgo.js.messaging.api.AddDocumentStartScriptDelegate
-import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.SingleInstanceIn
 import javax.inject.Inject
 
 @SingleInstanceIn(FragmentScope::class)
-@ContributesMultibinding(FragmentScope::class)
-class ContentScopeScriptsAddDocumentStartJavaScriptPlugin @Inject constructor(
+class ContentScopeScriptsAddDocumentStartJavaScript @Inject constructor(
     webViewCompatContentScopeScripts: WebViewCompatContentScopeScripts,
     contentScopeExperiments: ContentScopeExperiments,
     scriptInjectorDelegate: AddDocumentStartScriptDelegate,
-) : AddDocumentStartJavaScriptPlugin by scriptInjectorDelegate.createPlugin(
+) : AddDocumentStartJavaScript by scriptInjectorDelegate.createPlugin(
     object : AddDocumentStartJavaScriptScriptStrategy {
         override suspend fun canInject(): Boolean {
             return webViewCompatContentScopeScripts.isEnabled()

content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsAddDocumentStartJavaScriptPluginTest.kt renamed to content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsAddDocumentStartJavaScriptTest.kt

@@ -15,7 +15,7 @@ import org.mockito.kotlin.never
 import org.mockito.kotlin.verify
 import org.mockito.kotlin.whenever
 
-class ContentScopeScriptsAddDocumentStartJavaScriptPluginTest {
+class ContentScopeScriptsAddDocumentStartJavaScriptTest {
 
     @get:Rule
     var coroutineRule = CoroutineTestRule()
@@ -26,12 +26,12 @@ class ContentScopeScriptsAddDocumentStartJavaScriptPluginTest {
     private val mockWebView: WebView = mock()
     private val mockActiveContentScopeExperiments: ContentScopeExperiments = mock()
 
-    private lateinit var testee: ContentScopeScriptsAddDocumentStartJavaScriptPlugin
+    private lateinit var testee: ContentScopeScriptsAddDocumentStartJavaScript
 
     @Before
     fun setUp() = runTest {
         whenever(mockActiveContentScopeExperiments.getActiveExperiments()).thenReturn(listOf())
-        testee = ContentScopeScriptsAddDocumentStartJavaScriptPlugin(
+        testee = ContentScopeScriptsAddDocumentStartJavaScript(
             mockWebViewCompatContentScopeScripts,
             coroutineRule.testDispatcherProvider,
             mockWebViewCapabilityChecker,

js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/AddDocumentStartJavaScriptPlugin.kt renamed to js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/AddDocumentStartJavaScript.kt

@@ -23,7 +23,7 @@ import android.webkit.WebView
  * * Allows plugins to inject JavaScript that will be executed before any other scripts on the page.
  * Useful for privacy protections and that need to run as early as possible and/or on iframes.
  */
-interface AddDocumentStartJavaScriptPlugin {
+interface AddDocumentStartJavaScript {
 
     fun addDocumentStartJavaScript(
         webView: WebView,
@@ -58,7 +58,7 @@ interface AddDocumentStartScriptDelegate {
     /**
      * Creates an AddDocumentStartJavaScriptPlugin implementation with the given [AddDocumentStartJavaScriptScriptStrategy].
      * @param strategy the strategy to use for determining injection behavior
-     * @return [AddDocumentStartJavaScriptPlugin] implementation
+     * @return [AddDocumentStartJavaScript] implementation
      */
-    fun createPlugin(strategy: AddDocumentStartJavaScriptScriptStrategy): AddDocumentStartJavaScriptPlugin
+    fun createPlugin(strategy: AddDocumentStartJavaScriptScriptStrategy): AddDocumentStartJavaScript
 }

js-messaging/js-messaging-impl/src/main/java/com/duckduckgo/js/messaging/impl/RealAddDocumentStartScriptDelegate.kt

@@ -24,7 +24,7 @@ import com.duckduckgo.app.di.AppCoroutineScope
 import com.duckduckgo.browser.api.webviewcompat.WebViewCompatWrapper
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.di.scopes.AppScope
-import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptPlugin
+import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScript
 import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScriptScriptStrategy
 import com.duckduckgo.js.messaging.api.AddDocumentStartScriptDelegate
 import com.squareup.anvil.annotations.ContributesBinding
@@ -45,8 +45,8 @@ class RealAddDocumentStartScriptDelegate @Inject constructor(
     private val webViewCompatWrapper: WebViewCompatWrapper,
 ) : AddDocumentStartScriptDelegate {
 
-    override fun createPlugin(strategy: AddDocumentStartJavaScriptScriptStrategy): AddDocumentStartJavaScriptPlugin {
-        return object : AddDocumentStartJavaScriptPlugin {
+    override fun createPlugin(strategy: AddDocumentStartJavaScriptScriptStrategy): AddDocumentStartJavaScript {
+        return object : AddDocumentStartJavaScript {
 
             private var script: ScriptHandler? = null
             private var currentScriptString: String? = null