For #24114 - Refactor HomeFragmentState into AppState
Gabriel Luong
2 years ago
committed by
mergify[bot]
parent
09df4dd787
commit
c2e3d251cb
@ -1,258 +0,0 @@
|
||||
/* 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.home
|
||||
|
||||
import androidx.annotation.VisibleForTesting
|
||||
import mozilla.components.concept.storage.BookmarkNode
|
||||
import mozilla.components.feature.tab.collections.TabCollection
|
||||
import mozilla.components.feature.top.sites.TopSite
|
||||
import mozilla.components.lib.state.Action
|
||||
import mozilla.components.lib.state.Middleware
|
||||
import mozilla.components.lib.state.State
|
||||
import mozilla.components.lib.state.Store
|
||||
import mozilla.components.service.pocket.PocketRecommendedStory
|
||||
import org.mozilla.fenix.ext.filterOutTab
|
||||
import org.mozilla.fenix.ext.getFilteredStories
|
||||
import org.mozilla.fenix.ext.recentSearchGroup
|
||||
import org.mozilla.fenix.home.pocket.POCKET_STORIES_TO_SHOW_COUNT
|
||||
import org.mozilla.fenix.home.pocket.PocketRecommendedStoriesCategory
|
||||
import org.mozilla.fenix.home.pocket.PocketRecommendedStoriesSelectedCategory
|
||||
import org.mozilla.fenix.home.recentbookmarks.RecentBookmark
|
||||
import org.mozilla.fenix.home.recenttabs.RecentTab
|
||||
import org.mozilla.fenix.home.recenttabs.RecentTab.SearchGroup
|
||||
import org.mozilla.fenix.home.recentvisits.RecentlyVisitedItem
|
||||
import org.mozilla.fenix.home.recentvisits.RecentlyVisitedItem.RecentHistoryGroup
|
||||
import org.mozilla.fenix.home.recentvisits.RecentlyVisitedItem.RecentHistoryHighlight
|
||||
|
||||
/**
|
||||
* The [Store] for holding the [HomeFragmentState] and applying [HomeFragmentAction]s.
|
||||
*/
|
||||
class HomeFragmentStore(
|
||||
initialState: HomeFragmentState = HomeFragmentState(),
|
||||
middlewares: List<Middleware<HomeFragmentState, HomeFragmentAction>> = emptyList()
|
||||
) : Store<HomeFragmentState, HomeFragmentAction>(
|
||||
initialState, ::homeFragmentStateReducer, middlewares
|
||||
)
|
||||
|
||||
/**
|
||||
* The state for the [HomeFragment].
|
||||
*
|
||||
* @property collections The list of [TabCollection] to display in the [HomeFragment].
|
||||
* @property expandedCollections A set containing the ids of the [TabCollection] that are expanded
|
||||
* in the [HomeFragment].
|
||||
* @property mode The state of the [HomeFragment] UI.
|
||||
* @property topSites The list of [TopSite] in the [HomeFragment].
|
||||
* @property showCollectionPlaceholder If true, shows a placeholder when there are no collections.
|
||||
* @property showSetAsDefaultBrowserCard If true, shows the default browser card
|
||||
* @property recentTabs The list of recent [RecentTab] in the [HomeFragment].
|
||||
* @property recentBookmarks The list of recently saved [BookmarkNode]s to show on the [HomeFragment].
|
||||
* @property recentHistory The list of [RecentlyVisitedItem]s.
|
||||
* @property pocketStories The list of currently shown [PocketRecommendedStory]s.
|
||||
* @property pocketStoriesCategories All [PocketRecommendedStory] categories.
|
||||
* Also serves as an in memory cache of all stories mapped by category allowing for quick stories filtering.
|
||||
*/
|
||||
data class HomeFragmentState(
|
||||
val collections: List<TabCollection> = emptyList(),
|
||||
val expandedCollections: Set<Long> = emptySet(),
|
||||
val mode: Mode = Mode.Normal,
|
||||
val topSites: List<TopSite> = emptyList(),
|
||||
val showCollectionPlaceholder: Boolean = false,
|
||||
val showSetAsDefaultBrowserCard: Boolean = false,
|
||||
val recentTabs: List<RecentTab> = emptyList(),
|
||||
val recentBookmarks: List<RecentBookmark> = emptyList(),
|
||||
val recentHistory: List<RecentlyVisitedItem> = emptyList(),
|
||||
val pocketStories: List<PocketRecommendedStory> = emptyList(),
|
||||
val pocketStoriesCategories: List<PocketRecommendedStoriesCategory> = emptyList(),
|
||||
val pocketStoriesCategoriesSelections: List<PocketRecommendedStoriesSelectedCategory> = emptyList()
|
||||
) : State
|
||||
|
||||
sealed class HomeFragmentAction : Action {
|
||||
data class Change(
|
||||
val topSites: List<TopSite>,
|
||||
val mode: Mode,
|
||||
val collections: List<TabCollection>,
|
||||
val showCollectionPlaceholder: Boolean,
|
||||
val recentTabs: List<RecentTab>,
|
||||
val recentBookmarks: List<RecentBookmark>,
|
||||
val recentHistory: List<RecentlyVisitedItem>
|
||||
) :
|
||||
HomeFragmentAction()
|
||||
|
||||
data class CollectionExpanded(val collection: TabCollection, val expand: Boolean) :
|
||||
HomeFragmentAction()
|
||||
|
||||
data class CollectionsChange(val collections: List<TabCollection>) : HomeFragmentAction()
|
||||
data class ModeChange(val mode: Mode) : HomeFragmentAction()
|
||||
data class TopSitesChange(val topSites: List<TopSite>) : HomeFragmentAction()
|
||||
data class RecentTabsChange(val recentTabs: List<RecentTab>) : HomeFragmentAction()
|
||||
data class RemoveRecentTab(val recentTab: RecentTab) : HomeFragmentAction()
|
||||
data class RecentBookmarksChange(val recentBookmarks: List<RecentBookmark>) : HomeFragmentAction()
|
||||
data class RemoveRecentBookmark(val recentBookmark: RecentBookmark) : HomeFragmentAction()
|
||||
data class RecentHistoryChange(val recentHistory: List<RecentlyVisitedItem>) : HomeFragmentAction()
|
||||
data class RemoveRecentHistoryHighlight(val highlightUrl: String) : HomeFragmentAction()
|
||||
data class DisbandSearchGroupAction(val searchTerm: String) : HomeFragmentAction()
|
||||
data class SelectPocketStoriesCategory(val categoryName: String) : HomeFragmentAction()
|
||||
data class DeselectPocketStoriesCategory(val categoryName: String) : HomeFragmentAction()
|
||||
data class PocketStoriesShown(val storiesShown: List<PocketRecommendedStory>) : HomeFragmentAction()
|
||||
data class PocketStoriesChange(val pocketStories: List<PocketRecommendedStory>) : HomeFragmentAction()
|
||||
data class PocketStoriesCategoriesChange(val storiesCategories: List<PocketRecommendedStoriesCategory>) :
|
||||
HomeFragmentAction()
|
||||
data class PocketStoriesCategoriesSelectionsChange(
|
||||
val storiesCategories: List<PocketRecommendedStoriesCategory>,
|
||||
val categoriesSelected: List<PocketRecommendedStoriesSelectedCategory>
|
||||
) : HomeFragmentAction()
|
||||
object RemoveCollectionsPlaceholder : HomeFragmentAction()
|
||||
object RemoveSetDefaultBrowserCard : HomeFragmentAction()
|
||||
}
|
||||
|
||||
@Suppress("ReturnCount", "LongMethod")
|
||||
private fun homeFragmentStateReducer(
|
||||
state: HomeFragmentState,
|
||||
action: HomeFragmentAction
|
||||
): HomeFragmentState {
|
||||
return when (action) {
|
||||
is HomeFragmentAction.Change -> state.copy(
|
||||
collections = action.collections,
|
||||
mode = action.mode,
|
||||
topSites = action.topSites,
|
||||
recentBookmarks = action.recentBookmarks,
|
||||
recentTabs = action.recentTabs,
|
||||
recentHistory = if (action.recentHistory.isNotEmpty() && action.recentTabs.isNotEmpty()) {
|
||||
val recentSearchGroup = action.recentTabs.find { it is SearchGroup } as SearchGroup?
|
||||
action.recentHistory.filterOut(recentSearchGroup?.searchTerm)
|
||||
} else {
|
||||
action.recentHistory
|
||||
}
|
||||
)
|
||||
is HomeFragmentAction.CollectionExpanded -> {
|
||||
val newExpandedCollection = state.expandedCollections.toMutableSet()
|
||||
|
||||
if (action.expand) {
|
||||
newExpandedCollection.add(action.collection.id)
|
||||
} else {
|
||||
newExpandedCollection.remove(action.collection.id)
|
||||
}
|
||||
|
||||
state.copy(expandedCollections = newExpandedCollection)
|
||||
}
|
||||
is HomeFragmentAction.CollectionsChange -> state.copy(collections = action.collections)
|
||||
is HomeFragmentAction.ModeChange -> state.copy(mode = action.mode)
|
||||
is HomeFragmentAction.TopSitesChange -> state.copy(topSites = action.topSites)
|
||||
is HomeFragmentAction.RemoveCollectionsPlaceholder -> {
|
||||
state.copy(showCollectionPlaceholder = false)
|
||||
}
|
||||
is HomeFragmentAction.RemoveSetDefaultBrowserCard -> state.copy(showSetAsDefaultBrowserCard = false)
|
||||
is HomeFragmentAction.RecentTabsChange -> {
|
||||
val recentSearchGroup = action.recentTabs.find { it is SearchGroup } as SearchGroup?
|
||||
state.copy(
|
||||
recentTabs = action.recentTabs,
|
||||
recentHistory = state.recentHistory.filterOut(recentSearchGroup?.searchTerm)
|
||||
)
|
||||
}
|
||||
is HomeFragmentAction.RemoveRecentTab -> {
|
||||
state.copy(
|
||||
recentTabs = state.recentTabs.filterOutTab(action.recentTab)
|
||||
)
|
||||
}
|
||||
is HomeFragmentAction.RecentBookmarksChange -> state.copy(recentBookmarks = action.recentBookmarks)
|
||||
is HomeFragmentAction.RemoveRecentBookmark -> {
|
||||
state.copy(recentBookmarks = state.recentBookmarks.filterNot { it.url == action.recentBookmark.url })
|
||||
}
|
||||
is HomeFragmentAction.RecentHistoryChange -> state.copy(
|
||||
recentHistory = action.recentHistory.filterOut(state.recentSearchGroup?.searchTerm)
|
||||
)
|
||||
is HomeFragmentAction.RemoveRecentHistoryHighlight -> state.copy(
|
||||
recentHistory = state.recentHistory.filterNot {
|
||||
it is RecentHistoryHighlight && it.url == action.highlightUrl
|
||||
}
|
||||
)
|
||||
is HomeFragmentAction.DisbandSearchGroupAction -> state.copy(
|
||||
recentHistory = state.recentHistory.filterNot {
|
||||
it is RecentHistoryGroup && (
|
||||
it.title.equals(action.searchTerm, true) ||
|
||||
it.title.equals(state.recentSearchGroup?.searchTerm, true)
|
||||
)
|
||||
}
|
||||
)
|
||||
is HomeFragmentAction.SelectPocketStoriesCategory -> {
|
||||
val updatedCategoriesState = state.copy(
|
||||
pocketStoriesCategoriesSelections =
|
||||
state.pocketStoriesCategoriesSelections + PocketRecommendedStoriesSelectedCategory(
|
||||
name = action.categoryName
|
||||
)
|
||||
)
|
||||
|
||||
// Selecting a category means the stories to be displayed needs to also be changed.
|
||||
return updatedCategoriesState.copy(
|
||||
pocketStories = updatedCategoriesState.getFilteredStories(POCKET_STORIES_TO_SHOW_COUNT)
|
||||
)
|
||||
}
|
||||
is HomeFragmentAction.DeselectPocketStoriesCategory -> {
|
||||
val updatedCategoriesState = state.copy(
|
||||
pocketStoriesCategoriesSelections = state.pocketStoriesCategoriesSelections.filterNot {
|
||||
it.name == action.categoryName
|
||||
}
|
||||
)
|
||||
|
||||
// Deselecting a category means the stories to be displayed needs to also be changed.
|
||||
return updatedCategoriesState.copy(
|
||||
pocketStories = updatedCategoriesState.getFilteredStories(POCKET_STORIES_TO_SHOW_COUNT)
|
||||
)
|
||||
}
|
||||
is HomeFragmentAction.PocketStoriesCategoriesChange -> {
|
||||
val updatedCategoriesState = state.copy(pocketStoriesCategories = action.storiesCategories)
|
||||
// Whenever categories change stories to be displayed needs to also be changed.
|
||||
return updatedCategoriesState.copy(
|
||||
pocketStories = updatedCategoriesState.getFilteredStories(POCKET_STORIES_TO_SHOW_COUNT)
|
||||
)
|
||||
}
|
||||
is HomeFragmentAction.PocketStoriesCategoriesSelectionsChange -> {
|
||||
val updatedCategoriesState = state.copy(
|
||||
pocketStoriesCategories = action.storiesCategories,
|
||||
pocketStoriesCategoriesSelections = action.categoriesSelected
|
||||
)
|
||||
// Whenever categories change stories to be displayed needs to also be changed.
|
||||
return updatedCategoriesState.copy(
|
||||
pocketStories = updatedCategoriesState.getFilteredStories(POCKET_STORIES_TO_SHOW_COUNT)
|
||||
)
|
||||
}
|
||||
is HomeFragmentAction.PocketStoriesChange -> state.copy(pocketStories = action.pocketStories)
|
||||
is HomeFragmentAction.PocketStoriesShown -> {
|
||||
var updatedCategories = state.pocketStoriesCategories
|
||||
action.storiesShown.forEach { shownStory ->
|
||||
updatedCategories = updatedCategories.map { category ->
|
||||
when (category.name == shownStory.category) {
|
||||
true -> {
|
||||
category.copy(
|
||||
stories = category.stories.map { story ->
|
||||
when (story.title == shownStory.title) {
|
||||
true -> story.copy(timesShown = story.timesShown.inc())
|
||||
false -> story
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
false -> category
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
state.copy(pocketStoriesCategories = updatedCategories)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a [RecentHistoryGroup] identified by [groupTitle] if it exists in the current list.
|
||||
*
|
||||
* @param groupTitle [RecentHistoryGroup.title] of the item that should be removed.
|
||||
*/
|
||||
@VisibleForTesting
|
||||
internal fun List<RecentlyVisitedItem>.filterOut(groupTitle: String?): List<RecentlyVisitedItem> {
|
||||
return when (groupTitle != null) {
|
||||
true -> filterNot { it is RecentHistoryGroup && it.title.equals(groupTitle, true) }
|
||||
false -> this
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue