[Shipping Labels] Handle marking orders as complete #14321

hichamboushaba · 2025-07-14T14:45:44Z

Description

This PR implements the logic of marking orders as complete when purchasing a shipping label, it also adds logic to set the default value of the toggle using the account settings, to match the web behavior.

Steps to reproduce

Happy path

Open shipping label creation form.
Enable the option "Mark order as complete" from the shipment details bottom sheet.
Purchase the label.
Wait for the label to be purchased.
Confirm the order was marked as complete.

Unhappy path

1. Import the following config to the Api Faker

[
  {
    "request": {
      "httpMethod": "PUT",
      "id": 0,
      "path": "/wc/v3/orders/%",
      "queryParameters": [],
      "type": {
        "type": "wp-api"
      }
    },
    "response": {
      "body": "",
      "endpointId": 0,
      "statusCode": 403
    }
  }
]

Follow steps 1 to 4 from the happy path case.
Confirm that a Snack Bar is shown to indicate the failure to mark the order as complete.

Default value of the toggle

Confirm that the toggle uses the value that was used in last purchase.

Testing information

The above TCs have all the details

The tests that have been performed

The above.

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.

dangermattic · 2025-07-14T14:46:44Z

	1 Warning
⚠️	This PR is assigned to the milestone 22.8 ❄️. The due date for this milestone has already passed. Please assign it to a milestone with a later deadline or check whether the release for this milestone has already been finished.

Generated by 🚫 Danger

wpmobilebot · 2025-07-14T14:53:05Z

📲 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	`a4549c2`
	Direct Download	`woocommerce-wear-prototype-build-pr14321-a4549c2.apk`

wpmobilebot · 2025-07-14T15:08:30Z

📲 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	`a4549c2`
	Direct Download	`woocommerce-prototype-build-pr14321-a4549c2.apk`

…settings

codecov-commenter · 2025-07-14T21:43:18Z

Codecov Report

Attention: Patch coverage is 65.90909% with 15 lines in your changes missing coverage. Please review.

Project coverage is 37.66%. Comparing base (b37ce16) to head (a4549c2).

Files with missing lines	Patch %	Lines
...hippinglabels/WooShippingLabelCreationViewModel.kt	78.26%	0 Missing and 5 partials ⚠️
...oid/ui/orders/wooshippinglabels/networking/DTOs.kt	0.00%	4 Missing ⚠️
...nglabels/networking/WooShippingNetworkingMapper.kt	0.00%	2 Missing ⚠️
...ui/orders/wooshippinglabels/MarkOrderAsComplete.kt	90.00%	0 Missing and 1 partial ⚠️
.../orders/wooshippinglabels/PurchaseShippingLabel.kt	0.00%	1 Missing ⚠️
...inglabels/networking/WooShippingLabelRepository.kt	0.00%	1 Missing ⚠️
...inglabels/networking/WooShippingLabelRestClient.kt	0.00%	1 Missing ⚠️

Additional details and impacted files

@@                Coverage Diff                 @@
##             release/22.8   #14321      +/-   ##
==================================================
+ Coverage           37.64%   37.66%   +0.01%     
- Complexity           9082     9086       +4     
==================================================
  Files                1980     1981       +1     
  Lines              111396   111431      +35     
  Branches            14680    14686       +6     
==================================================
+ Hits                41940    41970      +30     
+ Misses              65618    65615       -3     
- Partials             3838     3846       +8

☔ 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.

hichamboushaba · 2025-07-15T08:02:47Z

...com/woocommerce/android/ui/orders/wooshippinglabels/networking/WooShippingLabelRestClient.kt

