[Shipping labels] Improve the error message for empty shipping rates list

RELEASE-NOTES.txt

@@ -11,6 +11,7 @@
 - [*] Shipping Labels: Fix layout issue with address status indicator [https://github.com/woocommerce/woocommerce-android/pull/14437]
 - [*] Shipping Labels: Updated shipments tab layout [https://github.com/woocommerce/woocommerce-android/pull/14448]
 - [*] Shipping Labels: Add a message for purchased shipments to the Split Shipments screen [https://github.com/woocommerce/woocommerce-android/pull/14455]
+- [*] Shipping Labels: Improved the error message for empty shipping rates list [https://github.com/woocommerce/woocommerce-android/pull/14433]
 
 23.0
 -----

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/WooShippingLabelCreationViewModel.kt

@@ -65,6 +65,7 @@ import com.woocommerce.android.ui.orders.wooshippinglabels.purchased.ObserveShip
 import com.woocommerce.android.ui.orders.wooshippinglabels.purchased.printing.FetchShippingLabelFile
 import com.woocommerce.android.ui.orders.wooshippinglabels.rates.datasource.WooShippingRateModel
 import com.woocommerce.android.ui.orders.wooshippinglabels.rates.domain.GetShippingRates
+import com.woocommerce.android.ui.orders.wooshippinglabels.rates.domain.NoAvailableRatesException
 import com.woocommerce.android.ui.orders.wooshippinglabels.rates.ui.CarrierUI
 import com.woocommerce.android.ui.orders.wooshippinglabels.rates.ui.ShippingRateOption
 import com.woocommerce.android.ui.orders.wooshippinglabels.rates.ui.ShippingRateUI
@@ -636,7 +637,13 @@ class WooShippingLabelCreationViewModel @Inject constructor(
                         trackShippingRatesLoading(isSuccess = true)
                     },
                     onFailure = { exception ->
-                        updateState(ShippingRatesState.Error)
+                        val errorMessage = if (exception is NoAvailableRatesException) {
+                            exception.messageResId
+                        } else {
+                            R.string.woo_shipping_labels_package_creation_shipping_rates_loading_error
+                        }
+
+                        updateState(ShippingRatesState.Error(errorMessage))
                         trackShippingRatesLoading(isSuccess = false, error = exception.message)
                     }
                 )
@@ -1231,7 +1238,7 @@ class WooShippingLabelCreationViewModel @Inject constructor(
             val missingDescription: Int
         ) : ShippingRatesState()
 
-        data object Error : ShippingRatesState()
+        data class Error(@StringRes val message: Int) : ShippingRatesState()
 
         data class Loading(
             val selectedRatesSortOrder: ShippingSortOption

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/packages/components/ErrorMessageWithButton.kt

@@ -6,6 +6,7 @@ import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.layout.size
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Text
@@ -30,7 +31,8 @@ fun ErrorMessageWithButton(
     Column(
         modifier = modifier
             .fillMaxSize()
-            .background(MaterialTheme.colors.surface),
+            .background(MaterialTheme.colors.surface)
+            .padding(16.dp),
         horizontalAlignment = Alignment.CenterHorizontally,
         verticalArrangement = Arrangement.spacedBy(24.dp, Alignment.CenterVertically)
     ) {

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/rates/domain/GetShippingRates.kt

@@ -1,5 +1,7 @@
 package com.woocommerce.android.ui.orders.wooshippinglabels.rates.domain
 
+import androidx.annotation.StringRes
+import com.woocommerce.android.R
 import com.woocommerce.android.model.Address
 import com.woocommerce.android.ui.orders.shippinglabels.creation.ShippingLabelHazmatCategory
 import com.woocommerce.android.ui.orders.wooshippinglabels.customs.CustomsData
@@ -36,7 +38,13 @@ class GetShippingRates @Inject constructor(
     ).fold(
         onSuccess = { ratesResponse ->
             if (ratesResponse.isEmpty()) {
-                Result.failure(Exception("no_rates_available"))
+                val message = if (hazmatSelection == null) {
+                    R.string.woo_shipping_labels_package_creation_shipping_rates_empty
+                } else {
+                    R.string.woo_shipping_labels_package_creation_shipping_rates_empty_with_hazmat
+                }
+
+                Result.failure(NoAvailableRatesException(message))
             } else {
                 try {
                     val mappedRates = shippingMapper(ratesResponse, currencyCode)
@@ -51,3 +59,5 @@ class GetShippingRates @Inject constructor(
         }
     )
 }
+
+class NoAvailableRatesException(@StringRes val messageResId: Int) : Exception("No available rates")

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/rates/ui/ShippingRatesSection.kt

@@ -6,7 +6,6 @@ import androidx.compose.foundation.layout.sizeIn
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
-import com.woocommerce.android.R
 import com.woocommerce.android.ui.orders.wooshippinglabels.WooShippingLabelCreationViewModel
 import com.woocommerce.android.ui.orders.wooshippinglabels.packages.components.ErrorMessageWithButton
 
@@ -32,8 +31,8 @@ internal fun ShippingRatesSection(
             )
         }
 
-        WooShippingLabelCreationViewModel.ShippingRatesState.Error -> ErrorMessageWithButton(
-            message = R.string.woo_shipping_labels_package_creation_shipping_rates_loading_error,
+        is WooShippingLabelCreationViewModel.ShippingRatesState.Error -> ErrorMessageWithButton(
+            message = shippingRatesState.message,
             modifier = Modifier.sizeIn(minHeight = 300.dp),
             onRetryClick = { onRefreshShippingRates() }
         )

WooCommerce/src/main/res/values/strings.xml

@@ -4626,6 +4626,8 @@
     <string name="woo_shipping_labels_package_creation_carrier_loading_error">We are unable to load carrier packages.</string>
     <string name="woo_shipping_labels_package_creation_saved_loading_error">We are unable to load saved packages.</string>
     <string name="woo_shipping_labels_package_creation_shipping_rates_loading_error">We are unable to load shipping rates.</string>
+    <string name="woo_shipping_labels_package_creation_shipping_rates_empty">We couldn\'t find a shipping service for the combination of the selected package and the total shipment weight. Please adjust your input and try again.</string>
+    <string name="woo_shipping_labels_package_creation_shipping_rates_empty_with_hazmat">We couldn\'t find a shipping service for the combination of the selected HAZMAT category, the selected package and the total shipment weight. Please adjust your input and try again.</string>
     <string name="woo_shipping_labels_package_creation_starred">Star this item</string>
     <string name="woo_shipping_labels_package_creation_unstarred">Unstar this item</string>
     <string name="woo_shipping_labels_shipping_rates_missing_destination">Add a destination address to get shipping rates</string>

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/orders/wooshippinglabels/rates/domain/GetShippingRatesTest.kt

@@ -130,5 +130,6 @@ class GetShippingRatesTest : BaseUnitTest() {
         )
 
         assertTrue(result.isFailure)
+        assertTrue(result.exceptionOrNull() is NoAvailableRatesException)
     }
 }