Merge pull request #14805 from woocommerce/feat/WOOMOB-1154-POS-Order-details-email-refresh-after

toupper · web-flow · commit f8bb8f0ebfa8 · 2025-10-29T14:46:45.000+01:00
[POS - Historical Orders] Refresh orders after the receipt was sent.
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/emailreceipt/WooPosEmailReceiptNavigation.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/emailreceipt/WooPosEmailReceiptNavigation.kt
@@ -11,6 +11,7 @@ import com.woocommerce.android.ui.woopos.home.HOME_ROUTE
 import com.woocommerce.android.ui.woopos.root.navigation.WooPosNavigationEvent
 import com.woocommerce.android.ui.woopos.root.navigation.navigateOnce
 
+const val EMAIL_RECEIPT_SENT = "email_receipt_sent"
 const val EMAIL_RECEIPT_ROUTE_ORDER_ID_KEY = "orderId"
 private const val EMAIL_RECEIPT_ROUTE = "$HOME_ROUTE/email_receipt/{$EMAIL_RECEIPT_ROUTE_ORDER_ID_KEY}"
 
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/emailreceipt/WooPosEmailReceiptScreen.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/emailreceipt/WooPosEmailReceiptScreen.kt
@@ -47,7 +47,7 @@ fun WooPosEmailReceiptScreen(onNavigationEvent: (WooPosNavigationEvent) -> Unit)
         onEmailAddressChanged = { viewModel.onUIEvent(WooPosEmailReceiptUIEvent.EmailChanged(it)) },
         onSendReceiptClicked = { viewModel.onUIEvent(WooPosEmailReceiptUIEvent.SendEmailClicked) },
         onBackClicked = { onNavigationEvent(WooPosNavigationEvent.GoBack) },
