Shipping Labels: Show shipment details on order details screen (#15889)

Author: itsmeichigo

Modules/Sources/Networking/Model/ShippingLabel/Shipments/WooShippingShipmentItem.swift

@@ -49,3 +49,10 @@ public struct WooShippingShipmentItem: Codable, Equatable, GeneratedFakeable, Ge
 }
 
 public typealias WooShippingShipments = [String: [WooShippingShipmentItem]]
+
+public extension WooShippingShipmentItem {
+    var quantity: Decimal {
+        guard let subItems else { return 0 }
+        return subItems.count > 0 ? Decimal(subItems.count) : 1
+    }
+}

Modules/Sources/Yosemite/Stores/WooShippingStore.swift

@@ -326,7 +326,12 @@ private extension WooShippingStore {
                 // If label has PURCHASED status, stop polling
                 if labelStatusResponse.status == .purchased,
                    let label = labelStatusResponse.getPurchasedLabel() {
-                    completion(.success(label))
+                    guard let self else {
+                        return completion(.success(label))
+                    }
+                    insertPurchasedLabelInBackground(siteID: siteID, orderID: orderID, shippingLabel: label) {
+                        completion(.success(label))
+                    }
                 }
 
                 // If label has PURCHASE_ERROR status, return error and stop polling
@@ -410,7 +415,23 @@ private extension WooShippingStore {
                         orderID: Int64,
                         shipmentToUpdate: WooShippingUpdateShipment,
                         completion: @escaping (Result<WooShippingShipments, Error>) -> Void) {
-        remote.updateShipment(siteID: siteID, orderID: orderID, shipmentToUpdate: shipmentToUpdate, completion: completion)
+        remote.updateShipment(siteID: siteID, orderID: orderID, shipmentToUpdate: shipmentToUpdate) { [weak self] result in
+            guard let self, let contents = try? result.get() else {
+                return completion(result)
+            }
+            let shipments = contents.map { (index, items) in
+                WooShippingShipment(siteID: siteID,
+                                    orderID: orderID,
+                                    index: index,
+                                    items: items,
+                                    shippingLabel: nil)
+            }
+            upsertShipmentsInBackground(siteID: siteID,
+                                        orderID: orderID,
+                                        shipments: shipments) {
+                completion(.success(contents))
+            }
+        }
     }
 }
 
@@ -644,10 +665,15 @@ private extension WooShippingStore {
                 DDLogWarn("⚠️ No shipping label found in storage when updating refund")
                 return shippingLabel.copy(refund: refund)
             }
+            let storageShipment = storageShippingLabel.shipment
 
             let storageRefund = storageShippingLabel.refund ?? storage.insertNewObject(ofType: Storage.ShippingLabelRefund.self)
             storageRefund.update(with: refund)
             storageShippingLabel.refund = storageRefund
+
+            // update stored shipment to trigger onDidChangeContent notification
+            storageShipment?.shippingLabel = storageShippingLabel
+
             return storageShippingLabel.toReadOnly()
 
         }, completion: { result in
@@ -676,6 +702,28 @@ private extension WooShippingStore {
         }, completion: nil, on: .main)
     }
 
