Update origin address errors #13612

atorresveiga · 2025-02-21T22:25:27Z

Part of: #12439

Description

This PR handles errors in the normalization/update address error flow. The errors will be displayed in a SnackBar with a retry action. Updating the address while an error is displayed will dismiss the SnackBar. This PR handles the normalization and address update errors. Navigation will be handled in the next PR, finishing with the update.

Testing information

TC1

Open the orders tab
Tap on an order eligible for shipping label creation
Expand the shipment details section
Expand the origin address selection (3 dots)
Tap on the pencil
Update the address with an invalid value
Tap on Validate & Save
Check that when the response fails, a SnackBar message is displayed informing about the error with a retry action
Check that the retry button retry the action
Check that updating the address dismisses the error message

TC2
Apply the following patch

Patch

Index: WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/NormalizeAddress.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/NormalizeAddress.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/NormalizeAddress.kt
--- a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/NormalizeAddress.kt	(revision 3c3054b603de22bc8fa3678a243afdba4ff32cbd)
+++ b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/NormalizeAddress.kt	(date 1740175623640)
@@ -4,6 +4,7 @@
 import com.woocommerce.android.tools.SelectedSite
 import com.woocommerce.android.ui.orders.wooshippinglabels.models.AddressNormalizationModel
 import com.woocommerce.android.ui.orders.wooshippinglabels.networking.WooShippingLabelRepository
+import kotlinx.coroutines.delay
 import javax.inject.Inject
 
 class NormalizeAddress @Inject constructor(
@@ -11,17 +12,7 @@
     private val site: SelectedSite,
 ) {
     suspend operator fun invoke(address: Address): Result<AddressNormalizationModel> {
-        return site.getOrNull()?.let {
-            val response = repository.normalizeAddress(it, address)
-            val result = response.model
-            when {
-                response.isError || result == null -> {
-                    val message =
-                        response.error.message ?: if (result == null) "Empty response" else "Unknown error"
-                    Result.failure(Exception(message))
-                }
-                else -> Result.success(result)
-            }
-        } ?: Result.failure(Exception("No site selected"))
+        delay(400)
+        return Result.failure(Exception("No site selected"))
     }
 }

Open the orders tab
Tap on an order eligible for shipping label creation
Expand the shipment details section
Expand the origin address selection (3 dots)
Tap on the pencil
Update the address
Tap on Validate & Save
Check that when the response fails, a SnackBar message is displayed informing about the error with a retry action
Check that the retry button retry the action
Check that updating the address dismisses the error message

TC3
Apply the following patch

Patch

Index: WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt
--- a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt	(revision 3c3054b603de22bc8fa3678a243afdba4ff32cbd)
+++ b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt	(date 1740176147292)
@@ -5,6 +5,7 @@
 import com.woocommerce.android.ui.orders.wooshippinglabels.models.OriginShippingAddress
 import com.woocommerce.android.ui.orders.wooshippinglabels.networking.WooShippingLabelRepository
 import com.woocommerce.android.util.CoroutineDispatchers
+import kotlinx.coroutines.delay
 import kotlinx.coroutines.withContext
 import javax.inject.Inject
 
@@ -17,21 +18,7 @@
         address: Address,
         addressId: String?
     ): Result<OriginShippingAddress> {
-        return withContext(coroutineDispatchers.io) {
-            selectedSite.getOrNull()?.let {
-                val response = shippingRepository.updateOriginAddress(it, address, addressId)
-                val result = response.model
-                when {
-                    response.isError || result == null -> {
-                        val message =
-                            response.error.message
-                                ?: if (result == null) "Empty response" else "Unknown error"
-                        Result.failure(Exception(message))
-                    }
-
-                    else -> Result.success(result)
-                }
-            } ?: Result.failure(Exception("No site selected"))
-        }
+        delay(400)
+        return Result.failure(Exception("Not implemented"))
     }
 }

Open the orders tab
Tap on an order eligible for shipping label creation
Expand the shipment details section
Expand the origin address selection (3 dots)
Tap on the pencil
Update the address
Tap on Validate & Save
Tap on confirm changes
Check that when the response fails, a SnackBar message is displayed informing about the error with a retry action
Check that the retry button retry the action
Check that selecting another address dismisses the error message

TC4
Apply the following patch

Patch

Index: WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt
--- a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt	(revision 3c3054b603de22bc8fa3678a243afdba4ff32cbd)
+++ b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/address/origin/UpdateOriginAddress.kt	(date 1740176147292)
@@ -5,6 +5,7 @@
 import com.woocommerce.android.ui.orders.wooshippinglabels.models.OriginShippingAddress
 import com.woocommerce.android.ui.orders.wooshippinglabels.networking.WooShippingLabelRepository
 import com.woocommerce.android.util.CoroutineDispatchers
+import kotlinx.coroutines.delay
 import kotlinx.coroutines.withContext
 import javax.inject.Inject
 
