[Woo POS][Refunds] Add "Review refund" step in POS refund flow #15064

samiuelson · 2025-12-05T12:20:52Z

Description

This PR introduces 2nd step in the POS refund flow. The "Review refund" step is shown after clicking "Continue" button in the item selection step. The changes include state management enhancements with a new step enum, formatted price fields for currency display, and test coverage for step navigation.

What's not included:

Refund reason - it's hardcoded for now, though the text style should match design specs
Edit reason button - it's not working yet
Via (payment method) - hardcoded text for now

Test Steps

Go to Woo POS > Orders
Tap "Issue refund" button and explore the refund flow

Images/gif

I have considered if this change warrants release notes and have added them to RELEASE-NOTES.txt if necessary. Use the "[Internal]" label for non-user-facing changes.

- Introduce `RefundStep` (SelectItems, ReviewRefund) in `WooPosRefundState` to manage the refund flow. - Add formatted price fields to `WooPosRefundState.Content` and populate them in `WooPosRefundViewModel` using `CurrencyFormatter`. - Update `WooPosIssueRefundDialog` to render either item selection or review content based on the current step. - Rename `RefundDialogContent` to `SelectItemsContent`. - Add `ReviewRefundContent` composable to display refund summary, including subtotal, taxes, and total. - Add `onContinueToReview` and `onBackToSelectItems` navigation logic to `WooPosRefundViewModel`. - Add string resources for the refund review screen.

wpmobilebot · 2025-12-05T12:26:41Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`09ff917`
	Direct Download	`woocommerce-wear-prototype-build-pr15064-09ff917.apk`

wpmobilebot · 2025-12-05T12:43:22Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`09ff917`
	Direct Download	`woocommerce-prototype-build-pr15064-09ff917.apk`

WooCommerce/src/main/res/values/strings.xml

codecov-commenter · 2025-12-05T17:02:00Z

Codecov Report

❌ Patch coverage is 14.36170% with 161 lines in your changes missing coverage. Please review.
✅ Project coverage is 38.63%. Comparing base (d62c547) to head (09ff917).

Files with missing lines	Patch %	Lines
...ndroid/ui/woopos/orders/WooPosIssueRefundDialog.kt	0.00%	161 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #15064      +/-   ##
============================================
- Coverage     38.66%   38.63%   -0.04%     
- Complexity    10362    10367       +5     
============================================
  Files          2168     2169       +1     
  Lines        123004   123170     +166     
  Branches      16977    16998      +21     
============================================
+ Hits          47561    47586      +25     
- Misses        70638    70779     +141     
  Partials       4805     4805

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

