Handle variation ID in DotcomError at POS checkout

joshheald · joshheald · commit ffd81e1f5b02 · 2025-12-03T11:53:39.000Z
- Add `data` to `DotcomError.unknown` case
- Parse `data` and handle variation ID when present during POS checkout
- Update other uses of it to use the new signature
diff --git a/Modules/Sources/Networking/Remote/AccountRemote.swift b/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
diff --git a/Modules/Sources/Networking/Remote/WordPressThemeRemote.swift b/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
         }
 
diff --git a/Modules/Sources/NetworkingCore/Model/DotcomError.swift b/Modules/Sources/NetworkingCore/Model/DotcomError.swift
@@ -34,7 +34,7 @@ public enum DotcomError: Error, Decodable, Equatable, GeneratedFakeable {
 
     /// 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/
@@ -55,6 +55,7 @@ public enum DotcomError: Error, Decodable, Equatable, GeneratedFakeable {
         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:
@@ -75,11 +76,10 @@ public enum DotcomError: Error, Decodable, Equatable, GeneratedFakeable {
             Constants.invalidBlog where message == ErrorMessages.jetpackNotConnected:
             self = .jetpackNotConnected
         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$@",
@@ -157,7 +158,7 @@ public func ==(lhs: DotcomError, rhs: DotcomError) -> Bool {
         (.statsModuleDisabled, .statsModuleDisabled),
         (.jetpackNotConnected, .jetpackNotConnected):
         return true
-    case let (.unknown(codeLHS, _), .unknown(codeRHS, _)):
+    case let (.unknown(codeLHS, _, _), .unknown(codeRHS, _, _)):
         return codeLHS == codeRHS
     default:
         return false
diff --git a/Modules/Sources/Yosemite/Stores/CouponsError.swift b/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):
diff --git a/Modules/Sources/Yosemite/Stores/OrderStore.swift b/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)))
diff --git a/Modules/Sources/Yosemite/Stores/PaymentsError.swift b/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,
diff --git a/Modules/Sources/Yosemite/Stores/ProductStore.swift b/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
             }
@@ -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
         }
