[fenix] For https://github.com/mozilla-mobile/fenix/issues/26423: add wallpaper metadata fetcher
parent
c347dbfb02
commit
278a5bbf30
@ -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
|
||||
}
|
||||
}
|
@ -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
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue