Also use existing DuckDuckGoWebView methods for messages

Author: CrisBarreiro

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

@@ -34,7 +34,6 @@ import androidx.core.view.NestedScrollingChild3
 import androidx.core.view.NestedScrollingChildHelper
 import androidx.core.view.ViewCompat
 import androidx.webkit.ScriptHandler
-import androidx.webkit.WebViewCompat
 import androidx.webkit.WebViewCompat.WebMessageListener
 import com.duckduckgo.anvil.annotations.InjectWith
 import com.duckduckgo.app.browser.api.DuckDuckGoWebView
@@ -437,7 +436,7 @@ class RealDuckDuckGoWebView : DuckDuckGoWebView, NestedScrollingChild3 {
         listener: WebMessageListener,
     ): Boolean = runCatching {
         if (webViewCapabilityChecker.isSupported(WebViewCapability.WebMessageListener) && !isDestroyed) {
-            WebViewCompat.addWebMessageListener(
+            webViewCompatWrapper.addWebMessageListener(
                 this,
                 jsObjectName,
                 allowedOriginRules,
@@ -452,6 +451,18 @@ class RealDuckDuckGoWebView : DuckDuckGoWebView, NestedScrollingChild3 {
         false
     }
 
+    override suspend fun safeRemoveWebMessageListener(jsObjectName: String): Boolean = runCatching {
+        if (webViewCapabilityChecker.isSupported(WebViewCapability.WebMessageListener) && !isDestroyed) {
+            webViewCompatWrapper.removeWebMessageListener(this, jsObjectName)
+            true
+        } else {
+            false
+        }
+    }.getOrElse { exception ->
+        logcat(ERROR) { "Error removing WebMessageListener: $jsObjectName: ${exception.asLog()}" }
+        false
+    }
+
     @SuppressLint("RequiresFeature")
     override suspend fun safeAddDocumentStartJavaScript(
         script: String,

browser-api/src/main/java/com/duckduckgo/app/browser/api/DuckDuckGoWebView.kt

@@ -46,6 +46,10 @@ abstract class DuckDuckGoWebView(
         listener: WebMessageListener,
     ): Boolean
 
+    abstract suspend fun safeRemoveWebMessageListener(
+        jsObjectName: String,
+    ): Boolean
+
     abstract suspend fun safeAddDocumentStartJavaScript(
         script: String,
         allowedOriginRules: Set<String>,

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

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

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

@@ -16,10 +16,8 @@
 
 package com.duckduckgo.contentscopescripts.impl.messaging
 
-import android.annotation.SuppressLint
 import android.webkit.WebView
-import androidx.webkit.WebViewCompat
-import androidx.webkit.WebViewFeature
+import com.duckduckgo.app.browser.api.DuckDuckGoWebView
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.contentscopescripts.api.AdsjsContentScopeJsMessageHandlersPlugin
@@ -85,16 +83,14 @@ class AdsjsContentScopeMessaging @Inject constructor(
         }
     }
 
-    @SuppressLint("AddWebMessageListenerUsage")
     override suspend fun register(webView: WebView, jsMessageCallback: JsMessageCallback?) {
         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,
+            (webView as? DuckDuckGoWebView)?.let {
+                return@runCatching it.safeAddWebMessageListener(
                     JS_OBJECT_NAME,
                     allowedDomains,
                 ) { _, message, _, _, replyProxy ->
@@ -103,10 +99,7 @@ class AdsjsContentScopeMessaging @Inject constructor(
                         jsMessageCallback,
                     )
                 }
-                true
-            } else {
-                false
-            }
+            } ?: false
         }.getOrElse { exception ->
             logcat(ERROR) { "Error adding WebMessageListener for contentScopeAdsjs: ${exception.asLog()}" }
             false
@@ -117,10 +110,11 @@ class AdsjsContentScopeMessaging @Inject constructor(
         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 (webView as? DuckDuckGoWebView)
+                    ?.safeRemoveWebMessageListener(JS_OBJECT_NAME)
+            }.getOrElse { exception ->
+                logcat(ERROR) {
+                    "Error removing WebMessageListener for contentScopeAdsjs: ${exception.asLog()}"
                 }
             }
         }

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

@@ -19,6 +19,7 @@ package com.duckduckgo.contentscopescripts.impl
 import android.annotation.SuppressLint
 import com.duckduckgo.app.privacy.db.UserAllowListRepository
 import com.duckduckgo.appbuildconfig.api.AppBuildConfig
+import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.contentscopescripts.api.ContentScopeConfigPlugin
 import com.duckduckgo.feature.toggles.api.FakeFeatureToggleFactory
@@ -33,6 +34,7 @@ import junit.framework.TestCase.assertFalse
 import junit.framework.TestCase.assertTrue
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
+import org.junit.Rule
 import org.junit.Test
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.times
@@ -42,6 +44,10 @@ import org.mockito.kotlin.whenever
 @SuppressLint("DenyListedApi")
 class RealAdsjsContentScopeScriptsTest {
 
+    @get:Rule
+    @Suppress("unused")
+    val coroutineRule = CoroutineTestRule()
+
     private val mockPluginPoint: PluginPoint<ContentScopeConfigPlugin> = mock()
     private val mockUserAllowListRepository: UserAllowListRepository = mock()
     private val mockContentScopeJsReader: ContentScopeJSReader = mock()
@@ -64,6 +70,7 @@ class RealAdsjsContentScopeScriptsTest {
             mockUnprotectedTemporary,
             mockFingerprintProtectionManager,
             contentScopeScriptsFeature,
+            coroutineRule.testDispatcherProvider,
         )
         whenever(mockPlugin1.config()).thenReturn(config1)
         whenever(mockPlugin2.config()).thenReturn(config2)