Bug 1847923 - Part 1: Add ProductAnalysisMapper
rahulsainani
10 months ago
committed by
mergify[bot]
parent
30942f532a
commit
25f04469f7
@ -0,0 +1,68 @@
|
||||
package org.mozilla.fenix.shopping.middleware
|
||||
|
||||
import mozilla.components.browser.engine.gecko.shopping.GeckoProductAnalysis
|
||||
import mozilla.components.browser.engine.gecko.shopping.Highlight
|
||||
import mozilla.components.concept.engine.shopping.ProductAnalysis
|
||||
import org.mozilla.fenix.shopping.store.ReviewQualityCheckState
|
||||
import org.mozilla.fenix.shopping.store.ReviewQualityCheckState.OptedIn.ProductReviewState
|
||||
|
||||
/**
|
||||
* Maps [ProductAnalysis] to [ProductReviewState].
|
||||
*/
|
||||
fun ProductAnalysis?.toProductReviewState(): ProductReviewState =
|
||||
if (this == null) {
|
||||
ProductReviewState.Error
|
||||
} else {
|
||||
when (this) {
|
||||
is GeckoProductAnalysis -> toProductReview()
|
||||
else -> ProductReviewState.Error
|
||||
}
|
||||
}
|
||||
|
||||
private fun GeckoProductAnalysis.toProductReview(): ProductReviewState =
|
||||
if (productId == null) {
|
||||
ProductReviewState.Error
|
||||
} else {
|
||||
val mappedRating = adjustedRating.toFloatOrNull()
|
||||
val mappedGrade = grade?.toGrade()
|
||||
val mappedHighlights = highlights?.toHighlights()?.toSortedMap()
|
||||
|
||||
if (mappedGrade == null && mappedRating == null && mappedHighlights == null) {
|
||||
ProductReviewState.NoAnalysisPresent
|
||||
} else {
|
||||
ProductReviewState.AnalysisPresent(
|
||||
productId = productId!!,
|
||||
reviewGrade = mappedGrade,
|
||||
needsAnalysis = needsAnalysis,
|
||||
adjustedRating = mappedRating,
|
||||
productUrl = analysisURL!!,
|
||||
highlights = mappedHighlights,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
private fun String.toGrade(): ReviewQualityCheckState.Grade? =
|
||||
try {
|
||||
ReviewQualityCheckState.Grade.valueOf(this)
|
||||
} catch (e: IllegalArgumentException) {
|
||||
null
|
||||
}
|
||||
|
||||
private fun Highlight.toHighlights(): Map<ReviewQualityCheckState.HighlightType, List<String>>? {
|
||||
val highlights: Map<ReviewQualityCheckState.HighlightType, List<String>?> = mapOf(
|
||||
ReviewQualityCheckState.HighlightType.QUALITY to quality,
|
||||
ReviewQualityCheckState.HighlightType.PRICE to price,
|
||||
ReviewQualityCheckState.HighlightType.SHIPPING to shipping,
|
||||
ReviewQualityCheckState.HighlightType.PACKAGING_AND_APPEARANCE to appearance,
|
||||
ReviewQualityCheckState.HighlightType.COMPETITIVENESS to competitiveness,
|
||||
)
|
||||
|
||||
return highlights.filterValues { it != null }.mapValues { it.value!! }.ifEmpty { null }
|
||||
}
|
||||
|
||||
private fun Double.toFloatOrNull(): Float? =
|
||||
if (this == 0.0) {
|
||||
null
|
||||
} else {
|
||||
toFloat()
|
||||
}
|
||||
@ -0,0 +1,48 @@
|
||||
package org.mozilla.fenix.shopping
|
||||
|
||||
import mozilla.components.browser.engine.gecko.shopping.GeckoProductAnalysis
|
||||
import mozilla.components.browser.engine.gecko.shopping.Highlight
|
||||
import org.mozilla.fenix.shopping.store.ReviewQualityCheckState
|
||||
import java.util.SortedMap
|
||||
|
||||
object ProductAnalysisTestData {
|
||||
|
||||
fun productAnalysis(
|
||||
productId: String? = "1",
|
||||
analysisURL: String = "https://test.com",
|
||||
grade: String? = "A",
|
||||
adjustedRating: Double = 4.5,
|
||||
needsAnalysis: Boolean = false,
|
||||
lastAnalysisTime: Int = 0,
|
||||
deletedProductReported: Boolean = false,
|
||||
deletedProduct: Boolean = false,
|
||||
highlights: Highlight? = null,
|
||||
): GeckoProductAnalysis = GeckoProductAnalysis(
|
||||
productId = productId,
|
||||
analysisURL = analysisURL,
|
||||
grade = grade,
|
||||
adjustedRating = adjustedRating,
|
||||
needsAnalysis = needsAnalysis,
|
||||
lastAnalysisTime = lastAnalysisTime,
|
||||
deletedProductReported = deletedProductReported,
|
||||
deletedProduct = deletedProduct,
|
||||
highlights = highlights,
|
||||
)
|
||||
|
||||
fun analysisPresent(
|
||||
productId: String = "1",
|
||||
productUrl: String = "https://test.com",
|
||||
reviewGrade: ReviewQualityCheckState.Grade? = ReviewQualityCheckState.Grade.A,
|
||||
adjustedRating: Float? = 4.5f,
|
||||
needsAnalysis: Boolean = false,
|
||||
highlights: SortedMap<ReviewQualityCheckState.HighlightType, List<String>>? = null,
|
||||
): ReviewQualityCheckState.OptedIn.ProductReviewState.AnalysisPresent =
|
||||
ReviewQualityCheckState.OptedIn.ProductReviewState.AnalysisPresent(
|
||||
productId = productId,
|
||||
productUrl = productUrl,
|
||||
reviewGrade = reviewGrade,
|
||||
adjustedRating = adjustedRating,
|
||||
needsAnalysis = needsAnalysis,
|
||||
highlights = highlights,
|
||||
)
|
||||
}
|
||||
@ -0,0 +1,143 @@
|
||||
package org.mozilla.fenix.shopping.middleware
|
||||
|
||||
import mozilla.components.browser.engine.gecko.shopping.Highlight
|
||||
import mozilla.components.concept.engine.shopping.ProductAnalysis
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Test
|
||||
import org.mozilla.fenix.shopping.ProductAnalysisTestData
|
||||
import org.mozilla.fenix.shopping.store.ReviewQualityCheckState
|
||||
import org.mozilla.fenix.shopping.store.ReviewQualityCheckState.HighlightType
|
||||
|
||||
class ProductAnalysisMapperTest {
|
||||
|
||||
@Test
|
||||
fun `WHEN GeckoProductAnalysis has data THEN it is mapped to AnalysisPresent`() {
|
||||
val actual = ProductAnalysisTestData.productAnalysis(
|
||||
productId = "id1",
|
||||
grade = "C",
|
||||
needsAnalysis = false,
|
||||
adjustedRating = 3.4,
|
||||
analysisURL = "https://example.com",
|
||||
highlights = Highlight(
|
||||
quality = listOf("quality"),
|
||||
price = listOf("price"),
|
||||
shipping = listOf("shipping"),
|
||||
appearance = listOf("appearance"),
|
||||
competitiveness = listOf("competitiveness"),
|
||||
),
|
||||
).toProductReviewState()
|
||||
|
||||
val expected = ProductAnalysisTestData.analysisPresent(
|
||||
productId = "id1",
|
||||
reviewGrade = ReviewQualityCheckState.Grade.C,
|
||||
needsAnalysis = false,
|
||||
adjustedRating = 3.4f,
|
||||
productUrl = "https://example.com",
|
||||
highlights = sortedMapOf(
|
||||
HighlightType.QUALITY to listOf("quality"),
|
||||
HighlightType.PRICE to listOf("price"),
|
||||
HighlightType.SHIPPING to listOf("shipping"),
|
||||
HighlightType.PACKAGING_AND_APPEARANCE to listOf("appearance"),
|
||||
HighlightType.COMPETITIVENESS to listOf("competitiveness"),
|
||||
),
|
||||
)
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN GeckoProductAnalysis has data with some missing highlights THEN it is mapped to AnalysisPresent with the non null highlights`() {
|
||||
val actual = ProductAnalysisTestData.productAnalysis(
|
||||
productId = "id1",
|
||||
grade = "C",
|
||||
needsAnalysis = false,
|
||||
adjustedRating = 3.4,
|
||||
analysisURL = "https://example.com",
|
||||
highlights = Highlight(
|
||||
quality = listOf("quality"),
|
||||
price = null,
|
||||
shipping = null,
|
||||
appearance = listOf("appearance"),
|
||||
competitiveness = listOf("competitiveness"),
|
||||
),
|
||||
).toProductReviewState()
|
||||
|
||||
val expected = ProductAnalysisTestData.analysisPresent(
|
||||
productId = "id1",
|
||||
reviewGrade = ReviewQualityCheckState.Grade.C,
|
||||
needsAnalysis = false,
|
||||
adjustedRating = 3.4f,
|
||||
productUrl = "https://example.com",
|
||||
highlights = sortedMapOf(
|
||||
HighlightType.QUALITY to listOf("quality"),
|
||||
HighlightType.PACKAGING_AND_APPEARANCE to listOf("appearance"),
|
||||
HighlightType.COMPETITIVENESS to listOf("competitiveness"),
|
||||
),
|
||||
)
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN GeckoProductAnalysis has an invalid grade THEN it is mapped to AnalysisPresent with grade as null`() {
|
||||
val actual = ProductAnalysisTestData.productAnalysis(
|
||||
productId = "id1",
|
||||
grade = "?",
|
||||
needsAnalysis = false,
|
||||
adjustedRating = 3.4,
|
||||
analysisURL = "https://example.com",
|
||||
).toProductReviewState()
|
||||
|
||||
val expected = ProductAnalysisTestData.analysisPresent(
|
||||
productId = "id1",
|
||||
reviewGrade = null,
|
||||
needsAnalysis = false,
|
||||
adjustedRating = 3.4f,
|
||||
productUrl = "https://example.com",
|
||||
)
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN product analysis is null THEN it is mapped to Error`() {
|
||||
val actual = null.toProductReviewState()
|
||||
val expected = ReviewQualityCheckState.OptedIn.ProductReviewState.Error
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN product id is null THEN it is mapped to Error`() {
|
||||
val actual =
|
||||
ProductAnalysisTestData.productAnalysis(productId = null).toProductReviewState()
|
||||
val expected = ReviewQualityCheckState.OptedIn.ProductReviewState.Error
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN grade, rating and highlights are all null THEN it is mapped to no analysis present`() {
|
||||
val actual =
|
||||
ProductAnalysisTestData.productAnalysis(
|
||||
grade = null,
|
||||
adjustedRating = 0.0,
|
||||
highlights = null,
|
||||
).toProductReviewState()
|
||||
val expected = ReviewQualityCheckState.OptedIn.ProductReviewState.NoAnalysisPresent
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN ProductAnalysis is not GeckoProductAnalysis THEN it is mapped to Error`() {
|
||||
val randomAnalysis = object : ProductAnalysis {
|
||||
override val productId: String = "id1"
|
||||
}
|
||||
|
||||
val actual = randomAnalysis.toProductReviewState()
|
||||
val expected = ReviewQualityCheckState.OptedIn.ProductReviewState.Error
|
||||
|
||||
assertEquals(expected, actual)
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue