Add plugins at the browser level

Author: CrisBarreiro

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

@@ -210,6 +210,7 @@ import com.duckduckgo.brokensite.api.BrokenSitePrompt
 import com.duckduckgo.brokensite.api.RefreshPattern
 import com.duckduckgo.browser.api.AddDocumentStartJavaScriptBrowserPlugin
 import com.duckduckgo.browser.api.UserBrowserProperties
+import com.duckduckgo.browser.api.WebMessagingBrowserPlugin
 import com.duckduckgo.browser.api.autocomplete.AutoComplete
 import com.duckduckgo.browser.api.autocomplete.AutoComplete.AutoCompleteSuggestion.AutoCompleteDefaultSuggestion
 import com.duckduckgo.browser.api.autocomplete.AutoComplete.AutoCompleteSuggestion.AutoCompleteHistoryRelatedSuggestion.AutoCompleteHistorySearchSuggestion
@@ -260,7 +261,7 @@ import com.duckduckgo.js.messaging.api.AddDocumentStartJavaScript
 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.WebMessaging
 import com.duckduckgo.js.messaging.api.WebViewCompatMessageCallback
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.MALWARE
@@ -613,7 +614,7 @@ class BrowserTabViewModelTest {
     private val mockWebView: WebView = mock()
 
     private val fakeAddDocumentStartJavaScriptPlugins = FakeAddDocumentStartJavaScriptPluginPoint()
-    private val fakeMessagingPlugins = FakeWebMessagingPluginPoint()
+    private val fakeMessagingPlugins = FakeWebMessagingBrowserPluginPoint()
     private val fakePostMessageWrapperPlugins = FakePostMessageWrapperPluginPoint()
 
     @Before
@@ -7526,11 +7527,11 @@ class BrowserTabViewModelTest {
         runTest {
             val mockCallback = mock<WebViewCompatMessageCallback>()
             val webView = DuckDuckGoWebView(context)
-            assertFalse(fakeMessagingPlugins.plugin.registered)
+            assertFalse(fakeMessagingPlugins.plugin.webMessaging().registered)
 
             testee.configureWebView(webView, mockCallback)
 
-            assertTrue(fakeMessagingPlugins.plugin.registered)
+            assertTrue(fakeMessagingPlugins.plugin.webMessaging().registered)
         }
 
     @UiThreadTest
@@ -7862,35 +7863,40 @@ class BrowserTabViewModelTest {
         override fun getPlugins(): Collection<PostMessageWrapperPlugin> = listOf(plugin)
     }
 
-    class FakeWebMessagingPlugin : WebMessagingPlugin {
+    class FakeWebMessaging : WebMessaging {
         var registered = false
             private set
 
         override suspend fun unregister(webView: WebView) {
             registered = false
         }
-
         override suspend fun register(
             jsMessageCallback: WebViewCompatMessageCallback,
             webView: WebView,
         ) {
             registered = true
         }
-
         override suspend fun postMessage(
             webView: WebView,
             subscriptionEventData: SubscriptionEventData,
         ) {
         }
-
         override val context: String
             get() = "test"
     }
 
-    class FakeWebMessagingPluginPoint : PluginPoint<WebMessagingPlugin> {
-        val plugin = FakeWebMessagingPlugin()
+    class FakeWebMessagingBrowserPlugin : WebMessagingBrowserPlugin {
+        private val webMessaging = FakeWebMessaging()
 
-        override fun getPlugins(): Collection<WebMessagingPlugin> = listOf(plugin)
+        override fun webMessaging(): FakeWebMessaging = webMessaging
+    }
+
+    class FakeWebMessagingBrowserPluginPoint : PluginPoint<WebMessagingBrowserPlugin> {
+        val plugin = FakeWebMessagingBrowserPlugin()
+
+        override fun getPlugins(): Collection<WebMessagingBrowserPlugin> {
+            return listOf(plugin)
+        }
     }
 
     class FakePostMessageWrapperPlugin : PostMessageWrapperPlugin {

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

@@ -276,6 +276,7 @@ import com.duckduckgo.brokensite.api.BrokenSitePrompt
 import com.duckduckgo.brokensite.api.RefreshPattern
 import com.duckduckgo.browser.api.AddDocumentStartJavaScriptBrowserPlugin
 import com.duckduckgo.browser.api.UserBrowserProperties
+import com.duckduckgo.browser.api.WebMessagingBrowserPlugin
 import com.duckduckgo.browser.api.autocomplete.AutoComplete
 import com.duckduckgo.browser.api.autocomplete.AutoComplete.AutoCompleteResult
 import com.duckduckgo.browser.api.autocomplete.AutoComplete.AutoCompleteSuggestion
@@ -323,7 +324,6 @@ import com.duckduckgo.history.api.NavigationHistory
 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
@@ -490,7 +490,7 @@ class BrowserTabViewModel @Inject constructor(
     private val vpnMenuStateProvider: VpnMenuStateProvider,
     private val webViewCompatWrapper: WebViewCompatWrapper,
     private val addDocumentStartJavascriptPlugins: PluginPoint<AddDocumentStartJavaScriptBrowserPlugin>,
-    private val webMessagingPlugins: PluginPoint<WebMessagingPlugin>,
+    private val webMessagingPlugins: PluginPoint<WebMessagingBrowserPlugin>,
     private val postMessageWrapperPlugins: PluginPoint<PostMessageWrapperPlugin>,
 ) : ViewModel(),
     WebViewClientListener,
@@ -4228,7 +4228,7 @@ class BrowserTabViewModel @Inject constructor(
 
             callback?.let {
                 webMessagingPlugins.getPlugins().forEach { plugin ->
-                    plugin.register(callback, webView)
+                    plugin.webMessaging().register(callback, webView)
                 }
             }
         }
@@ -4247,8 +4247,8 @@ class BrowserTabViewModel @Inject constructor(
     }
 
     private suspend fun addDocumentStartJavaScript(webView: WebView) {
-        addDocumentStartJavascriptPlugins.getPlugins().addDocumentStartJavaScript().forEach {
-            it.addDocumentStartJavaScript(
+        addDocumentStartJavascriptPlugins.getPlugins().forEach {
+            it.addDocumentStartJavaScript().addDocumentStartJavaScript(
                 webView,
             )
         }
@@ -4258,7 +4258,7 @@ class BrowserTabViewModel @Inject constructor(
         if (withContext(dispatchers.io()) { !androidBrowserConfig.updateScriptOnPageFinished().isEnabled() }) {
             addDocumentStartJavascriptPlugins
                 .getPlugins()
-                .addDocumentStartJavaScript()
+                .map { it.addDocumentStartJavaScript() }
                 .filter { plugin ->
                     (plugin.context == "contentScopeScripts")
                 }.forEach {

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
+    }
+}

app/src/main/java/com/duckduckgo/app/plugins/WebMessagingPluginPoint.kt renamed to 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

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
+}

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

@@ -25,14 +25,14 @@ 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
 
 @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,
@@ -43,11 +43,11 @@ class ContentScopeScriptsPostMessageWrapperPlugin @Inject constructor(
         webView: WebView,
     ) {
         if (webViewCompatContentScopeScripts.isEnabled()) {
-            webMessagingPlugin.postMessage(webView, message)
+            webMessaging.postMessage(webView, message)
         } else {
             jsMessageHelper.sendSubscriptionEvent(
                 subscriptionEvent = SubscriptionEvent(
-                    context = webMessagingPlugin.context,
+                    context = webMessaging.context,
                     featureName = message.featureName,
                     subscriptionName = message.subscriptionName,
                     params = message.params,
@@ -60,5 +60,5 @@ class ContentScopeScriptsPostMessageWrapperPlugin @Inject constructor(
     }
 
     override val context: String
-        get() = webMessagingPlugin.context
+        get() = webMessaging.context
 }

content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessagingPlugin.kt renamed to 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

content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsPostMessageWrapperPluginTest.kt

@@ -6,7 +6,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
@@ -17,7 +17,7 @@ import org.mockito.kotlin.verify
 import org.mockito.kotlin.whenever
 
 class ContentScopeScriptsPostMessageWrapperPluginTest {
-    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()
@@ -39,7 +39,7 @@ class ContentScopeScriptsPostMessageWrapperPluginTest {
 
     val testee =
         ContentScopeScriptsPostMessageWrapperPlugin(
-            webMessagingPlugin = mockWebMessagingPlugin,
+            webMessaging = mockWebMessaging,
             jsMessageHelper = mockJsHelper,
             coreContentScopeScripts = mockCoreContentScopeScripts,
             webViewCompatContentScopeScripts = mockWebViewCompatContentScopeScripts,
@@ -49,7 +49,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("{}")
     }
 
@@ -60,8 +60,8 @@ class ContentScopeScriptsPostMessageWrapperPluginTest {
 
             testee.postMessage(subscriptionEventData, mockWebView)
 
-            verify(mockWebMessagingPlugin).postMessage(mockWebView, subscriptionEventData)
-        }
+        verify(mockWebMessaging).postMessage(mockWebView, subscriptionEventData)
+    }
 
     @Test
     fun whenWebViewCompatContentScopeScriptsIsNotEnabledThenPostMessageToContentScopeScriptsJsMessaging() =

content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessagingPluginTest.kt renamed to content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsWebMessagingTest.kt

@@ -46,7 +46,8 @@ import org.mockito.kotlin.verify
 import org.mockito.kotlin.whenever
 
 @RunWith(AndroidJUnit4::class)
-class ContentScopeScriptsWebMessagingPluginTest {
+class ContentScopeScriptsWebMessagingTest {
+
     @get:Rule
     val coroutineRule = CoroutineTestRule()
 
@@ -56,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> = listOf(FakePlugin())
@@ -86,17 +87,15 @@ class ContentScopeScriptsWebMessagingPluginTest {
     }
 
     @Before
-    fun setUp() =
-        runTest {
-            whenever(webViewCompatContentScopeScripts.isEnabled()).thenReturn(true)
-            testee =
-                ContentScopeScriptsWebMessagingPlugin(
-                    handlers = handlers,
-                    globalHandlers = globalHandlers,
-                    webViewCompatContentScopeScripts = webViewCompatContentScopeScripts,
-                    webViewCompatWrapper = mockWebViewCompatWrapper,
-                )
-        }
+    fun setUp() = runTest {
+        whenever(webViewCompatContentScopeScripts.isEnabled()).thenReturn(true)
+        testee = ContentScopeScriptsWebMessaging(
+            handlers = handlers,
+            globalHandlers = globalHandlers,
+            webViewCompatContentScopeScripts = webViewCompatContentScopeScripts,
+            webViewCompatWrapper = mockWebViewCompatWrapper,
+        )
+    }
 
     @Test
     fun `when process and message can be handled then execute callback`() =