Merge branch 'trunk' into issue/9839-bool-decoding-fallbacks

rachelmcr · rachelmcr · commit c06d9fe2de17 · 2023-05-31T17:28:30.000+01:00
diff --git a/Networking/Networking.xcodeproj/project.pbxproj b/Networking/Networking.xcodeproj/project.pbxproj
@@ -641,6 +641,7 @@
 		CE19CB11222486A600E8AF7A /* order-statuses.json in Resources */ = {isa = PBXBuildFile; fileRef = CE19CB10222486A500E8AF7A /* order-statuses.json */; };
 		CE20179320E3EFA7005B4C18 /* broken-orders.json in Resources */ = {isa = PBXBuildFile; fileRef = CE20179220E3EFA7005B4C18 /* broken-orders.json */; };
 		CE227093228DD44C00C0626C /* ProductStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE227092228DD44C00C0626C /* ProductStatus.swift */; };
+		CE2678432A26102A00FD9AEB /* order-alternative-types.json in Resources */ = {isa = PBXBuildFile; fileRef = CE2678422A26102A00FD9AEB /* order-alternative-types.json */; };
 		CE43066A23465F340073CBFF /* Refund.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE43066923465F340073CBFF /* Refund.swift */; };
 		CE43066C2347C5F90073CBFF /* OrderItemRefund.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE43066B2347C5F90073CBFF /* OrderItemRefund.swift */; };
 		CE43066E2347CBA70073CBFF /* OrderItemTaxRefund.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE43066D2347CBA70073CBFF /* OrderItemTaxRefund.swift */; };
@@ -1579,6 +1580,7 @@
 		CE19CB10222486A500E8AF7A /* order-statuses.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "order-statuses.json"; sourceTree = "<group>"; };
 		CE20179220E3EFA7005B4C18 /* broken-orders.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "broken-orders.json"; sourceTree = "<group>"; };
 		CE227092228DD44C00C0626C /* ProductStatus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductStatus.swift; sourceTree = "<group>"; };
+		CE2678422A26102A00FD9AEB /* order-alternative-types.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "order-alternative-types.json"; sourceTree = "<group>"; };
 		CE43066923465F340073CBFF /* Refund.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Refund.swift; sourceTree = "<group>"; };
 		CE43066B2347C5F90073CBFF /* OrderItemRefund.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrderItemRefund.swift; sourceTree = "<group>"; };
 		CE43066D2347CBA70073CBFF /* OrderItemTaxRefund.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrderItemTaxRefund.swift; sourceTree = "<group>"; };
@@ -2541,6 +2543,7 @@
 				B554FA8C2180B59700C54DFF /* notifications-load-hashes.json */,
 				AE2D6624272A941C004A2C3A /* null-data.json */,
 				B5C6FCD520A3768900A4F8E4 /* order.json */,
+				CE2678422A26102A00FD9AEB /* order-alternative-types.json */,
 				DEF13C5F29668C420024A02B /* order-without-data.json */,
 				034480C227A42F9100DFACD2 /* order-with-charge.json */,
 				02C254D62563999200A04423 /* order-shipping-labels.json */,
@@ -3620,6 +3623,7 @@
 				74ABA1C9213F19FE00FFAD30 /* top-performers-month.json in Resources */,
 				3158FE7026129D7500E566B9 /* wcpay-account-rejected-listed.json in Resources */,
 				743E84F622172D3E00FAC9D7 /* shipment_tracking_single.json in Resources */,
+				CE2678432A26102A00FD9AEB /* order-alternative-types.json in Resources */,
 				D865CE5B278CA10B002C8520 /* stripe-payment-intent-requires-payment-method.json in Resources */,
 				CC9A254626442CA7005DE56E /* shipping-label-eligibility-failure.json in Resources */,
 				4524CD9C242CEFAB00B2F20A /* product-on-sale-with-empty-sale-price.json in Resources */,
