Merge pull request #4964 from woocommerce/issue/4745-error-handling

Shipping Labels: Display error when package creation fails

Author: rachelmcr

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Package Selection/Package Creation/PackageCreationError+UI.swift

@@ -0,0 +1,29 @@
+import Yosemite
+
+extension PackageCreationError {
+    var alertTitle: String {
+        switch self {
+        case .duplicatePackageNames, .duplicateNamesByCarrier, .duplicateCustomPackageNames, .duplicatePredefinedPackageNames:
+            return NSLocalizedString("Invalid Package Name",
+                                     comment: "The title of the alert when there is an error with the package name")
+        case .unknown:
+            return NSLocalizedString("Cannot add package",
+                                     comment: "The title of the alert when there is a generic error adding the package")
+        }
+    }
+}
+
+extension PackageCreationError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .duplicatePackageNames, .duplicateCustomPackageNames:
+            return NSLocalizedString("The new custom package name is not unique.",
+                                     comment: "The message of the alert when another custom package has the same name")
+        case .duplicateNamesByCarrier, .duplicatePredefinedPackageNames:
+            return NSLocalizedString("The new service package name is not unique.",
+                                     comment: "The message of the alert when another service package has the same name")
+        case .unknown:
+            return NSLocalizedString("Unexpected error", comment: "The message of the alert when there is an unexpected error adding the package")
+        }
+    }
+}

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Package Selection/Package Creation/ShippingLabelAddNewPackage.swift

@@ -4,7 +4,8 @@ import Yosemite
 struct ShippingLabelAddNewPackage: View {
     @ObservedObject var viewModel: ShippingLabelAddNewPackageViewModel
     @Environment(\.presentationMode) var presentation
-    @State var isSyncing = false
+    @State private var isSyncing = false
+    @State private var showingAddPackageError = false
 
     var body: some View {
         GeometryReader { geometry in
@@ -49,14 +50,20 @@ struct ShippingLabelAddNewPackage: View {
                             isSyncing = true
                             viewModel.createCustomPackage() { success in
                                 isSyncing = false
-                                guard success else { return }
+                                guard success else {
+                                    showingAddPackageError = true
+                                    return
+                                }
                                 presentation.wrappedValue.dismiss()
                             }
                         case .servicePackage:
                             isSyncing = true
                             viewModel.activateServicePackage() { success in
                                 isSyncing = false
-                                guard success else { return }
+                                guard success else {
+                                    showingAddPackageError = true
+                                    return
+                                }
                                 presentation.wrappedValue.dismiss()
                             }
                         }
@@ -69,6 +76,11 @@ struct ShippingLabelAddNewPackage: View {
                         }
                     })
                     .disabled(isSyncing)
+                    .alert(isPresented: $showingAddPackageError, content: {
+                        let title = viewModel.error?.alertTitle ?? Localization.errorAlertTitle
+                        let message = viewModel.error?.errorDescription ?? Localization.errorAlertMessage
+                        return Alert(title: Text(title), message: Text(message))
+                    })
                 })
             }
         }
@@ -81,6 +93,9 @@ private extension ShippingLabelAddNewPackage {
         static let customPackage = NSLocalizedString("Custom Package", comment: "Custom Package menu in Shipping Label Add New Package flow")
         static let servicePackage = NSLocalizedString("Service Package", comment: "Service Package menu in Shipping Label Add New Package flow")
         static let doneButton = NSLocalizedString("Done", comment: "Done navigation button in the Add New Package screen in Shipping Label flow")
+        static let errorAlertTitle = NSLocalizedString("Cannot add package", comment: "The title of the alert when there is a generic error adding the package")
+        static let errorAlertMessage = NSLocalizedString("Unexpected error",
+                                                         comment: "The message of the alert when there is an unexpected error adding the package")
     }
 }
 

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Package Selection/Package Creation/ShippingLabelAddNewPackageViewModel.swift

