Improve data fetching in Order Details, to avoid I/O performance on the main thread (#14999)

Author: itsmeichigo

Fakes/Fakes/Networking.generated.swift

@@ -871,7 +871,8 @@ extension Networking.Order {
             customFields: .fake(),
             renewalSubscriptionID: .fake(),
             appliedGiftCards: .fake(),
-            attributionInfo: .fake()
+            attributionInfo: .fake(),
+            shippingLabels: .fake()
         )
     }
 }

Networking/Networking.xcodeproj/project.pbxproj

@@ -472,6 +472,11 @@
 		453954D22C90D84200A3E64A /* meta-data-products-and-orders.json in Resources */ = {isa = PBXBuildFile; fileRef = 453954D12C90D84200A3E64A /* meta-data-products-and-orders.json */; };
 		453954D42C90E81300A3E64A /* MetaDataRemoteTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 453954D32C90E81300A3E64A /* MetaDataRemoteTests.swift */; };
 		453954D62C9193BC00A3E64A /* meta-data-products-orders-update.json in Resources */ = {isa = PBXBuildFile; fileRef = 453954D52C9193BC00A3E64A /* meta-data-products-orders-update.json */; };
+		453B33FD2D47F1F4005C05B0 /* ShippingLabel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C254A7256373AB00A04423 /* ShippingLabel.swift */; };
+		453B33FE2D47F1FB005C05B0 /* ShippingLabelStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C254AB2563781800A04423 /* ShippingLabelStatus.swift */; };
+		453B33FF2D47F203005C05B0 /* ShippingLabelRefund.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C2549F25636F6900A04423 /* ShippingLabelRefund.swift */; };
+		453B34002D47F20A005C05B0 /* ShippingLabelRefundStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C254AF256378D000A04423 /* ShippingLabelRefundStatus.swift */; };
+		453B34012D47F22C005C05B0 /* ShippingLabelAddress.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02C2549925636E1500A04423 /* ShippingLabelAddress.swift */; };
 		45551F122523E7F1007EF104 /* UserAgent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45551F112523E7F1007EF104 /* UserAgent.swift */; };
 		45551F142523E7FF007EF104 /* UserAgentTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45551F132523E7FF007EF104 /* UserAgentTests.swift */; };
 		4568E2222459ADC60007E478 /* SitePostsRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4568E2212459ADC60007E478 /* SitePostsRemote.swift */; };
@@ -5014,11 +5019,13 @@
 				2680B0D22BED5A4C00E7F1D8 /* AuthenticatedRESTRequest.swift in Sources */,
 				2680B0D02BED5A1900E7F1D8 /* WooConstants.swift in Sources */,
 				2680B0CF2BED59CE00E7F1D8 /* ApplicationPasswordStorage.swift in Sources */,
+				453B34002D47F20A005C05B0 /* ShippingLabelRefundStatus.swift in Sources */,
 				2680B0CB2BED58B200E7F1D8 /* ApplicationPasswordNameAndUUID.swift in Sources */,
 				26373E0A2BFCEAAF008E6735 /* OrderItemTax.swift in Sources */,
 				2680B0CC2BED58B200E7F1D8 /* ApplicationPassword.swift in Sources */,
 				26373E122BFCEDB7008E6735 /* OrderFeeLine.swift in Sources */,
 				26F2CADD2BED579100F9A5E7 /* ApplicationPasswordUseCase.swift in Sources */,
+				453B33FF2D47F203005C05B0 /* ShippingLabelRefund.swift in Sources */,
 				26F2CADA2BED578200F9A5E7 /* RequestProcessor.swift in Sources */,
 				26F2CADB2BED578200F9A5E7 /* RequestAuthenticator.swift in Sources */,
 				26F2CADC2BED578200F9A5E7 /* RequestConverter.swift in Sources */,
@@ -5031,6 +5038,7 @@
 				263A6DBC2BEAA49B00C292B2 /* AnyDecodable.swift in Sources */,
 				263A6DBD2BEAA49B00C292B2 /* AnyEncodable.swift in Sources */,
 				263A6DB92BEAA46F00C292B2 /* SiteSummaryStatsMapper.swift in Sources */,
+				453B33FD2D47F1F4005C05B0 /* ShippingLabel.swift in Sources */,
 				26373E112BFCEDAE008E6735 /* OrderRefundCondensed.swift in Sources */,
 				263A6DBA2BEAA46F00C292B2 /* SiteSummaryStats.swift in Sources */,
 				263A6DB62BEAA46000C292B2 /* SiteVisitStatsMapper.swift in Sources */,
@@ -5089,6 +5097,7 @@
 				26CFDEE12C0295EA005ABC31 /* MetaContainer.swift in Sources */,
 				26373E152BFCEDE9008E6735 /* OrderGiftCard.swift in Sources */,
 				269014CB2BEA9253006056E0 /* JetpackRequest.swift in Sources */,
+				453B34012D47F22C005C05B0 /* ShippingLabelAddress.swift in Sources */,
 				269014CA2BEA924B006056E0 /* NetworkError.swift in Sources */,
 				26373E092BFCEA90008E6735 /* OrderItemProductAddOn.swift in Sources */,
 				26373E162BFCEDFD008E6735 /* OrderAttributionInfo.swift in Sources */,
@@ -5101,6 +5110,7 @@
 				269014C32BEA9134006056E0 /* Mapper.swift in Sources */,
 				269014C22BEA912D006056E0 /* Request.swift in Sources */,
 				26373E182BFCEF79008E6735 /* KeyedDecodingContainer+Woo.swift in Sources */,
+				453B33FE2D47F1FB005C05B0 /* ShippingLabelStatus.swift in Sources */,
 				26373E202BFCF6A7008E6735 /* EntityDateModifiedMapper.swift in Sources */,
 				26CFDEE02C0295E1005ABC31 /* NoteRange.swift in Sources */,
 				26CFDEDE2C0295CB005ABC31 /* NoteBlock.swift in Sources */,

Networking/Networking/Model/Copiable/Models+Copiable.generated.swift

@@ -1395,7 +1395,8 @@ extension Networking.Order {
         customFields: CopiableProp<[MetaData]> = .copy,
         renewalSubscriptionID: NullableCopiableProp<String> = .copy,
         appliedGiftCards: CopiableProp<[OrderGiftCard]> = .copy,
-        attributionInfo: NullableCopiableProp<OrderAttributionInfo> = .copy
+        attributionInfo: NullableCopiableProp<OrderAttributionInfo> = .copy,
+        shippingLabels: CopiableProp<[ShippingLabel]> = .copy
     ) -> Networking.Order {
         let siteID = siteID ?? self.siteID
         let orderID = orderID ?? self.orderID
@@ -1435,6 +1436,7 @@ extension Networking.Order {
         let renewalSubscriptionID = renewalSubscriptionID ?? self.renewalSubscriptionID
         let appliedGiftCards = appliedGiftCards ?? self.appliedGiftCards
         let attributionInfo = attributionInfo ?? self.attributionInfo
+        let shippingLabels = shippingLabels ?? self.shippingLabels
 
         return Networking.Order(
             siteID: siteID,
@@ -1474,7 +1476,8 @@ extension Networking.Order {
             customFields: customFields,
             renewalSubscriptionID: renewalSubscriptionID,
             appliedGiftCards: appliedGiftCards,
-            attributionInfo: attributionInfo
+            attributionInfo: attributionInfo,
+            shippingLabels: shippingLabels
         )
     }
 }

Networking/Networking/Model/Order.swift

@@ -61,6 +61,10 @@ public struct Order: Decodable, Sendable, GeneratedCopiable, GeneratedFakeable {
     ///
     public let attributionInfo: OrderAttributionInfo?
 
+    /// Shipping labels associated with the order
+    ///
+    public let shippingLabels: [ShippingLabel]
+
     /// Order struct initializer.
     ///
     public init(siteID: Int64,
@@ -100,7 +104,8 @@ public struct Order: Decodable, Sendable, GeneratedCopiable, GeneratedFakeable {
                 customFields: [MetaData],
                 renewalSubscriptionID: String?,
                 appliedGiftCards: [OrderGiftCard],
-                attributionInfo: OrderAttributionInfo?) {
+                attributionInfo: OrderAttributionInfo?,
+                shippingLabels: [ShippingLabel]) {
 
         self.siteID = siteID
         self.orderID = orderID
@@ -145,6 +150,7 @@ public struct Order: Decodable, Sendable, GeneratedCopiable, GeneratedFakeable {
         self.renewalSubscriptionID = renewalSubscriptionID
         self.appliedGiftCards = appliedGiftCards
         self.attributionInfo = attributionInfo
+        self.shippingLabels = shippingLabels
     }
 
 
@@ -239,6 +245,11 @@ public struct Order: Decodable, Sendable, GeneratedCopiable, GeneratedFakeable {
             return OrderAttributionInfo(metaData: allOrderMetaData)
         }()
 
+        // Shipping labels
+        /// This will be an empty array by default because it's not directly parsed from the Order details, so it won't be decoded.
+        /// It's fetched with a specific API request, while at the same time it has a relationship in Core Data with Order.
+        let shippingLabels: [ShippingLabel] = []
+
         self.init(siteID: siteID,
                   orderID: orderID,
                   parentID: parentID,
@@ -276,7 +287,8 @@ public struct Order: Decodable, Sendable, GeneratedCopiable, GeneratedFakeable {
                   customFields: customFields,
                   renewalSubscriptionID: renewalSubscriptionID,
                   appliedGiftCards: appliedGiftCards,
-                  attributionInfo: attributionInfo)
+                  attributionInfo: attributionInfo,
+                  shippingLabels: shippingLabels)
     }
 
     public static var empty: Order {
@@ -317,7 +329,8 @@ public struct Order: Decodable, Sendable, GeneratedCopiable, GeneratedFakeable {
                   customFields: [],
                   renewalSubscriptionID: nil,
                   appliedGiftCards: [],
-                  attributionInfo: nil)
+                  attributionInfo: nil,
+                  shippingLabels: [])
     }
 }
 
@@ -365,6 +378,7 @@ internal extension Order {
         case taxLines           = "tax_lines"
         case metadata           = "meta_data"
         case giftCards          = "gift_cards"
+        case shippingLabels     = "shipping_labels"
     }
 }
 