diff --git a/Networking/Networking/Model/OrderItem.swift b/Networking/Networking/Model/OrderItem.swift
@@ -88,7 +88,11 @@ public struct OrderItem: Codable, Equatable, Hashable, GeneratedFakeable, Genera
         let decimalPrice = try container.decodeIfPresent(Decimal.self, forKey: .price) ?? Decimal(0)
         let price = NSDecimalNumber(decimal: decimalPrice)
 
-        let sku = try container.decodeIfPresent(String.self, forKey: .sku)
+        // Even though a plain install of WooCommerce Core provides String values,
+        // some plugins alter the field value from String to Int or Decimal.
+        let sku = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                    forKey: .sku,
+                                                    alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })])
         let subtotal = try container.decode(String.self, forKey: .subtotal)
         let subtotalTax = try container.decode(String.self, forKey: .subtotalTax)
         let taxClass = try container.decode(String.self, forKey: .taxClass)
diff --git a/Networking/Networking/Model/Product/Product.swift b/Networking/Networking/Model/Product/Product.swift
@@ -357,7 +357,12 @@ public struct Product: Codable, GeneratedCopiable, Equatable, GeneratedFakeable
 
         let fullDescription = try container.decodeIfPresent(String.self, forKey: .fullDescription)
         let shortDescription = try container.decodeIfPresent(String.self, forKey: .shortDescription)
-        let sku = try container.decodeIfPresent(String.self, forKey: .sku)
+
+        // Even though a plain install of WooCommerce Core provides String values,
+        // some plugins alter the field value from String to Int or Decimal.
+        let sku = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                    forKey: .sku,
+                                                    alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })])
 
         // Even though a plain install of WooCommerce Core provides string values,
         // some plugins alter the field value from String to Int or Decimal.
@@ -434,7 +439,12 @@ public struct Product: Codable, GeneratedCopiable, Equatable, GeneratedFakeable
         let backordered = try container.decode(Bool.self, forKey: .backordered)
 
         let soldIndividually = try container.decodeIfPresent(Bool.self, forKey: .soldIndividually) ?? false
-        let weight = try container.decodeIfPresent(String.self, forKey: .weight)
+
+        // Even though a plain install of WooCommerce Core provides String values,
+        // some plugins alter the field value from String to Int or Decimal.
+        let weight = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                       forKey: .weight,
+                                                       alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })])
         let dimensions = try container.decode(ProductDimensions.self, forKey: .dimensions)
 
         let shippingRequired = try container.decode(Bool.self, forKey: .shippingRequired)
diff --git a/Networking/Networking/Model/Product/ProductDimensions.swift b/Networking/Networking/Model/Product/ProductDimensions.swift
@@ -17,6 +17,24 @@ public struct ProductDimensions: Codable, Equatable, GeneratedFakeable {
         self.width = width
         self.height = height
     }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        // Even though a plain install of WooCommerce Core provides String dimension values,
+        // some plugins may alter the field values from String to Int or Decimal.
+        let length = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                       forKey: .length,
+                                                       alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })]) ?? ""
+        let width = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                      forKey: .width,
+                                                      alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })]) ?? ""
+        let height = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                       forKey: .height,
+                                                       alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })]) ?? ""
+
+        self.init(length: length, width: width, height: height)
+    }
 }
 
 /// Defines all of the Dimensions CodingKeys
diff --git a/Networking/Networking/Model/Product/ProductDownload.swift b/Networking/Networking/Model/Product/ProductDownload.swift
@@ -23,7 +23,11 @@ public struct ProductDownload: Codable, Equatable, GeneratedFakeable {
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
-        let downloadID = try container.decode(String.self, forKey: .downloadID)
+        // Even though a plain install of WooCommerce Core provides String values,
+        // some plugins alter the field value from String to Int or Decimal.
+        let downloadID = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                           forKey: .downloadID,
+                                                           alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })]) ?? "0"
         let name = try container.decodeIfPresent(String.self, forKey: .name)
         let fileURL = try container.decodeIfPresent(String.self, forKey: .fileURL)
 