@@ -38,6 +38,10 @@ final class ShippingLabelAddNewPackageViewModel: ObservableObject {
     ///
     private var packagesResponse: ShippingLabelPackagesResponse?
 
+    /// Error if package creation fails
+    ///
+    private(set) var error: PackageCreationError?
+
     /// Completion callback
     ///
     typealias Completion = (_ customPackage: ShippingLabelCustomPackage? ,
@@ -135,6 +139,7 @@ private extension ShippingLabelAddNewPackageViewModel {
                     onCompletion?(success)
                 }
             case .failure(let error):
+                self.error = error
                 DDLogError("⛔️ Error creating package: \(error.localizedDescription)")
                 onCompletion?(false)
             }

WooCommerce/WooCommerce.xcodeproj/project.pbxproj

@@ -972,6 +972,7 @@
 		CC4D1D8625E6CDDE00B6E4E7 /* RenameAttributesViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC4D1D8525E6CDDE00B6E4E7 /* RenameAttributesViewModel.swift */; };
 		CC4D1E7925EE415D00B6E4E7 /* RenameAttributesViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC4D1E7825EE415D00B6E4E7 /* RenameAttributesViewModelTests.swift */; };
 		CC593A6726EA116300EF0E04 /* ShippingLabelAddNewPackageViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC593A6626EA116300EF0E04 /* ShippingLabelAddNewPackageViewModelTests.swift */; };
+		CC593A6B26EA640800EF0E04 /* PackageCreationError+UI.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC593A6A26EA640800EF0E04 /* PackageCreationError+UI.swift */; };
 		CC69236226010946002FB669 /* LoginProloguePages.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC69236126010946002FB669 /* LoginProloguePages.swift */; };
 		CC6923AC26010D8D002FB669 /* LoginProloguePageViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC6923AB26010D8D002FB669 /* LoginProloguePageViewController.swift */; };
 		CC8413E423F5C48E00EFC277 /* stop.sh in Resources */ = {isa = PBXBuildFile; fileRef = CCFC011123E9E40B00157A78 /* stop.sh */; };
@@ -2404,6 +2405,7 @@
 		CC4D1D8525E6CDDE00B6E4E7 /* RenameAttributesViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RenameAttributesViewModel.swift; sourceTree = "<group>"; };
 		CC4D1E7825EE415D00B6E4E7 /* RenameAttributesViewModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RenameAttributesViewModelTests.swift; sourceTree = "<group>"; };
 		CC593A6626EA116300EF0E04 /* ShippingLabelAddNewPackageViewModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShippingLabelAddNewPackageViewModelTests.swift; sourceTree = "<group>"; };
+		CC593A6A26EA640800EF0E04 /* PackageCreationError+UI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "PackageCreationError+UI.swift"; sourceTree = "<group>"; };
 		CC69236126010946002FB669 /* LoginProloguePages.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginProloguePages.swift; sourceTree = "<group>"; };
 		CC6923AB26010D8D002FB669 /* LoginProloguePageViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginProloguePageViewController.swift; sourceTree = "<group>"; };
 		CCCC29DC25E5757C0046B96F /* RenameAttributesViewController.xib */ = {isa = PBXFileReference; lastKnownFileType = file.xib; path = RenameAttributesViewController.xib; sourceTree = "<group>"; };
@@ -5374,6 +5376,7 @@
 				CC254F3726C43B52005F3C82 /* ShippingLabelCustomPackageFormViewModel.swift */,
 				CCD2F51926D67BB50010E679 /* ShippingLabelServicePackageList.swift */,
 				CCD2F51B26D697860010E679 /* ShippingLabelServicePackageListViewModel.swift */,
+				CC593A6A26EA640800EF0E04 /* PackageCreationError+UI.swift */,
 			);
 			path = "Package Creation";
 			sourceTree = "<group>";
@@ -7779,6 +7782,7 @@
 				CC69236226010946002FB669 /* LoginProloguePages.swift in Sources */,
 				D817586422BDD81600289CFE /* OrderDetailsDataSource.swift in Sources */,
 				D8B4D5EE26C2C26C00F34E94 /* InPersonPaymentsStripeAcountReviewView.swift in Sources */,
+				CC593A6B26EA640800EF0E04 /* PackageCreationError+UI.swift in Sources */,
 				CE1F512920697F0100C6C810 /* UIFont+Helpers.swift in Sources */,
 				2687165A24D350C20042F6AE /* SurveyCoordinatingController.swift in Sources */,
 				02C88775245036D400E4470F /* FilterProductListViewModel.swift in Sources */,

Yosemite/Yosemite/Actions/ShippingLabelAction.swift

@@ -46,7 +46,7 @@ public enum ShippingLabelAction: Action {
     case createPackage(siteID: Int64,
                        customPackage: ShippingLabelCustomPackage? = nil,
                        predefinedOption: ShippingLabelPredefinedOption? = nil,
-                       completion: (Result<Bool, Error>) -> Void)
+                       completion: (Result<Bool, PackageCreationError>) -> Void)
 
     /// Fetch list of shipping carriers and their rates
     ///

