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

For #26423: add wallpaper metadata fetcher

This commit is contained in:
MatthewTighe 2022-08-16 13:57:34 -07:00 committed by mergify[bot]
parent bb44bfb72c
commit 532156bed6
8 changed files with 552 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
app/src/main/java/org/mozilla/fenix/wallpapers/Wallpaper.kt
View File

@ -10,21 +10,39 @@ import java.util.Date
* Type that represents wallpapers.
*
* @property name The name of the wallpaper.
* @property collectionName The name of the collection the wallpaper belongs to.
* @property availableLocales The locales that this wallpaper is restricted to. If null, the wallpaper
* @property collection The name of the collection the wallpaper belongs to.
* is not restricted.
* @property startDate The date the wallpaper becomes available in a promotion. If null, it is available
* from any date.
* @property endDate The date the wallpaper stops being available in a promotion. If null,
* the wallpaper will be available to any date.
* @property textColor The 8 digit hex code color that should be used for text overlaying the wallpaper.
* @property cardColor The 8 digit hex code color that should be used for cards overlaying the wallpaper.
*/
data class Wallpaper(
val name: String,
val collectionName: String,
val availableLocales: List<String>?,
val startDate: Date?,
val endDate: Date?
val collection: Collection,
val textColor: Long?,
val cardColor: Long?,
) {
/**
* Type that represents a collection that a [Wallpaper] belongs to.
*
* @property name The name of the collection the wallpaper belongs to.
* @property learnMoreUrl The URL that can be visited to learn more about a collection, if any.
* @property availableLocales The locales that this wallpaper is restricted to. If null, the wallpaper
* is not restricted.
* @property startDate The date the wallpaper becomes available in a promotion. If null, it is available
* from any date.
* @property endDate The date the wallpaper stops being available in a promotion. If null,
* the wallpaper will be available to any date.
*/
data class Collection(
val name: String,
val heading: String?,
val description: String?,
val learnMoreUrl: String?,
val availableLocales: List<String>?,
val startDate: Date?,
val endDate: Date?,
)
companion object {
const val amethystName = "amethyst"
const val ceruleanName = "cerulean"
@ -33,13 +51,21 @@ data class Wallpaper(
const val beachVibeName = "beach-vibe"
const val firefoxCollectionName = "firefox"
const val defaultName = "default"
val Default = Wallpaper(
val DefaultCollection = Collection(
name = defaultName,
collectionName = defaultName,
heading = null,
description = null,
learnMoreUrl = null,
availableLocales = null,
startDate = null,
endDate = null,
)
val Default = Wallpaper(
name = defaultName,
collection = DefaultCollection,
textColor = null,
cardColor = null,
)
/**
* Defines the standard path at which a wallpaper resource is kept on disk.

2
app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperDownloader.kt
View File

@ -78,7 +78,7 @@ class WallpaperDownloader(
val remotePath = "${context.resolutionSegment()}/" +
"$orientation/" +
"$theme/" +
"$collectionName/" +
"${collection.name}/" +
"$name.png"
WallpaperMetadata(remotePath, localPath)
}

7
app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperFileManager.kt
View File

@ -28,10 +28,9 @@ class WallpaperFileManager(
if (getAllLocalWallpaperPaths(name).all { File(rootDirectory, it).exists() }) {
Wallpaper(
name = name,
collectionName = "",
availableLocales = null,
startDate = null,
endDate = null,
collection = Wallpaper.DefaultCollection,
textColor = null,
cardColor = null,
)
} else null
}

101
app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperMetadataFetcher.kt Normal file
View File

@ -0,0 +1,101 @@
/* 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.wallpapers
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import mozilla.components.concept.fetch.Client
import mozilla.components.concept.fetch.Request
import org.json.JSONArray
import org.json.JSONObject
import org.mozilla.fenix.BuildConfig
import java.text.SimpleDateFormat
import java.util.Date
import java.util.Locale
/**
* Utility class for downloading wallpaper metadata from the remote server.
*
* @property client The client that will be used to fetch metadata.
*/
class WallpaperMetadataFetcher(
private val client: Client
) {
private val metadataUrl = BuildConfig.WALLPAPER_URL.substringBefore("android") +
"metadata/v$currentJsonVersion/wallpapers.json"
/**
* Downloads the list of wallpapers from the remote source. Failures will return an empty list.
*/
suspend fun downloadWallpaperList(): List<Wallpaper> = withContext(Dispatchers.IO) {
Result.runCatching {
val request = Request(url = metadataUrl, method = Request.Method.GET)
val response = client.fetch(request)
response.body.useBufferedReader {
val json = it.readText()
JSONObject(json).parseAsWallpapers()
}
}.getOrElse { listOf() }
}
private fun JSONObject.parseAsWallpapers(): List<Wallpaper> = with(getJSONArray("collections")) {
(0 until length()).map { index ->
getJSONObject(index).toCollectionOfWallpapers()
}.flatten()
}
private fun JSONObject.toCollectionOfWallpapers(): List<Wallpaper> {
val collectionId = getString("id")
val heading = optString("heading")
val description = optString("description")
val availableLocales = optJSONArray("available-locales")?.getAvailableLocales()
val availabilityRange = optJSONObject("availability-range")?.getAvailabilityRange()
val learnMoreUrl = optString("learn-more-url")
val collection = Wallpaper.Collection(
name = collectionId,
heading = heading,
description = description,
availableLocales = availableLocales,
startDate = availabilityRange?.first,
endDate = availabilityRange?.second,
learnMoreUrl = learnMoreUrl,
)
return getJSONArray("wallpapers").toWallpaperList(collection)
}
private fun JSONArray.getAvailableLocales(): List<String>? =
(0 until length()).map { getString(it) }
private fun JSONObject.getAvailabilityRange(): Pair<Date, Date>? {
val formatter = SimpleDateFormat("yyyy-MM-dd", Locale.US)
return Result.runCatching {
formatter.parse(getString("start"))!! to formatter.parse(getString("end"))!!
}.getOrNull()
}
private fun JSONArray.toWallpaperList(collection: Wallpaper.Collection): List<Wallpaper> =
(0 until length()).map { index ->
with(getJSONObject(index)) {
Wallpaper(
name = getString("id"),
textColor = getArgbValueAsLong("text-color"),
cardColor = getArgbValueAsLong("card-color"),
collection = collection,
)
}
}
/**
* The wallpaper metadata has 6 digit hex color codes for compatibility with iOS. Since Android
* expects 8 digit ARBG values, we prepend FF for the "fully visible" version of the color
* listed in the metadata.
*/
private fun JSONObject.getArgbValueAsLong(propName: String): Long = "FF${getString(propName)}"
.toLong(radix = 16)
companion object {
internal const val currentJsonVersion = 1
}
}

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

@ -124,51 +124,55 @@ class WallpapersUseCases(
}
private fun Wallpaper.isExpired(): Boolean {
val expired = this.endDate?.let { Date().after(it) } ?: false
val expired = this.collection.endDate?.let { Date().after(it) } ?: false
return expired && this.name != settings.currentWallpaper
}
private fun Wallpaper.isAvailableInLocale(): Boolean =
this.availableLocales?.contains(currentLocale) ?: true
this.collection.availableLocales?.contains(currentLocale) ?: true
companion object {
private val firefoxClassicCollection = Wallpaper.Collection(
name = Wallpaper.firefoxCollectionName,
heading = null,
description = null,
availableLocales = null,
startDate = null,
endDate = null,
learnMoreUrl = null
)
private val localWallpapers: List<Wallpaper> = listOf(
Wallpaper(
name = Wallpaper.amethystName,
collectionName = Wallpaper.firefoxCollectionName,
availableLocales = null,
startDate = null,
endDate = null,
collection = firefoxClassicCollection,
textColor = null,
cardColor = null,
),
Wallpaper(
name = Wallpaper.ceruleanName,
collectionName = Wallpaper.firefoxCollectionName,
availableLocales = null,
startDate = null,
endDate = null,
collection = firefoxClassicCollection,
textColor = null,
cardColor = null,
),
Wallpaper(
name = Wallpaper.sunriseName,
collectionName = Wallpaper.firefoxCollectionName,
availableLocales = null,
startDate = null,
endDate = null,
collection = firefoxClassicCollection,
textColor = null,
cardColor = null,
),
)
private val remoteWallpapers: List<Wallpaper> = listOf(
Wallpaper(
name = Wallpaper.twilightHillsName,
collectionName = Wallpaper.firefoxCollectionName,
availableLocales = null,
startDate = null,
endDate = null,
collection = firefoxClassicCollection,
textColor = null,
cardColor = null,
),
Wallpaper(
name = Wallpaper.beachVibeName,
collectionName = Wallpaper.firefoxCollectionName,
availableLocales = null,
startDate = null,
endDate = null,
collection = firefoxClassicCollection,
textColor = null,
cardColor = null,
),
)
val allWallpapers = listOf(Wallpaper.Default) + localWallpapers + remoteWallpapers
@ -278,7 +282,7 @@ class WallpapersUseCases(
Wallpapers.wallpaperSelected.record(
Wallpapers.WallpaperSelectedExtra(
name = wallpaper.name,
themeCollection = wallpaper.collectionName
themeCollection = wallpaper.collection.name
)
)
}

15
app/src/test/java/org/mozilla/fenix/wallpapers/WallpaperFileManagerTest.kt
View File

@ -96,9 +96,16 @@ class WallpaperFileManagerTest {
private fun generateWallpaper(name: String) = Wallpaper(
name = name,
collectionName = "",
availableLocales = null,
startDate = null,
endDate = null
textColor = null,
cardColor = null,
collection = Wallpaper.Collection(
name = Wallpaper.defaultName,
heading = null,
description = null,
availableLocales = null,
startDate = null,
endDate = null,
learnMoreUrl = null
),
)
}

349
app/src/test/java/org/mozilla/fenix/wallpapers/WallpaperMetadataFetcherTest.kt Normal file
View File

@ -0,0 +1,349 @@
package org.mozilla.fenix.wallpapers
import androidx.test.ext.junit.runners.AndroidJUnit4
import io.mockk.every
import io.mockk.mockk
import kotlinx.coroutines.test.runTest
import mozilla.components.concept.fetch.Client
import mozilla.components.concept.fetch.Request
import mozilla.components.concept.fetch.Response
import org.junit.Assert.assertEquals
import org.junit.Assert.assertTrue
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.mozilla.fenix.BuildConfig
import org.mozilla.fenix.wallpapers.WallpaperMetadataFetcher.Companion.currentJsonVersion
import java.text.SimpleDateFormat
import java.util.Calendar
import java.util.Locale
@RunWith(AndroidJUnit4::class)
class WallpaperMetadataFetcherTest {
private val expectedRequest = Request(
url = BuildConfig.WALLPAPER_URL.substringBefore("android") +
"metadata/v$currentJsonVersion/wallpapers.json",
method = Request.Method.GET
)
private val mockResponse = mockk<Response>()
private val mockClient = mockk<Client> {
every { fetch(expectedRequest) } returns mockResponse
}
private lateinit var metadataFetcher: WallpaperMetadataFetcher
@Before
fun setup() {
metadataFetcher = WallpaperMetadataFetcher(mockClient)
}
@Test
fun `GIVEN wallpaper metadata WHEN parsed THEN wallpapers have correct ids, text and card colors`() = runTest {
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": null,
"availability-range": null,
"wallpapers": [
{
"id": "beach-vibes",
"text-color": "FBFBFE",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
with(wallpapers[0]) {
assertEquals(0xFFFBFBFE, textColor)
assertEquals(0xFF15141A, cardColor)
}
with(wallpapers[1]) {
assertEquals(0xFF15141A, textColor)
assertEquals(0xFFFBFBFE, cardColor)
}
}
@Test
fun `GIVEN wallpaper metadata is missing an id WHEN parsed THEN parsing fails`() = runTest {
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": null,
"availability-range": null,
"wallpapers": [
{
"text-color": "FBFBFE",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isEmpty())
}
@Test
fun `GIVEN wallpaper metadata is missing a text color WHEN parsed THEN parsing fails`() = runTest {
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": null,
"availability-range": null,
"wallpapers": [
{
"id": "beach-vibes",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isEmpty())
}
@Test
fun `GIVEN wallpaper metadata is missing a card color WHEN parsed THEN parsing fails`() = runTest {
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": null,
"availability-range": null,
"wallpapers": [
{
"id": "beach-vibes",
"text-color": "FBFBFE",
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isEmpty())
}
@Test
fun `GIVEN collection with specified locales WHEN parsed THEN wallpapers includes locales`() = runTest {
val locales = listOf("en-US", "es-US", "en-CA", "fr-CA")
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": ["en-US", "es-US", "en-CA", "fr-CA"],
"availability-range": null,
"wallpapers": [
{
"id": "beach-vibes",
"text-color": "FBFBFE",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isNotEmpty())
assertTrue(
wallpapers.all {
it.collection.availableLocales == locales
}
)
}
@Test
fun `GIVEN collection with specified date range WHEN parsed THEN wallpapers includes dates`() = runTest {
val calendar = Calendar.getInstance()
val startDate = calendar.run {
set(2022, Calendar.JUNE, 27)
time
}
val endDate = calendar.run {
set(2022, Calendar.SEPTEMBER, 30)
time
}
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": null,
"availability-range": {
"start": "2022-06-27",
"end": "2022-09-30"
},
"wallpapers": [
{
"id": "beach-vibes",
"text-color": "FBFBFE",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isNotEmpty())
assertTrue(
wallpapers.all {
val formatter = SimpleDateFormat("yyyy-MM-dd", Locale.US)
formatter.format(startDate) == formatter.format(it.collection.startDate!!) &&
formatter.format(endDate) == formatter.format(it.collection.endDate!!)
}
)
}
@Test
fun `GIVEN collection with specified learn more url WHEN parsed THEN wallpapers includes url`() = runTest {
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"available-locales": null,
"availability-range": null,
"learn-more-url": "https://www.mozilla.org",
"wallpapers": [
{
"id": "beach-vibes",
"text-color": "FBFBFE",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isNotEmpty())
assertTrue(
wallpapers.all {
it.collection.learnMoreUrl == "https://www.mozilla.org"
}
)
}
@Test
fun `GIVEN collection with specified heading and description WHEN parsed THEN wallpapers include them`() = runTest {
val heading = "A classic firefox experience"
val description = "Check out these cool foxes, they're adorable and can be your wallpaper"
val json = """
{
"last-updated-date": "2022-01-01",
"collections": [
{
"id": "classic-firefox",
"heading": "$heading",
"description": "$description",
"available-locales": null,
"availability-range": null,
"learn-more-url": null,
"wallpapers": [
{
"id": "beach-vibes",
"text-color": "FBFBFE",
"card-color": "15141A"
},
{
"id": "sunrise",
"text-color": "15141A",
"card-color": "FBFBFE"
}
]
}
]
}
""".trimIndent()
every { mockResponse.body } returns Response.Body(json.byteInputStream())
val wallpapers = metadataFetcher.downloadWallpaperList()
assertTrue(wallpapers.isNotEmpty())
assertTrue(
wallpapers.all {
it.collection.heading == heading && it.collection.description == description
}
)
}
}

30
app/src/test/java/org/mozilla/fenix/wallpapers/WallpapersUseCasesTest.kt
View File

@ -266,18 +266,32 @@ class WallpapersUseCasesTest {
return if (isInPromo) {
Wallpaper(
name = name,
collectionName = "",
availableLocales = listOf("en-US"),
startDate = null,
endDate = relativeTime
collection = Wallpaper.Collection(
name = Wallpaper.firefoxCollectionName,
heading = null,
description = null,
availableLocales = listOf("en-US"),
startDate = null,
endDate = relativeTime,
learnMoreUrl = null
),
textColor = null,
cardColor = null,
)
} else {
Wallpaper(
name = name,
collectionName = "",
availableLocales = null,
startDate = null,
endDate = relativeTime
collection = Wallpaper.Collection(
name = Wallpaper.firefoxCollectionName,
heading = null,
description = null,
availableLocales = null,
startDate = null,
endDate = relativeTime,
learnMoreUrl = null
),
textColor = null,
cardColor = null,
)
}
}