diff --git a/Networking/Networking/Model/Product/ProductVariation.swift b/Networking/Networking/Model/Product/ProductVariation.swift
@@ -206,7 +206,12 @@ public struct ProductVariation: Codable, GeneratedCopiable, Equatable, Generated
         let statusKey = try container.decode(String.self, forKey: .statusKey)
         let status = ProductStatus(rawValue: statusKey)
         let description = try container.decodeIfPresent(String.self, forKey: .description)
-        let sku = try container.decodeIfPresent(String.self, forKey: .sku)
+
+        // Even though a plain install of WooCommerce Core provides String values,
+        // some plugins alter the field value from String to Int or Decimal.
+        let sku = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                    forKey: .sku,
+                                                    alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })])
 
         // Even though a plain install of WooCommerce Core provides string values,
         // some plugins alter the field value from String to Int or Decimal.
@@ -281,7 +286,12 @@ public struct ProductVariation: Codable, GeneratedCopiable, Equatable, Generated
                                                                   alternativeTypes: [ .string(transform: { NSString(string: $0).boolValue })]) ?? false
 
         let backordered = try container.decode(Bool.self, forKey: .backordered)
-        let weight = try container.decodeIfPresent(String.self, forKey: .weight)
+
+        // Even though a plain install of WooCommerce Core provides String values,
+        // some plugins alter the field value from String to Int or Decimal.
+        let weight = container.failsafeDecodeIfPresent(targetType: String.self,
+                                                       forKey: .weight,
+                                                       alternativeTypes: [.decimal(transform: { NSDecimalNumber(decimal: $0).stringValue })])
         let dimensions = try container.decode(ProductDimensions.self, forKey: .dimensions)
         let shippingClass = try container.decodeIfPresent(String.self, forKey: .shippingClass)
         let shippingClassID = try container.decode(Int64.self, forKey: .shippingClassID)
diff --git a/Networking/Networking/Model/ShippingLineTax.swift b/Networking/Networking/Model/ShippingLineTax.swift
@@ -24,6 +24,22 @@ public struct ShippingLineTax: Decodable, Hashable, GeneratedFakeable {
         self.subtotal = subtotal
         self.total = total
     }
+
+    /// The public initializer for ShippingLineTax.
+    ///
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        // Even though a plain install of WooCommerce Core provides Int values,
+        // some plugins alter the field value from Int to String.
+        let taxID = container.failsafeDecodeIfPresent(targetType: Int64.self,
+                                                       forKey: .taxID,
+                                                       alternativeTypes: [.string(transform: { Int64($0) ?? 0 })]) ?? 0
+        let subtotal = try container.decode(String.self, forKey: .subtotal)
+        let total = try container.decode(String.self, forKey: .total)
+
+        self.init(taxID: taxID, subtotal: subtotal, total: total)
+    }
 }
 
 /// Defines all of the ShippingLineTax CodingKeys.
diff --git a/Networking/NetworkingTests/Mapper/OrderMapperTests.swift b/Networking/NetworkingTests/Mapper/OrderMapperTests.swift
@@ -429,6 +429,15 @@ final class OrderMapperTests: XCTestCase {
         XCTAssertNil(compositeProduct.parent)
         XCTAssertEqual(component.parent, 830)
     }
+
+    func test_that_order_alternative_types_are_properly_parsed() throws {
+        // Given
+        let order = try XCTUnwrap(mapLoadOrderResponseWithAlternativeTypes())
+
+        // Then
+        XCTAssertEqual(order.shippingLines.first?.taxes.first?.taxID, 1)
+        XCTAssertEqual(order.items.first?.sku, "123")
+    }
 }
 
 
@@ -531,4 +540,10 @@ private extension OrderMapperTests {
         return mapOrder(from: "order-with-composite-product")
     }
 
+    /// Returns the Order output upon receiving `order-alternative-types`
+    ///
+    func mapLoadOrderResponseWithAlternativeTypes() -> Order? {
+        return mapOrder(from: "order-alternative-types")
+    }
+
 }
