[Shipping Labels Revamp] Introduce hazmat initial navigation and screen #13784

ThomazFB · 2025-03-17T22:58:58Z

Why

Fixes issue #13706. As the Shipping Labels must support the HAZMAT declarations, we should implement a proper flow for the pending Hazardous Materials question standing the main form that's currently a no-op.

How

This PR introduces the initial Hazmat base form with the Composable Screen, ViewModel, and Fragment, while also wires the navigation action of the HAZMAT button in the main creation flow.

⚠️ The complete elements of the form with the clickable links and following navigation action will be introduced in an upcoming PR.

Screen Capture

Screen_recording_20250318_202921.mp4

How to Test

Open an order that allows a Shipping Labels creation
Hit the HAZMAT question in the main creation form
Verify that the Hazmat form opens successfully
Verify that hitting the checkbox for the HAZMAT question enables the Select Category button

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.

…t form fragment

…odel

wpmobilebot · 2025-03-17T23:04:18Z

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

wpmobilebot · 2025-03-17T23:17:17Z

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

…matFormScreen.kt

...woocommerce/android/ui/orders/wooshippinglabels/hazmat/WooShippingLabelHazmatFormFragment.kt

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


codecov-commenter · 2025-03-18T23:52:15Z

Codecov Report

Attention: Patch coverage is 78.94737% with 4 lines in your changes missing coverage. Please review.

Project coverage is 38.11%. Comparing base (e80e478) to head (e4e5012).

Files with missing lines	Patch %	Lines
...hippinglabels/WooShippingLabelCreationViewModel.kt	0.00%	3 Missing ⚠️
...bels/hazmat/WooShippingLabelHazmatFormViewModel.kt	93.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##              trunk   #13784   +/-   ##
=========================================
  Coverage     38.10%   38.11%           
- Complexity     9256     9260    +4     
=========================================
  Files          2079     2080    +1     
  Lines        114560   114579   +19     
  Branches      14593    14593           
=========================================
+ Hits          43657    43672   +15     
- Misses        66936    66940    +4     
  Partials       3967     3967

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

wpmobilebot · 2025-03-21T10:20:23Z

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

irfano

Thanks for dividing this feature into multiple PRs. I’ve added some comments on the code and noticed two issues:

The screen isn't readable in dark mode.

The screen needs to be scrollable. With the increased font size, some text isn’t readable. This issue will become more noticeable as additional footer text is added.

irfano · 2025-03-21T14:19:44Z

...m/woocommerce/android/ui/orders/wooshippinglabels/hazmat/WooShippingLabelHazmatFormScreen.kt