Yosemite/Yosemite/Stores/ShippingLabelStore.swift

@@ -171,8 +171,15 @@ private extension ShippingLabelStore {
     func createPackage(siteID: Int64,
                        customPackage: ShippingLabelCustomPackage?,
                        predefinedOption: ShippingLabelPredefinedOption?,
-                       completion: @escaping (Result<Bool, Error>) -> Void) {
-        remote.createPackage(siteID: siteID, customPackage: customPackage, predefinedOption: predefinedOption, completion: completion)
+                       completion: @escaping (Result<Bool, PackageCreationError>) -> Void) {
+        remote.createPackage(siteID: siteID, customPackage: customPackage, predefinedOption: predefinedOption) { result in
+            switch result {
+            case .success(let success):
+                completion(.success(success))
+            case .failure(let error):
+                completion(.failure(PackageCreationError(error: error)))
+            }
+        }
     }
 
     func loadCarriersAndRates(siteID: Int64,
@@ -477,3 +484,56 @@ public enum LabelPurchaseError: Error {
     /// Label purchase not complete after polling the backend
     case purchaseIncomplete
 }
+
+/// An error that occurs while creating a package.
+///
+/// - duplicateCustomPackageNames: The new custom package names are not unique.
+/// - duplicatePackageNames: At least one of the new custom packages has the same name as existing packages.
+/// - duplicatePredefinedPackageNames: The new predefined package names are not unique.
+/// - duplicateNamesByCarrier: At least one of the new predefined packages has the same name as existing packages.
+/// - unknown: other error cases.
+///
+public enum PackageCreationError: Error, Equatable {
+    case duplicateCustomPackageNames
+    case duplicatePackageNames
+    case duplicatePredefinedPackageNames
+    case duplicateNamesByCarrier
+    case unknown(error: AnyError)
+
+    init(error: Error) {
+        guard let dotcomError = error as? DotcomError else {
+            self = .unknown(error: error.toAnyError)
+            return
+        }
+        switch dotcomError {
+        case .unknown(let code, _):
+            guard let errorCode = ErrorCode(rawValue: code) else {
+                self = .unknown(error: dotcomError.toAnyError)
+                return
+            }
+            self = errorCode.error
+        default:
+            self = .unknown(error: dotcomError.toAnyError)
+        }
+    }
+
+    private enum ErrorCode: String {
+        case duplicateCustomPackageNames = "duplicate_custom_package_names"
+        case duplicatePackageNames = "duplicate_custom_package_names_of_existing_packages"
+        case duplicatePredefinedPackageNames = "duplicate_predefined_package_names"
+        case duplicateNamesByCarrier = "duplicate_predefined_package_names_of_existing_packages"
+
+        var error: PackageCreationError {
+            switch self {
+            case .duplicateCustomPackageNames:
+                return .duplicateCustomPackageNames
+            case .duplicatePredefinedPackageNames:
+                return .duplicatePredefinedPackageNames
+            case .duplicatePackageNames:
+                return .duplicatePackageNames
+            case .duplicateNamesByCarrier:
+                return .duplicateNamesByCarrier
+            }
+        }
+    }
+}

Yosemite/YosemiteTests/Stores/ShippingLabelStoreTests.swift

@@ -514,7 +514,7 @@ final class ShippingLabelStoreTests: XCTestCase {
         let store = ShippingLabelStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
 
         // When
-        let result: Result<Bool, Error> = waitFor { promise in
+        let result: Result<Bool, PackageCreationError> = waitFor { promise in
             let action = ShippingLabelAction.createPackage(siteID: self.sampleSiteID, customPackage: self.sampleShippingLabelCustomPackage()) { result in
                 promise(result)
             }
@@ -534,16 +534,15 @@ final class ShippingLabelStoreTests: XCTestCase {
         let store = ShippingLabelStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
 
         // When
-        let result: Result<Bool, Error> = waitFor { promise in
+        let result: Result<Bool, PackageCreationError> = waitFor { promise in
             let action = ShippingLabelAction.createPackage(siteID: self.sampleSiteID, customPackage: self.sampleShippingLabelCustomPackage()) { result in
                 promise(result)
             }
             store.onAction(action)
         }
 
         // Then
-        let error = try XCTUnwrap(result.failure)
-        XCTAssertEqual(error as? NetworkError, expectedError)
+        XCTAssertTrue(result.isFailure)
     }
 
     // MARK: `loadCarriersAndRates`