Merge pull request #7056 from woocommerce/issue/6976-update-networking-with-is-editable

[Unified Order Editing] Update Order with new WC 6.6 properties

Author: Ecarrion

Fakes/Fakes/Networking.generated.swift

@@ -323,6 +323,9 @@ extension Order {
             parentID: .fake(),
             customerID: .fake(),
             orderKey: .fake(),
+            isEditable: .fake(),
+            needsPayment: .fake(),
+            needsProcessing: .fake(),
             number: .fake(),
             status: .fake(),
             currency: .fake(),

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

@@ -242,6 +242,9 @@ extension Order {
         parentID: CopiableProp<Int64> = .copy,
         customerID: CopiableProp<Int64> = .copy,
         orderKey: CopiableProp<String> = .copy,
+        isEditable: CopiableProp<Bool> = .copy,
+        needsPayment: CopiableProp<Bool> = .copy,
+        needsProcessing: CopiableProp<Bool> = .copy,
         number: CopiableProp<String> = .copy,
         status: CopiableProp<OrderStatusEnum> = .copy,
         currency: CopiableProp<String> = .copy,
@@ -273,6 +276,9 @@ extension Order {
         let parentID = parentID ?? self.parentID
         let customerID = customerID ?? self.customerID
         let orderKey = orderKey ?? self.orderKey
+        let isEditable = isEditable ?? self.isEditable
+        let needsPayment = needsPayment ?? self.needsPayment
+        let needsProcessing = needsProcessing ?? self.needsProcessing
         let number = number ?? self.number
         let status = status ?? self.status
         let currency = currency ?? self.currency
@@ -305,6 +311,9 @@ extension Order {
             parentID: parentID,
             customerID: customerID,
             orderKey: orderKey,
+            isEditable: isEditable,
+            needsPayment: needsPayment,
+            needsProcessing: needsProcessing,
             number: number,
             status: status,
             currency: currency,

Networking/Networking/Model/Order.swift

@@ -10,6 +10,9 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
     public let customerID: Int64
     public let orderKey: String
 
+    public let isEditable: Bool
+    public let needsPayment: Bool
+    public let needsProcessing: Bool
     public let number: String
     /// The Order status.
     ///
@@ -50,6 +53,9 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
                 parentID: Int64,
                 customerID: Int64,
                 orderKey: String,
+                isEditable: Bool,
+                needsPayment: Bool,
+                needsProcessing: Bool,
                 number: String,
                 status: OrderStatusEnum,
                 currency: String,
@@ -82,6 +88,9 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
         self.customerID = customerID
         self.orderKey = orderKey
 
+        self.isEditable = isEditable
+        self.needsPayment = needsPayment
+        self.needsProcessing = needsProcessing
         self.number = number
         self.status = status
         self.currency = currency
@@ -127,6 +136,11 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
         let customerID = try container.decode(Int64.self, forKey: .customerID)
         let orderKey = try container.decode(String.self, forKey: .orderKey)
 
+        // TODO: Update with local fallback implementation https://github.com/woocommerce/woocommerce-ios/issues/6977
+        let isEditable = try container.decodeIfPresent(Bool.self, forKey: .isEditable) ?? false
+        let needsPayment = try container.decodeIfPresent(Bool.self, forKey: .needsPayment) ?? false
+        let needsProcessing = try container.decodeIfPresent(Bool.self, forKey: .needsProcessing) ?? false
+
         let number = try container.decode(String.self, forKey: .number)
         let status = try container.decode(OrderStatusEnum.self, forKey: .status)
 
@@ -183,6 +197,9 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
                   parentID: parentID,
                   customerID: customerID,
                   orderKey: orderKey,
+                  isEditable: isEditable,
+                  needsPayment: needsPayment,
+                  needsProcessing: needsProcessing,
                   number: number,
                   status: status,
                   currency: currency,
@@ -216,6 +233,9 @@ public struct Order: Decodable, GeneratedCopiable, GeneratedFakeable {
                   parentID: 0,
                   customerID: 0,
                   orderKey: "",
+                  isEditable: false,
+                  needsPayment: false,
+                  needsProcessing: false,
                   number: "",
                   status: .pending,
                   currency: "",
@@ -255,6 +275,9 @@ internal extension Order {
         case customerID         = "customer_id"
         case orderKey           = "order_key"
 
+        case isEditable         = "is_editable"
+        case needsPayment       = "needs_payment"
+        case needsProcessing    = "needs_processing"
         case number             = "number"
         case status             = "status"
         case currency           = "currency"
@@ -297,6 +320,9 @@ extension Order: Equatable {
             lhs.parentID == rhs.parentID &&
             lhs.customerID == rhs.customerID &&
             lhs.orderKey == rhs.orderKey &&
+            lhs.isEditable == rhs.isEditable &&
+            lhs.needsPayment == rhs.needsPayment &&
+            lhs.needsProcessing == rhs.needsProcessing &&
             lhs.number == rhs.number &&
             lhs.status == rhs.status &&
             lhs.dateCreated == rhs.dateCreated &&

Networking/Networking/Remote/OrdersRemote.swift

@@ -294,7 +294,8 @@ public extension OrdersRemote {
         private static let commonOrderFieldValues = [
             "id", "parent_id", "number", "status", "currency", "customer_id", "customer_note", "date_created_gmt", "date_modified_gmt", "date_paid_gmt",
             "discount_total", "discount_tax", "shipping_total", "shipping_tax", "total", "total_tax", "payment_method", "payment_method_title",
-            "payment_url", "billing", "coupon_lines", "shipping_lines", "refunds", "fee_lines", "order_key", "tax_lines", "meta_data"
+            "payment_url", "billing", "coupon_lines", "shipping_lines", "refunds", "fee_lines", "order_key", "tax_lines", "meta_data", "is_editable",
+            "needs_payment", "needs_processing"
         ]
         // Use with caution. Any fields in here will be overwritten with empty values by
         // `Order+ReadOnlyConvertible.swift: Order.update(with:)` when the list of orders is fetched.

Networking/NetworkingTests/Remote/OrdersRemoteTests.swift

@@ -110,6 +110,26 @@ final class OrdersRemoteTests: XCTestCase {
         wait(for: [expectation], timeout: Constants.expectationTimeout)
     }
 
+    func test_load_single_order_properly_returns_WC6_6_new_fields() {
+        // Given
+        let remote = OrdersRemote(network: network)
+        network.simulateResponse(requestUrlSuffix: "orders/\(sampleOrderID)", filename: "order")
+
+        // When
+        let order: Order = waitFor { promise in
+            remote.loadOrder(for: self.sampleSiteID, orderID: self.sampleOrderID) { order, error in
+                if let order = order {
+                    promise(order)
+                }
+            }
+        }
+
+        // Then
+        XCTAssertTrue(order.isEditable)
+        XCTAssertTrue(order.needsPayment)
+        XCTAssertTrue(order.needsProcessing)
+    }
+
     /// Verifies that loadOrder properly relays any Networking Layer errors.
     ///
     func testLoadSingleOrderProperlyRelaysNetworkingErrors() {

Networking/NetworkingTests/Responses/order.json

@@ -2,6 +2,9 @@
     "data":              {
         "id": 963,
         "parent_id": 0,
+        "is_editable": true,
+        "needs_payment": true,
+        "needs_processing": true,
         "number": "963",
         "status": "processing",
         "order_key": "abc123",

Networking/NetworkingTests/Responses/orders-load-all.json

@@ -3,6 +3,9 @@
              {
              "id": 963,
              "parent_id": 0,
+             "is_editable": true,
+             "needs_payment": true,
+             "needs_processing": true,
              "number": "963",
              "status": "processing",
              "order_key": "abc123",

WooCommerce/Classes/ViewRelated/Orders/Order Details/Address Edit/EditOrderAddressForm.swift

@@ -431,6 +431,9 @@ struct EditAddressForm_Previews: PreviewProvider {
                                    parentID: 2,
                                    customerID: 11,
                                    orderKey: "",
+                                   isEditable: false,
+                                   needsPayment: false,
+                                   needsProcessing: false,
                                    number: "789",
                                    status: .processing,
                                    currency: "USD",

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Multi-package/ShippingLabelPackagesFormViewModel.swift

@@ -447,6 +447,9 @@ extension ShippingLabelPackagesFormViewModel {
                      parentID: 0,
                      customerID: 11,
                      orderKey: "",
+                     isEditable: false,
+                     needsPayment: false,
+                     needsProcessing: false,
                      number: "963",
                      status: .processing,
                      currency: "USD",

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/ShippingLabelSampleData.swift

@@ -11,6 +11,9 @@ enum ShippingLabelSampleData {
                      parentID: 0,
                      customerID: 11,
                      orderKey: "",
+                     isEditable: false,
+                     needsPayment: false,
+                     needsProcessing: false,
                      number: "963",
                      status: .processing,
                      currency: "USD",