ishan
/
fenix
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

For #26424 - Add contrasting text color for migrated Turning Red Wallpapers

This commit is contained in:
Mugurell 2022-09-14 14:38:26 +03:00 committed by mergify[bot]
parent 817827997f
commit d987afd23a
3 changed files with 82 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
app/src/main/java/org/mozilla/fenix/wallpapers/LegacyWallpaperMigration.kt
View File

@ -7,6 +7,7 @@ package org.mozilla.fenix.wallpapers
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import mozilla.components.support.base.log.logger.Logger
import org.mozilla.fenix.utils.Settings
import java.io.File
import java.io.IOException
@ -14,9 +15,11 @@ import java.io.IOException
* Manages the migration of legacy wallpapers to the new paths
*
* @property storageRootDirectory The top level app-local storage directory.
* @property settings Used to update the color of the text shown above wallpapers.
*/
class LegacyWallpaperMigration(
private val storageRootDirectory: File,
private val settings: Settings,
) {
/**
* Migrate the legacy wallpaper to the new path and delete the remaining legacy files.
@ -60,6 +63,11 @@ class LegacyWallpaperMigration(
"$targetDirectory/landscape.png",
),
)
// If an expired Turning Red wallpaper is successfully migrated
if (wallpaperName == TURNING_RED_MEI_WALLPAPER_NAME || wallpaperName == TURNING_RED_PANDA_WALLPAPER_NAME) {
settings.currentWallpaperTextColor = TURNING_RED_WALLPAPER_TEXT_COLOR.toLong(radix = 16)
}
} catch (e: IOException) {
Logger.error("Failed to migrate legacy wallpaper", e)
}
@ -68,4 +76,10 @@ class LegacyWallpaperMigration(
File(storageRootDirectory, "wallpapers/portrait").deleteRecursively()
File(storageRootDirectory, "wallpapers/landscape").deleteRecursively()
}
companion object {
const val TURNING_RED_MEI_WALLPAPER_NAME = "mei"
const val TURNING_RED_PANDA_WALLPAPER_NAME = "panda"
const val TURNING_RED_WALLPAPER_TEXT_COLOR = "FFFBFBFE"
}
}

5
app/src/main/java/org/mozilla/fenix/wallpapers/WallpapersUseCases.kt
View File

@ -47,7 +47,10 @@ class WallpapersUseCases(
val initialize: InitializeWallpapersUseCase by lazy {
if (FeatureFlags.wallpaperV2Enabled) {
val metadataFetcher = WallpaperMetadataFetcher(client)
val migrationHelper = LegacyWallpaperMigration(storageRootDirectory)
val migrationHelper = LegacyWallpaperMigration(
storageRootDirectory = storageRootDirectory,
settings = context.settings(),
)
DefaultInitializeWallpaperUseCase(
store = store,
downloader = downloader,

65
app/src/test/java/org/mozilla/fenix/wallpapers/LegacyWallpaperMigrationTest.kt
View File

@ -1,5 +1,7 @@
package org.mozilla.fenix.wallpapers
import io.mockk.mockk
import io.mockk.verify
import kotlinx.coroutines.test.runTest
import org.junit.Assert.assertFalse
import org.junit.Assert.assertTrue
@ -7,12 +9,17 @@ import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.rules.TemporaryFolder
import org.mozilla.fenix.utils.Settings
import org.mozilla.fenix.wallpapers.LegacyWallpaperMigration.Companion.TURNING_RED_MEI_WALLPAPER_NAME
import org.mozilla.fenix.wallpapers.LegacyWallpaperMigration.Companion.TURNING_RED_PANDA_WALLPAPER_NAME
import org.mozilla.fenix.wallpapers.LegacyWallpaperMigration.Companion.TURNING_RED_WALLPAPER_TEXT_COLOR
import java.io.File
class LegacyWallpaperMigrationTest {
@Rule
@JvmField
val tempFolder = TemporaryFolder()
private lateinit var settings: Settings
private lateinit var wallpapersFolder: File
private lateinit var migrationHelper: LegacyWallpaperMigration
private lateinit var portraitLightFolder: File
@ -23,8 +30,10 @@ class LegacyWallpaperMigrationTest {
@Before
fun setup() {
wallpapersFolder = File(tempFolder.root, "wallpapers")
settings = mockk(relaxed = true)
migrationHelper = LegacyWallpaperMigration(
storageRootDirectory = tempFolder.root,
settings = settings,
)
}
@ -83,8 +92,62 @@ class LegacyWallpaperMigrationTest {
assertFalse(getAllFiles(landscapeOnlyWallpaperName).any { it.exists() })
}
@Test
fun `GIVEN a Turning Red wallpaper WHEN it is successfully migrated THEN set a matching text color`() {
runTest {
createAllLegacyFiles(TURNING_RED_MEI_WALLPAPER_NAME)
migrationHelper.migrateLegacyWallpaper(TURNING_RED_MEI_WALLPAPER_NAME)
assertTrue(getAllFiles(TURNING_RED_MEI_WALLPAPER_NAME).all { it.exists() })
verify(exactly = 1) {
settings.currentWallpaperTextColor = TURNING_RED_WALLPAPER_TEXT_COLOR.toLong(radix = 16)
}
createAllLegacyFiles(TURNING_RED_PANDA_WALLPAPER_NAME)
migrationHelper.migrateLegacyWallpaper(TURNING_RED_PANDA_WALLPAPER_NAME)
assertTrue(getAllFiles(TURNING_RED_PANDA_WALLPAPER_NAME).all { it.exists() })
verify(exactly = 2) {
settings.currentWallpaperTextColor = TURNING_RED_WALLPAPER_TEXT_COLOR.toLong(radix = 16)
}
}
}
@Test
fun `GIVEN a Turning Red wallpaper WHEN it can't be migrated THEN don't set a matching text color`() {
runTest {
migrationHelper.migrateLegacyWallpaper(TURNING_RED_MEI_WALLPAPER_NAME)
migrationHelper.migrateLegacyWallpaper(TURNING_RED_PANDA_WALLPAPER_NAME)
assertFalse(getAllFiles(TURNING_RED_MEI_WALLPAPER_NAME).all { it.exists() })
assertFalse(getAllFiles(TURNING_RED_PANDA_WALLPAPER_NAME).all { it.exists() })
verify(exactly = 0) {
settings.currentWallpaperTextColor = TURNING_RED_WALLPAPER_TEXT_COLOR.toLong(radix = 16)
}
}
}
@Test
fun `GIVEN legacy wallpapers different than Turning Red WHEN they are tried to be migrated THEN don't set a matching text color`() {
runTest {
val wallpaper1 = "wallpaper1"
val wallpaper2 = "wallpaper2"
migrationHelper.migrateLegacyWallpaper(wallpaper1)
assertFalse(getAllFiles(wallpaper1).all { it.exists() })
verify(exactly = 0) {
settings.currentWallpaperTextColor = TURNING_RED_WALLPAPER_TEXT_COLOR.toLong(radix = 16)
}
createAllLegacyFiles(wallpaper2)
migrationHelper.migrateLegacyWallpaper(wallpaper2)
assertTrue(getAllFiles(wallpaper2).all { it.exists() })
verify(exactly = 0) {
settings.currentWallpaperTextColor = TURNING_RED_WALLPAPER_TEXT_COLOR.toLong(radix = 16)
}
}
}
private fun createAllLegacyFiles(name: String) {
if (!this::portraitLightFolder.isInitialized) {
if (!this::portraitLightFolder.isInitialized || !portraitLightFolder.exists()) {
portraitLightFolder = tempFolder.newFolder("wallpapers", "portrait", "light")
portraitDarkFolder = tempFolder.newFolder("wallpapers", "portrait", "dark")
landscapeLightFolder = tempFolder.newFolder("wallpapers", "landscape", "light")