Skip to content

[Product Bundles] Add support for parent/child relationships between AggregateOrderItems #9777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2023
Merged

[Product Bundles] Add support for parent/child relationships between AggregateOrderItems #9777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions WooCommerce/Classes/Copiable/Models+Copiable.generated.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ extension WooCommerce.AggregateOrderItem {
sku: NullableCopiableProp<String> = .copy,
total: NullableCopiableProp<NSDecimalNumber> = .copy,
imageURL: NullableCopiableProp<URL> = .copy,
attributes: CopiableProp<[OrderItemAttribute]> = .copy
attributes: CopiableProp<[OrderItemAttribute]> = .copy,
parent: NullableCopiableProp<Int64> = .copy
) -> WooCommerce.AggregateOrderItem {
let itemID = itemID ?? self.itemID
let productID = productID ?? self.productID
Expand All @@ -28,6 +29,7 @@ extension WooCommerce.AggregateOrderItem {
let total = total ?? self.total
let imageURL = imageURL ?? self.imageURL
let attributes = attributes ?? self.attributes
let parent = parent ?? self.parent

return WooCommerce.AggregateOrderItem(
itemID: itemID,
Expand All @@ -39,7 +41,8 @@ extension WooCommerce.AggregateOrderItem {
sku: sku,
total: total,
imageURL: imageURL,
attributes: attributes
attributes: attributes,
parent: parent
)
}
}
Expand Down
16 changes: 11 additions & 5 deletions WooCommerce/Classes/Tools/AggregateData/AggregateDataHelper.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,16 @@ final class AggregateDataHelper {
.compactMap { currency.convertToDecimal($0.total) }
.reduce(NSDecimalNumber(value: 0), { $0.adding($1) })

let attributes = orderItems.first(where: {
// Find the order item matching this refund, to get its properties
let matchingOrderItem = orderItems.first(where: {
guard let refundedItemID = item.refundedItemID else {
return false
}

return $0.itemID == Int64(refundedItemID)
})?.attributes ?? []
})
let attributes = matchingOrderItem?.attributes ?? []
let parent = matchingOrderItem?.parent

return AggregateOrderItem(
itemID: key,
Expand All @@ -65,7 +68,8 @@ final class AggregateDataHelper {
quantity: totalQuantity,
sku: item.sku,
total: total,
attributes: attributes
attributes: attributes,
parent: parent
)
}

Expand Down Expand Up @@ -93,7 +97,8 @@ final class AggregateDataHelper {
quantity: item.quantity,
sku: item.sku,
total: total,
attributes: item.attributes
attributes: item.attributes,
parent: item.parent
)
}

Expand Down Expand Up @@ -128,7 +133,8 @@ final class AggregateDataHelper {
quantity: totalQuantity,
sku: item.sku,
total: total,
attributes: item.attributes
attributes: item.attributes,
parent: item.parent
)
}