@@ -407,7 +421,8 @@ extension Order: Equatable {
             lhs.items.count == rhs.items.count &&
             lhs.items.sorted() == rhs.items.sorted() &&
             lhs.customerNote == rhs.customerNote &&
-            lhs.attributionInfo == rhs.attributionInfo
+            lhs.attributionInfo == rhs.attributionInfo &&
+            lhs.shippingLabels == rhs.shippingLabels
     }
 }
 

Networking/Networking/Model/ShippingLabel/Enums/ShippingLabelRefundStatus.swift

@@ -2,7 +2,7 @@ import Foundation
 import Codegen
 
 /// The status of shipping label refund.
-public enum ShippingLabelRefundStatus: GeneratedFakeable {
+public enum ShippingLabelRefundStatus: Sendable, GeneratedFakeable {
     case pending
     case unknown
 }

Networking/Networking/Model/ShippingLabel/Enums/ShippingLabelStatus.swift

@@ -2,7 +2,7 @@ import Foundation
 import Codegen
 
 /// The status of shipping label.
-public enum ShippingLabelStatus: GeneratedFakeable {
+public enum ShippingLabelStatus: Sendable, GeneratedFakeable {
     case purchased
     case purchaseError
     case purchaseInProgress

Networking/Networking/Model/ShippingLabel/ShippingLabel.swift

@@ -3,7 +3,7 @@ import Codegen
 
 /// Represents a Shipping Label.
 ///
-public struct ShippingLabel: Equatable, GeneratedCopiable, GeneratedFakeable {
+public struct ShippingLabel: Equatable, Sendable, GeneratedCopiable, GeneratedFakeable {
     /// The remote ID of the site that owns this shipping label.
     public let siteID: Int64
 

Networking/Networking/Model/ShippingLabel/ShippingLabelAddress.swift

@@ -3,7 +3,7 @@ import Codegen
 
 /// Represents a Shipping Label Address.
 ///
-public struct ShippingLabelAddress: GeneratedCopiable, Equatable, GeneratedFakeable {
+public struct ShippingLabelAddress: GeneratedCopiable, Equatable, Sendable, GeneratedFakeable {
     /// The name of the company at the address.
     public let company: String
 

Networking/Networking/Model/ShippingLabel/ShippingLabelRefund.swift

@@ -3,7 +3,7 @@ import Codegen
 
 /// Represents a Shipping Label Refund.
 ///
-public struct ShippingLabelRefund: Equatable, GeneratedFakeable {
+public struct ShippingLabelRefund: Equatable, Sendable, GeneratedFakeable {
     /// The date of refund request.
     public let dateRequested: Date
 

RELEASE-NOTES.txt

@@ -3,8 +3,8 @@
 
 22.1
 -----
-
 - [*] Order Creation: Fixed an issue where order recalculation would stop working after canceling a confirmation with unsaved changes [https://github.com/woocommerce/woocommerce-ios/pull/15392].
+- [internal] Improve data fetching in Order Details, to avoid I/O performance on the main thread. [https://github.com/woocommerce/woocommerce-ios/pull/14999]
 
 22.0
 -----