[Shipping Labels Revamp] Add Customs requirement check #13413

ThomazFB · 2025-01-28T19:38:00Z

Why

Fix issue #13365 by introducing both the Customs section UI and the Customs requirement logic check.

How

Customs Section UI

The Customs section UI and state data is introduced through the same Mutable state flow logic using a new CustomsState. When no Customs data is required, the state is set as NotRequired, when it's required but not available, it's set as Unavailable. The DataAvailable state option will be added later once the form is finished.

Customs requirement check

A use case called ShouldRequireCustomsForm is introduced, replicating the same logic used in the old Shipping Labels implementation declared at the ShippingLabelsStateMachine.

Screen Capture

How to Test

Scenario 1 - Customs required

Start the Shipping Labels creation flow
Fill the origin and destination address data, or make it pre-filled from the code if filling it is not available yet
Ensure the selected country between origin and destination addresses are different from each other
Verify the Customs section is displayed

Scenario 2 - Customs NOT required

Start the Shipping Labels creation flow
Fill the origin and destination address data, or make it pre-filled from the code if filling it is not available yet
Ensure the selected country between origin and destination addresses are exactly the same
Verify the Customs section is hidden

Update release notes:

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Reviewer (or Author, in the case of optional code reviews):

Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement:

The PR is small and has a clear, single focus, or a valid explanation is provided in the description. If needed, please request to split it into smaller PRs.
Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
Manual Testing: The author listed all the tests they ran, including smoke tests when needed (e.g., for refactorings). The reviewer confirmed that the PR works as expected on big (tablet) and small (phone) in case of UI changes, and no regressions are added.

wpmobilebot · 2025-01-28T19:42:22Z

📲 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	`1e64abe`
	Direct Download	`woocommerce-wear-prototype-build-pr13413-1e64abe.apk`

wpmobilebot · 2025-01-28T19:54:18Z

📲 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	`1e64abe`
	Direct Download	`woocommerce-prototype-build-pr13413-1e64abe.apk`

codecov-commenter · 2025-01-28T20:05:39Z

Codecov Report

Attention: Patch coverage is 83.87097% with 5 lines in your changes missing coverage. Please review.

Project coverage is 41.12%. Comparing base (73135c1) to head (1e64abe).
Report is 354 commits behind head on trunk.

Files with missing lines	Patch %	Lines
...hippinglabels/WooShippingLabelCreationViewModel.kt	84.21%	1 Missing and 2 partials ⚠️
...shippinglabels/customs/ShouldRequireCustomsForm.kt	83.33%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #13413      +/-   ##
============================================
+ Coverage     41.10%   41.12%   +0.01%     
- Complexity     6486     6497      +11     
============================================
  Files          1325     1326       +1     
  Lines         77572    77601      +29     
  Branches      10694    10699       +5     
============================================
+ Hits          31889    31913      +24     
- Misses        42850    42851       +1     
- Partials       2833     2837       +4

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

…LabelCreationViewModel

atorresveiga · 2025-01-31T16:26:21Z

...kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/WooShippingLabelCreationScreen.kt

@@ -393,6 +411,68 @@ internal fun HazmatCard(
    }
 }

