Bug 1955886 - Add app icon repository r=android-reviewers,sfamisa,marcin

mavduevskiy · mavduevskiy · commit 32c7c425b70d · 2025-07-24T22:37:16.000Z
Differential Revision: https://phabricator.services.mozilla.com/D256749
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/ActivityAlias.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/ActivityAlias.kt
@@ -182,6 +182,9 @@ enum class AliasSuffix(val suffix: String) {
     AppPride("AppPride"),
     AppCute("AppCute"),
     AppMomo("AppMomo"),
+
+    // This one is for testing purposes only; not intended to be used.
+    Unknown("Unknown"),
     ;
 
     /**
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/SettingsAppIcon.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/SettingsAppIcon.kt
@@ -5,6 +5,7 @@
 package org.mozilla.fenix.iconpicker
 
 import androidx.annotation.StringRes
+import androidx.annotation.VisibleForTesting
 import org.mozilla.fenix.R
 
 /**
@@ -67,7 +68,9 @@ data class SettingsAppIcon(
             activityAlias = ActivityAlias.AppGradientGoldenHour,
             titleId = R.string.alternative_app_icon_option_gradient_golden_hour,
         )
-        private val appGradientSunset = SettingsAppIcon(
+
+        @VisibleForTesting
+        internal val appGradientSunset = SettingsAppIcon(
             activityAlias = ActivityAlias.AppGradientSunset,
             titleId = R.string.alternative_app_icon_option_gradient_sunset,
         )
@@ -150,6 +153,39 @@ data class SettingsAppIcon(
                 appMomo,
             ),
         )
+
+        /**
+         * Returns the [SettingsAppIcon] associated with the provided [AliasSuffix].
+         *
+         * @param aliasSuffix The [AliasSuffix] used to find the corresponding [SettingsAppIcon].
+         */
+        fun fromAliasSuffix(aliasSuffix: AliasSuffix): SettingsAppIcon =
+            allIcons.find { it.activityAlias.aliasSuffix == aliasSuffix } ?: appDefault
+
+        private val allIcons = listOf(
+            appDefault,
+            appSolidLight,
+            appSolidDark,
+            appSolidRed,
+            appSolidGreen,
+            appSolidBlue,
+            appSolidPurple,
+            appSolidPurpleDark,
+            appGradientSunrise,
+            appGradientGoldenHour,
+            appGradientSunset,
+            appGradientBlueHour,
+            appGradientTwilight,
+            appGradientMidnight,
+            appGradientNorthernLights,
+            appRetro2004,
+            appRetro2017,
+            appPixelated,
+            appMinimal,
+            appPride,
+            appCute,
+            appMomo,
+        )
     }
 }
 
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/SettingsAppIconRepository.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/SettingsAppIconRepository.kt
@@ -0,0 +1,39 @@
+/* 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 org.mozilla.fenix.iconpicker
+
+import org.mozilla.fenix.utils.Settings
+
+/**
+ * An interface for accessing available and selected app icon options, as well as persisting the
+ * selected one.
+ */
+interface SettingsAppIconRepository {
+    /**
+     * The icon selected by the user or the default one.
+     */
+    var selectedAppIcon: SettingsAppIcon
+
+    /**
+     * Icons available for the user to choose from.
+     */
+    val groupedAppIcons: Map<SettingsGroupTitle, List<SettingsAppIcon>>
+}
+
+/**
+ * Default implementation of the [SettingsAppIconRepository]
+ *
+ * @param settings The settings object used to persist the selected icon.
+ */
+class DefaultSettingsAppIconRepository(
+    private val settings: Settings,
+) : SettingsAppIconRepository {
+    override var selectedAppIcon: SettingsAppIcon
+        get() = SettingsAppIcon.fromAliasSuffix(AliasSuffix.fromString(settings.selectedAppIcon))
+        set(value) { settings.selectedAppIcon = value.activityAlias.aliasSuffix.suffix }
+
+    override val groupedAppIcons: Map<SettingsGroupTitle, List<SettingsAppIcon>>
+        get() = SettingsAppIcon.groupedAppIcons
+}
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/ui/AppIconPreference.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/ui/AppIconPreference.kt
@@ -27,7 +27,10 @@ import androidx.preference.Preference
 import androidx.preference.PreferenceViewHolder
 import mozilla.components.compose.base.annotation.FlexibleWindowLightDarkPreview
 import org.mozilla.fenix.R
