Add missing attributes for ShippingLabelAccountSettings

Author: itsmeichigo

Modules/Sources/Storage/Model/MIGRATIONS.md

@@ -10,6 +10,7 @@ This file documents changes in the WCiOS Storage data model. Please explain any
   - Added `shipments` relationship to `Order` entity.
 - @itsmeichigo 2025-07-22
   - Added `WooShippingOriginAddress` entity.
+  - Added attributes `lastOrderCompleted` and `addPaymentMethodURL` to `ShippingLabelAccountSettings` entity.
 
 ## Model 123 (Release 22.8.0.0)
 - @iamgabrielma 2025-06-30

Modules/Sources/Storage/Model/ShippingLabelAccountSettings+CoreDataProperties.swift

@@ -12,13 +12,15 @@ extension ShippingLabelAccountSettings {
     @NSManaged public var canManagePayments: Bool
     @NSManaged public var isEmailReceiptsEnabled: Bool
     @NSManaged public var lastSelectedPackageID: String?
+    @NSManaged public var lastOrderCompleted: Bool
     @NSManaged public var paperSize: String?
     @NSManaged public var selectedPaymentMethodID: Int64
     @NSManaged public var siteID: Int64
     @NSManaged public var storeOwnerDisplayName: String?
     @NSManaged public var storeOwnerUsername: String?
     @NSManaged public var storeOwnerWpcomEmail: String?
     @NSManaged public var storeOwnerWpcomUsername: String?
+    @NSManaged public var addPaymentMethodURL: String?
     @NSManaged public var paymentMethods: Set<ShippingLabelPaymentMethod>?
 
 }

Modules/Sources/Storage/Resources/WooCommerce.xcdatamodeld/Model 124.xcdatamodel/contents

@@ -778,9 +778,11 @@
         <relationship name="shipment" optional="YES" maxCount="1" deletionRule="Nullify" destinationEntity="WooShippingShipment" inverseName="shippingLabel" inverseEntity="WooShippingShipment"/>
     </entity>
     <entity name="ShippingLabelAccountSettings" representedClassName="ShippingLabelAccountSettings" syncable="YES">
+        <attribute name="addPaymentMethodURL" optional="YES" attributeType="String"/>
         <attribute name="canEditSettings" attributeType="Boolean" usesScalarValueType="YES"/>
         <attribute name="canManagePayments" attributeType="Boolean" usesScalarValueType="YES"/>
         <attribute name="isEmailReceiptsEnabled" attributeType="Boolean" usesScalarValueType="YES"/>
+        <attribute name="lastOrderCompleted" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
         <attribute name="lastSelectedPackageID" attributeType="String" defaultValueString=""/>
         <attribute name="paperSize" attributeType="String"/>
         <attribute name="selectedPaymentMethodID" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES"/>

Modules/Sources/Yosemite/Model/Storage/ShippingLabelAccountSettings+ReadOnlyConvertible.swift

@@ -18,6 +18,8 @@ extension Storage.ShippingLabelAccountSettings: ReadOnlyConvertible {
         isEmailReceiptsEnabled = settings.isEmailReceiptsEnabled
         paperSize = settings.paperSize.rawValue
         lastSelectedPackageID = settings.lastSelectedPackageID
+        lastOrderCompleted = settings.lastOrderCompleted
+        addPaymentMethodURL = settings.addPaymentMethodURL?.absoluteString
     }
 
     /// Returns a ReadOnly version of the receiver.
@@ -26,7 +28,6 @@ extension Storage.ShippingLabelAccountSettings: ReadOnlyConvertible {
         let paymentMethodItems = paymentMethods?.map { $0.toReadOnly() } ?? []
 
         /// Since account settings are not persisted for the new shipping label flow,
-        /// the conversion for the new properties `addPaymentMethodURL` & `lastOrderCompleted` is ignored.
         /// This avoids the complication of unnecessary Core Data migration for the new properties.
         return ShippingLabelAccountSettings(siteID: siteID,
                                             canManagePayments: canManagePayments,
@@ -40,7 +41,7 @@ extension Storage.ShippingLabelAccountSettings: ReadOnlyConvertible {
                                             isEmailReceiptsEnabled: isEmailReceiptsEnabled,
                                             paperSize: .init(rawValue: paperSize ?? ""),
                                             lastSelectedPackageID: lastSelectedPackageID ?? "",
-                                            lastOrderCompleted: false,
-                                            addPaymentMethodURL: nil)
+                                            lastOrderCompleted: lastOrderCompleted,
+                                            addPaymentMethodURL: URL(string: addPaymentMethodURL ?? ""))
     }
 }

Modules/Tests/StorageTests/CoreData/MigrationTests.swift

@@ -3518,6 +3518,57 @@ final class MigrationTests: XCTestCase {
         let insertedAddress = try XCTUnwrap(targetContext.firstObject(ofType: WooShippingOriginAddress.self))
         XCTAssertEqual(insertedAddress, address)
     }
+
+    func test_migrating_from_123_to_124_adds_new_attributes_lastOrderCompleted_and_addPaymentMethodURL_to_ShippingLabelAccountSettings() throws {
+        // Given
+        let sourceContainer = try startPersistentContainer("Model 123")
+        let sourceContext = sourceContainer.viewContext
+
+        let object = sourceContext.insert(entityName: "ShippingLabelAccountSettings", properties: [
+            "siteID": 123,
+            "canEditSettings": false,
+            "canManagePayments": false,
+            "isEmailReceiptsEnabled": false,
+            "lastSelectedPackageID": "",
+            "paperSize": "",
+            "selectedPaymentMethodID": 0,
+            "storeOwnerDisplayName": "",
+            "storeOwnerUsername": "",
+            "storeOwnerWpcomEmail": "",
+            "storeOwnerWpcomUsername": ""
+        ])
+        try sourceContext.save()
+
+        // `lastOrderCompleted` and `addPaymentMethodURL` should not be present in model 122
+        XCTAssertNil(object.entity.attributesByName["lastOrderCompleted"], "Precondition. Attribute does not exist.")
+        XCTAssertNil(object.entity.attributesByName["addPaymentMethodURL"], "Precondition. Attribute does not exist.")
+
+        // When
+        let targetContainer = try migrate(sourceContainer, to: "Model 124")
+
+        // Then
+        let targetContext = targetContainer.viewContext
+        let migratedObject = try XCTUnwrap(targetContext.first(entityName: "ShippingLabelAccountSettings"))
+
+        // `lastOrderCompleted` should be present in model 124
+        XCTAssertNotNil(migratedObject.entity.attributesByName["lastOrderCompleted"])
+
+        // `addPaymentMethodURL` value should default as nil in model 124
+        let value = migratedObject.value(forKey: "addPaymentMethodURL") as? String
+        XCTAssertNil(value)
+
+        // `lastOrderCompleted` must be settable
+        migratedObject.setValue(true, forKey: "lastOrderCompleted")
+        try targetContext.save()
+        let updatedValue = migratedObject.value(forKey: "lastOrderCompleted") as? Bool
+        XCTAssertEqual(updatedValue, true)
+
+        // `addPaymentMethodURL` must be settable
+        migratedObject.setValue("https://example.com", forKey: "addPaymentMethodURL")
+        try targetContext.save()
+        let urlValue = migratedObject.value(forKey: "addPaymentMethodURL") as? String
+        XCTAssertEqual(urlValue, "https://example.com")
+    }
 }
 
 // MARK: - Persistent Store Setup and Migrations