Archives
/
iceraven-browser
mirror of https://github.com/fork-maintainers/iceraven-browser
2
0
Fork 0
Code Issues Releases Wiki Activity

Refactor History types to eliminate nullability

Browse Source 
This introduces a separate HistoryDB type at the PagedHistoryProvider
layer, that doesn't need to deal with positions. Positioning logic in
HistoryDataSource becomes a type conversion between the new type and an
existing History type that UI and ItemKeyedDataSource API is written against.

With this refactor, we entirely eliminate nullability from these types.
upstream-sync
Grisha Kruglov 3 years ago committed by mergify[bot]
parent 836ff1151b
commit 5bbfd49e1d
11 changed files with 184 additions and 95 deletions
Show Stats Download Patch File Download Diff File

80
app/src/main/java/org/mozilla/fenix/components/history/PagedHistoryProvider.kt
Unescape Escape View File

@ -6,29 +6,75 @@ package org.mozilla.fenix.components.history
import androidx.annotation.VisibleForTesting import androidx.annotation.VisibleForTesting
import mozilla.components.browser.storage.sync.PlacesHistoryStorage import mozilla.components.browser.storage.sync.PlacesHistoryStorage
import mozilla.components.concept.storage.HistoryMetadata
import mozilla.components.concept.storage.HistoryMetadataKey
import mozilla.components.concept.storage.VisitInfo import mozilla.components.concept.storage.VisitInfo
import mozilla.components.concept.storage.VisitType import mozilla.components.concept.storage.VisitType
import mozilla.components.support.ktx.kotlin.tryGetHostFromUrl import mozilla.components.support.ktx.kotlin.tryGetHostFromUrl
import org.mozilla.fenix.FeatureFlags import org.mozilla.fenix.FeatureFlags
import org.mozilla.fenix.library.history.History import org.mozilla.fenix.library.history.History
import org.mozilla.fenix.library.history.toHistoryMetadata
import org.mozilla.fenix.perf.runBlockingIncrement import org.mozilla.fenix.perf.runBlockingIncrement
import kotlin.math.abs import kotlin.math.abs
private const val BUFFER_TIME = 15000 /* 15 seconds in ms */ private const val BUFFER_TIME = 15000 /* 15 seconds in ms */
/** /**
* An Interface for providing a paginated list of [History]. * Class representing a history entry.
* Contrast this with [History] that's the same, but with an assigned position, for pagination
* and display purposes.
*/
sealed class HistoryDB {
abstract val title: String
abstract val visitedAt: Long
abstract val selected: Boolean
data class Regular(
override val title: String,
val url: String,
override val visitedAt: Long,
override val selected: Boolean = false
) : HistoryDB()
data class Metadata(
override val title: String,
val url: String,
override val visitedAt: Long,
val totalViewTime: Int,
val historyMetadataKey: HistoryMetadataKey,
override val selected: Boolean = false
) : HistoryDB()
data class Group(
override val title: String,
override val visitedAt: Long,
val items: List<Metadata>,
override val selected: Boolean = false
) : HistoryDB()
}
private fun HistoryMetadata.toHistoryDBMetadata(): HistoryDB.Metadata {
return HistoryDB.Metadata(
title = title?.takeIf(String::isNotEmpty)
?: key.url.tryGetHostFromUrl(),
url = key.url,
visitedAt = createdAt,
totalViewTime = totalViewTime,
historyMetadataKey = key
)
}
/**
* An Interface for providing a paginated list of [HistoryDB].
*/ */
interface PagedHistoryProvider { interface PagedHistoryProvider {
/** /**
* Gets a list of [History]. * Gets a list of [HistoryDB].
* *
* @param offset How much to offset the list by * @param offset How much to offset the list by
* @param numberOfItems How many items to fetch * @param numberOfItems How many items to fetch
* @param onComplete A callback that returns the list of [History] * @param onComplete A callback that returns the list of [HistoryDB]
*/ */
fun getHistory(offset: Int, numberOfItems: Int, onComplete: (List<History>) -> Unit) fun getHistory(offset: Int, numberOfItems: Int, onComplete: (List<HistoryDB>) -> Unit)
} }
/** /**
@ -59,18 +105,18 @@ class DefaultPagedHistoryProvider(
it == VisitType.REDIRECT_PERMANENT || it == VisitType.REDIRECT_TEMPORARY it == VisitType.REDIRECT_PERMANENT || it == VisitType.REDIRECT_TEMPORARY
} }
@Volatile private var historyGroups: List<History.Group>? = null @Volatile private var historyGroups: List<HistoryDB.Group>? = null
@Suppress("LongMethod") @Suppress("LongMethod")
override fun getHistory( override fun getHistory(
offset: Int, offset: Int,
numberOfItems: Int, numberOfItems: Int,
onComplete: (List<History>) -> Unit, onComplete: (List<HistoryDB>) -> Unit,
) { ) {
// A PagedList DataSource runs on a background thread automatically. // A PagedList DataSource runs on a background thread automatically.
// If we run this in our own coroutineScope it breaks the PagedList // If we run this in our own coroutineScope it breaks the PagedList
runBlockingIncrement { runBlockingIncrement {
val history: List<History> val history: List<HistoryDB>
if (showHistorySearchGroups) { if (showHistorySearchGroups) {
// We need to re-fetch all the history metadata if the offset resets back at 0 // We need to re-fetch all the history metadata if the offset resets back at 0
@ -81,10 +127,10 @@ class DefaultPagedHistoryProvider(
.filter { it.key.searchTerm != null } .filter { it.key.searchTerm != null }
.groupBy { it.key.searchTerm!! } .groupBy { it.key.searchTerm!! }
.map { (searchTerm, items) -> .map { (searchTerm, items) ->
History.Group( HistoryDB.Group(
title = searchTerm, title = searchTerm,
visitedAt = items.first().createdAt, visitedAt = items.first().createdAt,
items = items.map { it.toHistoryMetadata() } items = items.map { it.toHistoryDBMetadata() }
) )
} }
} }
@ -143,9 +189,9 @@ class DefaultPagedHistoryProvider(
private suspend fun getHistoryAndSearchGroups( private suspend fun getHistoryAndSearchGroups(
offset: Int, offset: Int,
numberOfItems: Int, numberOfItems: Int,
): List<History> { ): List<HistoryDB> {
val result = mutableListOf<History>() val result = mutableListOf<HistoryDB>()
val history: List<History.Regular> = historyStorage val history: List<HistoryDB.Regular> = historyStorage
.getVisitsPaginated( .getVisitsPaginated(
offset.toLong(), offset.toLong(),
numberOfItems.toLong(), numberOfItems.toLong(),
@ -207,12 +253,12 @@ class DefaultPagedHistoryProvider(
.sortedByDescending { it.visitedAt } .sortedByDescending { it.visitedAt }
} }
private fun transformVisitInfoToHistoryItem(visit: VisitInfo): History.Regular { private fun transformVisitInfoToHistoryItem(visit: VisitInfo): HistoryDB.Regular {
val title = visit.title val title = visit.title
?.takeIf(String::isNotEmpty) ?.takeIf(String::isNotEmpty)
?: visit.url.tryGetHostFromUrl() ?: visit.url.tryGetHostFromUrl()
return History.Regular( return HistoryDB.Regular(
title = title, title = title,
url = visit.url, url = visit.url,
visitedAt = visit.visitTime visitedAt = visit.visitTime
@ -221,11 +267,11 @@ class DefaultPagedHistoryProvider(
} }
@VisibleForTesting @VisibleForTesting
internal fun List<History>.removeConsecutiveDuplicates(): List<History> { internal fun List<HistoryDB>.removeConsecutiveDuplicates(): List<HistoryDB> {
var previousURL = "" var previousURL = ""
return filter { return filter {
var isNotDuplicate = true var isNotDuplicate = true
previousURL = if (it is History.Regular) { previousURL = if (it is HistoryDB.Regular) {
isNotDuplicate = it.url != previousURL isNotDuplicate = it.url != previousURL
it.url it.url
} else { } else {

2
app/src/main/java/org/mozilla/fenix/home/recentvisits/controller/RecentVisitsController.kt
Unescape Escape View File

@ -96,7 +96,7 @@ class DefaultRecentVisitsController(
HomeFragmentDirections.actionGlobalHistoryMetadataGroup( HomeFragmentDirections.actionGlobalHistoryMetadataGroup(
title = recentHistoryGroup.title, title = recentHistoryGroup.title,
historyMetadataItems = recentHistoryGroup.historyMetadata historyMetadataItems = recentHistoryGroup.historyMetadata
.map { it.toHistoryMetadata() }.toTypedArray() .mapIndexed { index, item -> item.toHistoryMetadata(index) }.toTypedArray()
) )
) )
} }

94
app/src/main/java/org/mozilla/fenix/library/history/HistoryDataSource.kt
Unescape Escape View File

@ -6,6 +6,7 @@ package org.mozilla.fenix.library.history
import androidx.annotation.VisibleForTesting import androidx.annotation.VisibleForTesting
import androidx.paging.ItemKeyedDataSource import androidx.paging.ItemKeyedDataSource
import org.mozilla.fenix.components.history.HistoryDB
import org.mozilla.fenix.components.history.PagedHistoryProvider import org.mozilla.fenix.components.history.PagedHistoryProvider
class HistoryDataSource( class HistoryDataSource(
@ -15,22 +16,20 @@ class HistoryDataSource(
// Because the pagination is not based off of the key // Because the pagination is not based off of the key
// we want to start at 1, not 0 to be able to send the correct offset // we want to start at 1, not 0 to be able to send the correct offset
// to the `historyProvider.getHistory` call. // to the `historyProvider.getHistory` call.
override fun getKey(item: History): Int = item.position!! + 1 override fun getKey(item: History): Int = item.position + 1
override fun loadInitial( override fun loadInitial(
params: LoadInitialParams<Int>, params: LoadInitialParams<Int>,
callback: LoadInitialCallback<History> callback: LoadInitialCallback<History>
) { ) {
historyProvider.getHistory(INITIAL_OFFSET, params.requestedLoadSize) { history -> historyProvider.getHistory(INITIAL_OFFSET, params.requestedLoadSize) { history ->
val positionedHistory = assignPositions(offset = INITIAL_OFFSET, history) callback.onResult(history.positionWithOffset(INITIAL_OFFSET))
callback.onResult(positionedHistory)
} }
} }
override fun loadAfter(params: LoadParams<Int>, callback: LoadCallback<History>) { override fun loadAfter(params: LoadParams<Int>, callback: LoadCallback<History>) {
historyProvider.getHistory(params.key, params.requestedLoadSize) { history -> historyProvider.getHistory(params.key, params.requestedLoadSize) { history ->
val positionedHistory = assignPositions(offset = params.key, history) callback.onResult(history.positionWithOffset(params.key))
callback.onResult(positionedHistory)
} }
} }
@ -38,38 +37,67 @@ class HistoryDataSource(
companion object { companion object {
private const val INITIAL_OFFSET = 0 private const val INITIAL_OFFSET = 0
}
}
@VisibleForTesting @VisibleForTesting
internal fun assignPositions(offset: Int, history: List<History>): List<History> { internal fun List<HistoryDB>.positionWithOffset(offset: Int): List<History> {
return history.foldIndexed(listOf()) { index, prev, item -> return this.foldIndexed(listOf()) { index, prev, item ->
// Only offset once while folding, so that we don't accumulate the offset for each element. // Only offset once while folding, so that we don't accumulate the offset for each element.
val itemOffset = if (index == 0) { val itemOffset = if (index == 0) {
offset offset
} else {
0
}
val previousPosition = prev.lastOrNull()?.position ?: 0
when (item) {
is HistoryDB.Group -> {
// XXX considering an empty group to have a non-zero offset is the obvious
// limitation of the current approach, and indicates that we're conflating
// two concepts here - position of an element for the sake of a RecyclerView,
// and an offset for the sake of our history pagination API.
val groupOffset = if (item.items.isEmpty()) {
1
} else { } else {
0 item.items.size
}
val previousPosition = prev.lastOrNull()?.position ?: 0
when (item) {
is History.Group -> {
// XXX considering an empty group to have a non-zero offset is the obvious
// limitation of the current approach, and indicates that we're conflating
// two concepts here - position of an element for the sake of a RecyclerView,
// and an offset for the sake of our history pagination API.
val groupOffset = if (item.items.isEmpty()) {
1
} else {
item.items.size
}
prev + item.copy(position = previousPosition + itemOffset + groupOffset)
}
is History.Metadata -> {
prev + item.copy(position = previousPosition + itemOffset + 1)
}
is History.Regular -> {
prev + item.copy(position = previousPosition + itemOffset + 1)
}
} }
prev + item.positioned(position = previousPosition + itemOffset + groupOffset)
}
is HistoryDB.Metadata -> {
prev + item.positioned(previousPosition + itemOffset + 1)
}
is HistoryDB.Regular -> {
prev + item.positioned(previousPosition + itemOffset + 1)
} }
} }
} }
} }
private fun HistoryDB.Group.positioned(position: Int): History.Group {
return History.Group(
position = position,
items = this.items.mapIndexed { index, item -> item.positioned(index) },
title = this.title,
visitedAt = this.visitedAt
)
}
private fun HistoryDB.Metadata.positioned(position: Int): History.Metadata {
return History.Metadata(
position = position,
historyMetadataKey = this.historyMetadataKey,
title = this.title,
totalViewTime = this.totalViewTime,
url = this.url,
visitedAt = this.visitedAt
)
}
private fun HistoryDB.Regular.positioned(position: Int): History.Regular {
return History.Regular(
position = position,
title = this.title,
url = this.url,
visitedAt = this.visitedAt
)
}

16
app/src/main/java/org/mozilla/fenix/library/history/HistoryFragmentStore.kt
Unescape Escape View File

@ -17,7 +17,7 @@ import mozilla.components.support.ktx.kotlin.tryGetHostFromUrl
* Class representing a history entry. * Class representing a history entry.
*/ */
sealed class History : Parcelable { sealed class History : Parcelable {
abstract val position: Int? abstract val position: Int
abstract val title: String abstract val title: String
abstract val visitedAt: Long abstract val visitedAt: Long
abstract val selected: Boolean abstract val selected: Boolean
@ -25,14 +25,14 @@ sealed class History : Parcelable {
/** /**
* A regular history item. * A regular history item.
* *
* @property id Unique id of the history item. * @property position Position of this item in a result list of other [History] items.
* @property title Title of the history item. * @property title Title of the history item.
* @property url URL of the history item. * @property url URL of the history item.
* @property visitedAt Timestamp of when this history item was visited. * @property visitedAt Timestamp of when this history item was visited.
* @property selected Whether or not the history item is selected. * @property selected Whether or not the history item is selected.
*/ */
@Parcelize data class Regular( @Parcelize data class Regular(
override val position: Int? = null, override val position: Int,
override val title: String, override val title: String,
val url: String, val url: String,
override val visitedAt: Long, override val visitedAt: Long,
@ -42,7 +42,7 @@ sealed class History : Parcelable {
/** /**
* A history metadata item. * A history metadata item.
* *
* @property id Unique id of the history metadata item. * @property position Position of this item in a result list of other [History] items.
* @property title Title of the history metadata item. * @property title Title of the history metadata item.
* @property url URL of the history metadata item. * @property url URL of the history metadata item.
* @property visitedAt Timestamp of when this history metadata item was visited. * @property visitedAt Timestamp of when this history metadata item was visited.
@ -52,7 +52,7 @@ sealed class History : Parcelable {
* @property selected Whether or not the history metadata item is selected. * @property selected Whether or not the history metadata item is selected.
*/ */
@Parcelize data class Metadata( @Parcelize data class Metadata(
override val position: Int? = null, override val position: Int,
override val title: String, override val title: String,
val url: String, val url: String,
override val visitedAt: Long, override val visitedAt: Long,
@ -64,14 +64,14 @@ sealed class History : Parcelable {
/** /**
* A history metadata group. * A history metadata group.
* *
* @property id Unique id of the history metadata group. * @property position Position of this item in a result list of other [History] items.
* @property title Title of the history metadata group. * @property title Title of the history metadata group.
* @property visitedAt Timestamp of when this history metadata group was visited. * @property visitedAt Timestamp of when this history metadata group was visited.
* @property items List of history metadata items associated with the group. * @property items List of history metadata items associated with the group.
* @property selected Whether or not the history group is selected. * @property selected Whether or not the history group is selected.
*/ */
@Parcelize data class Group( @Parcelize data class Group(
override val position: Int? = null, override val position: Int,
override val title: String, override val title: String,
override val visitedAt: Long, override val visitedAt: Long,
val items: List<Metadata>, val items: List<Metadata>,
@ -82,7 +82,7 @@ sealed class History : Parcelable {
/** /**
* Extension function for converting a [HistoryMetadata] into a [History.Metadata]. * Extension function for converting a [HistoryMetadata] into a [History.Metadata].
*/ */
fun HistoryMetadata.toHistoryMetadata(position: Int? = null): History.Metadata { fun HistoryMetadata.toHistoryMetadata(position: Int): History.Metadata {
return History.Metadata( return History.Metadata(
position = position, position = position,
title = title?.takeIf(String::isNotEmpty) title = title?.takeIf(String::isNotEmpty)

2
app/src/main/java/org/mozilla/fenix/library/history/HistoryView.kt
Unescape Escape View File

@ -76,7 +76,7 @@ class HistoryView(
val unselectedItems = oldMode.selectedItems - state.mode.selectedItems val unselectedItems = oldMode.selectedItems - state.mode.selectedItems
state.mode.selectedItems.union(unselectedItems).forEach { item -> state.mode.selectedItems.union(unselectedItems).forEach { item ->
historyAdapter.notifyItemChanged(item.position!!) historyAdapter.notifyItemChanged(item.position)
} }
} }

51
app/src/test/java/org/mozilla/fenix/components/history/PagedHistoryProviderTest.kt
Unescape Escape View File

@ -16,7 +16,6 @@ import mozilla.components.concept.storage.VisitType
import org.junit.Assert.assertEquals import org.junit.Assert.assertEquals
import org.junit.Before import org.junit.Before
import org.junit.Test import org.junit.Test
import org.mozilla.fenix.library.history.History
class PagedHistoryProviderTest { class PagedHistoryProviderTest {
@ -92,7 +91,7 @@ class PagedHistoryProviderTest {
coEvery { storage.getDetailedVisits(any(), any(), any()) } returns emptyList() coEvery { storage.getDetailedVisits(any(), any(), any()) } returns emptyList()
coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1, historyEntry2, historyEntry3) coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1, historyEntry2, historyEntry3)
var actualResults: List<History>? = null var actualResults: List<HistoryDB>? = null
provider.getHistory(10, 5) { provider.getHistory(10, 5) {
actualResults = it actualResults = it
} }
@ -114,19 +113,19 @@ class PagedHistoryProviderTest {
} }
val results = listOf( val results = listOf(
History.Group( HistoryDB.Group(
title = historyEntry1.key.searchTerm!!, title = historyEntry1.key.searchTerm!!,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
// Results are de-duped by URL and sorted descending by createdAt/visitedAt // Results are de-duped by URL and sorted descending by createdAt/visitedAt
items = listOf( items = listOf(
History.Metadata( HistoryDB.Metadata(
title = historyEntry1.title!!, title = historyEntry1.title!!,
url = historyEntry1.key.url, url = historyEntry1.key.url,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
totalViewTime = historyEntry1.totalViewTime, totalViewTime = historyEntry1.totalViewTime,
historyMetadataKey = historyMetadataKey1 historyMetadataKey = historyMetadataKey1
), ),
History.Metadata( HistoryDB.Metadata(
title = historyEntry3.title!!, title = historyEntry3.title!!,
url = historyEntry3.key.url, url = historyEntry3.key.url,
visitedAt = historyEntry3.createdAt, visitedAt = historyEntry3.createdAt,
@ -135,7 +134,7 @@ class PagedHistoryProviderTest {
) )
) )
), ),
History.Regular( HistoryDB.Regular(
title = visitInfo3.title!!, title = visitInfo3.title!!,
url = visitInfo3.url, url = visitInfo3.url,
visitedAt = visitInfo3.visitTime visitedAt = visitInfo3.visitTime
@ -175,7 +174,7 @@ class PagedHistoryProviderTest {
coEvery { storage.getDetailedVisits(any(), any(), any()) } returns emptyList() coEvery { storage.getDetailedVisits(any(), any(), any()) } returns emptyList()
coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1) coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1)
var actualResults: List<History>? = null var actualResults: List<HistoryDB>? = null
provider.getHistory(0, 5) { provider.getHistory(0, 5) {
actualResults = it actualResults = it
} }
@ -197,12 +196,12 @@ class PagedHistoryProviderTest {
} }
val results = listOf( val results = listOf(
History.Group( HistoryDB.Group(
title = historyEntry1.key.searchTerm!!, title = historyEntry1.key.searchTerm!!,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
// Results are de-duped by URL and sorted descending by createdAt/visitedAt // Results are de-duped by URL and sorted descending by createdAt/visitedAt
items = listOf( items = listOf(
History.Metadata( HistoryDB.Metadata(
title = historyEntry1.title!!, title = historyEntry1.title!!,
url = historyEntry1.key.url, url = historyEntry1.key.url,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
@ -247,7 +246,7 @@ class PagedHistoryProviderTest {
coEvery { storage.getDetailedVisits(any(), any(), any()) } returns emptyList() coEvery { storage.getDetailedVisits(any(), any(), any()) } returns emptyList()
coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1) coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1)
var actualResults: List<History>? = null var actualResults: List<HistoryDB>? = null
provider.getHistory(0, 5) { provider.getHistory(0, 5) {
actualResults = it actualResults = it
} }
@ -269,12 +268,12 @@ class PagedHistoryProviderTest {
} }
val results = listOf( val results = listOf(
History.Group( HistoryDB.Group(
title = historyEntry1.key.searchTerm!!, title = historyEntry1.key.searchTerm!!,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
// Results are de-duped by URL and sorted descending by createdAt/visitedAt // Results are de-duped by URL and sorted descending by createdAt/visitedAt
items = listOf( items = listOf(
History.Metadata( HistoryDB.Metadata(
title = historyEntry1.title!!, title = historyEntry1.title!!,
url = historyEntry1.key.url, url = historyEntry1.key.url,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
@ -396,7 +395,7 @@ class PagedHistoryProviderTest {
coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1, historyEntry2, historyEntry3, historyEntry4) coEvery { storage.getHistoryMetadataSince(any()) } returns listOf(historyEntry1, historyEntry2, historyEntry3, historyEntry4)
var actualResults: List<History>? = null var actualResults: List<HistoryDB>? = null
provider.getHistory(10, 5) { provider.getHistory(10, 5) {
actualResults = it actualResults = it
} }
@ -418,18 +417,18 @@ class PagedHistoryProviderTest {
} }
val results = listOf( val results = listOf(
History.Group( HistoryDB.Group(
title = historyEntry2.key.searchTerm!!, title = historyEntry2.key.searchTerm!!,
visitedAt = historyEntry2.createdAt, visitedAt = historyEntry2.createdAt,
items = listOf( items = listOf(
History.Metadata( HistoryDB.Metadata(
title = historyEntry2.title!!, title = historyEntry2.title!!,
url = historyEntry2.key.url, url = historyEntry2.key.url,
visitedAt = historyEntry2.createdAt, visitedAt = historyEntry2.createdAt,
totalViewTime = historyEntry2.totalViewTime, totalViewTime = historyEntry2.totalViewTime,
historyMetadataKey = historyMetadataKey2 historyMetadataKey = historyMetadataKey2
), ),
History.Metadata( HistoryDB.Metadata(
title = historyEntry1.title!!, title = historyEntry1.title!!,
url = historyEntry1.key.url, url = historyEntry1.key.url,
visitedAt = historyEntry1.createdAt, visitedAt = historyEntry1.createdAt,
@ -445,32 +444,32 @@ class PagedHistoryProviderTest {
@Test @Test
fun `WHEN removeConsecutiveDuplicates is called THEN all consecutive duplicates must be removed`() { fun `WHEN removeConsecutiveDuplicates is called THEN all consecutive duplicates must be removed`() {
val results = listOf( val results = listOf(
History.Group( HistoryDB.Group(
title = "Group 1", title = "Group 1",
visitedAt = 0, visitedAt = 0,
items = emptyList() items = emptyList()
), ),
History.Regular( HistoryDB.Regular(
title = "No duplicate item", title = "No duplicate item",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0
), ),
History.Regular( HistoryDB.Regular(
title = "Duplicate item 1", title = "Duplicate item 1",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0
), ),
History.Regular( HistoryDB.Regular(
title = "Duplicate item 2", title = "Duplicate item 2",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0
), ),
History.Group( HistoryDB.Group(
title = "Group 5", title = "Group 5",
visitedAt = 0, visitedAt = 0,
items = emptyList() items = emptyList()
), ),
History.Regular( HistoryDB.Regular(
title = "No duplicate item", title = "No duplicate item",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0
@ -478,22 +477,22 @@ class PagedHistoryProviderTest {
).removeConsecutiveDuplicates() ).removeConsecutiveDuplicates()
val expectedList = listOf( val expectedList = listOf(
History.Group( HistoryDB.Group(
title = "Group 1", title = "Group 1",
visitedAt = 0, visitedAt = 0,
items = emptyList() items = emptyList()
), ),
History.Regular( HistoryDB.Regular(
title = "No duplicate item", title = "No duplicate item",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0
), ),
History.Group( HistoryDB.Group(
title = "Group 5", title = "Group 5",
visitedAt = 0, visitedAt = 0,
items = emptyList() items = emptyList()
), ),
History.Regular( HistoryDB.Regular(
title = "No duplicate item", title = "No duplicate item",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0

13
app/src/test/java/org/mozilla/fenix/library/history/HistoryAdapterTest.kt
Unescape Escape View File

@ -14,6 +14,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with future date THEN item is grouped to today`() { fun `WHEN grouping history item with future date THEN item is grouped to today`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() + DateUtils.WEEK_IN_MILLIS visitedAt = System.currentTimeMillis() + DateUtils.WEEK_IN_MILLIS
@ -26,6 +27,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with today's date THEN item is grouped to today`() { fun `WHEN grouping history item with today's date THEN item is grouped to today`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() - DateUtils.MINUTE_IN_MILLIS visitedAt = System.currentTimeMillis() - DateUtils.MINUTE_IN_MILLIS
@ -44,6 +46,7 @@ class HistoryAdapterTest {
} }
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = calendar.timeInMillis visitedAt = calendar.timeInMillis
@ -62,6 +65,7 @@ class HistoryAdapterTest {
} }
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = calendar.timeInMillis - DateUtils.HOUR_IN_MILLIS visitedAt = calendar.timeInMillis - DateUtils.HOUR_IN_MILLIS
@ -79,6 +83,7 @@ class HistoryAdapterTest {
calendar.set(Calendar.SECOND, 0) calendar.set(Calendar.SECOND, 0)
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = calendar.timeInMillis - (DateUtils.HOUR_IN_MILLIS * 23) visitedAt = calendar.timeInMillis - (DateUtils.HOUR_IN_MILLIS * 23)
@ -97,6 +102,7 @@ class HistoryAdapterTest {
} }
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = calendar.timeInMillis - (DateUtils.HOUR_IN_MILLIS * 25) visitedAt = calendar.timeInMillis - (DateUtils.HOUR_IN_MILLIS * 25)
@ -109,6 +115,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with 3 days ago date THEN item is grouped to this week`() { fun `WHEN grouping history item with 3 days ago date THEN item is grouped to this week`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 3) visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 3)
@ -121,6 +128,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with 6 days ago date THEN item is grouped to this week`() { fun `WHEN grouping history item with 6 days ago date THEN item is grouped to this week`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 6) visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 6)
@ -133,6 +141,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with 8 days ago date THEN item is grouped to this month`() { fun `WHEN grouping history item with 8 days ago date THEN item is grouped to this month`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 8) visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 8)
@ -145,6 +154,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with 29 days ago date THEN item is grouped to this month`() { fun `WHEN grouping history item with 29 days ago date THEN item is grouped to this month`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 29) visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 29)
@ -157,6 +167,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with 31 days ago date THEN item is grouped to older`() { fun `WHEN grouping history item with 31 days ago date THEN item is grouped to older`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 31) visitedAt = System.currentTimeMillis() - (DateUtils.DAY_IN_MILLIS * 31)
@ -169,6 +180,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with zero date THEN item is grouped to older`() { fun `WHEN grouping history item with zero date THEN item is grouped to older`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = 0 visitedAt = 0
@ -181,6 +193,7 @@ class HistoryAdapterTest {
@Test @Test
fun `WHEN grouping history item with negative date THEN item is grouped to older`() { fun `WHEN grouping history item with negative date THEN item is grouped to older`() {
val history = History.Regular( val history = History.Regular(
position = 1,
title = "test item", title = "test item",
url = "url", url = "url",
visitedAt = -100 visitedAt = -100

16
app/src/test/java/org/mozilla/fenix/library/history/HistoryDataSourceTest.kt
Unescape Escape View File

@ -7,6 +7,7 @@ package org.mozilla.fenix.library.history
import mozilla.components.concept.storage.HistoryMetadataKey import mozilla.components.concept.storage.HistoryMetadataKey
import org.junit.Assert.assertEquals import org.junit.Assert.assertEquals
import org.junit.Test import org.junit.Test
import org.mozilla.fenix.components.history.HistoryDB
class HistoryDataSourceTest { class HistoryDataSourceTest {
private val testCases = listOf( private val testCases = listOf(
@ -154,10 +155,7 @@ class HistoryDataSourceTest {
assertEquals( assertEquals(
"For case $history with offset $offset", "For case $history with offset $offset",
expectedPositions, expectedPositions,
HistoryDataSource.assignPositions( history.toHistoryDB().positionWithOffset(offset).map { it.position }
offset = offset,
history.toHistoryWithoutPositions()
).map { it.position }
) )
} }
@ -169,14 +167,14 @@ class HistoryDataSourceTest {
// For position tests, we just care about the basic tree structure here, // For position tests, we just care about the basic tree structure here,
// the details (view times, timestamps, etc) don't matter. // the details (view times, timestamps, etc) don't matter.
private fun List<TestHistory>.toHistoryWithoutPositions(): List<History> { private fun List<TestHistory>.toHistoryDB(): List<HistoryDB> {
return this.map { return this.map {
when (it) { when (it) {
is TestHistory.Regular -> { is TestHistory.Regular -> {
History.Regular(title = it.url, url = it.url, visitedAt = 0) HistoryDB.Regular(title = it.url, url = it.url, visitedAt = 0)
} }
is TestHistory.Metadata -> { is TestHistory.Metadata -> {
History.Metadata( HistoryDB.Metadata(
title = it.url, title = it.url,
url = it.url, url = it.url,
visitedAt = 0, visitedAt = 0,
@ -185,10 +183,10 @@ class HistoryDataSourceTest {
) )
} }
is TestHistory.Group -> { is TestHistory.Group -> {
History.Group( HistoryDB.Group(
title = it.title, visitedAt = 0, title = it.title, visitedAt = 0,
items = it.items.map { item -> items = it.items.map { item ->
History.Metadata( HistoryDB.Metadata(
title = item, title = item,
url = item, url = item,
visitedAt = 0, visitedAt = 0,

2
app/src/test/java/org/mozilla/fenix/library/historymetadata/HistoryMetadataGroupFragmentStoreTest.kt
Unescape Escape View File

@ -19,6 +19,7 @@ class HistoryMetadataGroupFragmentStoreTest {
private lateinit var store: HistoryMetadataGroupFragmentStore private lateinit var store: HistoryMetadataGroupFragmentStore
private val mozillaHistoryMetadataItem = History.Metadata( private val mozillaHistoryMetadataItem = History.Metadata(
position = 1,
title = "Mozilla", title = "Mozilla",
url = "mozilla.org", url = "mozilla.org",
visitedAt = 0, visitedAt = 0,
@ -26,6 +27,7 @@ class HistoryMetadataGroupFragmentStoreTest {
historyMetadataKey = HistoryMetadataKey("http://www.mozilla.com", "mozilla", null) historyMetadataKey = HistoryMetadataKey("http://www.mozilla.com", "mozilla", null)
) )
private val firefoxHistoryMetadataItem = History.Metadata( private val firefoxHistoryMetadataItem = History.Metadata(
position = 1,
title = "Firefox", title = "Firefox",
url = "firefox.com", url = "firefox.com",
visitedAt = 0, visitedAt = 0,

2
app/src/test/java/org/mozilla/fenix/library/historymetadata/controller/HistoryMetadataGroupControllerTest.kt
Unescape Escape View File

@ -53,6 +53,7 @@ class HistoryMetadataGroupControllerTest {
private val searchTerm = "mozilla" private val searchTerm = "mozilla"
private val historyMetadataKey = HistoryMetadataKey("http://www.mozilla.com", searchTerm, null) private val historyMetadataKey = HistoryMetadataKey("http://www.mozilla.com", searchTerm, null)
private val mozillaHistoryMetadataItem = History.Metadata( private val mozillaHistoryMetadataItem = History.Metadata(
position = 1,
title = "Mozilla", title = "Mozilla",
url = "mozilla.org", url = "mozilla.org",
visitedAt = 0, visitedAt = 0,
@ -60,6 +61,7 @@ class HistoryMetadataGroupControllerTest {
historyMetadataKey = historyMetadataKey historyMetadataKey = historyMetadataKey
) )
private val firefoxHistoryMetadataItem = History.Metadata( private val firefoxHistoryMetadataItem = History.Metadata(
position = 1,
title = "Firefox", title = "Firefox",
url = "firefox.com", url = "firefox.com",
visitedAt = 0, visitedAt = 0,

1
app/src/test/java/org/mozilla/fenix/library/historymetadata/view/HistoryMetadataGroupItemViewHolderTest.kt
Unescape Escape View File

@ -29,6 +29,7 @@ class HistoryMetadataGroupItemViewHolderTest {
private lateinit var selectionHolder: SelectionHolder<History.Metadata> private lateinit var selectionHolder: SelectionHolder<History.Metadata>
private val item = History.Metadata( private val item = History.Metadata(
position = 1,
title = "Mozilla", title = "Mozilla",
url = "mozilla.org", url = "mozilla.org",
visitedAt = 0, visitedAt = 0,

Write Preview
Loading…
Cancel
Save