Also use existing DuckDuckGoWebView methods for messages

CrisBarreiro · CrisBarreiro · commit e629a4832170 · 2025-08-28T16:17:59.000+02:00
diff --git a/app/src/main/java/com/duckduckgo/app/browser/BrowserTabFragment.kt b/app/src/main/java/com/duckduckgo/app/browser/BrowserTabFragment.kt
@@ -296,7 +296,6 @@ import com.duckduckgo.duckchat.api.inputscreen.InputScreenActivityResultCodes
 import com.duckduckgo.duckchat.api.inputscreen.InputScreenActivityResultParams
 import com.duckduckgo.duckplayer.api.DuckPlayer
 import com.duckduckgo.duckplayer.api.DuckPlayerSettingsNoParams
-import com.duckduckgo.js.messaging.api.AdsjsMessaging
 import com.duckduckgo.js.messaging.api.JsCallbackData
 import com.duckduckgo.js.messaging.api.JsMessageCallback
 import com.duckduckgo.js.messaging.api.JsMessaging
@@ -513,10 +512,6 @@ class BrowserTabFragment :
     @Named("DuckPlayer")
     lateinit var duckPlayerScripts: JsMessaging
 
-    @Inject
-    @Named("AdsjsContentScopeScripts")
-    lateinit var adsJsContentScopeScripts: AdsjsMessaging
-
     @Inject
     lateinit var webContentDebugging: WebContentDebugging
 
