Add UpdateNativeSettingsHandler to process updateNativeSettings messages from SERP

Author: mikescamell

settings/settings-impl/src/main/java/com/duckduckgo/settings/impl/serpsettings/messaging/UpdateNativeSettingsHandler.kt

@@ -0,0 +1,65 @@
+/*
+ * 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.settings.impl.serpsettings.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.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 the updateNativeSettings message from SERP to persist setting changes.
+ */
+@ContributesMultibinding(AppScope::class)
+class UpdateNativeSettingsHandler @Inject constructor(
+ private val dispatcherProvider: DispatcherProvider,
+ @AppCoroutineScope private val appScope: CoroutineScope,
+ private val settingsPageFeature: SettingsPageFeature,
+ // TODO: Inject data store when implemented
+) : ContentScopeJsMessageHandlersPlugin {
+
+ override fun getJsMessageHandler(): JsMessageHandler =
+ object : JsMessageHandler {
+ override fun process(
+ jsMessage: JsMessage,
+ jsMessaging: JsMessaging,
+ jsMessageCallback: JsMessageCallback?,
+ ) {
+ appScope.launch(dispatcherProvider.io()) {
+ if (settingsPageFeature.serpSettingsSync().isEnabled()) {
+ logcat { "SERP-SETTINGS: UpdateNativeSettingsHandler processing message" }
+ // TODO Use a data store to store the settings from SERP
+ }
+ }
+ }
+
+ override val allowedDomains: List<String> = listOf(AppUrl.Url.HOST)
+ override val featureName: String = "serpSettings"
+ override val methods: List<String> = listOf("updateNativeSettings")
+ }
+}

settings/settings-impl/src/test/java/com/duckduckgo/settings/impl/serpsettings/messaging/UpdateNativeSettingsHandlerTest.kt

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