+    /// Inserts the specified readonly shipping label entity *in a background thread*.
+    /// `onCompletion` will be called on the main thread!
+    func insertPurchasedLabelInBackground(siteID: Int64,
+                                          orderID: Int64,
+                                          shippingLabel: ShippingLabel,
+                                          onCompletion: @escaping () -> Void) {
+        storageManager.performAndSave({ [weak self] storage in
+            guard let self else { return }
+
+            let storageOrder = storage.loadOrder(siteID: siteID, orderID: orderID)
+            let storageShipment = storage.loadAllShipments(siteID: siteID, orderID: orderID)
+                .first(where: { $0.index == shippingLabel.shipmentID })
+
+            guard let storageOrder, let storageShipment else { return }
+
+            update(storageShipment: storageShipment,
+                   storageOrder: storageOrder,
+                   shippingLabel: shippingLabel,
+                   using: storage)
+        }, completion: onCompletion, on: .main)
+    }
+
     /// Updates/inserts the specified readonly shipments entities *in a background thread*.
     /// `onCompletion` will be called on the main thread!
     func upsertShipmentsInBackground(siteID: Int64,

Modules/Tests/YosemiteTests/Stores/WooShippingStoreTests.swift

@@ -531,17 +531,22 @@ final class WooShippingStoreTests: XCTestCase {
 
     // MARK: `purchaseShippingLabel`
 
-    func test_purchaseShippingLabel_returns_shipping_label_on_success() throws {
+    func test_purchaseShippingLabel_returns_shipping_label_on_success_and_persists_label_in_storage() throws {
         // Given
-        let expectedLabel = ShippingLabel.fake().copy(shippingLabelID: 13579)
+        let expectedLabel = ShippingLabel.fake().copy(siteID: sampleSiteID, orderID: sampleOrderID, shippingLabelID: 13579, shipmentID: "0")
         let labelStatusResponse = ShippingLabelStatusPollingResponse.purchased(expectedLabel)
         let remote = MockWooShippingRemote()
         remote.whenPurchaseShippingLabel(siteID: sampleSiteID, thenReturn: .success([ShippingLabelPurchase.fake().copy(shippingLabelID: 13579)]))
         remote.whenCheckLabelStatus(siteID: sampleSiteID, thenReturn: .success(labelStatusResponse))
+
+        let order = insertOrder(siteID: sampleSiteID, orderID: sampleOrderID)
+        let shipment = insertShipment(siteID: sampleSiteID, orderID: sampleOrderID, index: "0")
+        shipment.order = order
+
         let store = WooShippingStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
 
         // When
-        let result: Result<ShippingLabel, Error> = waitFor { promise in
+        let result: Result<ShippingLabel, Error> = waitFor(timeout: 10) { promise in
             let action = WooShippingAction.purchaseShippingLabel(siteID: self.sampleSiteID,
                                                                  orderID: self.sampleOrderID,
                                                                  originAddress: .fake(),
@@ -558,6 +563,15 @@ final class WooShippingStoreTests: XCTestCase {
         XCTAssertTrue(result.isSuccess)
         let actualLabel = try XCTUnwrap(result.get())
         XCTAssertEqual(actualLabel, expectedLabel)
+
+        // label is persisted
+        let storedLabels = storageManager.viewStorage.loadAllShippingLabels(siteID: sampleSiteID, orderID: sampleOrderID)
+        XCTAssertEqual(storedLabels.count, 1)
+        XCTAssertEqual(storedLabels.first?.shippingLabelID, expectedLabel.shippingLabelID)
+
+        let storedShipments = storageManager.viewStorage.loadAllShipments(siteID: sampleSiteID, orderID: sampleOrderID)
+        XCTAssertEqual(storedShipments.count, 1)
+        XCTAssertEqual(storedShipments.first?.shippingLabel?.shippingLabelID, expectedLabel.shippingLabelID)
     }
 
     func test_purchaseShippingLabel_returns_error_on_purchaseShippingLabel_request_failure() throws {
@@ -1037,11 +1051,13 @@ final class WooShippingStoreTests: XCTestCase {
 
     // MARK: `updateShipment`
 
-    func test_updateShipment_returns_success_response() throws {
+    func test_updateShipment_returns_success_response_and_persists_shipments() throws {
         // Given
         let remote = MockWooShippingRemote()
         let expected = ["0": [WooShippingShipmentItem.fake()]]
         remote.whenUpdatingShipment(siteID: sampleSiteID, thenReturn: .success(expected))
+
+        insertOrder(siteID: sampleSiteID, orderID: sampleOrderID)
         let store = WooShippingStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
 
         // When
@@ -1057,6 +1073,10 @@ final class WooShippingStoreTests: XCTestCase {
         // Then
         let actual = try XCTUnwrap(result.get())
         XCTAssertEqual(actual, expected)
+
+        let storedShipments = storageManager.viewStorage.loadAllShipments(siteID: sampleSiteID, orderID: sampleOrderID)
+        XCTAssertEqual(storedShipments.count, 1)
+        XCTAssertEqual(storedShipments.first?.index, "0")
     }
 
     func test_updateShipment_returns_error_on_failure() throws {
@@ -1088,16 +1108,18 @@ final class WooShippingStoreTests: XCTestCase {
         let sampleOrderID: Int64 = 134
         let remote = MockWooShippingRemote()
         let expectedRefund = Yosemite.ShippingLabelRefund(dateRequested: Date(), status: .pending)
-        let shippingLabel = MockShippingLabel.emptyLabel().copy(siteID: sampleSiteID, orderID: sampleOrderID, shippingLabelID: 123)
+        let shippingLabel = MockShippingLabel.emptyLabel().copy(siteID: sampleSiteID, orderID: sampleOrderID, shippingLabelID: 123, shipmentID: "0")
 
         remote.whenRefundingShippingLabel(siteID: shippingLabel.siteID,
                                           orderID: shippingLabel.orderID,
                                           shippingLabelID: shippingLabel.shippingLabelID,
                                           thenReturn: .success(expectedRefund))
         let store = WooShippingStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
 
+        let shipment = insertShipment(siteID: sampleSiteID, orderID: sampleOrderID, index: "0")
         // Inserts a shipping label without a refund.
-        insertShippingLabel(shippingLabel)
+        let storedLabel = insertShippingLabel(shippingLabel)
+        shipment.shippingLabel = storedLabel
 
         XCTAssertEqual(viewStorage.countObjects(ofType: StorageShippingLabel.self), 1)
         XCTAssertEqual(viewStorage.countObjects(ofType: StorageShippingLabelRefund.self), 0)
@@ -1121,6 +1143,10 @@ final class WooShippingStoreTests: XCTestCase {
 
         XCTAssertEqual(viewStorage.countObjects(ofType: StorageShippingLabel.self), 1)
         XCTAssertEqual(viewStorage.countObjects(ofType: StorageShippingLabelRefund.self), 1)
+
+        let storedShipments = viewStorage.loadAllShipments(siteID: sampleSiteID, orderID: sampleOrderID)
+        XCTAssertEqual(storedShipments.first?.shippingLabel?.shippingLabelID, shippingLabel.shippingLabelID)
+        XCTAssertNotNil(storedShipments.first?.shippingLabel?.refund)
     }
 
     func test_refundShippingLabel_returns_error_on_failure() throws {
@@ -1390,15 +1416,28 @@ private extension WooShippingStoreTests {
                                                                                                  groupId: "")])])
     }
 
-    func insertShippingLabel(_ readOnlyShippingLabel: Yosemite.ShippingLabel) {
+    @discardableResult
+    func insertShippingLabel(_ readOnlyShippingLabel: Yosemite.ShippingLabel) -> StorageShippingLabel {
         let shippingLabel = viewStorage.insertNewObject(ofType: StorageShippingLabel.self)
         shippingLabel.update(with: readOnlyShippingLabel)
+        return shippingLabel
     }
 
-    func insertOrder(siteID: Int64, orderID: Int64) {
+    @discardableResult
+    func insertOrder(siteID: Int64, orderID: Int64) -> StorageOrder {
         let order = viewStorage.insertNewObject(ofType: StorageOrder.self)
         order.siteID = siteID
         order.orderID = orderID
         order.statusKey = ""
+        return order
+    }
+
+    @discardableResult
+    func insertShipment(siteID: Int64, orderID: Int64, index: String) -> StorageWooShippingShipment {
+        let shipment = viewStorage.insertNewObject(ofType: StorageWooShippingShipment.self)
+        shipment.siteID = siteID
+        shipment.orderID = orderID
+        shipment.index = index
+        return shipment
     }
 }

RELEASE-NOTES.txt

@@ -3,6 +3,7 @@
 
 22.9
 -----
+- [**] Order Details: Update Shipping Labels section for stores with Woo Shipping extension [https://github.com/woocommerce/woocommerce-ios/pull/15889]
 - [*] Order List: New orders made through Point of Sale are now filterable via the Order List filters menu [https://github.com/woocommerce/woocommerce-ios/pull/15910]
 
 22.8