@@ -154,7 +154,7 @@ class WooShippingLabelRestClient @Inject constructor(
        selectedRate: RateDTO,
        parentRate: RateDTO?,
        selectedRateOptions: Map<WooShippingRateModel.Option, ShippingRateSurchargeDTO>,
-        markOrderComplete: Boolean,
+        lastOrderCompleted: Boolean,


This argument indicates whether the user has enabled the option and is used to update the account settings, so I renamed it to a clearer name.

hichamboushaba · 2025-07-15T08:04:04Z

...com/woocommerce/android/ui/orders/wooshippinglabels/WooShippingLabelCreationViewModelTest.kt

+        onBlocking {
+            invoke(any(), any(), any(), any(), any(), any(), any(), any(), any(), isNull(), isNull())
+        } doReturn Result.success(
+            PurchasedLabelData(
+                labels = listOf(shippingLabelModel.copy(status = PURCHASED)),
+                origin = emptyMap(),
+                destination = emptyMap(),
+                rates = emptyMap()
+            )
+        )


I moved the default initialization to the mock declaration and then removed it from the tests, this reduces code duplication.

hichamboushaba · 2025-07-15T08:06:32Z

...com/woocommerce/android/ui/orders/wooshippinglabels/WooShippingLabelCreationViewModelTest.kt

-        val ratesState = (
-            sut.viewState.runAndCaptureValues {
-                sut.onPackageSelected(defaultPackageData)
-                advanceUntilIdle()
-            }.last() as DataState
-            ).shipmentUIList.first().shippingRatesState as ShippingRatesState.DataState
+        val ratesState = sut.viewState.runAndCaptureValues {
+            sut.onPackageSelected(defaultPackageData)
+            advanceUntilIdle()
+        }.last().let { viewState ->
+            (viewState as DataState).shipmentUIList.first().shippingRatesState as ShippingRatesState.DataState
+        }


I just improved the formatting here and in similar sections. The parentheses made the code harder to read, and I overlooked them when I first added them.

...e/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/MarkOrderAsComplete.kt

...c/test/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/MarkOrderAsCompleteTest.kt

irfano · 2025-07-15T15:50:53Z

...com/woocommerce/android/ui/orders/wooshippinglabels/WooShippingLabelCreationViewModelTest.kt

+            whenever(markOrderAsComplete(orderId)) doReturn Result.success(Unit)
+            whenever(observeShippingLabelStatus(eq(orderId), any())) doReturn flowOf(
+                ObserveShippingLabelStatus.ObserveShippingLabelStatusResult(
+                    status = PURCHASED,
+                    shippingLabelModel = shippingLabelModel.copy(status = PURCHASED)
+                )
+            )


Suggestion: We can add these mocks for markOrderAsComplete and observeShippingLabelStatus to the global definitions like you did for the purchaseShippingLabel mock.

I didn't move these because they are not used in many tests, and also for the observeShippingLabelStatus returning the PURCHASED status doesn't seem like a default behavior. WDYT about this thought?

...lin/com/woocommerce/android/ui/orders/wooshippinglabels/WooShippingLabelCreationViewModel.kt

Co-authored-by: Irfan Ömür <[email protected]>

hichamboushaba · 2025-07-15T19:40:18Z

Thanks @irfano for the review, I applied all your suggestions except one where I shared my opinion.

Regarding the MarkOrderAsCompleteTest suggestions, this class was fully generated with AI, do you think we need to be this careful about code review for tests like this? I just want to have your perspective here, as IMO it's OK to have non-optimal code in tests as long there is no performance issues and it tests the behavior as expected, and that's why AI is a good fit for writing tests.

hichamboushaba added type: enhancement A request for an enhancement. feature: shipping labels Related to creating, ordering, or printing shipping labels. labels Jul 14, 2025

Add logic to mark order as complete when label purchased

72c72e7

hichamboushaba force-pushed the issue/WOOMOB-797-sl-mark-order-complete branch from 8e53d76 to a377995 Compare July 14, 2025 20:23

hichamboushaba added 3 commits July 14, 2025 23:50

Add and update unit tests

77ced47

Rename argument to better reflect its role

bcf6b83

Set the default value of mark order as complete according to account …

32d1294

…settings

hichamboushaba force-pushed the issue/WOOMOB-797-sl-mark-order-complete branch from a377995 to 32d1294 Compare July 14, 2025 20:50

hichamboushaba added 2 commits July 15, 2025 00:08

Add tracking

a0c45f6

Update tests

5e195e0

hichamboushaba commented Jul 15, 2025

View reviewed changes

hichamboushaba requested review from irfano and JorgeMucientes and removed request for irfano July 15, 2025 08:06

hichamboushaba added this to the 22.8 ❄️ milestone Jul 15, 2025

hichamboushaba marked this pull request as ready for review July 15, 2025 08:07

irfano self-assigned this Jul 15, 2025

irfano requested changes Jul 15, 2025

View reviewed changes

hichamboushaba and others added 4 commits July 15, 2025 20:26

Fix getting the class name

fc28361

Co-authored-by: Irfan Ömür <[email protected]>

Simplify code

5aacdba

Co-authored-by: Irfan Ömür <[email protected]>

Use if instead of when

c33d1f7

Remove redundant code

a4549c2

hichamboushaba requested a review from irfano July 15, 2025 19:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Shipping Labels] Handle marking orders as complete #14321

[Shipping Labels] Handle marking orders as complete #14321

hichamboushaba commented Jul 14, 2025 •

edited

Loading

Uh oh!

dangermattic commented Jul 14, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Jul 14, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Jul 14, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Jul 14, 2025 •

edited

Loading

Uh oh!

hichamboushaba Jul 15, 2025

Uh oh!

hichamboushaba Jul 15, 2025

Uh oh!

hichamboushaba Jul 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

irfano Jul 15, 2025

Uh oh!

hichamboushaba Jul 15, 2025

Uh oh!

Uh oh!

hichamboushaba commented Jul 15, 2025

Uh oh!

Uh oh!

[Shipping Labels] Handle marking orders as complete #14321

Are you sure you want to change the base?

[Shipping Labels] Handle marking orders as complete #14321

Conversation

hichamboushaba commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to reproduce

Happy path

Unhappy path

Default value of the toggle

Testing information

The tests that have been performed

Uh oh!

dangermattic commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

hichamboushaba Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

hichamboushaba Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

hichamboushaba Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

irfano Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

hichamboushaba Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hichamboushaba commented Jul 15, 2025

Uh oh!

Uh oh!

hichamboushaba commented Jul 14, 2025 •

edited

Loading

dangermattic commented Jul 14, 2025 •

edited

Loading

wpmobilebot commented Jul 14, 2025 •

edited

Loading

wpmobilebot commented Jul 14, 2025 •

edited

Loading

codecov-commenter commented Jul 14, 2025 •

edited

Loading