@@ -17,21 +18,7 @@
         address: Address,
         addressId: String?
     ): Result<OriginShippingAddress> {
-        return withContext(coroutineDispatchers.io) {
-            selectedSite.getOrNull()?.let {
-                val response = shippingRepository.updateOriginAddress(it, address, addressId)
-                val result = response.model
-                when {
-                    response.isError || result == null -> {
-                        val message =
-                            response.error.message
-                                ?: if (result == null) "Empty response" else "Unknown error"
-                        Result.failure(Exception(message))
-                    }
-
-                    else -> Result.success(result)
-                }
-            } ?: Result.failure(Exception("No site selected"))
-        }
+        delay(400)
+        return Result.failure(Exception("Not implemented"))
     }
 }

Open the orders tab
Tap on an order eligible for shipping label creation
Expand the shipment details section
Expand the origin address selection (3 dots)
Tap on the pencil
Update the name field
Tap on Save changes
Check that when the response fails, a SnackBar message is displayed informing about the error with a retry action
Check that the retry button retry the action
Check that updating the address dismisses the error message

The tests that have been performed

Images/gif

Screen_recording_20250221_161755.mp4

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.

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.

…ate-origin-address-errors

dangermattic · 2025-02-21T22:26:15Z

	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-02-21T22:30:35Z

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

wpmobilebot · 2025-02-21T22:43:51Z

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

atorresveiga · 2025-02-21T22:44:18Z

.../com/woocommerce/android/ui/orders/wooshippinglabels/address/WooShippingEditAddressScreen.kt

+            }
+        )
+
+        if (error != null) {


SnackBars are not displayed on top of a BottomSheetDialog, I needed to define a new SnackBar on top of the BottomSheetDialog

.../com/woocommerce/android/ui/orders/wooshippinglabels/address/WooShippingEditAddressScreen.kt

@@ -27,16 +31,20 @@
 import androidx.compose.foundation.text.KeyboardActions
 import androidx.compose.foundation.text.KeyboardOptions
 import androidx.compose.foundation.verticalScroll
+import androidx.compose.material.ButtonDefaults


.../com/woocommerce/android/ui/orders/wooshippinglabels/address/WooShippingEditAddressScreen.kt

 import androidx.compose.material.CircularProgressIndicator
 import androidx.compose.material.Icon
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Scaffold
+import androidx.compose.material.Snackbar


.../com/woocommerce/android/ui/orders/wooshippinglabels/address/WooShippingEditAddressScreen.kt

 import androidx.compose.material.SnackbarDuration
 import androidx.compose.material.SnackbarHost
 import androidx.compose.material.SnackbarHostState
 import androidx.compose.material.SnackbarResult
 import androidx.compose.material.Surface
 import androidx.compose.material.Text
+import androidx.compose.material.TextButton


ThomazFB

Working as described! Looks good

Alejo added 9 commits February 21, 2025 09:26

add errors string resources

fd50b1d

new class to represent errors

ae5dd30

refactor error state and loading state to a private function

e443d7e

add current selection inside the error class for retry with same data

e0e1016

move update state outside the coroutine

ddc7c3e

display errors in a snack bar with retry action

c6fb42a

fix unit tests

d33666b

Merge branch 'issue/12439-update-origin-address' into issue/12439-upd…

ac1d19c

…ate-origin-address-errors

fail when success is not true

3c3054b

atorresveiga added type: task An internally driven task. feature: shipping labels Related to creating, ordering, or printing shipping labels. labels Feb 21, 2025

atorresveiga added this to the 21.9 milestone Feb 21, 2025

atorresveiga requested a review from ThomazFB February 21, 2025 22:25

atorresveiga mentioned this pull request Feb 21, 2025

Update origin address #13594

Merged

4 tasks

Base automatically changed from issue/12439-update-origin-address to trunk February 21, 2025 22:32

atorresveiga commented Feb 21, 2025

View reviewed changes

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

View reviewed changes

atorresveiga and others added 2 commits February 21, 2025 17:15

Merge branch 'trunk' into issue/12439-update-origin-address-errors

40f508f

fix detekt warnings

1e8817c

ThomazFB self-assigned this Feb 25, 2025

ThomazFB approved these changes Feb 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update origin address errors #13612

Update origin address errors #13612

atorresveiga commented Feb 21, 2025 •

edited

Loading

dangermattic commented Feb 21, 2025

wpmobilebot commented Feb 21, 2025 •

edited

Loading

wpmobilebot commented Feb 21, 2025 •

edited

Loading

atorresveiga Feb 21, 2025

ThomazFB left a comment

Update origin address errors #13612

Are you sure you want to change the base?

Update origin address errors #13612

Conversation

atorresveiga commented Feb 21, 2025 • edited Loading

Description

Testing information

The tests that have been performed

Images/gif

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

dangermattic commented Feb 21, 2025

wpmobilebot commented Feb 21, 2025 • edited Loading

wpmobilebot commented Feb 21, 2025 • edited Loading

atorresveiga Feb 21, 2025

Choose a reason for hiding this comment

ThomazFB left a comment

Choose a reason for hiding this comment

atorresveiga commented Feb 21, 2025 •

edited

Loading

wpmobilebot commented Feb 21, 2025 •

edited

Loading

wpmobilebot commented Feb 21, 2025 •

edited

Loading