+@Composable
+private fun CustomsCard(
+    modifier: Modifier = Modifier,


np: Modifier parameters should be ordered as the first optional parameter. In this case, it should be the last parameter because the other parameters are not optional.

Thanks for the suggestion @atorresveiga! I took the opportunity to also adjust this in all components I introduced that wasn't following this convention in the file: 1e64abe

atorresveiga · 2025-01-31T16:29:35Z

...tlin/com/woocommerce/android/ui/orders/wooshippinglabels/customs/ShouldRequireCustomsForm.kt

+import com.woocommerce.android.ui.orders.wooshippinglabels.WooShippingAddresses
+import javax.inject.Inject
+
+class ShouldRequireCustomsForm @Inject constructor() {


atorresveiga

Great work, @ThomazFB! I left a very minor NP, but the code looks great and is working as described.

LGTM!

wpmobilebot · 2025-01-31T18:13:02Z

Version 21.6 has now entered code-freeze, so the milestone of this PR has been updated to 21.7.

ThomazFB added 7 commits January 28, 2025 15:42

Define ShouldRequireCustomsForm use case

cf3b844

Add US military state logic into ShouldRequireCustomsForm use case

8b9dce0

Finish ShouldRequireCustomsForm business logic

0006023

Make ShouldRequireCustomsForm injectable

7ba07c7

Add ShouldRequireCustomsFormTest file

7fd47ed

Add ShouldRequireCustomsFormTest unit test scenarios

c6bf739

Fix lint issues

3ea8d07

ThomazFB added type: task An internally driven task. feature: shipping labels Related to creating, ordering, or printing shipping labels. labels Jan 28, 2025

ThomazFB added this to the 21.6 milestone Jan 28, 2025

ThomazFB linked an issue Jan 28, 2025 that may be closed by this pull request

[Shipping Labels: Customs] Introduce Customs form main layout #13366

Open

ThomazFB added 12 commits January 29, 2025 13:11

Define the CustomsState

ca67034

Adjust CustomsState to match the strategy used inside the WooShipping…

2a1fae8

…LabelCreationViewModel

Combine the Customs state with the ViewState flow

7b087d2

Add Flow logic to control Customs requirement changes

0aea6b4

Wire the Customs state with the WooShippingLabelCreationScreen

e820ab4

Declare CustomsCard associated with the Customs state

f7aab61

Add missing Customs string resources

306519d

Define initial scaffold for the Customs section

8b6601b

Adjust Customs card to follow design requirements

50fee13

Introduce Badge UI for the Customs card

510b5b2

Add Edit action into the Customs section

a4a4f56

Fix lint issues

bae7fb8

ThomazFB linked an issue Jan 29, 2025 that may be closed by this pull request

[Shipping Labels: Customs] Add Customs section in main form #13365

Closed

ThomazFB removed a link to an issue Jan 29, 2025

[Shipping Labels: Customs] Introduce Customs form main layout #13366

Open

Fix Customs Card paddings

8d042c3

ThomazFB added the unit-tests-exemption label Jan 29, 2025

ThomazFB added 3 commits January 29, 2025 16:55

Fix build errors in WooShippingLabelCreationViewModelTest

5057b5c

Add unit test coverage for the Custom State values

515f0ec

Fix lint issues

092eeb8

ThomazFB requested a review from atorresveiga January 29, 2025 20:13

ThomazFB marked this pull request as ready for review January 29, 2025 20:13

atorresveiga self-assigned this Jan 31, 2025

atorresveiga reviewed Jan 31, 2025

View reviewed changes

atorresveiga approved these changes Jan 31, 2025

View reviewed changes

Update optional Modifier parameter rule to follow file strategy

1e64abe

wpmobilebot modified the milestones: 21.6, 21.7 Jan 31, 2025

ThomazFB merged commit 123033e into trunk Jan 31, 2025
16 of 17 checks passed

ThomazFB deleted the issue/add-initial-customs-entry-point branch January 31, 2025 19:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Shipping Labels Revamp] Add Customs requirement check #13413

[Shipping Labels Revamp] Add Customs requirement check #13413

ThomazFB commented Jan 28, 2025 •

edited

Loading

wpmobilebot commented Jan 28, 2025 •

edited

Loading

wpmobilebot commented Jan 28, 2025 •

edited

Loading

codecov-commenter commented Jan 28, 2025 •

edited

Loading

atorresveiga Jan 31, 2025

ThomazFB Jan 31, 2025

atorresveiga Jan 31, 2025

atorresveiga left a comment

wpmobilebot commented Jan 31, 2025

[Shipping Labels Revamp] Add Customs requirement check #13413

[Shipping Labels Revamp] Add Customs requirement check #13413

Conversation

ThomazFB commented Jan 28, 2025 • edited Loading

Why

How

Customs Section UI

Customs requirement check

Screen Capture

How to Test

Scenario 1 - Customs required

Scenario 2 - Customs NOT required

Reviewer (or Author, in the case of optional code reviews):

wpmobilebot commented Jan 28, 2025 • edited Loading

wpmobilebot commented Jan 28, 2025 • edited Loading

codecov-commenter commented Jan 28, 2025 • edited Loading

Codecov Report

atorresveiga Jan 31, 2025

Choose a reason for hiding this comment

ThomazFB Jan 31, 2025

Choose a reason for hiding this comment

atorresveiga Jan 31, 2025

Choose a reason for hiding this comment

atorresveiga left a comment

Choose a reason for hiding this comment

wpmobilebot commented Jan 31, 2025

ThomazFB commented Jan 28, 2025 •

edited

Loading

wpmobilebot commented Jan 28, 2025 •

edited

Loading

wpmobilebot commented Jan 28, 2025 •

edited

Loading

codecov-commenter commented Jan 28, 2025 •

edited

Loading