Add handler for nativeDuckAiSettingChanged to sync Duck.ai setting changes with SERP

Author: mikescamell

duckchat/duckchat-impl/src/main/java/com/duckduckgo/duckchat/impl/messaging/NativeDuckAiSettingChangedHandler.kt

@@ -0,0 +1,75 @@
+/*
+ * 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.duckchat.impl.messaging
+
+import com.duckduckgo.app.di.AppCoroutineScope
+import com.duckduckgo.common.utils.AppUrl
+import com.duckduckgo.common.utils.DispatcherProvider
+import com.duckduckgo.contentscopescripts.api.ContentScopeJsMessageHandlersPlugin
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.duckchat.impl.DuckChatInternal
+import com.duckduckgo.js.messaging.api.JsMessage
+import com.duckduckgo.js.messaging.api.JsMessageCallback
+import com.duckduckgo.js.messaging.api.JsMessageHandler
+import com.duckduckgo.js.messaging.api.JsMessaging
+import com.duckduckgo.settings.api.SettingsPageFeature
+import com.squareup.anvil.annotations.ContributesMultibinding
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+import logcat.logcat
+import javax.inject.Inject
+
+/**
+ * Handles subscription to Duck.ai setting changes to notify SERP when the native setting changes.
+ *
+ * Purpose: When a user changes the Duck.ai setting in native Android settings,
+ * this handler pushes the update to any active SERP pages so they can update their UI.
+ */
+@ContributesMultibinding(AppScope::class)
+class NativeDuckAiSettingChangedHandler @Inject constructor(
+ duckChatInternal: DuckChatInternal,
+ private val dispatcherProvider: DispatcherProvider,
+ @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
+ private val settingsPageFeature: SettingsPageFeature,
+) : ContentScopeJsMessageHandlersPlugin {
+
+ override fun getJsMessageHandler(): JsMessageHandler =
+ object : JsMessageHandler {
+
+ override fun process(
+ jsMessage: JsMessage,
+ jsMessaging: JsMessaging,
+ jsMessageCallback: JsMessageCallback?,
+ ) {
+ appCoroutineScope.launch(dispatcherProvider.io()) {
+ if (settingsPageFeature.serpSettingsSync().isEnabled()) {
+ logcat { "SERP-SETTINGS: Subscribing SERP page to Duck.ai setting changes" }
+
+ // TODO observe and send back updates
+ }
+ }
+ }
+
+ override val allowedDomains: List<String> = listOf(AppUrl.Url.HOST)
+ override val featureName: String = "serpSettings"
+ override val methods: List<String> = listOf(NATIVE_DUCK_AI_SETTING_CHANGE_METHOD_NAME)
+ }
+
+ companion object {
+ const val NATIVE_DUCK_AI_SETTING_CHANGE_METHOD_NAME = "nativeDuckAiSettingChanged"
+ }
+}

duckchat/duckchat-impl/src/test/kotlin/com/duckduckgo/duckchat/impl/messaging/NativeDuckAiSettingChangedHandlerTest.kt

@@ -0,0 +1,57 @@
+/*
+ * 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.duckchat.impl.messaging
+
+import com.duckduckgo.common.test.CoroutineTestRule
+import com.duckduckgo.duckchat.impl.DuckChatInternal
+import com.duckduckgo.settings.api.SettingsPageFeature
+import org.junit.Assert.*
+import org.junit.Rule
+import org.junit.Test
+import org.mockito.kotlin.mock
+
+class NativeDuckAiSettingChangedHandlerTest {
+
+ @get:Rule
+ val coroutineTestRule: CoroutineTestRule = CoroutineTestRule()
+
+ private val handler = NativeDuckAiSettingChangedHandler(
+ duckChatInternal = mock<DuckChatInternal>(),
+ dispatcherProvider = coroutineTestRule.testDispatcherProvider,
+ appCoroutineScope = coroutineTestRule.testScope,
+ settingsPageFeature = mock<SettingsPageFeature>(),
+ ).getJsMessageHandler()
+
+ @Test
+ fun `only allow duckduckgo dot com domains`() {
+ val domains = handler.allowedDomains
+ assertEquals(1, domains.size)
+ assertEquals("duckduckgo.com", domains.first())
+ }
+
+ @Test
+ fun `feature name is serpSettings`() {
+ assertEquals("serpSettings", handler.featureName)
+ }
+
+ @Test
+ fun `only contains nativeDuckAiSettingChanged method`() {
+ val methods = handler.methods
+ assertEquals(1, methods.size)
+ assertEquals("nativeDuckAiSettingChanged", methods[0])
+ }
+}