Partial refund for products

RELEASE-NOTES.txt

@@ -3,6 +3,7 @@
 19.8
 -----
 - [*] Stats: The Google Campaign analytics card now has a call to action to create a paid campaign if there are no campaign analytics for the selected time period. [https://github.com/woocommerce/woocommerce-android/pull/12161]
+- [**] Added support for partial refunds. [https://github.com/woocommerce/woocommerce-android/pull/12164]
 
 19.7
 -----

WooCommerce/src/main/kotlin/com/woocommerce/android/model/Refund.kt

@@ -1,11 +1,14 @@
 package com.woocommerce.android.model
 
 import android.os.Parcelable
+import com.woocommerce.android.extensions.sumByBigDecimal
 import com.woocommerce.android.ui.products.ProductHelper
 import kotlinx.parcelize.IgnoredOnParcel
 import kotlinx.parcelize.Parcelize
 import org.wordpress.android.fluxc.model.refunds.WCRefundModel
-import org.wordpress.android.fluxc.model.refunds.WCRefundModel.*
+import org.wordpress.android.fluxc.model.refunds.WCRefundModel.WCRefundFeeLine
+import org.wordpress.android.fluxc.model.refunds.WCRefundModel.WCRefundItem
+import org.wordpress.android.fluxc.model.refunds.WCRefundModel.WCRefundShippingLine
 import java.math.BigDecimal
 import java.math.RoundingMode.HALF_UP
 import java.util.Date
@@ -117,6 +120,10 @@ fun WCRefundFeeLine.toAppModel(): Refund.FeeLine {
     )
 }
 
+fun List<Refund>.getRefundedProductsAmount() = filter { it.items.isNotEmpty() }.sumByBigDecimal {
+    it.items.sumByBigDecimal { item -> item.total }
+}
+
 fun List<Refund>.getNonRefundedProducts(
     products: List<Order.Item>
 ): List<Order.Item> {

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/refunds/IssueRefundViewModel.kt

@@ -8,6 +8,7 @@ import com.woocommerce.android.R
 import com.woocommerce.android.WooException
 import com.woocommerce.android.analytics.AnalyticsEvent.CREATE_ORDER_REFUND_ITEM_QUANTITY_DIALOG_OPENED
 import com.woocommerce.android.analytics.AnalyticsEvent.CREATE_ORDER_REFUND_NEXT_BUTTON_TAPPED
+import com.woocommerce.android.analytics.AnalyticsEvent.CREATE_ORDER_REFUND_PRODUCT_AMOUNT_DIALOG_OPENED
 import com.woocommerce.android.analytics.AnalyticsEvent.CREATE_ORDER_REFUND_SELECT_ALL_ITEMS_BUTTON_TAPPED
 import com.woocommerce.android.analytics.AnalyticsEvent.CREATE_ORDER_REFUND_SUMMARY_REFUND_BUTTON_TAPPED
 import com.woocommerce.android.analytics.AnalyticsEvent.ORDER_NOTE_ADD_FAILED
@@ -28,6 +29,7 @@ import com.woocommerce.android.model.OrderNote
 import com.woocommerce.android.model.PaymentGateway
 import com.woocommerce.android.model.Refund
 import com.woocommerce.android.model.getMaxRefundQuantities
+import com.woocommerce.android.model.getRefundedProductsAmount
 import com.woocommerce.android.model.toAppModel
 import com.woocommerce.android.tools.NetworkStatus
 import com.woocommerce.android.tools.SelectedSite
@@ -38,6 +40,7 @@ import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.InputVal
 import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.HideValidationError
 import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.OpenUrl
 import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.ShowNumberPicker
+import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.ShowRefundAmountDialog
 import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.ShowRefundConfirmation
 import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.ShowRefundSummary
 import com.woocommerce.android.ui.payments.refunds.IssueRefundViewModel.IssueRefundEvent.ShowValidationError
@@ -179,6 +182,7 @@ class IssueRefundViewModel @Inject constructor(
     private val refundableFeeLineIds: List<Long> /* Fees lines that haven't been refunded */
 
     private val maxRefund: BigDecimal
+    private val availableRefundForProducts: BigDecimal
     private val maxQuantities: Map<Long, Float>
     private val formatCurrency: (BigDecimal) -> String
     private val gateway: PaymentGateway
@@ -202,6 +206,7 @@ class IssueRefundViewModel @Inject constructor(
         refunds = refundStore.getAllRefunds(selectedSite.get(), arguments.orderId).map { it.toAppModel() }
         formatCurrency = currencyFormatter.buildBigDecimalFormatter(order.currency)
         maxRefund = order.total - order.refundTotal
+        availableRefundForProducts = calculateProductTotal(order) - refunds.getRefundedProductsAmount()
         maxQuantities = refunds.getMaxRefundQuantities(order.items)
             .map { (id, quantity) -> id to quantity }
             .toMap()
@@ -494,6 +499,7 @@ class IssueRefundViewModel @Inject constructor(
                     refundStore.createItemsRefund(
                         selectedSite.get(),
                         order.id,
+                        commonState.refundTotal,
                         refundSummaryState.refundReason ?: "",
                         true,
                         gateway.supportsRefunds,
@@ -614,6 +620,24 @@ class IssueRefundViewModel @Inject constructor(
         refundSummaryState = refundSummaryState.copy(isSummaryTextTooLong = currLength > maxLength)
     }
 
+    fun onProductRefundAmountTapped() {
+        triggerEvent(
+            ShowRefundAmountDialog(
+                refundByItemsState.productsRefund,
+                availableRefundForProducts,
+                resourceProvider.getString(
+                    R.string.order_refunds_available_for_refund,
+                    formatCurrency(availableRefundForProducts)
+                )
+            )
+        )
+
+        analyticsTrackerWrapper.track(
+            CREATE_ORDER_REFUND_PRODUCT_AMOUNT_DIALOG_OPENED,
+            mapOf(AnalyticsTracker.KEY_ORDER_ID to order.id)
+        )
+    }
+
     fun onProductsRefundAmountChanged(newAmount: BigDecimal) {
         refundByItemsState = refundByItemsState.copy(
             productsRefund = newAmount,
@@ -628,7 +652,7 @@ class IssueRefundViewModel @Inject constructor(
         selectedQuantities[uniqueId] = newQuantity
 
         val (subtotal, taxes) = newItems.calculateTotals()
-        val productsRefund = min(max(subtotal + taxes, BigDecimal.ZERO), maxRefund)
+        val productsRefund = min(max(subtotal + taxes, BigDecimal.ZERO), availableRefundForProducts)
 
         val selectButtonTitle = if (areAllItemsSelected) {
             resourceProvider.getString(R.string.order_refunds_items_select_none)
@@ -867,6 +891,8 @@ class IssueRefundViewModel @Inject constructor(
         return availableFeeLines
     }
 
+    private fun calculateProductTotal(order: Order) = order.items.sumByBigDecimal { it.subtotal + it.totalTax }
+
     private fun calculatePartialShippingSubtotal(selectedShippingLinesId: List<Long>): BigDecimal {
         return order.shippingLines
             .filter { it.itemId in selectedShippingLinesId }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/refunds/RefundByItemsFragment.kt

@@ -113,6 +113,9 @@ class RefundByItemsFragment :
             viewModel.onFeesRefundMainSwitchChanged(isChecked)
             binding.issueRefundFeesSection.root.isVisible = isChecked
         }
+        productsBinding.issueRefundProductsTotal.setOnClickListener {
+            viewModel.onProductRefundAmountTapped()
+        }
     }
 
     private fun setupObservers() {

WooCommerce/src/main/res/layout/refund_by_items_products.xml

@@ -108,11 +108,13 @@
 
     <com.google.android.material.textview.MaterialTextView
         android:id="@+id/issueRefund_productsTotal"
-        style="@style/Woo.Card.Body.Bold"
+        style="@style/Woo.ListItem.Title"
         android:layout_width="wrap_content"
-        android:layout_height="wrap_content"
-        android:layout_marginTop="@dimen/major_75"
-        android:layout_marginBottom="@dimen/major_75"
+        android:layout_height="32dp"
+        android:layout_marginVertical="@dimen/major_75"
+        android:background="@drawable/refund_product_item_qty_bg"
+        android:minWidth="42dp"
+        android:paddingHorizontal="@dimen/major_75"
         app:layout_constraintBottom_toBottomOf="parent"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintTop_toBottomOf="@id/issueRefund_dividerBelowTaxes"

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/payments/refunds/IssueRefundViewModelTest.kt

@@ -381,6 +381,7 @@ class IssueRefundViewModelTest : BaseUnitTest() {
                 refundStore.createItemsRefund(
                     site = any(),
                     orderId = any(),
+                    amount = any(),
                     reason = any(),
                     restockItems = any(),
                     autoRefund = any(),
@@ -432,6 +433,7 @@ class IssueRefundViewModelTest : BaseUnitTest() {
                 refundStore.createItemsRefund(
                     site = any(),
                     orderId = any(),
+                    amount = any(),
                     reason = any(),
                     restockItems = any(),
                     autoRefund = any(),
@@ -483,6 +485,7 @@ class IssueRefundViewModelTest : BaseUnitTest() {
                 refundStore.createItemsRefund(
                     site = any(),
                     orderId = any(),
+                    amount = any(),
                     reason = any(),
                     restockItems = any(),
                     autoRefund = any(),
@@ -800,6 +803,7 @@ class IssueRefundViewModelTest : BaseUnitTest() {
                 refundStore.createItemsRefund(
                     site = any(),
                     orderId = any(),
+                    amount = any(),
                     reason = any(),
                     restockItems = any(),
                     autoRefund = any(),
@@ -855,6 +859,7 @@ class IssueRefundViewModelTest : BaseUnitTest() {
                 refundStore.createItemsRefund(
                     site = any(),
                     orderId = any(),
+                    amount = any(),
                     reason = any(),
                     restockItems = any(),
                     autoRefund = any(),
@@ -929,6 +934,25 @@ class IssueRefundViewModelTest : BaseUnitTest() {
         }
     }
 
+    @Test
+    fun `when product refund amount is tapped, then proper track event is triggered`() {
+        testBlocking {
+            val orderWithMultipleShipping = OrderTestUtils.generateOrderWithMultipleShippingLines().copy(
+                paymentMethod = "cod",
+                metaData = "[]"
+            )
+            whenever(orderStore.getOrderByIdAndSite(any(), any())).thenReturn(orderWithMultipleShipping)
+
+            initViewModel()
+            viewModel.onProductRefundAmountTapped()
+
+            verify(analyticsTrackerWrapper).track(
+                AnalyticsEvent.CREATE_ORDER_REFUND_PRODUCT_AMOUNT_DIALOG_OPENED,
+                mapOf(AnalyticsTracker.KEY_ORDER_ID to ORDER_ID)
+            )
+        }
+    }
+
     @Test
     fun `when select button is tapped, then proper track event is triggered`() {
         testBlocking {

build.gradle

@@ -99,7 +99,7 @@ tasks.register("installGitHooks", Copy) {
 }
 
 ext {
-    fluxCVersion = 'trunk-cc6b2f85546a844b13d99bc0ad6ceabd1af131d3'
+    fluxCVersion = '3069-7afd7e6be72dd202b98897527c5878d7c1a4aeff'
     glideVersion = '4.16.0'
     coilVersion = '2.1.0'
     constraintLayoutVersion = '1.2.0'