diff --git a/Modules/Sources/Yosemite/Stores/ShippingLabelStore.swift b/Modules/Sources/Yosemite/Stores/ShippingLabelStore.swift
@@ -492,7 +492,7 @@ public enum PackageCreationError: Error, Equatable {
             return
         }
         switch dotcomError {
-        case .unknown(let code, _):
+        case .unknown(let code, _, _):
             guard let errorCode = ErrorCode(rawValue: code) else {
                 self = .unknown(error: dotcomError.toAnyError)
                 return
diff --git a/Modules/Sources/Yosemite/Stores/SiteStore.swift b/Modules/Sources/Yosemite/Stores/SiteStore.swift
@@ -210,7 +210,7 @@ public enum SiteCreationError: Error, Equatable {
             }
         case let remoteError as DotcomError:
             switch remoteError {
-            case let .unknown(code, _):
+            case let .unknown(code, _, _):
                 switch code {
                 case "blog_name_exists":
                     self = .domainExists
diff --git a/Modules/Sources/Yosemite/Tools/CommonReaderConfigProvider.swift b/Modules/Sources/Yosemite/Tools/CommonReaderConfigProvider.swift
@@ -66,9 +66,9 @@ final public class CommonReaderConfigProvider: CommonReaderConfigProviding {
 private extension CardReaderConfigError {
     init?(error: Error) {
         switch error {
-        case DotcomError.unknown(code: "store_address_is_incomplete", let message):
+        case DotcomError.unknown(code: "store_address_is_incomplete", let message, _):
             self = .incompleteStoreAddress(adminUrl: URL(string: message ?? ""))
-        case DotcomError.unknown(code: "postal_code_invalid", _):
+        case DotcomError.unknown(code: "postal_code_invalid", _, _):
             self = .invalidPostalCode
         case NetworkError.unacceptableStatusCode(_, let responseData):
             guard let responseData,
diff --git a/Modules/Sources/Yosemite/Tools/POS/POSOrderService.swift b/Modules/Sources/Yosemite/Tools/POS/POSOrderService.swift
@@ -152,9 +152,11 @@ private extension POSOrderService {
         }()
 
         // Check for DotcomError with product/variation validation error codes
-        if case .unknown(let code, _) = underlyingError as? DotcomError {
+        if case .unknown(let code, _, let data) = underlyingError as? DotcomError {
             if isProductValidationError(code: code) {
-                // DotcomError doesn't include data field, fall back to generic error
+                if let variationID = extractVariationID(from: data) {
+                    return createMissingProductInfo(forVariationID: variationID, cart: cart)
+                }
                 return extractMissingProductsFromCart()
             }
         }
diff --git a/Modules/Tests/NetworkingTests/Remote/JetpackSettingsRemoteTests.swift b/Modules/Tests/NetworkingTests/Remote/JetpackSettingsRemoteTests.swift
@@ -31,7 +31,7 @@ final class JetpackSettingsRemoteTests: XCTestCase {
             // When
             try await remote.enableJetpackModule(for: sampleSiteID, moduleSlug: "invalidmodule")
         }, errorAssert: { error in
-            (error as? DotcomError) == .unknown(code: "some_updated", message: "Invalid option: invalidmodule.")
+            (error as? DotcomError) == .unknown(code: "some_updated", message: "Invalid option: invalidmodule.", data: nil)
         })
     }
 
diff --git a/Modules/Tests/NetworkingTests/Remote/ShippingLabelRemoteTests.swift b/Modules/Tests/NetworkingTests/Remote/ShippingLabelRemoteTests.swift
@@ -102,7 +102,8 @@ final class ShippingLabelRemoteTests: XCTestCase {
         let expectedError = DotcomError
             .unknown(code: "wcc_server_error_response",
                      message: "Error: The WooCommerce Shipping & Tax server returned: Bad Request Unable to request refund. " +
-                        "The parcel has been shipped. ( 400 )")
+                        "The parcel has been shipped. ( 400 )",
+                     data: nil)
         XCTAssertEqual(result.failure as? DotcomError, expectedError)
     }
 
@@ -278,7 +279,8 @@ final class ShippingLabelRemoteTests: XCTestCase {
         // Then
         let expectedError = DotcomError
             .unknown(code: "duplicate_custom_package_names_of_existing_packages",
-                     message: "At least one of the new custom packages has the same name as existing packages.")
+                     message: "At least one of the new custom packages has the same name as existing packages.",
+                     data: nil)
         XCTAssertEqual(result.failure as? DotcomError, expectedError)
     }
 
diff --git a/Modules/Tests/NetworkingTests/Remote/SiteRemoteTests.swift b/Modules/Tests/NetworkingTests/Remote/SiteRemoteTests.swift
@@ -50,8 +50,10 @@ final class SiteRemoteTests: XCTestCase {
         await assertThrowsError({
             // When
             _ = try await remote.createSite(name: "Wapuu swags", flow: .onboarding(domain: "wapuu.store"))
-        }, errorAssert: { ($0 as? DotcomError) == .unknown(code: "blog_name_only_lowercase_letters_and_numbers",
-                                                message: "Site names can only contain lowercase letters (a-z) and numbers.")
+        }, errorAssert: { ($0 as? DotcomError) == .unknown(
+            code: "blog_name_only_lowercase_letters_and_numbers",
+            message: "Site names can only contain lowercase letters (a-z) and numbers.",
+            data: nil)
         })
     }
 
@@ -128,8 +130,10 @@ final class SiteRemoteTests: XCTestCase {
             // When
             try await remote.enableFreeTrial(siteID: 134)
         }, errorAssert: { error in
-            (error as? DotcomError) == .unknown(code: "no-upgrades-permitted",
-                                                message: "You cannot add WordPress.com eCommerce Trial when you already have paid upgrades")
+            (error as? DotcomError) == .unknown(
+                code: "no-upgrades-permitted",
+                message: "You cannot add WordPress.com eCommerce Trial when you already have paid upgrades",
+                data: nil)
         })
     }
 
@@ -320,7 +324,8 @@ final class SiteRemoteTests: XCTestCase {
             _ = try await remote.loadSite(domain: domain)
         }, errorAssert: { ($0 as? DotcomError) == .unknown(
             code: "parse_error",
-            message: "The Jetpack site is inaccessible or returned an error: parse error (local). not well formed [-32710]"
+            message: "The Jetpack site is inaccessible or returned an error: parse error (local). not well formed [-32710]",
+            data: nil
         )})
     }
 
diff --git a/Modules/Tests/NetworkingTests/Remote/WooShippingRemoteTests.swift b/Modules/Tests/NetworkingTests/Remote/WooShippingRemoteTests.swift
@@ -104,7 +104,8 @@ final class WooShippingRemoteTests: XCTestCase {
         // Then
         let expectedError = DotcomError
             .unknown(code: "duplicate_custom_package_names_of_existing_packages",
-                     message: "At least one of the new custom packages has the same name as existing packages.")
+                     message: "At least one of the new custom packages has the same name as existing packages.",
+                     data: nil)
         XCTAssertEqual(result.failure as? DotcomError, expectedError)
     }
 