-        onEmailSent = { onNavigationEvent(WooPosNavigationEvent.GoBack) }
+        onEmailSent = { onNavigationEvent(WooPosNavigationEvent.GoBackWithResult(key = EMAIL_RECEIPT_SENT, true)) }
     )
 }
 
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt
@@ -67,6 +67,31 @@ class WooPosOrdersDataSource @Inject constructor(
     suspend fun loadMore(searchQuery: String? = null): Result<List<Order>> =
         withContext(Dispatchers.IO) { loadNextPage(searchQuery) }
 
+    suspend fun refreshOrderById(orderId: Long): Result<Order> {
+        val site = selectedSite.get()
+        val payload = restClient.fetchSingleOrder(site, orderId)
+        return if (payload.error == null) {
+            val entity = payload.orderWithMeta.first
+            val order = orderMapper.toAppModel(entity)
+
+            updateCachedOrderIfPresent(order)
+
+            Result.success(order)
+        } else {
+            Result.failure(Throwable("[${payload.error.type}] ${payload.error.message}"))
+        }
+    }
+
+    private fun updateCachedOrderIfPresent(order: Order) {
+        val current = ordersCache.getAll()
+        val idx = current.indexOfFirst { it.id == order.id }
+        if (idx < 0) return
+
+        val updated = current.toMutableList()
+        updated[idx] = order
+        ordersCache.setAll(updated)
+    }
+
     private suspend fun loadFirstPage(searchQuery: String? = null): Result<List<Order>> {
         page.set(1)
         canLoadMore.set(false)
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersNavigation.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersNavigation.kt
@@ -2,9 +2,11 @@ package com.woocommerce.android.ui.woopos.orders
 
 import androidx.compose.animation.slideInHorizontally
 import androidx.compose.animation.slideOutHorizontally
+import androidx.compose.runtime.collectAsState
 import androidx.navigation.NavController
 import androidx.navigation.NavGraphBuilder
 import androidx.navigation.compose.composable
+import com.woocommerce.android.ui.woopos.emailreceipt.EMAIL_RECEIPT_SENT
 import com.woocommerce.android.ui.woopos.home.HOME_ROUTE
 import com.woocommerce.android.ui.woopos.root.navigation.WooPosNavigationEvent
 import com.woocommerce.android.ui.woopos.root.navigation.navigateOnce
@@ -40,9 +42,16 @@ fun NavGraphBuilder.ordersScreen(
                 targetOffsetX = { fullWidth -> fullWidth },
             )
         },
-    ) {
+    ) { backStackEntry ->
+        val navigatedFromEmailReceiptSent = backStackEntry.savedStateHandle
+            .getStateFlow(EMAIL_RECEIPT_SENT, false)
+            .collectAsState()
+
+        backStackEntry.savedStateHandle.remove<Boolean>(EMAIL_RECEIPT_SENT)
+
         WooPosOrdersScreen(
             onNavigationEvent = onNavigationEvent,
+            navigatedFromEmailReceiptSent = navigatedFromEmailReceiptSent.value
         )
     }
 }
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersScreen.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersScreen.kt
@@ -81,10 +81,15 @@ val WOO_POS_ORDERS_TOOLBAR_HEIGHT = 56.dp
 @Composable
 fun WooPosOrdersScreen(
     onNavigationEvent: (WooPosNavigationEvent) -> Unit,
+    navigatedFromEmailReceiptSent: Boolean,
 ) {
     val viewModel: WooPosOrdersViewModel = hiltViewModel()
     val state by viewModel.state.collectAsState()
 
+    if (navigatedFromEmailReceiptSent) {
+        viewModel.onBackFromSuccessfullySendingEmailReceipt()
+    }
+
     val context = LocalContext.current
 
     LaunchedEffect(Unit) {
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersState.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersState.kt
@@ -63,7 +63,7 @@ sealed class WooPosOrdersState {
         override val pullToRefreshState: WooPosPullToRefreshState,
         override val searchInputState: WooPosSearchInputState,
         val selectedDetails: OrderDetailsViewState,
-        val paginationState: WooPosPaginationState,
+        val paginationState: WooPosPaginationState
     ) : WooPosOrdersState() {
         sealed class Items {
             data class Loaded(val items: Map<OrderItemViewState, OrderDetailsViewState>) : Items()
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModel.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModel.kt
@@ -230,6 +230,38 @@ class WooPosOrdersViewModel @Inject constructor(
         }
     }
 
+    fun onBackFromSuccessfullySendingEmailReceipt() {
+        refreshSelectedOrder()
+    }
+
+    private fun refreshSelectedOrder() {
+        val current = _state.value as? WooPosOrdersState.Content ?: return
+        val selectedOrderId = current.selectedDetails.id
+
+        viewModelScope.launch {
+            ordersDataSource.refreshOrderById(selectedOrderId)
+                .onSuccess { applyOrderUpdate(it) }
+        }
+    }
+
+    private suspend fun applyOrderUpdate(updated: Order) {
+        val current = _state.value as? WooPosOrdersState.Content ?: return
+        val loaded = current.items as? WooPosOrdersState.Content.Items.Loaded ?: return
+
+        val selectedId = loaded.items.keys.firstOrNull { it.isSelected }?.id
+        val newItem = mapOrderItem(updated, selectedId)
+        val newDetails = mapOrderDetails(updated)
+
+        val newMap = loaded.items.entries.associate { (item, details) ->
+            if (item.id == updated.id) newItem to newDetails else item to details
+        }
+
+        _state.value = current.copy(
+            items = WooPosOrdersState.Content.Items.Loaded(newMap),
+            selectedDetails = if (selectedId == updated.id) newDetails else current.selectedDetails
+        )
+    }
+
     private fun updateSearchState(searchState: WooPosSearchInputState) {
         _state.value = when (val currentState = _state.value) {
             is WooPosOrdersState.Content -> currentState.copy(searchInputState = searchState)
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/navigation/WooPosNavigationEvent.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/navigation/WooPosNavigationEvent.kt
@@ -9,6 +9,7 @@ sealed class WooPosNavigationEvent {
     data class OpenCashPayment(val orderId: Long) : WooPosNavigationEvent()
     data class OpenEmailReceipt(val orderId: Long) : WooPosNavigationEvent()
     data object GoBack : WooPosNavigationEvent()
+    data class GoBackWithResult(val key: String, val value: Any) : WooPosNavigationEvent()
     data object OpenHomeFromCashPaymentAfterSuccessfulPayment : WooPosNavigationEvent()
     data object ReturnHomeFromCashPayment : WooPosNavigationEvent()
     data class OpenEligibilityScreenFromSplash(
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/navigation/WooPosNavigationEventHandler.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/navigation/WooPosNavigationEventHandler.kt
@@ -21,16 +21,32 @@ fun NavHostController.handleNavigationEvent(
 
         is WooPosNavigationEvent.OpenHomeFromSplash -> navigateToHomeScreen()
         is WooPosNavigationEvent.OpenCashPayment -> navigateToCashPaymentScreen(event.orderId)
+
+        is WooPosNavigationEvent.GoBackWithResult -> {
+            previousBackStackEntry
+                ?.savedStateHandle
+                ?.set(event.key, event.value)
+            popBackStack()
+        }
+
         is WooPosNavigationEvent.GoBack -> popBackStack()
+
         is WooPosNavigationEvent.OpenHomeFromCashPaymentAfterSuccessfulPayment ->
             navigateToHomeScreenAfterSuccessfulCashPayment()
 
-        is WooPosNavigationEvent.OpenEmailReceipt -> navigateToEmailReceipt(event.orderId)
-        WooPosNavigationEvent.ReturnHomeFromCashPayment -> navigateToHomeScreenIfHomeScreenNotOpen()
+        is WooPosNavigationEvent.OpenEmailReceipt ->
+            navigateToEmailReceipt(event.orderId)
+
+        WooPosNavigationEvent.ReturnHomeFromCashPayment ->
+            navigateToHomeScreenIfHomeScreenNotOpen()
 
         is WooPosNavigationEvent.OpenEligibilityScreenFromSplash ->
             navigateToEligibilityScreen(event.reason)
-        is WooPosNavigationEvent.OpenSettings -> navigateToSettingsScreen()
-        is WooPosNavigationEvent.OpenOrders -> navigateToOrdersScreen()
+
+        is WooPosNavigationEvent.OpenSettings ->
+            navigateToSettingsScreen()
+
+        is WooPosNavigationEvent.OpenOrders ->
+            navigateToOrdersScreen()
     }
 }
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/navigation/WooPosRootHost.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/navigation/WooPosRootHost.kt
@@ -41,7 +41,7 @@ fun WooPosRootHost(
     ) {
         mainGraph(
             onNavigationEvent = onNavigationEvent,
-            homeViewModel = homeViewModel,
+            homeViewModel = homeViewModel
         )
     }
 }
diff --git a/WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSourceTest.kt b/WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSourceTest.kt
@@ -11,6 +11,7 @@ import org.assertj.core.api.Assertions.assertThat
 import org.junit.Rule
 import org.mockito.kotlin.any
 import org.mockito.kotlin.anyOrNull
+import org.mockito.kotlin.argumentCaptor
 import org.mockito.kotlin.eq
 import org.mockito.kotlin.isNull
 import org.mockito.kotlin.mock
@@ -468,4 +469,71 @@ class WooPosOrdersDataSourceTest {
             searchQuery = query
         )
     }
+
+    @Test
+    fun `given orderId, when refreshOrderById succeeds, then returns mapped order`() = runTest {
+        // GIVEN
+        val orderId = 123L
+        val entity = OrderEntity(localSiteId = LocalOrRemoteId.LocalId(1), orderId = orderId)
+        val mapped = OrderTestUtils.generateTestOrder(orderId = orderId)
+
+        whenever(orderMapper.toAppModel(entity)).thenReturn(mapped)
+
+        val payload = WCOrderStore.RemoteOrderPayload.Fetching(
+            orderWithMeta = entity to emptyList<WCMetaData>(),
+            site = siteModel
+        )
+        whenever(orderRestClient.fetchSingleOrder(siteModel, orderId)).thenReturn(payload)
+
+        // WHEN
+        val result = sut.refreshOrderById(orderId)
+
+        // THEN
+        assertThat(result.isSuccess).isTrue
+        assertThat(result.getOrThrow()).isEqualTo(mapped)
+
+        verify(selectedSite).get()
+        verify(orderRestClient).fetchSingleOrder(siteModel, orderId)
+        verify(orderMapper).toAppModel(entity)
+    }
+
+    @Test
+    fun `given order in cache, when refreshOrderById succeeds, then replaces cached order and keeps list size`() = runTest {
+        // GIVEN
+        val orderId = 42L
+        val site = siteModel
+
+        val cached1 = OrderTestUtils.generateTestOrder(orderId = 1)
+        val cachedTarget = OrderTestUtils.generateTestOrder(orderId = orderId)
+        val cached3 = OrderTestUtils.generateTestOrder(orderId = 3)
+        whenever(ordersCache.getAll()).thenReturn(listOf(cached1, cachedTarget, cached3))
+
+        val entity = OrderEntity(localSiteId = LocalOrRemoteId.LocalId(1), orderId = orderId)
+        val mappedUpdated = OrderTestUtils.generateTestOrder(orderId = orderId) // different instance
+        whenever(orderMapper.toAppModel(entity)).thenReturn(mappedUpdated)
+
+        val payload = WCOrderStore.RemoteOrderPayload.Fetching(
+            orderWithMeta = entity to emptyList<WCMetaData>(),
+            site = site
+        )
+        whenever(orderRestClient.fetchSingleOrder(site, orderId)).thenReturn(payload)
+
+        // WHEN
+        val result = sut.refreshOrderById(orderId)
+
+        // THEN
+        assertThat(result.isSuccess).isTrue
+        assertThat(result.getOrThrow()).isEqualTo(mappedUpdated)
+
+        val listCaptor = argumentCaptor<List<com.woocommerce.android.model.Order>>()
+        verify(ordersCache).getAll()
+        verify(ordersCache).setAll(listCaptor.capture())
+
+        val finalList = listCaptor.firstValue
+        assertThat(finalList).hasSize(3)
+
+        assertThat(finalList[0]).isEqualTo(cached1)
+        assertThat(finalList[1]).isEqualTo(mappedUpdated)
+        assertThat(finalList[2]).isEqualTo(cached3)
+    }
 }
diff --git a/WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModelTest.kt b/WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModelTest.kt
@@ -698,4 +698,56 @@ class WooPosOrdersViewModelTest {
         assertThat(content.selectedDetails.breakdown.refunds).containsExactly("-$10.00", "-$5.00")
         assertThat(content.selectedDetails.breakdown.netPayment).isNotNull()
     }
+
+    @Test
+    fun `given selected order, when onBackFromSuccessfullySendingEmailReceipt succeeds, then refreshes details`() = runTest {
+        // GIVEN
+        whenever(dataSource.loadOrders()).thenReturn(
+            flow { emit(LoadOrdersResult.SuccessRemote(listOf(order(100), order(200)))) }
+        )
+        viewModel = createViewModel()
+        advanceUntilIdle()
+
+        viewModel.onOrderSelected(200L)
+        advanceUntilIdle()
+
+        whenever(dataSource.refreshOrderById(200L)).thenReturn(Result.success(order(200)))
+
+        // WHEN
+        viewModel.onBackFromSuccessfullySendingEmailReceipt()
+        advanceUntilIdle()
+
+        // THEN
+        val state = viewModel.state.value as WooPosOrdersState.Content
+
+        assertThat(state.selectedDetails.id).isEqualTo(200L)
+        verify(dataSource).refreshOrderById(200L)
+    }
+
+    @Test
+    fun `given selected order, when onBackFromSuccessfullySendingEmailReceipt fails, then details remain unchanged`() = runTest {
+        // GIVEN
+        whenever(dataSource.loadOrders()).thenReturn(
+            flow { emit(LoadOrdersResult.SuccessRemote(listOf(order(1), order(2)))) }
+        )
+        viewModel = createViewModel()
+        advanceUntilIdle()
+
+        viewModel.onOrderSelected(1L)
+        advanceUntilIdle()
+        val before = viewModel.state.value as WooPosOrdersState.Content
+        val beforeDetails = before.selectedDetails
+
+        whenever(dataSource.refreshOrderById(1L)).thenReturn(Result.failure(RuntimeException("boom")))
+
+        // WHEN
+        viewModel.onBackFromSuccessfullySendingEmailReceipt()
+        advanceUntilIdle()
+
+        // THEN
+        val after = viewModel.state.value as WooPosOrdersState.Content
+
+        assertThat(after.selectedDetails).isEqualTo(beforeDetails)
+        verify(dataSource).refreshOrderById(1L)
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ fun WooPosEmailReceiptScreen(onNavigationEvent: (WooPosNavigationEvent) -> Unit)`
`47`	`47`	`onEmailAddressChanged = { viewModel.onUIEvent(WooPosEmailReceiptUIEvent.EmailChanged(it)) },`
`48`	`48`	`onSendReceiptClicked = { viewModel.onUIEvent(WooPosEmailReceiptUIEvent.SendEmailClicked) },`
`49`	`49`	`onBackClicked = { onNavigationEvent(WooPosNavigationEvent.GoBack) },`
`50`		`- onEmailSent = { onNavigationEvent(WooPosNavigationEvent.GoBack) }`
	`50`	`+ onEmailSent = { onNavigationEvent(WooPosNavigationEvent.GoBackWithResult(key = EMAIL_RECEIPT_SENT, true)) }`
`51`	`51`	`)`
`52`	`52`	`}`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ fun WooPosRootHost(`
`41`	`41`	`) {`
`42`	`42`	`mainGraph(`
`43`	`43`	`onNavigationEvent = onNavigationEvent,`
`44`		`- homeViewModel = homeViewModel,`
	`44`	`+ homeViewModel = homeViewModel`
`45`	`45`	`)`
`46`	`46`	`}`
`47`	`47`	`}`