diff --git a/Networking/NetworkingTests/Mapper/ProductMapperTests.swift b/Networking/NetworkingTests/Mapper/ProductMapperTests.swift
@@ -117,6 +117,12 @@ final class ProductMapperTests: XCTestCase {
         XCTAssertFalse(product.soldIndividually)
         XCTAssertTrue(product.purchasable)
         XCTAssertEqual(product.permalink, "")
+        XCTAssertEqual(product.sku, "123")
+        XCTAssertEqual(product.weight, "213")
+        XCTAssertEqual(product.dimensions.length, "12")
+        XCTAssertEqual(product.dimensions.width, "33")
+        XCTAssertEqual(product.dimensions.height, "54")
+        XCTAssertEqual(product.downloads.first?.downloadID, "12345")
         XCTAssertEqual(product.backordersAllowed, true)
         XCTAssertEqual(product.onSale, false)
     }
diff --git a/Networking/NetworkingTests/Mapper/ProductVariationMapperTests.swift b/Networking/NetworkingTests/Mapper/ProductVariationMapperTests.swift
@@ -40,6 +40,8 @@ final class ProductVariationMapperTests: XCTestCase {
         XCTAssertFalse(productVariation.manageStock)
         XCTAssertTrue(productVariation.purchasable)
         XCTAssertEqual(productVariation.permalink, "")
+        XCTAssertEqual(productVariation.sku, "12345")
+        XCTAssertEqual(productVariation.weight, "2.5")
         XCTAssertEqual(productVariation.backordersAllowed, true)
         XCTAssertEqual(productVariation.onSale, false)
     }
diff --git a/Networking/NetworkingTests/Responses/order-alternative-types.json b/Networking/NetworkingTests/Responses/order-alternative-types.json
diff --git a/Networking/NetworkingTests/Responses/product-alternative-types.json b/Networking/NetworkingTests/Responses/product-alternative-types.json
diff --git a/Networking/NetworkingTests/Responses/product-variation-alternative-types.json b/Networking/NetworkingTests/Responses/product-variation-alternative-types.json
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt

Original file line number	Diff line number	Diff line change
`@@ -429,6 +429,15 @@ final class OrderMapperTests: XCTestCase {`
`429`	`429`	`XCTAssertNil(compositeProduct.parent)`
`430`	`430`	`XCTAssertEqual(component.parent, 830)`
`431`	`431`	`}`
	`432`	`+`
	`433`	`+ func test_that_order_alternative_types_are_properly_parsed() throws {`
	`434`	`+ // Given`
	`435`	`+ let order = try XCTUnwrap(mapLoadOrderResponseWithAlternativeTypes())`
	`436`	`+`
	`437`	`+ // Then`
	`438`	`+ XCTAssertEqual(order.shippingLines.first?.taxes.first?.taxID, 1)`
	`439`	`+ XCTAssertEqual(order.items.first?.sku, "123")`
	`440`	`+ }`
`432`	`441`	`}`
`433`	`442`
`434`	`443`
`@@ -531,4 +540,10 @@ private extension OrderMapperTests {`
`531`	`540`	`return mapOrder(from: "order-with-composite-product")`
`532`	`541`	`}`
`533`	`542`
	`543`	+ /// Returns the Order output upon receiving `order-alternative-types`
	`544`	`+ ///`
	`545`	`+ func mapLoadOrderResponseWithAlternativeTypes() -> Order? {`
	`546`	`+ return mapOrder(from: "order-alternative-types")`
	`547`	`+ }`
	`548`	`+`
`534`	`549`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ final class ProductVariationMapperTests: XCTestCase {`
`40`	`40`	`XCTAssertFalse(productVariation.manageStock)`
`41`	`41`	`XCTAssertTrue(productVariation.purchasable)`
`42`	`42`	`XCTAssertEqual(productVariation.permalink, "")`
	`43`	`+ XCTAssertEqual(productVariation.sku, "12345")`
	`44`	`+ XCTAssertEqual(productVariation.weight, "2.5")`
`43`	`45`	`XCTAssertEqual(productVariation.backordersAllowed, true)`
`44`	`46`	`XCTAssertEqual(productVariation.onSale, false)`
`45`	`47`	`}`