+fun WooShippingLabelHazmatFormScreen(viewModel: WooShippingLabelHazmatFormViewModel) {
+    val viewState by viewModel.viewState.observeAsState()
+    WooShippingLabelHazmatFormScreen(
+        containsHazmatChecked = viewState?.containsHazmatChecked ?: false,


Equality check can be used instead of elvis for nullable boolean check

The IDE displays this warning, and I agree that using == true is better than perming a null check. Please consider updating it.

irfano · 2025-03-21T14:34:24Z

...mmerce/android/ui/orders/wooshippinglabels/hazmat/WooShippingLabelHazmatFormViewModelTest.kt

+        viewModel.onSelectCategoryClick()
+
+        // Then
+        assertThat(capturedEvent).isNotNull()


I think the line checking isNotNull() is redundant since the next line already verifies that capturedEvent is not null.

…tFormScreen

…odelTest

ThomazFB · 2025-03-25T00:03:47Z

Hey @irfano! Thanks for your careful review. I addressed all of your suggestions and the PR is ready for a second round.

irfano

Thanks for the changes, Thomaz. Looks great. 👍🏻

ThomazFB added 13 commits March 17, 2025 19:17

Add Hazmat notice click event UI wiring

b846032

Define Hazmat Form click event and call function

35232fb

Declare WooShippingLabelHazmatFormFragment with compose scaffold

0933a9f

Define navigation route between the Label Creation fragment and Hazma…

502efb0

…t form fragment

Define WooShippingLabelHazmatFormScreen.kt

4dec8f1

Define WooShippingLabelHazmatFormScreen main UI elements and behaviors

f6d7edc

Define WooShippingLabelHazmatFormViewModel with initial ViewState

95f80b1

Add ViewModel main interface with the Composable UI

fab3fcd

Wire the Hazmat full call path between Fragment, Composable and ViewM…

047a928

…odel

Add proper event trigger for the onSelectCategoryClick function call

97738e4

Fix missing injection into WooShippingLabelHazmatFormViewModel

1662e7e

Introduce WooShippingLabelHazmatFormViewModelTest coverage

e812c34

Fix lint issues

d3f1866

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

This was linked to issues Mar 17, 2025

[Hazmat] Initial purchase screen #13706

Closed

[Hazmat] Hazmat sheet #13707

Closed

ThomazFB added 5 commits March 18, 2025 18:25

Add Preview to WooShippingLabelHazmatFormScreen

0a0373e

Declare and assign proper string resources to the WooShippingLabelHaz…

9b6bfe2

…matFormScreen.kt

Add proper spacing to the WooShippingLabelHazmatFormScreen

2770463

Add missing Hazmat click event wiring

1c7780a

Move away from Material3 surface for now

cb73765

ThomazFB removed a link to an issue Mar 18, 2025

[Hazmat] Hazmat sheet #13707

Closed

ThomazFB marked this pull request as ready for review March 18, 2025 23:36

ThomazFB added this to the 22.0 milestone Mar 18, 2025

ThomazFB requested review from irfano and atorresveiga March 18, 2025 23:36

github-advanced-security bot found potential problems Mar 18, 2025

View reviewed changes

wpmobilebot modified the milestones: 22.0, 22.1 Mar 21, 2025

irfano self-assigned this Mar 21, 2025

irfano requested changes Mar 21, 2025

View reviewed changes

ThomazFB force-pushed the issue/introduce-hazmat-initial-navigation branch from 48d9240 to cb73765 Compare March 24, 2025 23:13

ThomazFB added 5 commits March 24, 2025 20:16

Add Dark mode support and vertical scrolling to WooShippingLabelHazma…

2d3ecf6

…tFormScreen

Remove redundant isNotNull check from WooShippingLabelHazmatFormViewM…

385d7d3

…odelTest

Update onSurface color for WooShippingLabelHazmatFormScreen texts

0344978

Merge branch 'trunk' into issue/introduce-hazmat-initial-navigation

02d4beb

Fix WooShippingLabelHazmatFormScreen checkbox color

e4e5012

irfano approved these changes Mar 25, 2025

View reviewed changes

irfano merged commit 5ed2824 into trunk Mar 25, 2025
17 checks passed

irfano deleted the issue/introduce-hazmat-initial-navigation branch March 25, 2025 22:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Shipping Labels Revamp] Introduce hazmat initial navigation and screen #13784

[Shipping Labels Revamp] Introduce hazmat initial navigation and screen #13784

ThomazFB commented Mar 17, 2025 •

edited by irfano

Loading

wpmobilebot commented Mar 17, 2025 •

edited

Loading

wpmobilebot commented Mar 17, 2025 •

edited

Loading

codecov-commenter commented Mar 18, 2025 •

edited

Loading

wpmobilebot commented Mar 21, 2025

irfano left a comment •

edited

Loading

irfano Mar 21, 2025

irfano Mar 21, 2025 •

edited

Loading

ThomazFB commented Mar 25, 2025

irfano left a comment

[Shipping Labels Revamp] Introduce hazmat initial navigation and screen #13784

[Shipping Labels Revamp] Introduce hazmat initial navigation and screen #13784

Conversation

ThomazFB commented Mar 17, 2025 • edited by irfano Loading

Why

How

Screen Capture

How to Test

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

wpmobilebot commented Mar 17, 2025 • edited Loading

wpmobilebot commented Mar 17, 2025 • edited Loading

codecov-commenter commented Mar 18, 2025 • edited Loading

Codecov Report

wpmobilebot commented Mar 21, 2025

irfano left a comment • edited Loading

Choose a reason for hiding this comment

irfano Mar 21, 2025

Choose a reason for hiding this comment

irfano Mar 21, 2025 • edited Loading

Choose a reason for hiding this comment

ThomazFB commented Mar 25, 2025

irfano left a comment

Choose a reason for hiding this comment

ThomazFB commented Mar 17, 2025 •

edited by irfano

Loading

wpmobilebot commented Mar 17, 2025 •

edited

Loading

wpmobilebot commented Mar 17, 2025 •

edited

Loading

codecov-commenter commented Mar 18, 2025 •

edited

Loading

irfano left a comment •

edited

Loading

irfano Mar 21, 2025 •

edited

Loading