diff --git a/Modules/Tests/PointOfSaleTests/Controllers/PointOfSaleOrderControllerTests.swift b/Modules/Tests/PointOfSaleTests/Controllers/PointOfSaleOrderControllerTests.swift
@@ -529,7 +529,7 @@ struct PointOfSaleOrderControllerTests {
                                              currencySettingsProvider: MockCurrencySettingsProvider(),
                                              analytics: MockPOSAnalytics())
         let errorMessage = "Invalid coupon code"
-        mockOrderService.errorToReturn = DotcomError.unknown(code: "woocommerce_rest_invalid_coupon", message: errorMessage)
+        mockOrderService.errorToReturn = DotcomError.unknown(code: "woocommerce_rest_invalid_coupon", message: errorMessage, data: nil)
 
         var orderStates: [PointOfSaleInternalOrderState] = [sut.orderState]
         var orderStateAppendTask: Task<Void, Never>? = nil
diff --git a/Modules/Tests/PointOfSaleTests/Tools/POSReceiptSenderTests.swift b/Modules/Tests/PointOfSaleTests/Tools/POSReceiptSenderTests.swift
@@ -43,7 +43,7 @@ struct POSReceiptSenderTests {
                                          systemPlugin: SystemPlugin.fake().copy(plugin: "woocommerce/woocommerce.php",
                                                                                 version: "10.0.0-dev",
                                                                                 active: true))
-        mockReceiptService.sendReceiptResult = .failure(DotcomError.unknown(code: "test_error", message: "Test error"))
+        mockReceiptService.sendReceiptResult = .failure(DotcomError.unknown(code: "test_error", message: "Test error", data: nil))
         let order = Order.fake()
 
         // When
diff --git a/Modules/Tests/YosemiteTests/PointOfSale/POSProductOrVariationResolverTests.swift b/Modules/Tests/YosemiteTests/PointOfSale/POSProductOrVariationResolverTests.swift
@@ -164,7 +164,7 @@ struct POSProductOrVariationResolverTests {
         )
         let scannedCode = "test-barcode-loading"
         let someError = NSError(domain: "Test", code: 1, userInfo: nil)
-        let dotcomNotFoundError = DotcomError.unknown(code: "woocommerce_rest_product_invalid_id", message: "Not found")
+        let dotcomNotFoundError = DotcomError.unknown(code: "woocommerce_rest_product_invalid_id", message: "Not found", data: nil)
 
         // NotFound case (simulate DotcomError for not found)
         mockProductsRemote.whenLoadingProductForPointOfSale(siteID: variation.siteID, productID: variation.parentID, thenReturn: .failure(dotcomNotFoundError))
diff --git a/Modules/Tests/YosemiteTests/Stores/CardPresentPaymentStoreTests.swift b/Modules/Tests/YosemiteTests/Stores/CardPresentPaymentStoreTests.swift
@@ -582,7 +582,7 @@ final class CardPresentPaymentStoreTests: XCTestCase {
         XCTAssert(viewStorage.countObjects(ofType: Storage.WCPayCharge.self, matching: nil) == 2)
 
         network.simulateError(requestUrlSuffix: "payments/charges/\(sampleErrorChargeID)",
-                              error: DotcomError.unknown(code: "beep", message: "boop"))
+                              error: DotcomError.unknown(code: "beep", message: "boop", data: nil))
 
         let _: Result<Yosemite.WCPayCharge, Error> = waitFor { [self] promise in
             let action = CardPresentPaymentAction.fetchWCPayCharge(siteID: self.sampleSiteID, chargeID: self.sampleErrorChargeID, onCompletion: { result in
diff --git a/Modules/Tests/YosemiteTests/Stores/ProductStore+FilterProductsTests.swift b/Modules/Tests/YosemiteTests/Stores/ProductStore+FilterProductsTests.swift
@@ -203,7 +203,8 @@ final class ProductStore_FilterProductsTests: XCTestCase {
         let remote = MockProductsRemote()
         remote.whenLoadingAllProducts(siteID: sampleSiteID,
                                       thenReturn: .failure(DotcomError.unknown(code: "rest_invalid_param",
-                                                                               message: "Invalid parameter(s): type")))
+                                                                               message: "Invalid parameter(s): type",
+                                                                               data: nil)))
         let productStore = ProductStore(dispatcher: dispatcher,
                                         storageManager: storageManager,
                                         network: network,
@@ -238,7 +239,8 @@ final class ProductStore_FilterProductsTests: XCTestCase {
         let remote = MockProductsRemote()
         remote.whenLoadingAllProducts(siteID: sampleSiteID,
                                       thenReturn: .failure(DotcomError.unknown(code: "rest_invalid_param",
-                                                                               message: "Invalid parameter(s): type")))
+                                                                               message: "Invalid parameter(s): type",
+                                                                               data: nil)))
         let productStore = ProductStore(dispatcher: dispatcher,
                                         storageManager: storageManager,
                                         network: network,
@@ -265,7 +267,8 @@ final class ProductStore_FilterProductsTests: XCTestCase {
             XCTAssertTrue(result.isFailure)
             let error = try XCTUnwrap(result.failure)
             XCTAssertEqual(error as? DotcomError, .unknown(code: "rest_invalid_param",
-                                                           message: "Invalid parameter(s): type"))
+                                                           message: "Invalid parameter(s): type",
+                                                           data: nil))
         }
     }
 