Expand Down
8 changes: 7 additions & 1 deletion WooCommerce/Classes/ViewModels/Order Details/Aggregate Order Items/AggregateOrderItem.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ struct AggregateOrderItem: Equatable, GeneratedCopiable {

let attributes: [OrderItemAttribute]

/// Item ID of the parent order item, if any.
///
let parent: Int64?

/// Designated initializer.
///
init(itemID: String,
Expand All @@ -37,7 +41,8 @@ struct AggregateOrderItem: Equatable, GeneratedCopiable {
sku: String?,
total: NSDecimalNumber?,
imageURL: URL? = nil,
attributes: [OrderItemAttribute]) {
attributes: [OrderItemAttribute],
parent: Int64?) {
self.itemID = itemID
self.productID = productID
self.variationID = variationID
Expand All @@ -48,6 +53,7 @@ struct AggregateOrderItem: Equatable, GeneratedCopiable {
self.total = total
self.imageURL = imageURL
self.attributes = attributes
self.parent = parent
}
}

Expand Down
8 changes: 5 additions & 3 deletions .../Classes/ViewModels/Order Details/Shipping Labels/AggregatedShippingLabelOrderItems.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ private extension AggregatedShippingLabelOrderItems {
func orderItem(from model: OrderItemModel, quantity: Int) -> AggregateOrderItem {
switch model {
case .productName(let name):
return .init(itemID: "0", productID: 0, variationID: 0, name: name, price: nil, quantity: 0, sku: nil, total: nil, attributes: [])
return .init(itemID: "0", productID: 0, variationID: 0, name: name, price: nil, quantity: 0, sku: nil, total: nil, attributes: [], parent: nil)
case .product(let product, let orderItem, let name):
let itemID = orderItem?.itemID.description ?? "0"
let productName = orderItem?.name ?? name
Expand All @@ -131,7 +131,8 @@ private extension AggregatedShippingLabelOrderItems {
sku: orderItem?.sku ?? product.sku,
total: totalPrice,
imageURL: imageURL,
attributes: orderItem?.attributes ?? [])
attributes: orderItem?.attributes ?? [],
parent: orderItem?.parent)
case .productVariation(let variation, let orderItem, let name):
let itemID = orderItem?.itemID.description ?? "0"
let productName = orderItem?.name ?? name
Expand All @@ -153,7 +154,8 @@ private extension AggregatedShippingLabelOrderItems {
sku: orderItem?.sku ?? variation.sku,
total: totalPrice,
imageURL: imageURL,
attributes: orderItem?.attributes ?? [])
attributes: orderItem?.attributes ?? [],
parent: orderItem?.parent)
}
}

Expand Down
32 changes: 27 additions & 5 deletions WooCommerce/WooCommerceTests/Tools/AggregateDataHelperTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,23 @@ final class AggregateDataHelperTests: XCTestCase {
XCTAssertEqual(aggregatedOrderItems[0].attributes, testOrderItemAttributes)
}

func test_refunded_AggregateOrderItem_has_parent_from_OrderItem() throws {
// Given
let productID: Int64 = 1
let parentID: Int64 = 61
let orderItems = [MockOrderItem.sampleItem(itemID: parentID, productID: productID, quantity: 1),
MockOrderItem.sampleItem(itemID: 62, productID: productID, quantity: 1, parent: parentID)]
let refundItems = [MockRefunds.sampleRefundItem(productID: productID, refundedItemID: "62", quantity: 1)]
let refunds = [MockRefunds.sampleRefund(items: refundItems)]

// When
let aggregatedRefundItems = AggregateDataHelper.combineRefundedProducts(from: refunds, orderItems: orderItems)

// Then
let actualParentID = try XCTUnwrap(aggregatedRefundItems?.first).parent
XCTAssertEqual(actualParentID, parentID)
}

func test_two_order_items_with_same_productID_and_different_itemIDs_create_two_AggregateOrderItems() {
// Given
let productID: Int64 = 1
Expand Down Expand Up @@ -183,7 +200,8 @@ private extension AggregateDataHelperTests {
quantity: -1,
sku: "HOODIE-HAPPY-NINJA",
total: currencyFormatter.convertToDecimal("-31.50") ?? NSDecimalNumber.zero,
attributes: []
attributes: [],
parent: nil
)

let item1 = AggregateOrderItem(
Expand All @@ -195,7 +213,8 @@ private extension AggregateDataHelperTests {
quantity: -1,
sku: "T-SHIRT-NINJA-SILHOUETTE",
total: currencyFormatter.convertToDecimal("-18.00") ?? NSDecimalNumber.zero,
attributes: []
attributes: [],
parent: nil
)

let item2 = AggregateOrderItem(
Expand All @@ -207,7 +226,8 @@ private extension AggregateDataHelperTests {
quantity: -1,
sku: "HOODIE-SHIP-YOUR-IDEA-BLACK-L",
total: currencyFormatter.convertToDecimal("-31.50") ?? NSDecimalNumber.zero,
attributes: testOrderItemAttributes
attributes: testOrderItemAttributes,
parent: nil
)

let item3 = AggregateOrderItem(
Expand All @@ -219,7 +239,8 @@ private extension AggregateDataHelperTests {
quantity: -2,
sku: "HOODIE-WOO-LOGO",
total: currencyFormatter.convertToDecimal("-63.00") ?? NSDecimalNumber.zero,
attributes: []
attributes: [],
parent: nil
)

let item4 = AggregateOrderItem(
Expand All @@ -231,7 +252,8 @@ private extension AggregateDataHelperTests {
quantity: -3,
sku: "HOODIE-SHIP-YOUR-IDEA-BLUE-XL",
total: currencyFormatter.convertToDecimal("-81.00") ?? NSDecimalNumber.zero,
attributes: []
attributes: [],
parent: nil
)

return [item0, item1, item2, item3, item4]
Expand Down
3 changes: 2 additions & 1 deletion WooCommerce/WooCommerceTests/Tools/MockAggregateOrderItem.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public struct MockAggregateOrderItem {
quantity: 0,
sku: nil,
total: nil,
attributes: [])
attributes: [],
parent: nil)
}
}
2 changes: 1 addition & 1 deletion WooCommerce/WooCommerceTests/Tools/MockOrderItem.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ public struct MockOrderItem {
total: total,
totalTax: totalTax,
attributes: attributes,
parent: nil)
parent: parent)
}
}
6 changes: 4 additions & 2 deletions .../WooCommerceTests/ViewRelated/Orders/Order Details/ProductDetailsCellViewModelTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,8 @@ private extension ProductDetailsCellViewModelTests {
total: NSDecimalNumber?,
sku: String = "",
imageURL: URL? = nil,
attributes: [OrderItemAttribute] = []) -> AggregateOrderItem {
attributes: [OrderItemAttribute] = [],
parent: Int64? = nil) -> AggregateOrderItem {
AggregateOrderItem(itemID: "2",
productID: 1,
variationID: 6,
Expand All @@ -235,7 +236,8 @@ private extension ProductDetailsCellViewModelTests {
sku: sku,
total: total,
imageURL: imageURL,
attributes: attributes)
attributes: attributes,
parent: parent)
}