@@ -3027,22 +3022,18 @@ class BrowserTabFragment :
             it.isSafeWebViewEnabled = safeWebViewFeature.self().isEnabled()
             it.webViewClient = webViewClient
             lifecycleScope.launch(dispatchers.main()) {
-                webViewClient.configureWebView(it)
-                adsJsContentScopeScripts.register(
-                    it,
-                    object : JsMessageCallback() {
-                        override fun process(
-                            featureName: String,
-                            method: String,
-                            id: String?,
-                            data: JSONObject?,
-                        ) {
-                            viewModel.processJsCallbackMessage(featureName, method, id, data, isActiveCustomTab()) {
-                                it.url
-                            }
+                webViewClient.configureWebView(it, object : JsMessageCallback() {
+                    override fun process(
+                        featureName: String,
+                        method: String,
+                        id: String?,
+                        data: JSONObject?,
+                    ) {
+                        viewModel.processJsCallbackMessage(featureName, method, id, data, isActiveCustomTab()) {
+                            it.url
                         }
-                    },
-                )
+                    }
+                })
             }
 
             it.webChromeClient = webChromeClient
@@ -3877,7 +3868,7 @@ class BrowserTabFragment :
         if (::webViewContainer.isInitialized) webViewContainer.removeAllViews()
         appCoroutineScope.launch(dispatchers.main()) {
             webView?.let {
-                adsJsContentScopeScripts.unregister(it)
+                webViewClient.destroy(it)
                 it.destroy()
             }
             webView = null
diff --git a/app/src/main/java/com/duckduckgo/app/browser/BrowserWebViewClient.kt b/app/src/main/java/com/duckduckgo/app/browser/BrowserWebViewClient.kt
@@ -71,6 +71,7 @@ import com.duckduckgo.common.utils.CurrentTimeProvider
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.contentscopescripts.api.AddDocumentStartJavaScriptPlugin
+import com.duckduckgo.contentscopescripts.api.WebMessagingPlugin
 import com.duckduckgo.contentscopescripts.api.contentscopeExperiments.ContentScopeExperiments
 import com.duckduckgo.cookies.api.CookieManagerProvider
 import com.duckduckgo.duckchat.api.DuckChat
@@ -80,6 +81,7 @@ 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.JsMessageCallback
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed
 import com.duckduckgo.privacy.config.api.AmpLinks
 import com.duckduckgo.subscriptions.api.Subscriptions
@@ -91,6 +93,7 @@ import logcat.LogPriority.INFO
 import logcat.LogPriority.VERBOSE
 import logcat.LogPriority.WARN
 import logcat.logcat
+import org.json.JSONObject
 
 private const val ABOUT_BLANK = "about:blank"
 
@@ -128,6 +131,7 @@ class BrowserWebViewClient @Inject constructor(
     private val duckChat: DuckChat,
     private val contentScopeExperiments: ContentScopeExperiments,
     private val addDocumentStartJavascriptPlugins: PluginPoint<AddDocumentStartJavaScriptPlugin>,
+    private val webMessagingPlugins: PluginPoint<WebMessagingPlugin>,
 ) : WebViewClient() {
 
     var webViewClientListener: WebViewClientListener? = null
@@ -465,14 +469,25 @@ class BrowserWebViewClient @Inject constructor(
         webView.settings.mediaPlaybackRequiresUserGesture = mediaPlayback.doesMediaPlaybackRequireUserGestureForUrl(url)
     }
 
-    fun configureWebView(webView: DuckDuckGoWebView) {
+    fun configureWebView(webView: DuckDuckGoWebView, callback: JsMessageCallback) {
         appCoroutineScope.launch {
             val activeExperiments = contentScopeExperiments.getActiveExperiments()
             addDocumentStartJavascriptPlugins.getPlugins().forEach { plugin ->
                 plugin.configureAddDocumentStartJavaScript(activeExperiments) { scriptString, allowedOrigins ->
                     webView.safeAddDocumentStartJavaScript(scriptString, allowedOrigins)
                 }
             }
+
+
+            webMessagingPlugins.getPlugins().forEach { plugin ->
+                plugin.register(webView, callback) { objectName, allowedOriginRules, webMessageListener ->
+                    webView.safeAddWebMessageListener(
+                        objectName,
+                        allowedOriginRules,
+                        webMessageListener,
+                    )
+                }
+            }
         }
     }
 
@@ -760,6 +775,15 @@ class BrowserWebViewClient @Inject constructor(
     fun addExemptedMaliciousSite(url: Uri, feed: Feed) {
         requestInterceptor.addExemptedMaliciousSite(url, feed)
     }
+
+    suspend fun destroy(webView: DuckDuckGoWebView) {
+
+        webMessagingPlugins.getPlugins().forEach { plugin ->
+            plugin.unregister { objectName ->
+                webView.safeRemoveWebMessageListener(objectName)
+            }
+        }
+    }
 }
 
 enum class WebViewPixelName(override val pixelName: String) : Pixel.PixelName {
diff --git a/app/src/main/java/com/duckduckgo/app/plugins/WebMessagingPluginPoint.kt b/app/src/main/java/com/duckduckgo/app/plugins/WebMessagingPluginPoint.kt
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2023 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.plugins
+
+import com.duckduckgo.anvil.annotations.ContributesPluginPoint
+import com.duckduckgo.contentscopescripts.api.AddDocumentStartJavaScriptPlugin
+import com.duckduckgo.contentscopescripts.api.WebMessagingPlugin
+import com.duckduckgo.di.scopes.AppScope
+
+@ContributesPluginPoint(
+    scope = AppScope::class,
+    boundType = WebMessagingPlugin::class,
+)
+@Suppress("unused")
+interface UnusedWebMessagingPluginPoint
diff --git a/content-scope-scripts/content-scope-scripts-api/src/main/java/com/duckduckgo/contentscopescripts/api/WebMessagingPlugin.kt b/content-scope-scripts/content-scope-scripts-api/src/main/java/com/duckduckgo/contentscopescripts/api/WebMessagingPlugin.kt
@@ -0,0 +1,34 @@
+/*
+ * 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.contentscopescripts.api
+
+import android.webkit.WebView
+import androidx.webkit.ScriptHandler
+import androidx.webkit.WebViewCompat.WebMessageListener
+import com.duckduckgo.feature.toggles.api.Toggle
+import com.duckduckgo.js.messaging.api.JsMessageCallback
+import kotlinx.coroutines.withContext
+
+interface WebMessagingPlugin {
+    suspend fun register(
+        webView: WebView,
+        jsMessageCallback: JsMessageCallback?,
+        registerer: suspend (objectName: String, allowedOriginRules: Set<String>, webMessageListener: WebMessageListener) -> Boolean)
+
+    suspend fun unregister(
+        unregisterer: suspend (objectName: String) -> Boolean)
+}
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/RealWebViewCompatWrapper.kt b/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/RealWebViewCompatWrapper.kt
@@ -17,6 +17,7 @@
 package com.duckduckgo.contentscopescripts.impl
 
 import android.annotation.SuppressLint
+import android.webkit.WebView
 import androidx.webkit.ScriptHandler
 import androidx.webkit.WebViewCompat
 import com.duckduckgo.di.scopes.AppScope
@@ -38,4 +39,20 @@ class RealWebViewCompatWrapper @Inject constructor() : WebViewCompatWrapper {
     ): ScriptHandler {
         return WebViewCompat.addDocumentStartJavaScript(webView, script, allowedOriginRules)
     }
+
+    override fun removeWebMessageListener(webView: WebView, jsObjectName: String) {
+        WebViewCompat.removeWebMessageListener(
+            webView,
+            jsObjectName,
+        )
+    }
+
+    override fun addWebMessageListener(
+        webView: WebView,
+        jsObjectName: String,
+        allowedOriginRules: Set<String>,
+        listener: WebViewCompat.WebMessageListener,
+    ) {
+        return WebViewCompat.addWebMessageListener(webView, jsObjectName, allowedOriginRules, listener)
+    }
 }
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/WebViewCompatWrapper.kt b/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/WebViewCompatWrapper.kt
@@ -18,6 +18,7 @@ package com.duckduckgo.contentscopescripts.impl
 
 import android.webkit.WebView
 import androidx.webkit.ScriptHandler
+import androidx.webkit.WebViewCompat.WebMessageListener
 
 interface WebViewCompatWrapper {
 
@@ -26,4 +27,16 @@ interface WebViewCompatWrapper {
         script: String,
         allowedOriginRules: Set<String>,
     ): ScriptHandler
+
+    fun removeWebMessageListener(
+        webView: WebView,
+        jsObjectName: String,
+    )
+
+    fun addWebMessageListener(
+        webView: WebView,
+        jsObjectName: String,
+        allowedOriginRules: Set<String>,
+        listener: WebMessageListener,
+    )
 }
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/WebCompatMessagingPlugin.kt b/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/WebCompatMessagingPlugin.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 DuckDuckGo
+ * 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.
@@ -16,45 +16,41 @@
 
 package com.duckduckgo.contentscopescripts.impl.messaging
 
-import android.annotation.SuppressLint
 import android.webkit.WebView
-import androidx.webkit.WebViewCompat
-import androidx.webkit.WebViewFeature
+import androidx.webkit.WebViewCompat.WebMessageListener
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.contentscopescripts.api.AdsjsContentScopeJsMessageHandlersPlugin
 import com.duckduckgo.contentscopescripts.api.GlobalContentScopeJsMessageHandlersPlugin
+import com.duckduckgo.contentscopescripts.api.WebMessagingPlugin
 import com.duckduckgo.contentscopescripts.impl.AdsJsContentScopeScripts
 import com.duckduckgo.di.scopes.ActivityScope
-import com.duckduckgo.js.messaging.api.AdsjsMessaging
 import com.duckduckgo.js.messaging.api.JsMessage
 import com.duckduckgo.js.messaging.api.JsMessageCallback
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.moshi.Moshi
-import javax.inject.Inject
-import javax.inject.Named
 import kotlinx.coroutines.withContext
-import logcat.LogPriority.ERROR
+import logcat.LogPriority
 import logcat.asLog
 import logcat.logcat
+import javax.inject.Inject
+import javax.inject.Named
 
 private const val JS_OBJECT_NAME = "contentScopeAdsjs"
 
 @ContributesBinding(ActivityScope::class)
 @Named("AdsjsContentScopeScripts")
-class AdsjsContentScopeMessaging @Inject constructor(
+class WebCompatMessagingPlugin @Inject constructor(
     private val handlers: PluginPoint<AdsjsContentScopeJsMessageHandlersPlugin>,
     private val globalHandlers: PluginPoint<GlobalContentScopeJsMessageHandlersPlugin>,
     private val adsJsContentScopeScripts: AdsJsContentScopeScripts,
     private val dispatcherProvider: DispatcherProvider,
-) : AdsjsMessaging {
+) : WebMessagingPlugin {
 
     private val moshi = Moshi.Builder().add(JSONObjectAdapter()).build()
 
-    private lateinit var webView: WebView
-
-    override val context: String = "contentScopeScripts"
-    override val allowedDomains: Set<String> = setOf("*")
+    private val context: String = "contentScopeScripts"
+    private val allowedDomains: Set<String> = setOf("*")
 
     private fun process(
         message: String,
@@ -81,46 +77,40 @@ class AdsjsContentScopeMessaging @Inject constructor(
                 }
             }
         } catch (e: Exception) {
-            logcat(ERROR) { "Exception is ${e.asLog()}" }
+            logcat(LogPriority.ERROR) { "Exception is ${e.asLog()}" }
         }
     }
 
-    @SuppressLint("AddWebMessageListenerUsage")
-    override suspend fun register(webView: WebView, jsMessageCallback: JsMessageCallback?) {
+
+    override suspend fun register(
+        webView: WebView,
+        jsMessageCallback: JsMessageCallback?,
+        registerer: suspend (objectName: String, allowedOriginRules: Set<String>, webMessageListener: WebMessageListener) -> Boolean)
+    {
         if (withContext(dispatcherProvider.io()) { !adsJsContentScopeScripts.isEnabled() }) return
         if (jsMessageCallback == null) throw Exception("Callback cannot be null")
-        this.webView = webView
 
         runCatching {
-            if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) {
-                WebViewCompat.addWebMessageListener(
-                    webView,
-                    JS_OBJECT_NAME,
-                    allowedDomains,
-                ) { _, message, _, _, replyProxy ->
-                    process(
-                        message.data ?: "",
-                        jsMessageCallback,
-                    )
-                }
-                true
-            } else {
-                false
-            }
+
+            return@runCatching registerer(JS_OBJECT_NAME, allowedDomains,
+                WebMessageListener { _, message, _, _, _ -> process(message.data ?: "", jsMessageCallback) }
+            )
         }.getOrElse { exception ->
-            logcat(ERROR) { "Error adding WebMessageListener for contentScopeAdsjs: ${exception.asLog()}" }
+            logcat(LogPriority.ERROR) { "Error adding WebMessageListener for contentScopeAdsjs: ${exception.asLog()}" }
             false
         }
     }
 
-    override suspend fun unregister(webView: WebView) {
+    override suspend fun unregister(
+        unregisterer: suspend (objectName: String) -> Boolean
+    ) {
         if (!adsJsContentScopeScripts.isEnabled()) return
         withContext(dispatcherProvider.main()) {
             runCatching {
-                if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) {
-                    WebViewCompat.removeWebMessageListener(webView, JS_OBJECT_NAME)
-                } else {
-                    logcat(ERROR) { "WebMessageListener is not supported on this WebView" }
+                return@runCatching unregister(unregisterer)
+            }.getOrElse { exception ->
+                logcat(LogPriority.ERROR) {
+                    "Error removing WebMessageListener for contentScopeAdsjs: ${exception.asLog()}"
                 }
             }
         }
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/RealAdsJsContentScopeScriptsTest.kt b/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/RealAdsJsContentScopeScriptsTest.kt
diff --git a/js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/AdsjsMessaging.kt b/js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/AdsjsMessaging.kt