diff --git a/Modules/Tests/YosemiteTests/Stores/ProductStoreTests.swift b/Modules/Tests/YosemiteTests/Stores/ProductStoreTests.swift
@@ -763,7 +763,7 @@ final class ProductStoreTests: XCTestCase {
         productStore.upsertStoredProduct(readOnlyProduct: sampleProduct(), in: viewStorage)
         XCTAssertEqual(viewStorage.countObjects(ofType: Storage.Product.self), 1)
 
-        let dotComError = DotcomError.unknown(code: ProductLoadError.ErrorCode.invalidID.rawValue, message: nil)
+        let dotComError = DotcomError.unknown(code: ProductLoadError.ErrorCode.invalidID.rawValue, message: nil, data: nil)
 
         // Action
         network.simulateError(requestUrlSuffix: "products/282", error: dotComError)
diff --git a/Modules/Tests/YosemiteTests/Stores/SiteStoreTests.swift b/Modules/Tests/YosemiteTests/Stores/SiteStoreTests.swift
diff --git a/Modules/Tests/YosemiteTests/Stores/SiteVisitStatsStoreErrorTests.swift b/Modules/Tests/YosemiteTests/Stores/SiteVisitStatsStoreErrorTests.swift
diff --git a/Modules/Tests/YosemiteTests/Tools/CommonReaderConfigProviderTests.swift b/Modules/Tests/YosemiteTests/Tools/CommonReaderConfigProviderTests.swift
diff --git a/Modules/Tests/YosemiteTests/Tools/POS/POSOrderServiceTests.swift b/Modules/Tests/YosemiteTests/Tools/POS/POSOrderServiceTests.swift
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Creation/EditableOrderViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Creation/EditableOrderViewModel.swift
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShippingCreateLabelsViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShippingCreateLabelsViewModel.swift
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/Downloadable Files/File List/ProductDownloadListViewController.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/Downloadable Files/File List/ProductDownloadListViewController.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Analytics Hub/AnalyticsHubViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Analytics Hub/AnalyticsHubViewModelTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/EditableOrderViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/EditableOrderViewModelTests.swift

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public enum InstallThemeError: Error {`
`71`	`71`
`72`	`72`	`init?(_ error: Error) {`
`73`	`73`	`guard let dotcomError = error as? DotcomError,`
`74`		`- case let .unknown(code, _) = dotcomError else {`
	`74`	`+ case let .unknown(code, _, _) = dotcomError else {`
`75`	`75`	`return nil`
`76`	`76`	`}`
`77`	`77`
Original file line number	Diff line number	Diff line change
`@@ -492,7 +492,7 @@ public enum PackageCreationError: Error, Equatable {`
`492`	`492`	`return`
`493`	`493`	`}`
`494`	`494`	`switch dotcomError {`
`495`		`- case .unknown(let code, _):`
	`495`	`+ case .unknown(let code, _, _):`
`496`	`496`	`guard let errorCode = ErrorCode(rawValue: code) else {`
`497`	`497`	`self = .unknown(error: dotcomError.toAnyError)`
`498`	`498`	`return`
Original file line number	Diff line number	Diff line change
`@@ -210,7 +210,7 @@ public enum SiteCreationError: Error, Equatable {`
`210`	`210`	`}`
`211`	`211`	`case let remoteError as DotcomError:`
`212`	`212`	`switch remoteError {`
`213`		`- case let .unknown(code, _):`
	`213`	`+ case let .unknown(code, _, _):`
`214`	`214`	`switch code {`
`215`	`215`	`case "blog_name_exists":`
`216`	`216`	`self = .domainExists`