Add plugins at the browser level

CrisBarreiro · CrisBarreiro · commit 02224573d0e2 · 2025-09-23T17:21:36.000+02:00
diff --git a/app/src/androidTest/java/com/duckduckgo/app/browser/BrowserWebViewClientTest.kt b/app/src/androidTest/java/com/duckduckgo/app/browser/BrowserWebViewClientTest.kt
@@ -87,7 +87,7 @@ import com.duckduckgo.history.api.NavigationHistory
 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
+import com.duckduckgo.js.messaging.api.WebMessaging
 import com.duckduckgo.js.messaging.api.WebViewCompatMessageCallback
 import com.duckduckgo.privacy.config.api.AmpLinks
 import com.duckduckgo.subscriptions.api.Subscriptions
@@ -1349,7 +1349,7 @@ class BrowserWebViewClientTest {
         override fun getPlugins() = listOf(plugin)
     }
 
-    class FakeWebMessagingPlugin : WebMessagingPlugin {
+    class FakeWebMessagingPlugin : WebMessaging {
         var registered = false
             private set
 
@@ -1371,10 +1371,10 @@ class BrowserWebViewClientTest {
             get() = "test"
     }
 
-    class FakeWebMessagingPluginPoint : PluginPoint<WebMessagingPlugin> {
+    class FakeWebMessagingPluginPoint : PluginPoint<WebMessaging> {
         val plugin = FakeWebMessagingPlugin()
 
-        override fun getPlugins(): Collection<WebMessagingPlugin> {
+        override fun getPlugins(): Collection<WebMessaging> {
             return listOf(plugin)
         }
     }
diff --git a/app/src/main/java/com/duckduckgo/app/browser/BrowserWebViewClient.kt b/app/src/main/java/com/duckduckgo/app/browser/BrowserWebViewClient.kt
@@ -67,6 +67,7 @@ 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.browser.api.WebMessagingBrowserPlugin
 import com.duckduckgo.common.utils.AppUrl.ParamKey.QUERY
 import com.duckduckgo.common.utils.CurrentTimeProvider
 import com.duckduckgo.common.utils.DispatcherProvider
@@ -82,7 +83,6 @@ import com.duckduckgo.duckplayer.impl.DUCK_PLAYER_OPEN_IN_YOUTUBE_PATH
 import com.duckduckgo.history.api.NavigationHistory
 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.privacy.config.api.AmpLinks
@@ -132,7 +132,7 @@ class BrowserWebViewClient @Inject constructor(
     private val duckChat: DuckChat,
     private val contentScopeExperiments: ContentScopeExperiments,
     private val addDocumentStartJavascriptPlugins: PluginPoint<AddDocumentStartJavaScriptPlugin>,
-    private val webMessagingPlugins: PluginPoint<WebMessagingPlugin>,
+    private val webMessagingPlugins: PluginPoint<WebMessagingBrowserPlugin>,
     private val postMessageWrapperPlugins: PluginPoint<PostMessageWrapperPlugin>,
 ) : WebViewClient() {
 
@@ -478,7 +478,7 @@ class BrowserWebViewClient @Inject constructor(
 
         callback?.let {
             webMessagingPlugins.getPlugins().forEach { plugin ->
-                plugin.register(callback, webView)
+                plugin.webMessaging().register(callback, webView)
             }
         }
     }
@@ -763,7 +763,7 @@ class BrowserWebViewClient @Inject constructor(
 
     fun destroy(webView: DuckDuckGoWebView) {
         webMessagingPlugins.getPlugins().forEach { plugin ->
-            plugin.unregister(webView)
+            plugin.webMessaging().unregister(webView)
         }
     }
 
diff --git a/app/src/main/java/com/duckduckgo/app/browser/messaging/ContentScopeScriptsWebMessagingBrowserPlugin.kt b/app/src/main/java/com/duckduckgo/app/browser/messaging/ContentScopeScriptsWebMessagingBrowserPlugin.kt
@@ -0,0 +1,39 @@
+/*
+ * 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.messaging
+
+import com.duckduckgo.browser.api.WebMessagingBrowserPlugin
+import com.duckduckgo.contentscopescripts.impl.messaging.ContentScopeScriptsWebMessaging
+import com.duckduckgo.di.scopes.FragmentScope
+import com.duckduckgo.js.messaging.api.WebMessaging
+import com.squareup.anvil.annotations.ContributesBinding
+import com.squareup.anvil.annotations.ContributesMultibinding
+import dagger.SingleInstanceIn
+import javax.inject.Inject
+import javax.inject.Named
+
+@Named("contentScopeScripts")
+@SingleInstanceIn(FragmentScope::class)
+@ContributesBinding(FragmentScope::class)
+@ContributesMultibinding(scope = FragmentScope::class, ignoreQualifier = true)
+class ContentScopeScriptsWebMessagingBrowserPlugin @Inject constructor(
+    private val contentScopeScriptsWebMessaging: ContentScopeScriptsWebMessaging,
+) : WebMessagingBrowserPlugin {
+    override fun webMessaging(): WebMessaging {
+        return contentScopeScriptsWebMessaging
+    }
+}
diff --git a/app/src/main/java/com/duckduckgo/app/plugins/WebMessagingBrowserPluginPoint.kt b/app/src/main/java/com/duckduckgo/app/plugins/WebMessagingBrowserPluginPoint.kt
@@ -17,12 +17,12 @@
 package com.duckduckgo.app.plugins
 
 import com.duckduckgo.anvil.annotations.ContributesPluginPoint
+import com.duckduckgo.browser.api.WebMessagingBrowserPlugin
 import com.duckduckgo.di.scopes.AppScope
-import com.duckduckgo.js.messaging.api.WebMessagingPlugin
 
 @ContributesPluginPoint(
     scope = AppScope::class,
-    boundType = WebMessagingPlugin::class,
+    boundType = WebMessagingBrowserPlugin::class,
 )
 @Suppress("unused")
-interface UnusedWebMessagingPluginPoint
+interface UnusedWebMessagingBrowserPluginPoint
diff --git a/browser-api/src/main/java/com/duckduckgo/browser/api/WebMessagingBrowserPlugin.kt b/browser-api/src/main/java/com/duckduckgo/browser/api/WebMessagingBrowserPlugin.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.WebMessaging
+
+interface WebMessagingBrowserPlugin {
+    fun webMessaging(): WebMessaging
+}
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsPostMessageWrapperPlugin.kt b/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsPostMessageWrapperPlugin.kt
@@ -26,7 +26,7 @@ import com.duckduckgo.js.messaging.api.JsMessageHelper
 import com.duckduckgo.js.messaging.api.PostMessageWrapperPlugin
 import com.duckduckgo.js.messaging.api.SubscriptionEvent
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
-import com.duckduckgo.js.messaging.api.WebMessagingPlugin
+import com.duckduckgo.js.messaging.api.WebMessaging
 import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
 import javax.inject.Named
@@ -35,7 +35,7 @@ import kotlinx.coroutines.launch
 
 @ContributesMultibinding(FragmentScope::class)
 class ContentScopeScriptsPostMessageWrapperPlugin @Inject constructor(
-    @Named("contentScopeScripts") private val webMessagingPlugin: WebMessagingPlugin,
+    @Named("contentScopeScripts") private val webMessaging: WebMessaging,
     private val jsMessageHelper: JsMessageHelper,
     private val coreContentScopeScripts: CoreContentScopeScripts,
     private val webViewCompatContentScopeScripts: WebViewCompatContentScopeScripts,
@@ -45,11 +45,11 @@ class ContentScopeScriptsPostMessageWrapperPlugin @Inject constructor(
     override fun postMessage(message: SubscriptionEventData, webView: WebView) {
         coroutineScope.launch {
             if (webViewCompatContentScopeScripts.isEnabled()) {
-                webMessagingPlugin.postMessage(message)
+                webMessaging.postMessage(message)
             } else {
                 jsMessageHelper.sendSubscriptionEvent(
                     subscriptionEvent = SubscriptionEvent(
-                        context = webMessagingPlugin.context,
+                        context = webMessaging.context,
                         featureName = message.featureName,
                         subscriptionName = message.subscriptionName,
                         params = message.params,
@@ -63,5 +63,5 @@ class ContentScopeScriptsPostMessageWrapperPlugin @Inject constructor(
     }
 
     override val context: String
-        get() = webMessagingPlugin.context
+        get() = webMessaging.context
 }
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessaging.kt b/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessaging.kt
@@ -21,27 +21,25 @@ import com.duckduckgo.contentscopescripts.api.WebViewCompatContentScopeJsMessage
 import com.duckduckgo.contentscopescripts.impl.WebViewCompatContentScopeScripts
 import com.duckduckgo.di.scopes.FragmentScope
 import com.duckduckgo.js.messaging.api.GlobalJsMessageHandler
-import com.duckduckgo.js.messaging.api.WebMessagingPlugin
-import com.duckduckgo.js.messaging.api.WebMessagingPluginDelegate
-import com.duckduckgo.js.messaging.api.WebMessagingPluginStrategy
+import com.duckduckgo.js.messaging.api.WebMessaging
+import com.duckduckgo.js.messaging.api.WebMessagingDelegate
+import com.duckduckgo.js.messaging.api.WebMessagingStrategy
 import com.duckduckgo.js.messaging.api.WebViewCompatMessageHandler
 import com.squareup.anvil.annotations.ContributesBinding
-import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.SingleInstanceIn
 import javax.inject.Inject
 import javax.inject.Named
 
 @Named("contentScopeScripts")
 @SingleInstanceIn(FragmentScope::class)
 @ContributesBinding(FragmentScope::class)
-@ContributesMultibinding(scope = FragmentScope::class, ignoreQualifier = true)
-class ContentScopeScriptsWebMessagingPlugin @Inject constructor(
+class ContentScopeScriptsWebMessaging @Inject constructor(
     handlers: PluginPoint<WebViewCompatContentScopeJsMessageHandlersPlugin>,
     globalHandlers: PluginPoint<GlobalContentScopeJsMessageHandlersPlugin>,
     webViewCompatContentScopeScripts: WebViewCompatContentScopeScripts,
-    webMessagingPluginDelegate: WebMessagingPluginDelegate,
-) : WebMessagingPlugin by webMessagingPluginDelegate.createPlugin(
-    object : WebMessagingPluginStrategy {
+    webMessagingDelegate: WebMessagingDelegate,
+) : WebMessaging by webMessagingDelegate.createPlugin(
+    object : WebMessagingStrategy {
         override val context: String = "contentScopeScripts"
         override val allowedDomains: Set<String> = setOf("*")
         override val objectName: String
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsAddDocumentStartJavaScriptTest.kt b/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/ContentScopeScriptsAddDocumentStartJavaScriptTest.kt
@@ -5,6 +5,7 @@ import com.duckduckgo.app.browser.api.WebViewCapabilityChecker
 import com.duckduckgo.browser.api.webviewcompat.WebViewCompatWrapper
 import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.contentscopescripts.api.contentscopeExperiments.ContentScopeExperiments
+import com.duckduckgo.js.messaging.api.AddDocumentStartScriptDelegate
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
 import org.junit.Rule
@@ -25,6 +26,7 @@ class ContentScopeScriptsAddDocumentStartJavaScriptTest {
     private val mockWebViewCompatWrapper: WebViewCompatWrapper = mock()
     private val mockWebView: WebView = mock()
     private val mockActiveContentScopeExperiments: ContentScopeExperiments = mock()
+    private val mockScriptInjectorDelegate: AddDocumentStartScriptDelegate = mock()
 
     private lateinit var testee: ContentScopeScriptsAddDocumentStartJavaScript
 
@@ -33,11 +35,8 @@ class ContentScopeScriptsAddDocumentStartJavaScriptTest {
         whenever(mockActiveContentScopeExperiments.getActiveExperiments()).thenReturn(listOf())
         testee = ContentScopeScriptsAddDocumentStartJavaScript(
             mockWebViewCompatContentScopeScripts,
-            coroutineRule.testDispatcherProvider,
-            mockWebViewCapabilityChecker,
-            mockWebViewCompatWrapper,
             mockActiveContentScopeExperiments,
-            coroutineRule.testScope,
+            mockScriptInjectorDelegate,
         )
     }
 
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsPostMessageWrapperPluginTest.kt b/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsPostMessageWrapperPluginTest.kt
@@ -7,7 +7,7 @@ import com.duckduckgo.contentscopescripts.impl.WebViewCompatContentScopeScripts
 import com.duckduckgo.js.messaging.api.JsMessageHelper
 import com.duckduckgo.js.messaging.api.SubscriptionEvent
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
-import com.duckduckgo.js.messaging.api.WebMessagingPlugin
+import com.duckduckgo.js.messaging.api.WebMessaging
 import kotlinx.coroutines.test.runTest
 import org.json.JSONObject
 import org.junit.Before
@@ -23,7 +23,7 @@ class ContentScopeScriptsPostMessageWrapperPluginTest {
     @get:Rule
     var coroutineRule = CoroutineTestRule()
 
-    private val mockWebMessagingPlugin: WebMessagingPlugin = mock()
+    private val mockWebMessaging: WebMessaging = mock()
     private val mockJsHelper: JsMessageHelper = mock()
     private val mockCoreContentScopeScripts: CoreContentScopeScripts = mock()
     private val mockWebViewCompatContentScopeScripts: WebViewCompatContentScopeScripts = mock()
@@ -42,7 +42,7 @@ class ContentScopeScriptsPostMessageWrapperPluginTest {
     )
 
     val testee = ContentScopeScriptsPostMessageWrapperPlugin(
-        webMessagingPlugin = mockWebMessagingPlugin,
+        webMessaging = mockWebMessaging,
         jsMessageHelper = mockJsHelper,
         coreContentScopeScripts = mockCoreContentScopeScripts,
         webViewCompatContentScopeScripts = mockWebViewCompatContentScopeScripts,
@@ -53,7 +53,7 @@ class ContentScopeScriptsPostMessageWrapperPluginTest {
     fun setup() {
         whenever(mockCoreContentScopeScripts.callbackName).thenReturn("callbackName")
         whenever(mockCoreContentScopeScripts.secret).thenReturn("secret")
-        whenever(mockWebMessagingPlugin.context).thenReturn("contentScopeScripts")
+        whenever(mockWebMessaging.context).thenReturn("contentScopeScripts")
         whenever(mockJsonObject.toString()).thenReturn("{}")
     }
 
@@ -63,7 +63,7 @@ class ContentScopeScriptsPostMessageWrapperPluginTest {
 
         testee.postMessage(subscriptionEventData, mockWebView)
 
-        verify(mockWebMessagingPlugin).postMessage(subscriptionEventData)
+        verify(mockWebMessaging).postMessage(subscriptionEventData)
     }
 
     @Test
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessagingTest.kt b/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessagingTest.kt
@@ -46,7 +46,7 @@ import org.mockito.kotlin.verify
 import org.mockito.kotlin.whenever
 
 @RunWith(AndroidJUnit4::class)
-class ContentScopeScriptsWebMessagingPluginTest {
+class ContentScopeScriptsWebMessagingTest {
 
     @get:Rule
     val coroutineRule = CoroutineTestRule()
@@ -57,7 +57,7 @@ class ContentScopeScriptsWebMessagingPluginTest {
     private val globalHandlers: PluginPoint<GlobalContentScopeJsMessageHandlersPlugin> = FakeGlobalHandlersPluginPoint()
     private val mockWebViewCompatWrapper: WebViewCompatWrapper = mock()
     private val mockWebView: WebView = mock()
-    private lateinit var testee: ContentScopeScriptsWebMessagingPlugin
+    private lateinit var testee: ContentScopeScriptsWebMessaging
 
     private class FakePluginPoint : PluginPoint<WebViewCompatContentScopeJsMessageHandlersPlugin> {
         override fun getPlugins(): Collection<WebViewCompatContentScopeJsMessageHandlersPlugin> {
@@ -105,7 +105,7 @@ class ContentScopeScriptsWebMessagingPluginTest {
     @Before
     fun setUp() = runTest {
         whenever(webViewCompatContentScopeScripts.isEnabled()).thenReturn(true)
-        testee = ContentScopeScriptsWebMessagingPlugin(
+        testee = ContentScopeScriptsWebMessaging(
             handlers = handlers,
             globalHandlers = globalHandlers,
             webViewCompatContentScopeScripts = webViewCompatContentScopeScripts,
diff --git a/js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/WebMessaging.kt b/js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/WebMessaging.kt
@@ -18,7 +18,7 @@ package com.duckduckgo.js.messaging.api
 
 import android.webkit.WebView
 
-interface WebMessagingPlugin {
+interface WebMessaging {
     fun register(
         jsMessageCallback: WebViewCompatMessageCallback,
         webView: WebView,
@@ -33,21 +33,21 @@ interface WebMessagingPlugin {
     val context: String
 }
 
-interface WebMessagingPluginDelegate {
+interface WebMessagingDelegate {
 
     /**
-     * Creates a [WebMessagingPlugin] implementation with the given [WebMessagingPluginStrategy].
+     * Creates a [WebMessaging] implementation with the given [WebMessagingStrategy].
      * @param strategy the strategy to use for web messaging behavior
-     * @return [WebMessagingPlugin] implementation
+     * @return [WebMessaging] implementation
      */
-    fun createPlugin(strategy: WebMessagingPluginStrategy): WebMessagingPlugin
+    fun createPlugin(strategy: WebMessagingStrategy): WebMessaging
 }
 
 /**
  * Strategy interface for web messaging logic.
  * Allows different implementations to provide their own behavior.
  */
-interface WebMessagingPluginStrategy {
+interface WebMessagingStrategy {
     val context: String
     val allowedDomains: Set<String>
     val objectName: String
diff --git a/js-messaging/js-messaging-impl/src/main/java/com/duckduckgo/js/messaging/impl/RealWebMessagingDelegate.kt b/js-messaging/js-messaging-impl/src/main/java/com/duckduckgo/js/messaging/impl/RealWebMessagingDelegate.kt
@@ -30,9 +30,9 @@ import com.duckduckgo.js.messaging.api.ProcessResult.SendResponse
 import com.duckduckgo.js.messaging.api.ProcessResult.SendToConsumer
 import com.duckduckgo.js.messaging.api.SubscriptionEvent
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
-import com.duckduckgo.js.messaging.api.WebMessagingPlugin
-import com.duckduckgo.js.messaging.api.WebMessagingPluginDelegate
-import com.duckduckgo.js.messaging.api.WebMessagingPluginStrategy
+import com.duckduckgo.js.messaging.api.WebMessaging
+import com.duckduckgo.js.messaging.api.WebMessagingDelegate
+import com.duckduckgo.js.messaging.api.WebMessagingStrategy
 import com.duckduckgo.js.messaging.api.WebViewCompatMessageCallback
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.moshi.Moshi
@@ -50,9 +50,9 @@ class RealWebMessagingDelegate @Inject constructor(
     private val webViewCompatWrapper: WebViewCompatWrapper,
     private val dispatcherProvider: DispatcherProvider,
     @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
-) : WebMessagingPluginDelegate {
-    override fun createPlugin(strategy: WebMessagingPluginStrategy): WebMessagingPlugin {
-        return object : WebMessagingPlugin {
+) : WebMessagingDelegate {
+    override fun createPlugin(strategy: WebMessagingStrategy): WebMessaging {
+        return object : WebMessaging {
             private val moshi = Moshi.Builder().add(JSONObjectAdapter()).build()
 
             private var globalReplyProxy: JavaScriptReplyProxy? = null
