[Shipping Labels Revamp] Introduce Customs initial form #13378

ThomazFB · 2025-01-22T21:26:54Z

Why

Partially fix issue #13366 by introducing the initial Customs form connected with the main Shipping Labels creation form.

The data validation and error handling will be delivered in the following PR.

The Product Details section will be delivered through issue #13367.

How

Introduces the ViewModel, Screen, and Fragment set for the Customs form, with the navigation action coming from the Shipping Labels creation form. It also defines the basic UI structure alongside the Content, Restriction, and ITN fields, with proper support for the Other option, opening an additional Text field for additional description.

Unit tests are also added for the ViewModel viewState and events controls.

Screen Capture

Screen_recording_20250130_144547.mp4

How to Test

In case you want to avoid having to fill the address data to access the Customs form, you can simply override the ShouldRequireCustomsForm use case always to return true to trigger the Customs data requirement forcefully.

Open the Shipping Labels Creation form, click the edit button inside the Customs section
Verify all UI options are operational and interactable.

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.

… screen

dangermattic · 2025-01-22T21:28:27Z

	1 Warning
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

wpmobilebot · 2025-01-22T21:31:15Z

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

wpmobilebot · 2025-01-22T21:43:35Z

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

…ViewModel

…FormViewModel

…duce-customs-section

codecov-commenter · 2025-01-30T18:11:44Z

Codecov Report

Attention: Patch coverage is 85.00000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 41.15%. Comparing base (092eeb8) to head (3fb4558).
Report is 331 commits behind head on trunk.

Files with missing lines	Patch %	Lines
...glabels/customs/WooShippingCustomsFormViewModel.kt	89.47%	6 Missing ⚠️
...hippinglabels/WooShippingLabelCreationViewModel.kt	0.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #13378      +/-   ##
============================================
+ Coverage     41.12%   41.15%   +0.03%     
- Complexity     6497     6507      +10     
============================================
  Files          1326     1327       +1     
  Lines         77601    77661      +60     
  Branches      10699    10701       +2     
============================================
+ Hits          31913    31964      +51     
- Misses        42851    42860       +9     
  Partials       2837     2837

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

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

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

atorresveiga · 2025-01-31T21:44:38Z

...om/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormFragment.kt