+import org.mozilla.fenix.ext.settings
+import org.mozilla.fenix.iconpicker.DefaultSettingsAppIconRepository
 import org.mozilla.fenix.iconpicker.SettingsAppIcon
+import org.mozilla.fenix.iconpicker.SettingsAppIconRepository
 import org.mozilla.fenix.settings.CustomizationFragmentDirections
 import org.mozilla.fenix.theme.FirefoxTheme
 
@@ -42,6 +45,10 @@ class AppIconPreference @JvmOverloads constructor(
     attrs: AttributeSet? = null,
 ) : Preference(context, attrs) {
 
+    private val appIconRepository: SettingsAppIconRepository by lazy {
+        DefaultSettingsAppIconRepository(context.settings())
+    }
+
     init {
         layoutResource = R.layout.app_icon_preference
     }
@@ -52,7 +59,7 @@ class AppIconPreference @JvmOverloads constructor(
         (holder.findViewById(R.id.compose_view) as ComposeView).setContent {
             FirefoxTheme {
                 SelectAppIcon(
-                    appIcon = SettingsAppIcon.appDefault,
+                    appIcon = appIconRepository.selectedAppIcon,
                     onClick = {
                         val navController = holder.itemView.findNavController()
                         navController.navigate(
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/ui/AppIconSelectionFragment.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/iconpicker/ui/AppIconSelectionFragment.kt
@@ -12,16 +12,21 @@ import androidx.fragment.app.Fragment
 import androidx.navigation.fragment.findNavController
 import mozilla.components.support.base.feature.UserInteractionHandler
 import org.mozilla.fenix.R
+import org.mozilla.fenix.ext.settings
 import org.mozilla.fenix.ext.showToolbar
-import org.mozilla.fenix.iconpicker.ActivityAlias
-import org.mozilla.fenix.iconpicker.SettingsAppIcon
+import org.mozilla.fenix.iconpicker.DefaultSettingsAppIconRepository
+import org.mozilla.fenix.iconpicker.SettingsAppIconRepository
 import org.mozilla.fenix.theme.FirefoxTheme
 
 /**
  * Fragment that displays a list of alternative app icons.
  */
 class AppIconSelectionFragment : Fragment(), UserInteractionHandler {
 
+    private val appIconRepository: SettingsAppIconRepository by lazy {
+        DefaultSettingsAppIconRepository(requireContext().settings())
+    }
+
     override fun onCreateView(
         inflater: LayoutInflater,
         container: ViewGroup?,
@@ -30,9 +35,13 @@ class AppIconSelectionFragment : Fragment(), UserInteractionHandler {
         setContent {
             FirefoxTheme {
                 AppIconSelection(
-                    currentAppIcon = ActivityAlias.AppDefault,
-                    groupedIconOptions = SettingsAppIcon.groupedAppIcons,
-                    onClick = {},
+                    currentAppIcon = appIconRepository.selectedAppIcon.activityAlias,
+                    groupedIconOptions = appIconRepository.groupedAppIcons,
+                    onClick = { selectedAppIcon ->
+                        // a warning dialog about app restart will be added here
+                        // in https://bugzilla.mozilla.org/show_bug.cgi?id=1976776
+                        appIconRepository.selectedAppIcon = selectedAppIcon
+                    },
                 )
             }
         }
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/utils/Settings.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/utils/Settings.kt
@@ -49,6 +49,7 @@ import org.mozilla.fenix.ext.components
 import org.mozilla.fenix.ext.getPreferenceKey
 import org.mozilla.fenix.home.pocket.ContentRecommendationsFeatureHelper
 import org.mozilla.fenix.home.topsites.TopSitesConfigConstants.TOP_SITES_MAX_COUNT
+import org.mozilla.fenix.iconpicker.AliasSuffix
 import org.mozilla.fenix.nimbus.CookieBannersSection
 import org.mozilla.fenix.nimbus.FxNimbus
 import org.mozilla.fenix.nimbus.HomeScreenSection
@@ -2613,6 +2614,14 @@ class Settings(private val appContext: Context) : PreferencesHolder {
         default = "",
     )
 
+    /**
+     * Suffix of the currently selected app icon (launcher alias).
+     */
+    var selectedAppIcon by stringPreference(
+        key = appContext.getPreferenceKey(R.string.pref_key_selected_app_icon),
+        default = AliasSuffix.AppDefault.suffix,
+    )
+
     /**
      * Indicates whether the app should automatically clean up downloaded files.
      */
diff --git a/mobile/android/fenix/app/src/main/res/values/preference_keys.xml b/mobile/android/fenix/app/src/main/res/values/preference_keys.xml
@@ -164,6 +164,8 @@
 
     <!-- App icon settings-->
     <string name="pref_key_app_icon">pref_key_app_icon</string>
+    <string name="pref_key_selected_app_icon">pref_key_selected_app_icon</string>
+
     <!-- Menu -->
     <string name="pref_key_menu_cfr" translatable="false">pref_key_menu_cfr</string>
 
diff --git a/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/iconpicker/DefaultSettingsAppIconRepositoryTest.kt b/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/iconpicker/DefaultSettingsAppIconRepositoryTest.kt
@@ -0,0 +1,60 @@
+/* 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 org.mozilla.fenix.iconpicker
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import io.mockk.every
+import mozilla.components.support.test.robolectric.testContext
+import org.junit.Assert.assertEquals
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.mozilla.fenix.ext.settings
+import org.mozilla.fenix.utils.Settings
+
+@RunWith(AndroidJUnit4::class)
+class DefaultSettingsAppIconRepositoryTest {
+    private lateinit var settings: Settings
+
+    @Before
+    fun setup() {
+       settings = Settings(testContext)
+       every { testContext.settings() } returns settings
+    }
+
+    @Test
+    fun `WHEN the selected app icon value changes in the repository THEN the shared preference updates as well`() {
+        val repository = DefaultSettingsAppIconRepository(testContext.settings())
+        val defaultIcon = SettingsAppIcon.appDefault
+        val newAppIcon = SettingsAppIcon.appGradientSunset
+
+        assertEquals(defaultIcon.activityAlias.aliasSuffix.suffix, settings.selectedAppIcon)
+        repository.selectedAppIcon = newAppIcon
+
+        assertEquals(newAppIcon.activityAlias.aliasSuffix.suffix, settings.selectedAppIcon)
+    }
+
+    @Test
+    fun `WHEN a new value has been assigned THEN the repository returns the new value`() {
+        val repository = DefaultSettingsAppIconRepository(testContext.settings())
+        val defaultIcon = SettingsAppIcon.appDefault
+        val newAppIcon = SettingsAppIcon.appGradientSunset
+
+        assertEquals(defaultIcon, repository.selectedAppIcon)
+
+        repository.selectedAppIcon = SettingsAppIcon.appGradientSunset
+
+        assertEquals(newAppIcon, repository.selectedAppIcon)
+    }
+
+    @Test
+    fun `WHEN grouped icon list is requested THEN repository returns the settings app icon collection`() {
+        val repository = DefaultSettingsAppIconRepository(testContext.settings())
+
+        val result = repository.groupedAppIcons
+
+        assertEquals(SettingsAppIcon.groupedAppIcons, result)
+    }
+}
diff --git a/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/iconpicker/SettingsAppIconTest.kt b/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/iconpicker/SettingsAppIconTest.kt
@@ -0,0 +1,29 @@
+/* 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 org.mozilla.fenix.iconpicker
+
+import junit.framework.TestCase.assertEquals
+import org.junit.Test
+
+class SettingsAppIconTest {
+
+    @Test
+    fun `GIVEN a valid AliasSuffix WHEN fromAliasSuffix is called THEN matching SettingsAppIcon is returned`() {
+        val input = AliasSuffix.AppGradientSunset
+
+        val result = SettingsAppIcon.fromAliasSuffix(input)
+
+        assertEquals(SettingsAppIcon.appGradientSunset, result)
+    }
+
+    @Test
+    fun `GIVEN an unknown AliasSuffix WHEN fromAliasSuffix is called THEN appDefault is returned`() {
+        val unknownAliasSuffix = AliasSuffix.Unknown
+
+        val result = SettingsAppIcon.fromAliasSuffix(unknownAliasSuffix)
+
+        assertEquals(SettingsAppIcon.appDefault, result)
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,9 @@ enum class AliasSuffix(val suffix: String) {`
`182`	`182`	`AppPride("AppPride"),`
`183`	`183`	`AppCute("AppCute"),`
`184`	`184`	`AppMomo("AppMomo"),`
	`185`	`+`
	`186`	`+ // This one is for testing purposes only; not intended to be used.`
	`187`	`+ Unknown("Unknown"),`
`185`	`188`	`;`
`186`	`189`
`187`	`190`	`/**`