Add Subscriptions SERP integration (#6061)

nalcalag · web-flow · commit 3146732fac99 · 2025-05-15T13:36:05.000+01:00
Task/Issue URL: https://app.asana.com/1/137249556945/project/1201807753394693/task/1210023557524902?focus=true ### Description - Uses the C-S-S navigatorInterface + messageBridge to request information about the subscription status. - The functionality is disabled when aiChat is disabled in the config. ### Steps to test this PR _Pre steps_ - [x] Change remote config URL to https://jsonblob.com/api/1371926095833784320 - [x] Add logs to see the JS messages requests and responses within `fun processJsCallbackMessage()` - In line _3577_ log JS request `Timber.d("JsRequestMessage, featureName: $featureName, method: $method, id: $id")` - In line _3631_ log JS response `Timber.e("JS response: $it")` - [x] Use a VPN to set your location to US - [x] Apply patch to be privacy pro eligible _Subscriptions message non US_ - [x] Install from branch - [x] Perform a search - [x] Check you don't get any messages for featureName _subscriptions_ as you are not in US _Handshake request_ - [x] Set a VPN to US - [x] Install from branch - [x] Perform a search - [x] Verify you see in the logs the message request: `featureName: subscriptions, method: handshake` - [x] Verify you see in the logs the message response: `JsCallbackData(params={"availableMessages":["subscriptionDetails"],"platform":"android"}, featureName=subscriptions, method=handshake` ... _subscriptionDetails request with no Subscription_ - [x] Verify you see in the logs the message request: `featureName: subscriptions, method: subscriptionDetails` - [x] Verify you see in the logs the message response: `{"isSubscribed":false}` ... _subscriptionDetails request with active Subscription_ - [x] from previous test, go to Settings > Privacy Pro - [x] Purchase a subscription - [x] Perform a search - [x] Verify you see in the logs the message request: `featureName: subscriptions, method: subscriptionDetails` - [x] Verify you see in the logs the message response: `{"isSubscribed":true,"billingPeriod":"Monthly or Yearly","startedAt":...,"expiresOrRenewsAt":...,"paymentPlatform":"google","status":"Auto-Renewable"}` ... _subscriptionDetails request with expired Subscription_ - [x] from previous test, go to Settings > Privacy Pro Settings - [x] Cancel the subscription - [x] Wait until subscription expires - [x] Perform a search - [x] Verify you see in the logs the message request: `featureName: subscriptions, method: subscriptionDetails` - [x] Verify you see in the logs the message response: `{"isSubscribed":false,"billingPeriod":"Monthly or Yearly","startedAt":...,"expiresOrRenewsAt":...,"paymentPlatform":"google","status":"Expired"}` ### No UI changes
diff --git a/app/src/androidTest/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt b/app/src/androidTest/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt
@@ -277,6 +277,8 @@ import com.duckduckgo.site.permissions.api.SitePermissionsManager.LocationPermis
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.SitePermissionQueryResponse
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.SitePermissions
 import com.duckduckgo.subscriptions.api.Subscriptions
+import com.duckduckgo.subscriptions.impl.messaging.RealSubscriptionsJSHelper.Companion.SUBSCRIPTIONS_FEATURE_NAME
+import com.duckduckgo.subscriptions.impl.messaging.SubscriptionsJSHelper
 import com.duckduckgo.sync.api.favicons.FaviconsFetchingPrompt
 import com.duckduckgo.voice.api.VoiceSearchAvailability
 import com.duckduckgo.voice.api.VoiceSearchAvailabilityPixelLogger
@@ -550,6 +552,7 @@ class BrowserTabViewModelTest {
     private val mockSiteErrorHandlerKillSwitchToggle: Toggle = mock { on { it.isEnabled() } doReturn true }
     private val mockSiteErrorHandler: StringSiteErrorHandler = mock()
     private val mockSiteHttpErrorHandler: HttpCodeSiteErrorHandler = mock()
+    private val mockSubscriptionsJSHelper: SubscriptionsJSHelper = mock()
 
     private val selectedTab = TabEntity("TAB_ID", "https://example.com", position = 0, sourceTabId = "TAB_ID_SOURCE")
 
@@ -742,6 +745,7 @@ class BrowserTabViewModelTest {
             siteErrorHandler = mockSiteErrorHandler,
             siteHttpErrorHandler = mockSiteHttpErrorHandler,
             senseOfProtectionExperiment = mockSenseOfProtectionExperiment,
+            subscriptionsJSHelper = mockSubscriptionsJSHelper,
         )
 
         testee.loadData("abc", null, false, false)
@@ -6294,6 +6298,33 @@ class BrowserTabViewModelTest {
         verify(mockDuckChat, never()).openDuckChat()
     }
 
+    @Test
+    fun whenProcessJsCallbackMessageForSubscriptionsThenSendCommand() = runTest {
+        val jsCallbackData = JsCallbackData(JSONObject(), "", "", "")
+        whenever(mockSubscriptionsJSHelper.processJsCallbackMessage(anyString(), anyString(), anyOrNull(), anyOrNull())).thenReturn(jsCallbackData)
+        testee.processJsCallbackMessage(
+            featureName = SUBSCRIPTIONS_FEATURE_NAME,
+            method = "method",
+            id = "id",
+            data = null,
+        ) { "someUrl" }
+        verify(mockSubscriptionsJSHelper).processJsCallbackMessage(SUBSCRIPTIONS_FEATURE_NAME, "method", "id", null)
+        assertCommandIssued<Command.SendResponseToJs>()
+    }
+
+    @Test
+    fun whenProcessJsCallbackMessageForSubscriptionsAndResponseIsNullThenDoNotSendCommand() = runTest {
+        whenever(mockDuckChatJSHelper.processJsCallbackMessage(anyString(), anyString(), anyOrNull(), anyOrNull())).thenReturn(null)
+        testee.processJsCallbackMessage(
+            featureName = SUBSCRIPTIONS_FEATURE_NAME,
+            method = "method",
+            id = "id",
+            data = null,
+        ) { "someUrl" }
+        verify(mockSubscriptionsJSHelper).processJsCallbackMessage(SUBSCRIPTIONS_FEATURE_NAME, "method", "id", null)
+        assertCommandNotIssued<Command.SendResponseToJs>()
+    }
+
     private fun aCredential(): LoginCredentials {
         return LoginCredentials(domain = null, username = null, password = null)
     }
diff --git a/app/src/main/java/com/duckduckgo/app/browser/BrowserTabViewModel.kt b/app/src/main/java/com/duckduckgo/app/browser/BrowserTabViewModel.kt
@@ -342,6 +342,8 @@ import com.duckduckgo.site.permissions.api.SitePermissionsManager.LocationPermis
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.SitePermissionQueryResponse
 import com.duckduckgo.site.permissions.api.SitePermissionsManager.SitePermissions
 import com.duckduckgo.subscriptions.api.Subscriptions
+import com.duckduckgo.subscriptions.impl.messaging.RealSubscriptionsJSHelper.Companion.SUBSCRIPTIONS_FEATURE_NAME
+import com.duckduckgo.subscriptions.impl.messaging.SubscriptionsJSHelper
 import com.duckduckgo.sync.api.favicons.FaviconsFetchingPrompt
 import dagger.Lazy
 import io.reactivex.schedulers.Schedulers
@@ -479,6 +481,7 @@ class BrowserTabViewModel @Inject constructor(
     private val siteErrorHandler: StringSiteErrorHandler,
     private val siteHttpErrorHandler: HttpCodeSiteErrorHandler,
     private val senseOfProtectionExperiment: SenseOfProtectionExperiment,
+    private val subscriptionsJSHelper: SubscriptionsJSHelper,
 ) : WebViewClientListener,
     EditSavedSiteListener,
     DeleteBookmarkListener,
@@ -3619,6 +3622,17 @@ class BrowserTabViewModel @Inject constructor(
                 }
             }
 
+            SUBSCRIPTIONS_FEATURE_NAME -> {
+                viewModelScope.launch(dispatchers.io()) {
+                    val response = subscriptionsJSHelper.processJsCallbackMessage(featureName, method, id, data)
+                    withContext(dispatchers.main()) {
+                        response?.let {
+                            command.value = SendResponseToJs(it)
+                        }
+                    }
+                }
+            }
+
             else -> {}
         }
     }
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsJsMessaging.kt b/content-scope-scripts/content-scope-scripts-impl/src/main/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsJsMessaging.kt
@@ -62,7 +62,13 @@ class ContentScopeScriptsJsMessaging @Inject constructor(
     override val secret: String = coreContentScopeScripts.secret
     override val allowedDomains: List<String> = emptyList()
 
-    private val handlers: List<JsMessageHandler> = listOf(ContentScopeHandler(), breakageHandler, DuckPlayerHandler(), DuckChatHandler())
+    private val handlers: List<JsMessageHandler> = listOf(
+        ContentScopeHandler(),
+        breakageHandler,
+        DuckPlayerHandler(),
+        DuckChatHandler(),
+        SubscriptionsHandler(),
+    )
 
     @JavascriptInterface
     override fun process(message: String, secret: String) {
@@ -166,4 +172,20 @@ class ContentScopeScriptsJsMessaging @Inject constructor(
             "openAIChatSettings",
         )
     }
+
+    inner class SubscriptionsHandler : JsMessageHandler {
+        override fun process(jsMessage: JsMessage, secret: String, jsMessageCallback: JsMessageCallback?) {
+            jsMessageCallback?.process(featureName, jsMessage.method, jsMessage.id ?: "", jsMessage.params)
+        }
+
+        override val allowedDomains: List<String> = listOf(
+            AppUrl.Url.HOST,
+        )
+
+        override val featureName: String = "subscriptions"
+        override val methods: List<String> = listOf(
+            "handshake",
+            "subscriptionDetails",
+        )
+    }
 }