+                    )
+                }
+
+                is ShowRestrictionTypeDialog -> {


np: Should we move away from these dialogs and start relying only on Jetpack Compose? Maybe with the use of a Dropdown or a BottomSheet?

This is a np and not a blocker for the PR ☝️

That might be a good idea. I think the best approach would be to adjust this usage on both the Customs and Packages UIs, which are the ones I introduced this old fragment-reliant strategy. Should we add a side nice-to-have task to tackle this improvement as a separate issue? WDYT?

atorresveiga · 2025-01-31T21:46:02Z

.../com/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormScreen.kt

+
+@Composable
+fun WooShippingCustomsFormScreen(
+    modifier: Modifier = Modifier,


np: modifier should be the first optional parameter

atorresveiga · 2025-01-31T22:33:38Z

...m/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormViewModel.kt

+
+    fun onITNChanged(newItnValue: String) {
+        _viewState.update {
+            it.copy(itnValue = newItnValue)


From this article, I learned this:

At the moment, it is not recommended to use reactive streams to define the state variable for TextField

That is why I used mutable state for input fields in other screens of the new experience.

That said ☝️ I tested typing new values, and the functionality worked fine, maybe because it is exposed as a livedata

Oh, very interesting approach. Thanks for sharing @atorresveiga! Yeah, I was always curious if the reactive stream approach wouldn't risk to introduce a circular reference of changes, but the Live Data always took care of avoiding that. I agree that we should adopt this strategy.

In that case, similar to what I said in the previous comment, WDYT if we add a separate task to fix this both on the Customs UI and Packages UI? I believe I can actually fix this for the Customs UI in upcoming PRs since I'm still working on that screen, but I think the Packages part also need a bit of attention since it's also using inputs like this.

atorresveiga

The code looks nice and is working as expected. I left a couple of minor notes that are not blockers for this PR.

LGTM!

ThomazFB · 2025-02-03T20:14:04Z

Thanks for the inputs and review, @atorresveiga! I've replied to your inputs suggesting we to adjust both the TextField reactive approach and adopting the native Compose spinner as fixes for upcoming PRs, since this one is already quite big.

So, to unblock the upcoming PRs, I'll merge this one and ensure that both adjustments are covered 🫡

...om/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormFragment.kt

+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import androidx.compose.material.Surface


.../com/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormScreen.kt

+import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.text.KeyboardOptions
+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material.Button


.../com/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormScreen.kt

+import androidx.compose.foundation.text.KeyboardOptions
+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material.Button
+import androidx.compose.material.Checkbox


.../com/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormScreen.kt

+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material.Button
+import androidx.compose.material.Checkbox
+import androidx.compose.material.CheckboxDefaults


.../com/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormScreen.kt

+import androidx.compose.material.Button
+import androidx.compose.material.Checkbox
+import androidx.compose.material.CheckboxDefaults
+import androidx.compose.material.MaterialTheme


.../com/woocommerce/android/ui/orders/wooshippinglabels/customs/WooShippingCustomsFormScreen.kt

+import androidx.compose.material.Checkbox
+import androidx.compose.material.CheckboxDefaults
+import androidx.compose.material.MaterialTheme
+import androidx.compose.material.Text


ThomazFB added 13 commits January 21, 2025 17:24

Define basic types for Customs form

4261971

Configure initial wiring between Customs form Fragment and ViewModel

980be5d

Configure initial wiring between Customs form Fragment and Composable…

44c8bbb

… screen

Add initial scaffold UI container for WooShippingCustomsFormScreen

f95987c

Introduce Add Missing Information button

acc3dee

Define Content Type spinner UI

189ffc7

Define Restriction Type spinner UI

3e34935

Define ITN text field UI

22bf207

Define return to sender labeled checkbox UI

93c3845

Add WooShippingCustomsFormScreen preview

0910d72

Define ViewState for WooShippingCustomsFormViewModel

05fdcce

Wire ViewModel ViewState with WooShippingCustomsFormScreen

a3bc057

Fix lint issues

c352421

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

ThomazFB added this to the 21.5 milestone Jan 22, 2025

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

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

Closed

Merge branch 'trunk' into issue/introduce-customs-section

b7dd6f8

ThomazFB added 9 commits January 24, 2025 16:45

Define and wire ViewModel onContentTypeClickEvent

23c74c7

Define and wire ViewModel onRestrictionTypeClickEvent

b050e62

Define and wire ViewModel onITNChanged

2bd1cb3

Define and wire ViewModel onReturnToSenderChanged

635c1cb

Declare ContentType options and selection into WooShippingCustomsForm…

e427470

…ViewModel

Declare RestrictionType options and selection into WooShippingCustoms…

718e3a7

…FormViewModel

Declare WooShippingCustomsFormFragment into nav_graph_orders.xml

7afcfd0

Add ViewModel event bus listening into WooShippingCustomsFormFragment

56c0fcd

Add Item Selector navigation handling

ccf53d8

Merge branch 'issue/add-initial-customs-entry-point' into issue/intro…

6bfa8df

…duce-customs-section

ThomazFB changed the base branch from trunk to issue/add-initial-customs-entry-point January 28, 2025 19:38

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

ThomazFB added 9 commits January 30, 2025 13:48

Merge branch 'issue/add-initial-customs-entry-point' into issue/intro…

ebda836

…duce-customs-section

Wire Customs click event with ViewModel

e2e53b5

Add route between Shipping Label Creation and Custom form

b87ecf2

Add missing Woo Theme to WooShippingCustomsFormScreen

c5bbfa5

Fix incorrect position for checkbox inside WooShippingCustomsFormScreen

1a22e76

Introduce initial test suite for WooShippingCustomsFormViewModelTest

255eb59

Adjust WooShippingCustomsFormViewModelTest test structure

5ef380b

Adopt assertThat usage instead of simple asserts

3839b19

Update event calls to also use the observeForever capture

eb675b7

Fix lint issues

3fb4558

ThomazFB marked this pull request as ready for review January 30, 2025 18:25

ThomazFB requested a review from atorresveiga January 30, 2025 18:25

atorresveiga self-assigned this Jan 31, 2025

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

Base automatically changed from issue/add-initial-customs-entry-point to trunk January 31, 2025 19:32

atorresveiga reviewed Jan 31, 2025

View reviewed changes

atorresveiga approved these changes Jan 31, 2025

View reviewed changes

Merge branch 'trunk' into issue/introduce-customs-section

bf4d4de

github-advanced-security bot found potential problems Feb 3, 2025

View reviewed changes

ThomazFB merged commit 8418862 into trunk Feb 3, 2025
15 checks passed

ThomazFB deleted the issue/introduce-customs-section branch February 3, 2025 20:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Shipping Labels Revamp] Introduce Customs initial form #13378

[Shipping Labels Revamp] Introduce Customs initial form #13378

ThomazFB commented Jan 22, 2025 •

edited

Loading

dangermattic commented Jan 22, 2025 •

edited

Loading

wpmobilebot commented Jan 22, 2025 •

edited

Loading

wpmobilebot commented Jan 22, 2025 •

edited

Loading

codecov-commenter commented Jan 30, 2025 •

edited

Loading

wpmobilebot commented Jan 31, 2025

atorresveiga Jan 31, 2025 •

edited

Loading

ThomazFB Feb 3, 2025

atorresveiga Jan 31, 2025

atorresveiga Jan 31, 2025

ThomazFB Feb 3, 2025

atorresveiga left a comment

ThomazFB commented Feb 3, 2025

[Shipping Labels Revamp] Introduce Customs initial form #13378

[Shipping Labels Revamp] Introduce Customs initial form #13378

Conversation

ThomazFB commented Jan 22, 2025 • edited Loading

Why

How

Screen Capture

How to Test

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

dangermattic commented Jan 22, 2025 • edited Loading

wpmobilebot commented Jan 22, 2025 • edited Loading

wpmobilebot commented Jan 22, 2025 • edited Loading

codecov-commenter commented Jan 30, 2025 • edited Loading

Codecov Report

wpmobilebot commented Jan 31, 2025

atorresveiga Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

ThomazFB Feb 3, 2025

Choose a reason for hiding this comment

atorresveiga Jan 31, 2025

Choose a reason for hiding this comment

atorresveiga Jan 31, 2025

Choose a reason for hiding this comment

ThomazFB Feb 3, 2025

Choose a reason for hiding this comment

atorresveiga left a comment

Choose a reason for hiding this comment

ThomazFB commented Feb 3, 2025

ThomazFB commented Jan 22, 2025 •

edited

Loading

dangermattic commented Jan 22, 2025 •

edited

Loading

wpmobilebot commented Jan 22, 2025 •

edited

Loading

wpmobilebot commented Jan 22, 2025 •

edited

Loading

codecov-commenter commented Jan 30, 2025 •

edited

Loading

atorresveiga Jan 31, 2025 •

edited

Loading