func makeOrderItemRefund(quantity: Decimal,
Expand Down
31 changes: 26 additions & 5 deletions ...Related/Orders/Order Details/Shipping Labels/AggregatedShippingLabelOrderItemsTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,16 @@ final class AggregatedShippingLabelOrderItemsTests: XCTestCase {

// Then
XCTAssertEqual(shippingLabelOrderItems, [
.init(itemID: "0", productID: 0, variationID: 0, name: "Password protected!", price: nil, quantity: 0, sku: nil, total: nil, attributes: [])
.init(itemID: "0",
productID: 0,
variationID: 0,
name: "Password protected!",
price: nil,
quantity: 0,
sku: nil,
total: nil,
attributes: [],
parent: nil)
])
XCTAssertEqual(shippingLabelOrderItems[0], aggregatedOrderItems.orderItem(of: shippingLabel, at: 0))
}
Expand Down Expand Up @@ -50,10 +59,20 @@ final class AggregatedShippingLabelOrderItemsTests: XCTestCase {
sku: orderItem1.sku,
total: 59.2,
imageURL: imageURL1,
attributes: orderItem1.attributes),
attributes: orderItem1.attributes,
parent: nil),
// Product with ID 3013 does not have a matching OrderItem so the price and SKU come from the Product.
// Since a Product's name could change, the name falls back to the name in shipping label's `productNames`.
.init(itemID: "0", productID: 3013, variationID: 0, name: "PW", price: 25.9, quantity: 3, sku: product2.sku, total: 77.7, attributes: [])
.init(itemID: "0",
productID: 3013,
variationID: 0,
name: "PW",
price: 25.9,
quantity: 3,
sku: product2.sku,
total: 77.7,
attributes: [],
parent: nil)
])
XCTAssertEqual(shippingLabelOrderItems[0], aggregatedOrderItems.orderItem(of: shippingLabel, at: 0))
XCTAssertEqual(shippingLabelOrderItems[1], aggregatedOrderItems.orderItem(of: shippingLabel, at: 1))
Expand Down Expand Up @@ -97,7 +116,8 @@ final class AggregatedShippingLabelOrderItemsTests: XCTestCase {
sku: orderItem.sku,
total: 25.9,
imageURL: imageURL,
attributes: orderItem.attributes)
attributes: orderItem.attributes,
parent: nil)
])
XCTAssertEqual(shippingLabelOrderItems[0], aggregatedOrderItems.orderItem(of: shippingLabel, at: 0))
}
Expand Down Expand Up @@ -131,7 +151,8 @@ final class AggregatedShippingLabelOrderItemsTests: XCTestCase {
sku: variation.sku,
total: 62,
imageURL: imageURL,
attributes: [])
attributes: [],
parent: nil)
])
XCTAssertEqual(shippingLabelOrderItems[0], aggregatedOrderItems.orderItem(of: shippingLabel, at: 0))
}
Expand Down
3 changes: 2 additions & 1 deletion ...erceTests/ViewRelated/Products/Product Loader/ProductLoaderViewControllerModelTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ private extension ProductLoaderViewControllerModelTests {
quantity: 3,
sku: nil,
total: 3.6,
attributes: [])
attributes: [],
parent: nil)
}

func makeTopEarnerStatsItem(productID: Int64) -> TopEarnerStatsItem {
Expand Down