Support subscriptions by replying to ping message

Author: CrisBarreiro

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

@@ -1214,7 +1214,8 @@ class BrowserTabFragment :
     private fun onOmnibarCustomTabPrivacyDashboardPressed() {
         val params = PrivacyDashboardPrimaryScreen(tabId)
         val intent = globalActivityStarter.startIntent(requireContext(), params)
-        contentScopeScripts.sendSubscriptionEvent(createBreakageReportingEventData())
+        adsJsContentScopeScripts.postMessage(createBreakageReportingEventData())
+        // contentScopeScripts.sendSubscriptionEvent(createBreakageReportingEventData())
         intent?.let { activityResultPrivacyDashboard.launch(intent) }
         pixel.fire(CustomTabPixelNames.CUSTOM_TABS_PRIVACY_DASHBOARD_OPENED)
     }
@@ -1226,12 +1227,14 @@ class BrowserTabFragment :
     }
 
     private fun onBrowserMenuButtonPressed() {
-        contentScopeScripts.sendSubscriptionEvent(createBreakageReportingEventData())
+        adsJsContentScopeScripts.postMessage(createBreakageReportingEventData())
+        // contentScopeScripts.sendSubscriptionEvent(createBreakageReportingEventData())
         viewModel.onBrowserMenuClicked(isCustomTab = isActiveCustomTab())
     }
 
     private fun onOmnibarPrivacyShieldButtonPressed() {
-        contentScopeScripts.sendSubscriptionEvent(createBreakageReportingEventData())
+        adsJsContentScopeScripts.postMessage(createBreakageReportingEventData())
+        // contentScopeScripts.sendSubscriptionEvent(createBreakageReportingEventData())
         viewModel.onOmnibarPrivacyShieldButtonPressed()
         launchPrivacyDashboard(toggle = false)
     }

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

@@ -3669,6 +3669,9 @@ class BrowserTabViewModel @Inject constructor(
             "webShare" -> if (id != null && data != null) {
                 adsjsWebShare(featureName, method, id, data, onResponse)
             }
+            "breakageReportResult" -> if (data != null) {
+                breakageReportResult(data)
+            }
         }
     }
 

breakage-reporting/breakage-reporting-impl/src/main/java/com/duckduckgo/breakagereporting/impl/AdsjsBreakageContentScopeJsMessageHandler.kt

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2024 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.breakagereporting.impl
+
+import com.duckduckgo.contentscopescripts.api.AdsjsContentScopeJsMessageHandlersPlugin
+import com.duckduckgo.di.scopes.ActivityScope
+import com.duckduckgo.js.messaging.api.AdsjsJsMessageCallback
+import com.duckduckgo.js.messaging.api.AdsjsMessageHandler
+import com.duckduckgo.js.messaging.api.JsMessage
+import com.squareup.anvil.annotations.ContributesMultibinding
+import javax.inject.Inject
+import org.json.JSONObject
+
+@ContributesMultibinding(ActivityScope::class)
+class AdsjsBreakageContentScopeJsMessageHandler @Inject constructor() : AdsjsContentScopeJsMessageHandlersPlugin {
+
+    override fun getJsMessageHandler(): AdsjsMessageHandler = object : AdsjsMessageHandler {
+
+        override fun process(
+            jsMessage: JsMessage,
+            jsMessageCallback: AdsjsJsMessageCallback?,
+            onResponse: (JSONObject) -> Unit,
+        ) {
+            jsMessageCallback?.process(featureName, jsMessage.method, jsMessage.id, jsMessage.params, onResponse)
+        }
+
+        override val featureName: String = "breakageReporting"
+        override val methods: List<String> = listOf("breakageReportResult")
+    }
+}

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

@@ -16,6 +16,7 @@
 
 package com.duckduckgo.contentscopescripts.impl.messaging
 
+import android.annotation.SuppressLint
 import android.webkit.WebView
 import androidx.annotation.VisibleForTesting
 import androidx.webkit.JavaScriptReplyProxy
@@ -31,6 +32,8 @@ import com.duckduckgo.js.messaging.api.AdsjsJsMessageCallback
 import com.duckduckgo.js.messaging.api.AdsjsMessaging
 import com.duckduckgo.js.messaging.api.JsCallbackData
 import com.duckduckgo.js.messaging.api.JsMessage
+import com.duckduckgo.js.messaging.api.SubscriptionEvent
+import com.duckduckgo.js.messaging.api.SubscriptionEventData
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.moshi.Moshi
 import javax.inject.Inject
@@ -62,6 +65,8 @@ class AdsjsContentScopeMessaging @Inject constructor(
     override val context: String = "contentScopeScripts"
     override val allowedDomains: Set<String> = setOf("*")
 
+    private var globalReplyProxy: JavaScriptReplyProxy? = null
+
     @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
     internal fun process(
         message: String,
@@ -75,6 +80,11 @@ class AdsjsContentScopeMessaging @Inject constructor(
             jsMessage?.let {
                 if (context == jsMessage.context) {
                     // Process global handlers first (always processed regardless of feature handlers)
+
+                    if (jsMessage.featureName == "messaging" || jsMessage.method == "initialPing") {
+                        globalReplyProxy = replyProxy
+                    }
+
                     globalHandlers.getPlugins()
                         .map { it.getGlobalJsMessageHandler() }
                         .filter { it.method == jsMessage.method }
@@ -158,4 +168,20 @@ class AdsjsContentScopeMessaging @Inject constructor(
             }
         }
     }
+
+    @SuppressLint("RequiresFeature")
+    override fun postMessage(subscriptionEventData: SubscriptionEventData) {
+        runCatching {
+            val subscriptionEvent = SubscriptionEvent(
+                context = context,
+                featureName = subscriptionEventData.featureName,
+                subscriptionName = subscriptionEventData.subscriptionName,
+                params = subscriptionEventData.params,
+            ).let {
+                moshi.adapter(SubscriptionEvent::class.java).toJson(it)
+            }
+
+            globalReplyProxy?.postMessage(subscriptionEvent)
+        }
+    }
 }

js-messaging/js-messaging-api/src/main/java/com/duckduckgo/js/messaging/api/AdsjsMessaging.kt

@@ -30,6 +30,8 @@ interface AdsjsMessaging {
     )
     suspend fun unregister(webView: WebView)
 
+    fun postMessage(subscriptionEventData: SubscriptionEventData)
+
     /**
      * Context name
      */

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

@@ -33,6 +33,7 @@ import dagger.SingleInstanceIn
 import javax.inject.Inject
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
+import logcat.logcat
 
 @SingleInstanceIn(AppScope::class)
 @ContributesBinding(AppScope::class)
@@ -47,6 +48,9 @@ class RealJsMessageHelper @Inject constructor(
         val jsonAdapter: JsonAdapter<SubscriptionEvent> = moshi.adapter(SubscriptionEvent::class.java)
         val message = jsonAdapter.toJson(subscriptionEvent).toString()
         val response = buildJsResponse(message, callbackName, secret)
+
+        logcat("Cris") { "$response" }
+
         sendResponse(response, webView)
     }