diff --git a/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsJsMessagingTest.kt b/content-scope-scripts/content-scope-scripts-impl/src/test/java/com/duckduckgo/contentscopescripts/impl/messaging/ContentScopeScriptsJsMessagingTest.kt
@@ -278,6 +278,76 @@ class ContentScopeScriptsJsMessagingTest {
         assertEquals(0, callback.counter)
     }
 
+    @Test
+    fun whenProcessSubscriptionsMessageWithHandshakeMethodThenCallbackExecuted() = runTest {
+        givenInterfaceIsRegistered()
+        whenever(mockWebView.url).thenReturn("https://duckduckgo.com")
+
+        val message = """
+        {"context":"contentScopeScripts","featureName":"subscriptions","id":"myId","method":"handshake"}
+        """.trimIndent()
+
+        contentScopeScriptsJsMessaging.process(message, contentScopeScriptsJsMessaging.secret)
+
+        assertEquals(1, callback.counter)
+    }
+
+    @Test
+    fun whenProcessSubscriptionsMessageWithSubscriptionDetailsMethodThenCallbackExecuted() = runTest {
+        givenInterfaceIsRegistered()
+        whenever(mockWebView.url).thenReturn("https://duckduckgo.com")
+
+        val message = """
+        {"context":"contentScopeScripts","featureName":"subscriptions","id":"myId","method":"subscriptionDetails"}
+        """.trimIndent()
+
+        contentScopeScriptsJsMessaging.process(message, contentScopeScriptsJsMessaging.secret)
+
+        assertEquals(1, callback.counter)
+    }
+
+    @Test
+    fun whenProcessSubscriptionsMessageWithUnknownMethodThenDoNothing() = runTest {
+        givenInterfaceIsRegistered()
+        whenever(mockWebView.url).thenReturn("https://duckduckgo.com")
+
+        val message = """
+        {"context":"contentScopeScripts","featureName":"subscriptions","id":"myId","method":"unknownMethod"}
+        """.trimIndent()
+
+        contentScopeScriptsJsMessaging.process(message, contentScopeScriptsJsMessaging.secret)
+
+        assertEquals(0, callback.counter)
+    }
+
+    @Test
+    fun whenProcessSubscriptionsMessageWithInvalidFeatureNameThenDoNothing() = runTest {
+        givenInterfaceIsRegistered()
+        whenever(mockWebView.url).thenReturn("https://duckduckgo.com")
+
+        val message = """
+        {"context":"contentScopeScripts","featureName":"invalidFeature","id":"myId","method":"handshake"}
+        """.trimIndent()
+
+        contentScopeScriptsJsMessaging.process(message, contentScopeScriptsJsMessaging.secret)
+
+        assertEquals(0, callback.counter)
+    }
+
+    @Test
+    fun whenProcessSubscriptionsMessageWithInvalidDomainThenDoNothing() = runTest {
+        givenInterfaceIsRegistered()
+        whenever(mockWebView.url).thenReturn("https://invalid-domain.com")
+
+        val message = """
+        {"context":"contentScopeScripts","featureName":"subscriptions","id":"myId","method":"subscriptionDetails"}
+        """.trimIndent()
+
+        contentScopeScriptsJsMessaging.process(message, contentScopeScriptsJsMessaging.secret)
+
+        assertEquals(0, callback.counter)
+    }
+
     private val callback = object : JsMessageCallback() {
         var counter = 0
         override fun process(featureName: String, method: String, id: String?, data: JSONObject?) {
diff --git a/subscriptions/subscriptions-impl/src/main/java/com/duckduckgo/subscriptions/impl/messaging/SubscriptionsJSHelper.kt b/subscriptions/subscriptions-impl/src/main/java/com/duckduckgo/subscriptions/impl/messaging/SubscriptionsJSHelper.kt
@@ -0,0 +1,94 @@
+/*
+ * 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.subscriptions.impl.messaging
+
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.js.messaging.api.JsCallbackData
+import com.duckduckgo.subscriptions.impl.SubscriptionsManager
+import com.squareup.anvil.annotations.ContributesBinding
+import javax.inject.Inject
+import org.json.JSONArray
+import org.json.JSONObject
+
+interface SubscriptionsJSHelper {
+    suspend fun processJsCallbackMessage(
+        featureName: String,
+        method: String,
+        id: String?,
+        data: JSONObject?,
+    ): JsCallbackData?
+}
+
+@ContributesBinding(AppScope::class)
+class RealSubscriptionsJSHelper @Inject constructor(
+    private val subscriptionsManager: SubscriptionsManager,
+) : SubscriptionsJSHelper {
+
+    override suspend fun processJsCallbackMessage(
+        featureName: String,
+        method: String,
+        id: String?,
+        data: JSONObject?,
+    ): JsCallbackData? = when (method) {
+        METHOD_HANDSHAKE -> id?.let {
+            val jsonPayload = JSONObject().apply {
+                put(AVAILABLE_MESSAGES, JSONArray().put(SUBSCRIPTION_DETAILS))
+                put(PLATFORM, ANDROID)
+            }
+            return JsCallbackData(jsonPayload, featureName, method, id)
+        }
+
+        METHOD_SUBSCRIPTION_DETAILS -> id?.let {
+            getSubscriptionDetailsData(featureName, method, it)
+        }
+
+        else -> null
+    }
+
+    private suspend fun getSubscriptionDetailsData(featureName: String, method: String, id: String): JsCallbackData {
+        val jsonPayload = subscriptionsManager.getSubscription()?.let { userSubscription ->
+            JSONObject().apply {
+                put(IS_SUBSCRIBED, userSubscription.isActive())
+                put(BILLING_PERIOD, userSubscription.billingPeriod)
+                put(STARTED_AT, userSubscription.startedAt)
+                put(EXPIRES_OR_RENEWS_AT, userSubscription.expiresOrRenewsAt)
+                put(PAYMENT_PLATFORM, userSubscription.platform)
+                put(STATUS, userSubscription.status.statusName)
+            }
+        } ?: JSONObject().apply {
+            put(IS_SUBSCRIBED, false)
+        }
+
+        return JsCallbackData(jsonPayload, featureName, method, id)
+    }
+
+    companion object {
+        const val SUBSCRIPTIONS_FEATURE_NAME = "subscriptions"
+        private const val METHOD_HANDSHAKE = "handshake"
+        private const val METHOD_SUBSCRIPTION_DETAILS = "subscriptionDetails"
+        private const val AVAILABLE_MESSAGES = "availableMessages"
+        private const val SUBSCRIPTION_DETAILS = "subscriptionDetails"
+        private const val PLATFORM = "platform"
+        private const val ANDROID = "android"
+        private const val IS_SUBSCRIBED = "isSubscribed"
+        private const val BILLING_PERIOD = "billingPeriod"
+        private const val STARTED_AT = "startedAt"
+        private const val EXPIRES_OR_RENEWS_AT = "expiresOrRenewsAt"
+        private const val PAYMENT_PLATFORM = "paymentPlatform"
+        private const val STATUS = "status"
+    }
+}
diff --git a/subscriptions/subscriptions-impl/src/test/java/com/duckduckgo/subscriptions/impl/messaging/RealSubscriptionsJSHelperTest.kt b/subscriptions/subscriptions-impl/src/test/java/com/duckduckgo/subscriptions/impl/messaging/RealSubscriptionsJSHelperTest.kt
