[Shipping Labels] Show custom error when no label rates available (#15322)

Author: selanthiraiyan

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShipping Package and Rate Selection/WooShippingServiceView.swift

@@ -33,7 +33,13 @@ struct WooShippingServiceView: View {
                     MissingDataStateView(title: Localization.noWeightTitle,
                                          message: Localization.noWeightMessage)
                 case WooShippingServiceViewModel.Error.failedLoadingLabelRates:
-                    errorState
+                    ErrorState(message: Localization.failedLoadingDataError) {
+                        if let package = viewModel.selectedPackage {
+                            viewModel.loadLabelRates(for: package)
+                        }
+                    }
+                case .noRatesAvailable:
+                    ErrorState(message: Localization.noRatesAvailable)
                 }
             }
         }
@@ -78,35 +84,49 @@ struct WooShippingServiceView: View {
         .padding(.horizontal, Layout.padding * -1) // Offset the additional padding in TopTabView
     }
 
-    var errorState: some View {
-        VStack(spacing: Layout.padding) {
+    var progressView: some View {
+        VStack(spacing: Layout.placeholderPadding) {
+            Image(uiImage: .wooShippingRatesPlaceholder)
+
+            ProgressView()
+                .progressViewStyle(.circular)
+        }
+        .frame(maxWidth: .infinity, alignment: .center)
+        .padding(Layout.placeholderPadding)
+        .roundedBorder(cornerRadius: 8, lineColor: Color(.border), lineWidth: 1, dashed: true)
+        .padding(.vertical, Layout.padding)
+    }
+}
+
+private struct ErrorState: View {
+    let message: String
+    let retryAction: (() -> Void)?
+
+    init(message: String, retryAction: (() -> Void)? = nil) {
+        self.message = message
+        self.retryAction = retryAction
+    }
+
+    var body: some View {
+        VStack(spacing: WooShippingServiceView.Layout.padding) {
             Image(uiImage: .grayErrorIcon)
                 .resizable()
                 .aspectRatio(contentMode: .fit)
                 .frame(width: Layout.errorIconSize, height: Layout.errorIconSize)
-            Text(Localization.failedLoadingDataError)
+            Text(message)
                 .multilineTextAlignment(.center)
-            Button(Localization.retryCTA) {
-                if let package = viewModel.selectedPackage {
-                    viewModel.loadLabelRates(for: package)
+            if let retryAction {
+                Button(WooShippingServiceView.Localization.retryCTA) {
+                    retryAction()
                 }
             }
         }
         .frame(maxWidth: .infinity, alignment: .center)
         .padding(WooShippingServiceView.Layout.placeholderPadding)
     }
 
-    var progressView: some View {
-        VStack(spacing: Layout.placeholderPadding) {
-            Image(uiImage: .wooShippingRatesPlaceholder)
-
-            ProgressView()
-                .progressViewStyle(.circular)
-        }
-        .frame(maxWidth: .infinity, alignment: .center)
-        .padding(Layout.placeholderPadding)
-        .roundedBorder(cornerRadius: 8, lineColor: Color(.border), lineWidth: 1, dashed: true)
-        .padding(.vertical, Layout.padding)
+    enum Layout {
+        static let errorIconSize: CGFloat = 86
     }
 }
 
@@ -153,7 +173,6 @@ fileprivate extension WooShippingServiceView {
         static let padding: CGFloat = 16
         static let innerSpacing: CGFloat = 8
         static let placeholderPadding: CGFloat = 32
-        static let errorIconSize: CGFloat = 86
     }
 }
 
@@ -187,6 +206,11 @@ private extension WooShippingServiceView {
                                                               value: "We are unable to load shipping rates",
                                                               comment: "Error message when loading shipping label rates "
                                                               + "failed on the shipping label creation screen")
+        static let noRatesAvailable = NSLocalizedString("wooShipping.createLabels.rates.noRatesAvailable",
+                                                        value: "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.",
+                                                        comment: "Error message when no shipping rates were found "
+                                                        + "based on the combination of the selected package and the total shipment weight.")
         static let retryCTA = NSLocalizedString("wooShipping.createLabels.rates.retryCTA",
                                                 value: "Retry",
                                                 comment: "Button to retry loading data on the shipping label creation screen")

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShipping Package and Rate Selection/WooShippingServiceViewModel.swift

@@ -94,11 +94,13 @@ final class WooShippingServiceViewModel: ObservableObject {
 
             switch result {
             case let .success(rates):
-                guard let rates = rates.first(where: { $0.packageID == selectedPackage.id }) else {
+                guard let rates = rates.first(where: { $0.packageID == selectedPackage.id }),
+                      rates.defaultRates.isNotEmpty else {
                     DDLogError("⛔️ Fetched shipping label rates for Woo Shipping do not include rates for selected package: \(selectedPackage)")
-                    updateLoadingState(to: .error(Error.failedLoadingLabelRates))
+                    updateLoadingState(to: .error(Error.noRatesAvailable))
                     return
                 }
+
                 standardRates = rates.defaultRates
                 signatureRates = rates.signatureRequired
                 adultSignatureRates = rates.adultSignatureRequired
@@ -146,6 +148,7 @@ extension WooShippingServiceViewModel {
         case missingDestinationAddress
         case missingShipmentWeight
         case failedLoadingLabelRates
+        case noRatesAvailable
     }
 }
 

WooCommerce/WooCommerceTests/ViewRelated/Shipping Label/WooShipping Create Shipping Labels/WooShippingServiceViewModelTests.swift

@@ -261,6 +261,33 @@ final class WooShippingServiceViewModelTests: XCTestCase {
         // Then
         XCTAssertEqual(viewModel.loadingState, .error(.missingShipmentWeight))
     }
+
+    func test_when_loadLabelRates_receives_empty_rates_it_sets_error_state() {
+        // Given
+        let stores = MockStoresManager(sessionManager: .testingInstance)
+        let emptyRates = [ShippingLabelCarriersAndRates(packageID: Self.samplePackageID,
+                                                        defaultRates: [],
+                                                        signatureRequired: [],
+                                                        adultSignatureRequired: [])]
+        stores.whenReceivingAction(ofType: WooShippingAction.self) { action in
+            switch action {
+            case let .loadLabelRates(_, _, _, _, packages, completion):
+                completion(packages, .success(emptyRates))
+            default:
+                XCTFail("Received unexpected action: \(action)")
+            }
+        }
+        let viewModel = WooShippingServiceViewModel(order: Order.fake(),
+                                                    originAddress: WooShippingAddress.fake(),
+                                                    destinationAddress: sampleDestinationAddress(),
+                                                    stores: stores)
+
+        // When
+        viewModel.loadLabelRates(for: samplePackage)
+
+        // Then
+        XCTAssertEqual(viewModel.loadingState, .error(.noRatesAvailable))
+    }
 }
 
 private extension WooShippingServiceViewModelTests {