[Local catalog] Handle variation ids in dotcom errors (#16430)

Author: joshheald

Modules/Sources/Fakes/NetworkingCore.generated.swift

@@ -44,7 +44,7 @@ extension NetworkingCore.DotcomError {
     /// Returns a "ready to use" type filled with fake values.
     ///
     public static func fake() -> NetworkingCore.DotcomError {
-        .empty
+        .empty()
     }
 }
 extension NetworkingCore.MetaContainer {

Modules/Sources/Networking/Remote/AccountRemote.swift

@@ -253,7 +253,7 @@ public enum CreateAccountError: Error, Equatable {
     /// Decodable Initializer.
     ///
     init(dotcomError error: DotcomError) {
-        if case let .unknown(code, message) = error {
+        if case let .unknown(code, message, _) = error {
             switch code {
             case Constants.emailExists:
                 self = .emailExists

Modules/Sources/Networking/Remote/DevicesRemote.swift

@@ -56,7 +56,7 @@ public class DevicesRemote: Remote {
 
         enqueue(request, mapper: mapper) { (success, error) in
             guard success == true else {
-                completion(error ?? DotcomError.empty)
+                completion(error ?? DotcomError.empty())
                 return
             }
 

Modules/Sources/Networking/Remote/WordPressThemeRemote.swift

@@ -71,7 +71,7 @@ public enum InstallThemeError: Error {
 
     init?(_ error: Error) {
         guard let dotcomError = error as? DotcomError,
-              case let .unknown(code, _) = dotcomError else {
+              case let .unknown(code, _, _) = dotcomError else {
             return nil
         }
 

Modules/Sources/NetworkingCore/Model/DotcomError.swift

@@ -7,79 +7,79 @@ public enum DotcomError: Error, Decodable, Equatable, GeneratedFakeable {
 
     /// Non explicit reason
     ///
-    case empty
+    case empty(data: [String: AnyDecodable]? = nil)
 
     /// Missing Token!
     ///
-    case unauthorized
+    case unauthorized(data: [String: AnyDecodable]? = nil)
 
     /// We're not properly authenticated
     ///
-    case invalidToken
+    case invalidToken(data: [String: AnyDecodable]? = nil)
 
     /// Remote Request Failed
     ///
-    case requestFailed
+    case requestFailed(data: [String: AnyDecodable]? = nil)
 
     /// No route was found matching the URL and request method
     ///
-    case noRestRoute
+    case noRestRoute(data: [String: AnyDecodable]? = nil)
 
     /// Jetpack is not connected
     ///
     /// This can be caused by an `unknown_token` error from Jetpack
     /// or an `invalid_blog` error from WordPress.com Stats.
     ///
-    case jetpackNotConnected
+    case jetpackNotConnected(data: [String: AnyDecodable]? = nil)
 
     /// Unknown: Represents an unmapped remote error. Capisce?
     ///
-    case unknown(code: String, message: String?)
+    case unknown(code: String, message: String?, data: [String: AnyDecodable]?)
 
     /// Stats error cases - API documentation of possible errors:
     /// https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/stats/
     /// Note: when the cases get large, consider refactoring them into a separate error enum that conforms to a Dotcom error protocol
 
     /// No permission to view site stats
-    case noStatsPermission
+    case noStatsPermission(data: [String: AnyDecodable]? = nil)
 
     /// Jetpack site stats module disabled
-    case statsModuleDisabled
+    case statsModuleDisabled(data: [String: AnyDecodable]? = nil)
 
     /// The requested resourced does not exist remotely
-    case resourceDoesNotExist
+    case resourceDoesNotExist(data: [String: AnyDecodable]? = nil)
 
     /// Decodable Initializer.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let error = try container.decode(String.self, forKey: .error)
         let message = try container.decodeIfPresent(String.self, forKey: .message)
+        let data = try container.decodeIfPresent([String: AnyDecodable].self, forKey: .data)
 
         switch error {
         case Constants.invalidToken:
-            self = .invalidToken
+            self = .invalidToken(data: data)
         case Constants.requestFailed:
-            self = .requestFailed
+            self = .requestFailed(data: data)
         case Constants.unauthorized where message == ErrorMessages.noStatsPermission:
-            self = .noStatsPermission
+            self = .noStatsPermission(data: data)
         case Constants.unauthorized:
-            self = .unauthorized
+            self = .unauthorized(data: data)
         case Constants.noRestRoute:
-            self = .noRestRoute
+            self = .noRestRoute(data: data)
         case Constants.invalidBlog where message == ErrorMessages.statsModuleDisabled:
-            self = .statsModuleDisabled
+            self = .statsModuleDisabled(data: data)
         case Constants.restTermInvalid where message == ErrorMessages.resourceDoesNotExist:
-            self = .resourceDoesNotExist
+            self = .resourceDoesNotExist(data: data)
         case Constants.unknownToken,
             Constants.invalidBlog where message == ErrorMessages.jetpackNotConnected:
-            self = .jetpackNotConnected
+            self = .jetpackNotConnected(data: data)
         default:
-            self = .unknown(code: error, message: message)
+            self = .unknown(code: error, message: message, data: data)
         }
     }
 
-
     /// Constants for Possible Error Identifiers
     ///
     private enum Constants {
@@ -97,6 +97,7 @@ public enum DotcomError: Error, Decodable, Equatable, GeneratedFakeable {
     private enum CodingKeys: String, CodingKey {
         case error
         case message
+        case data
     }
 
     /// Possible Error Messages
@@ -134,7 +135,7 @@ extension DotcomError: CustomStringConvertible {
             return NSLocalizedString("Dotcom Resource does not exist", comment: "WordPress.com error thrown when a requested resource does not exist remotely.")
         case .jetpackNotConnected:
             return NSLocalizedString("Jetpack Not Connected", comment: "WordPress.com error thrown when Jetpack is not connected.")
-        case .unknown(let code, let message):
+        case .unknown(let code, let message, _):
             let theMessage = message ?? String()
             let messageFormat = NSLocalizedString(
                 "Dotcom Error: [%1$@] %2$@",
@@ -150,14 +151,17 @@ extension DotcomError: CustomStringConvertible {
 //
 public func ==(lhs: DotcomError, rhs: DotcomError) -> Bool {
     switch (lhs, rhs) {
-    case (.requestFailed, .requestFailed),
+    case (.empty, .empty),
         (.unauthorized, .unauthorized),
+        (.invalidToken, .invalidToken),
+        (.requestFailed, .requestFailed),
         (.noRestRoute, .noRestRoute),
+        (.jetpackNotConnected, .jetpackNotConnected),
         (.noStatsPermission, .noStatsPermission),
         (.statsModuleDisabled, .statsModuleDisabled),
-        (.jetpackNotConnected, .jetpackNotConnected):
+        (.resourceDoesNotExist, .resourceDoesNotExist):
         return true
-    case let (.unknown(codeLHS, _), .unknown(codeRHS, _)):
+    case let (.unknown(codeLHS, _, _), .unknown(codeRHS, _, _)):
         return codeLHS == codeRHS
     default:
         return false

Modules/Sources/NetworkingCore/Remote/NotificationsRemote.swift

@@ -74,7 +74,7 @@ public final class NotificationsRemote: Remote, NotificationsRemoteProtocol {
 
         enqueue(request, mapper: mapper) { (success, error) in
             guard success == true else {
-                completion(error ?? DotcomError.empty)
+                completion(error ?? DotcomError.empty())
                 return
             }
 
@@ -99,7 +99,7 @@ public final class NotificationsRemote: Remote, NotificationsRemoteProtocol {
 
         enqueue(request, mapper: mapper) { (success, error) in
             guard success == true else {
-                completion(error ?? DotcomError.empty)
+                completion(error ?? DotcomError.empty())
                 return
             }
 

Modules/Sources/Yosemite/Stores/CouponsError.swift

@@ -8,7 +8,7 @@ public struct CouponsError: Error, LocalizedError {
 
     public init?(underlyingError error: Error) {
         switch error {
-        case DotcomError.unknown(Constants.invalidCouponCode, let message):
+        case DotcomError.unknown(Constants.invalidCouponCode, let message, _):
             self.message = message ?? Localizations.defaultCouponsError
             self.underlyingError = error
         case let NetworkError.unacceptableStatusCode(_, response):

Modules/Sources/Yosemite/Stores/OrderStore.swift

@@ -663,7 +663,7 @@ private extension OrderStore {
                 })
             case .failure(let error):
                 if let dotcomError = error as? DotcomError,
-                   case let .unknown(code, message) = dotcomError {
+                   case let .unknown(code, message, _) = dotcomError {
                     switch code {
                         case "woocommerce_rest_gift_card_cannot_apply":
                             return onCompletion(.failure(GiftCardError.cannotApply(reason: message)))

Modules/Sources/Yosemite/Stores/PaymentsError.swift

@@ -19,7 +19,7 @@ public enum PaymentsError: Error, LocalizedError {
 
     private static func unwrapError(error: Error) -> PaymentsErrorConvertible? {
         switch error {
-        case let DotcomError.unknown(code, message):
+        case let DotcomError.unknown(code, message, _):
             return PaymentsDotcomErrorDetails(code: code, message: message)
         case let NetworkError.unacceptableStatusCode(_, response):
             guard let response,

Modules/Sources/Yosemite/Stores/ProductStore.swift

@@ -317,8 +317,9 @@ private extension ProductStore {
                                                    shouldDeleteExistingProducts: shouldDeleteExistingProducts)
             let hasNextPage = products.count == pageSize
             return hasNextPage
-        } catch let error as DotcomError where error == .unknown(code: "rest_invalid_param", message: "Invalid parameter(s): type") {
-            if let productType,
+        } catch let error as DotcomError {
+            if case .unknown(code: "rest_invalid_param", message: "Invalid parameter(s): type", data: _) = error,
+               let productType,
                ProductType.coreTypes.contains(productType) == false {
                 return false
             }
@@ -684,7 +685,7 @@ private extension ProductStore {
                                                                                 feature: .productDetailsFromScannedTexts,
                                                                                 responseFormat: .json)
                 guard let jsonData = jsonString.data(using: .utf8) else {
-                    return completion(.failure(DotcomError.resourceDoesNotExist))
+                    return completion(.failure(DotcomError.resourceDoesNotExist()))
                 }
                 let details = try JSONDecoder().decode(ProductDetailsFromScannedTexts.self, from: jsonData)
                 completion(.success(.init(name: details.name, description: details.description)))
@@ -1388,7 +1389,7 @@ public enum ProductUpdateError: Error, Equatable {
             return
         }
         switch dotcomError {
-        case let .unknown(code, message):
+        case let .unknown(code, message, _):
             guard let errorCode = ErrorCode(rawValue: code) else {
                 self = .unknown(error: dotcomError.toAnyError)
                 return
@@ -1476,7 +1477,7 @@ public enum ProductLoadError: Error, Equatable {
     case unknown(error: AnyError)
 
     init(underlyingError error: Error) {
-        guard case let DotcomError.unknown(code, _) = error else {
+        guard case let DotcomError.unknown(code, _, _) = error else {
             self = .unknown(error: error.toAnyError)
             return
         }