samiuelson · 2025-12-05T18:10:08Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosIssueRefundDialog.kt

    onContinue: () -> Unit
 ) {
-    Column(modifier = Modifier.fillMaxSize()) {
+    Column(modifier = Modifier.fillMaxWidth()) {


💡 This makes the dialog adjust its height to the content rather than taking the whole height of the screen.

samiuelson · 2025-12-05T18:10:49Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosIssueRefundDialog.kt

+                    isTotal = true
+                )
+                WooPosText(
+                    text = "Via payment card ••••1456",


This will be replaced with real value in the next iteration.

🔍 In general, I think it's safer to put an apparently wrong text for testing - just to ensure we don't miss it. E.g. "TEST: Via payment card ••••9999".

samiuelson · 2025-12-05T18:11:01Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosIssueRefundDialog.kt

+                    )
+                }
+                WooPosText(
+                    text = "Customer bought an extra item.",


This as well.

Copilot

Pull request overview

This PR introduces a two-step refund flow in the WooCommerce POS by adding a "Review refund" step between item selection and actual refund processing. The changes include state management enhancements with a new step enum, formatted price fields for currency display, comprehensive test coverage for step navigation, and a new review screen UI with refund summary details.

Added RefundStep enum (SelectItems, ReviewRefund) to manage the refund workflow
Integrated CurrencyFormatter to populate formatted price fields in the refund state
Created ReviewRefundContent composable displaying subtotal, taxes, total, and placeholder sections for payment method and refund reason

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
WooPosRefundState.kt	Added `RefundStep` sealed class and formatted price fields (formattedSubtotal, formattedTaxes, formattedTotal) to Content state
WooPosRefundUIEvent.kt	Created new sealed class with events for navigation between steps (ContinueToReviewClicked, BackToSelectItemsClicked, DialogDismissed)
WooPosRefundViewModel.kt	Added CurrencyFormatter dependency, price formatting logic in buildContentState, and onUIEvent handler for step transitions
WooPosRefundViewModelTest.kt	Added comprehensive tests for step navigation, dialog dismissal behavior, and non-content state handling
WooPosIssueRefundDialog.kt	Renamed RefundDialogContent to SelectItemsContent, added ReviewRefundContent with summary rows and action buttons, implemented step-based rendering
WooPosOrdersScreen.kt	Removed onContinue parameter from WooPosIssueRefundDialog as navigation is now handled internally
strings.xml	Added string resources for review screen labels, including plurals for items subtotal, refund total, reason, and edit actions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosIssueRefundDialog.kt

WooCommerce/src/main/res/values/strings.xml

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosIssueRefundDialog.kt

…tep' into woomob-1826-show-review-refund-step

samiuelson · 2025-12-05T18:34:28Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosIssueRefundDialog.kt

 ) {
    val viewModel: WooPosRefundViewModel =
-        hiltViewModel<WooPosRefundViewModel, WooPosRefundViewModel.Factory> { factory ->
+        hiltViewModel<WooPosRefundViewModel, WooPosRefundViewModel.Factory>(key = "refund_$orderId") { factory ->


💡 This recreates the VM when another order gets selected in the Orders pane.

malinajirka

Thanks @samiuelson, great job! I've found a couple UI issues - they are not all related to the PR, but I thought it's better to mention them.

I noticed the Refund dialog appears instantly without an animation - feels a bit off and inconsistent.
Semi-related to the above - moving between steps is also without an animation.
If I proceed to the Review refund step and I dismiss the dialog, upon reopening the flow, I'm on the review refund step instead of item selection step.

github-advanced-security bot found potential problems Dec 5, 2025

View reviewed changes

WooCommerce/src/main/res/values/strings.xml Fixed Show fixed Hide fixed

samiuelson added 6 commits December 5, 2025 13:52

Change refund dialog height to "wrap-content"

46516b2

Refactor refund dialog to use UI events

fe23c9b

Reset refund step when the dialog is dismissed

98f4044

Add tests

ba6d09b

Keep mocked strings away from res

7425ff5

Recreate WooPosRefundViewModel on each selected order_id change

b19d100

samiuelson added 2 commits December 5, 2025 18:49

Use correct plurals string

fbfaeee

Merge branch 'trunk' into woomob-1826-show-review-refund-step

daacc93

samiuelson requested a review from Copilot December 5, 2025 18:08

Copilot started reviewing on behalf of samiuelson December 5, 2025 18:08 View session

samiuelson commented Dec 5, 2025

View reviewed changes

Copilot AI reviewed Dec 5, 2025

View reviewed changes

samiuelson added 3 commits December 5, 2025 19:13

Clean up code

1c9845a

Clean up code

3df1d3b

Merge remote-tracking branch 'origin/woomob-1826-show-review-refund-s…

bcec418

…tep' into woomob-1826-show-review-refund-step

samiuelson added type: task An internally driven task. feature: POS labels Dec 5, 2025

samiuelson added this to the 23.9 milestone Dec 5, 2025

Remove unused res

09ff917

samiuelson marked this pull request as ready for review December 5, 2025 18:32

samiuelson commented Dec 5, 2025

View reviewed changes

samiuelson requested a review from malinajirka December 5, 2025 18:35

malinajirka self-assigned this Dec 8, 2025

malinajirka approved these changes Dec 8, 2025

View reviewed changes

[Woo POS][Refunds] Add "Review refund" step in POS refund flow #15064

Are you sure you want to change the base?

[Woo POS][Refunds] Add "Review refund" step in POS refund flow #15064

Conversation

samiuelson commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Test Steps

Images/gif

Uh oh!

wpmobilebot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

samiuelson Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

samiuelson Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

malinajirka Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samiuelson Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samiuelson Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

malinajirka left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

samiuelson commented Dec 5, 2025 •

edited

Loading

wpmobilebot commented Dec 5, 2025 •

edited

Loading

wpmobilebot commented Dec 5, 2025 •

edited

Loading

codecov-commenter commented Dec 5, 2025 •

edited

Loading

malinajirka Dec 8, 2025 •

edited

Loading