Merge pull request #13961 from woocommerce/woomob-350-woo-posproducts-search-crash-if-popular-product-selected

[WOOMOB-350][Woo POS][Product Search] Crash if popular product selected after pull to refresh

Author: samiuelson

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosPopularProductsProvider.kt

@@ -26,6 +26,10 @@ class WooPosPopularProductsProvider @Inject constructor(
 
     suspend fun getPopularProducts(): List<Product> = mutex.withLock { popularProductsCache }
 
+    suspend fun addPopularItemsToCache() = mutex.withLock {
+        productsCache.addAll(popularProductsCache)
+    }
+
     suspend fun fetchAndCachePopularProducts(): Result<Unit> = mutex.withLock {
         val result = productStore.fetchProducts(
             site = selectedSite.get(),

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosItemsEmptySearchQueryStateScreen.kt

@@ -66,7 +66,7 @@ fun WooPosItemsEmptySearchQueryStateScreen(
                         PopularItemsSection(
                             popularItems = state.popularItems,
                             onPopularItemClicked = { popularItem ->
-                                onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(popularItem))
+                                onUIEvent(WooPosItemsSearchUiEvent.OnPopularItemClicked(popularItem))
                             }
                         )
                     }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosItemsSearchEmptyStateRepository.kt

@@ -6,7 +6,6 @@ import com.woocommerce.android.ui.woopos.util.datastore.WooPosPreferencesReposit
 import kotlinx.coroutines.flow.first
 import javax.inject.Inject
 
-@Suppress("MagicNumber")
 class WooPosItemsSearchEmptyStateRepository @Inject constructor(
     private val preferencesRepository: WooPosPreferencesRepository,
     private val popularProductsProvider: WooPosPopularProductsProvider,
@@ -18,4 +17,8 @@ class WooPosItemsSearchEmptyStateRepository @Inject constructor(
     suspend fun addRecentSearch(search: String) {
         preferencesRepository.addRecentProductSearch(search)
     }
+
+    suspend fun addPopularItemsToCache() {
+        popularProductsProvider.addPopularItemsToCache()
+    }
 }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosItemsSearchScreen.kt

@@ -99,7 +99,7 @@ private fun WooPosItemsSearchContent(
     WooPosItemList(
         state = state,
         listState = listState,
-        onItemClicked = { onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(it)) },
+        onItemClicked = { onUIEvent(WooPosItemsSearchUiEvent.OnItemClicked(it)) },
         onEndOfProductsListReached = { onUIEvent(WooPosItemsSearchUiEvent.OnNextPageRequested) },
         onErrorWhilePaginating = {
             WooPosPaginationErrorIndicator(

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosItemsSearchUiEvent.kt

@@ -3,8 +3,9 @@ package com.woocommerce.android.ui.woopos.home.items.search
 import com.woocommerce.android.ui.woopos.home.items.WooPosItemSelectionViewState
 
 sealed class WooPosItemsSearchUiEvent {
-    data class ItemClicked(val item: WooPosItemSelectionViewState) : WooPosItemsSearchUiEvent()
+    data class OnItemClicked(val item: WooPosItemSelectionViewState) : WooPosItemsSearchUiEvent()
     data object OnNextPageRequested : WooPosItemsSearchUiEvent()
     data object LoadingErrorRetryButtonClicked : WooPosItemsSearchUiEvent()
     data class OnRecentSearchClicked(val recentSearch: String) : WooPosItemsSearchUiEvent()
+    data class OnPopularItemClicked(val item: WooPosItemSelectionViewState) : WooPosItemsSearchUiEvent()
 }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosItemsSearchViewModel.kt

@@ -5,6 +5,7 @@ import androidx.lifecycle.viewModelScope
 import com.woocommerce.android.model.Product
 import com.woocommerce.android.ui.products.ProductType
 import com.woocommerce.android.ui.woopos.home.ChildToParentEvent
+import com.woocommerce.android.ui.woopos.home.ChildToParentEvent.SearchEvent.RecentSearchSelected
 import com.woocommerce.android.ui.woopos.home.ParentToChildrenEvent
 import com.woocommerce.android.ui.woopos.home.WooPosChildrenToParentEventSender
 import com.woocommerce.android.ui.woopos.home.WooPosParentToChildrenEventReceiver
@@ -76,7 +77,7 @@ class WooPosItemsSearchViewModel @Inject constructor(
     fun onUIEvent(event: WooPosItemsSearchUiEvent) {
         when (event) {
             WooPosItemsSearchUiEvent.OnNextPageRequested -> onEndOfListReached()
-            is WooPosItemsSearchUiEvent.ItemClicked -> handleItemClicked(event.item)
+            is WooPosItemsSearchUiEvent.OnItemClicked -> handleItemClicked(event.item)
             WooPosItemsSearchUiEvent.LoadingErrorRetryButtonClicked -> {
                 val currentState = _viewState.value as? WooPosItemsSearchViewState.Error ?: return
                 loadContent(currentState.searchQuery)
@@ -85,12 +86,19 @@ class WooPosItemsSearchViewModel @Inject constructor(
             is WooPosItemsSearchUiEvent.OnRecentSearchClicked -> {
                 viewModelScope.launch {
                     childToParentEventSender.sendToParent(
-                        ChildToParentEvent.SearchEvent.RecentSearchSelected(
+                        RecentSearchSelected(
                             event.recentSearch
                         )
                     )
                 }
             }
+
+            is WooPosItemsSearchUiEvent.OnPopularItemClicked -> {
+                viewModelScope.launch {
+                    emptyStateRepository.addPopularItemsToCache()
+                    handleItemClicked(event.item)
+                }
+            }
         }
     }
 

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/ProductSearchPredicate.kt renamed to WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosProductSearchPredicate.kt

@@ -5,7 +5,7 @@ import javax.inject.Inject
 import javax.inject.Singleton
 
 @Singleton
-class ProductSearchPredicate @Inject constructor() {
+class WooPosProductSearchPredicate @Inject constructor() {
     private val whitespaceRegex = "\\s+".toRegex()
 
     operator fun invoke(query: String): (Product) -> Boolean {

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosSearchProductsDataSource.kt

@@ -24,7 +24,7 @@ class WooPosSearchProductsDataSource @Inject constructor(
     private val selectedSite: SelectedSite,
     private val productsCache: WooPosProductsCache,
     private val searchResultsIndex: WooPosSearchResultsIndex,
-    private val searchPredicate: ProductSearchPredicate,
+    private val searchPredicate: WooPosProductSearchPredicate,
     private val productsTypesFilterConfig: WooPosProductsTypesFilterConfig
 ) {
     companion object {

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosItemsSearchViewModelTest.kt

@@ -620,7 +620,7 @@ class WooPosItemsSearchViewModelTest {
 
         // WHEN
         val viewModel = createViewModel()
-        viewModel.onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(simpleProduct))
+        viewModel.onUIEvent(WooPosItemsSearchUiEvent.OnItemClicked(simpleProduct))
 
         // THEN
         verify(mockChildToParentEventSender).sendToParent(
@@ -644,7 +644,7 @@ class WooPosItemsSearchViewModelTest {
 
         // WHEN
         val viewModel = createViewModel()
-        viewModel.onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(variableProduct))
+        viewModel.onUIEvent(WooPosItemsSearchUiEvent.OnItemClicked(variableProduct))
         advanceUntilIdle()
 
         // THEN
@@ -675,7 +675,7 @@ class WooPosItemsSearchViewModelTest {
 
         // THEN
         assertThrows(IllegalStateException::class.java) {
-            viewModel.onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(variation))
+            viewModel.onUIEvent(WooPosItemsSearchUiEvent.OnItemClicked(variation))
         }
     }
 
@@ -706,7 +706,7 @@ class WooPosItemsSearchViewModelTest {
             // WHEN
             val viewModel = createViewModel()
             advanceTimeBy(600)
-            viewModel.onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(simpleProduct))
+            viewModel.onUIEvent(WooPosItemsSearchUiEvent.OnItemClicked(simpleProduct))
 
             // THEN
             verify(mockEmptyStateProvider).addRecentSearch(query)
@@ -719,12 +719,37 @@ class WooPosItemsSearchViewModelTest {
 
         // WHEN
         val viewModel = createViewModel()
-        viewModel.onUIEvent(WooPosItemsSearchUiEvent.ItemClicked(simpleProduct))
+        viewModel.onUIEvent(WooPosItemsSearchUiEvent.OnItemClicked(simpleProduct))
 
         // THEN
         verify(mockEmptyStateProvider, never()).addRecentSearch(any())
     }
 
+    @Test
+    fun `given popular item, when OnPopularItemClicked event is triggered, then add popular items to cache and handle item click`() =
+        runTest {
+            // GIVEN
+            val simpleProduct = Product.Simple(
+                id = 42L,
+                name = "Popular Product",
+                price = "$15.0",
+                imageUrl = "https://example.com/image.jpg"
+            )
+
+            // WHEN
+            val viewModel = createViewModel()
+            viewModel.onUIEvent(WooPosItemsSearchUiEvent.OnPopularItemClicked(simpleProduct))
+            advanceUntilIdle()
+
+            // THEN
+            verify(mockEmptyStateProvider).addPopularItemsToCache()
+            verify(mockChildToParentEventSender).sendToParent(
+                ChildToParentEvent.ItemClickedInProductSelector(
+                    ItemClickedData.Product.Simple(id = simpleProduct.id)
+                )
+            )
+        }
+
     private fun mockSuccessfulSearch(query: String, products: List<com.woocommerce.android.model.Product>) {
         whenever(mockDataSource.searchProducts(query)).thenReturn(
             flow {

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/home/items/search/WooPosSearchProductsDataSourceTest.kt

@@ -36,7 +36,7 @@ class WooPosSearchProductsDataSourceTest {
     private val wooPosProductsCache: WooPosProductsCache = mock()
     private val searchResultsIndex: WooPosSearchResultsIndex = mock()
     private val selectedSite: SelectedSite = mock()
-    private val searchPredicate: ProductSearchPredicate = mock()
+    private val searchPredicate: WooPosProductSearchPredicate = mock()
     private val siteModel: SiteModel = mock()
 
     private lateinit var sut: WooPosSearchProductsDataSource