Bug 2021407 - Adds shared prefs implementation of summarization settings r=segunfamisa

[try](https://treeherder.mozilla.org/jobs?repo=try&landoCommitID=1837750)

Pull request: #98

Author: boek

mobile/android/android-components/.buildconfig.yml

@@ -1408,14 +1408,18 @@ projects:
     path: components/feature/summarize
     publish: true
     upstream_dependencies:
+    - components:browser-errorpages
     - components:compose-base
     - components:concept-base
+    - components:concept-engine
     - components:concept-fetch
     - components:concept-llm
+    - components:concept-storage
     - components:lib-publicsuffixlist
     - components:lib-state
     - components:support-base
     - components:support-ktx
+    - components:support-test-fakes
     - components:support-utils
     - components:tooling-lint
     - components:ui-colors

mobile/android/android-components/components/feature/summarize/build.gradle

@@ -24,9 +24,9 @@ android {
 }
 
 dependencies {
+    implementation project(':components:compose-base')
     implementation project(':components:concept-llm')
     implementation project(':components:lib-state')
-    implementation project(':components:compose-base')
     implementation project(':components:ui-icons')
     implementation project(':components:ui-richtext')
 
@@ -35,10 +35,13 @@ dependencies {
     implementation libs.androidx.compose.ui.graphics
     implementation libs.androidx.compose.ui.tooling.preview
     implementation libs.androidx.compose.material3
+    implementation libs.androidx.core.ktx
     debugImplementation libs.androidx.compose.ui.tooling
 
     testImplementation libs.androidx.test.junit
     testImplementation libs.kotlinx.coroutines.test
+
+    testImplementation project(':components:support-test-fakes')
 }
 
 apply from: '../../../common-config.gradle'

mobile/android/android-components/components/feature/summarize/src/main/java/mozilla/components/feature/summarize/SummarizationMiddleware.kt

@@ -80,7 +80,7 @@ class SummarizationMiddleware(
     private suspend fun needsShakeConsent(state: SummarizationState): Boolean =
         state is SummarizationState.Inert &&
             state.initializedWithShake &&
-            !settings.getHasConsentedToShake()
+            !settings.hasConsentedToShake()
 
     private val systemPrompt = "This is the system prompt: "
 }

mobile/android/android-components/components/feature/summarize/src/main/java/mozilla/components/feature/summarize/SummarizationSettings.kt

@@ -4,6 +4,11 @@
 
 package mozilla.components.feature.summarize
 
+import android.content.Context
+import android.content.Context.MODE_PRIVATE
+import android.content.SharedPreferences
+import androidx.core.content.edit
+
 /**
  * Defines the contract for persisting and retrieving user settings related to
  * the summarization feature.
@@ -21,7 +26,7 @@ interface SummarizationSettings {
      * @return `true` if the user has previously accepted the shake consent prompt,
      * `false` otherwise.
      */
-    suspend fun getHasConsentedToShake(): Boolean
+    suspend fun hasConsentedToShake(): Boolean
 
     /**
      * Persists the user's consent status for the shake gesture interaction.
@@ -47,11 +52,40 @@ interface SummarizationSettings {
         ) = object : SummarizationSettings {
             var hasConsentedToShake = hasConsentedToShakeInitial
 
-            override suspend fun getHasConsentedToShake() = hasConsentedToShake
+            override suspend fun hasConsentedToShake() = hasConsentedToShake
 
             override suspend fun setHasConsentedToShake(newValue: Boolean) {
                 hasConsentedToShake = newValue
             }
         }
+
+        /**
+         * Creates an implementation of [SummarizationSettings] that is backed by [SharedPreferences].
+         *
+         * @param context required to create [SharedPreferences].
+         * @return An in-memory [SummarizationSettings] instance.
+         */
+        fun sharedPrefs(
+            context: Context,
+        ): SummarizationSettings {
+            val prefs = context.getSharedPreferences("summarization_prefs", MODE_PRIVATE)
+            return SharedPrefsBackedSummarizationSettings(prefs)
+        }
+    }
+}
+
+internal class SharedPrefsBackedSummarizationSettings(
+    private val prefs: SharedPreferences,
+) : SummarizationSettings {
+    override suspend fun hasConsentedToShake(): Boolean {
+        return prefs.getBoolean(HAS_CONSENT_TO_SHAKE, false)
+    }
+
+    override suspend fun setHasConsentedToShake(newValue: Boolean) {
+        prefs.edit { putBoolean(HAS_CONSENT_TO_SHAKE, newValue) }
+    }
+
+    companion object {
+        const val HAS_CONSENT_TO_SHAKE = "has_consent_to_shake"
     }
 }

mobile/android/android-components/components/feature/summarize/src/test/java/mozilla/components/feature/summarize/SummarizationSettingsTest.kt

@@ -0,0 +1,26 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.feature.summarize
+
+import kotlinx.coroutines.test.runTest
+import mozilla.components.support.test.fakes.android.FakeSharedPreferences
+import org.junit.Assert.assertFalse
+import org.junit.Assert.assertTrue
+import org.junit.Test
+
+class SummarizationSettingsTest {
+
+    @Test
+    fun `test that we can set and retrieve that the user has consented to shake`() = runTest {
+        val prefs = FakeSharedPreferences()
+        val settings = SharedPrefsBackedSummarizationSettings(prefs)
+
+        assertFalse(settings.hasConsentedToShake())
+
+        settings.setHasConsentedToShake(true)
+
+        assertTrue(settings.hasConsentedToShake())
+    }
+}

mobile/android/android-components/components/feature/summarize/src/test/java/mozilla/components/feature/summarize/SummarizationStoreTest.kt

@@ -59,7 +59,7 @@ class SummarizationStoreTest {
         )
 
         assertEquals(expected, states)
-        assertTrue(settings.getHasConsentedToShake())
+        assertTrue(settings.hasConsentedToShake())
     }
 
     @Test
@@ -98,7 +98,7 @@ class SummarizationStoreTest {
         )
 
         assertEquals(expected, states)
-        assertFalse(settings.getHasConsentedToShake())
+        assertFalse(settings.hasConsentedToShake())
     }
 
     @Test

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/summarization/SummarizationFragment.kt

@@ -55,7 +55,7 @@ class SummarizationFragment : BottomSheetDialogFragment() {
         SummarizationStoreViewModel.factory(
             initializedFromShake = args.fromShake,
             llmProvider = provider,
-            settings = SummarizationSettings.inMemory(),
+            settings = SummarizationSettings.sharedPrefs(requireContext()),
             pageContentExtractor = engineSession.asPageContentExtractor(),
         )
     }