Shipping Labels: Display label size from account settings as default (#15873)

Author: itsmeichigo

Modules/Sources/Yosemite/Stores/WooShippingStore.swift

@@ -192,7 +192,17 @@ private extension WooShippingStore {
 
     func loadAccountSettings(siteID: Int64,
                              completion: @escaping (Result<WooShippingAccountSettings, Error>) -> Void) {
-        remote.loadAccountSettings(siteID: siteID, completion: completion)
+        remote.loadAccountSettings(siteID: siteID, completion: { [weak self] result in
+            guard let self else { return }
+            switch result {
+            case .success(let settings):
+                upsertShippingLabelAccountSettingsInBackground(siteID: siteID, accountSettings: settings.accountSettings) {
+                    completion(.success(settings))
+                }
+            case .failure(let error):
+                completion(.failure(error))
+            }
+        })
     }
 
     func updateAccountSettings(siteID: Int64,
@@ -732,6 +742,29 @@ private extension WooShippingStore {
             storageShippingLabel.refund = nil
         }
     }
+
+    /// Updates/inserts the specified readonly shipping label account settings entity *in a background thread*.
+    /// `onCompletion` will be called on the main thread!
+    ///
+    func upsertShippingLabelAccountSettingsInBackground(siteID: Int64,
+                                                        accountSettings: ShippingLabelAccountSettings,
+                                                        onCompletion: @escaping () -> Void) {
+        storageManager.performAndSave({ storage in
+            let storageAccountSettings = storage.loadShippingLabelAccountSettings(siteID: siteID) ??
+                storage.insertNewObject(ofType: Storage.ShippingLabelAccountSettings.self)
+            storageAccountSettings.update(with: accountSettings)
+
+            // Remove all previous payment methods
+            storageAccountSettings.paymentMethods?.removeAll()
+
+            // Insert the payment methods from the read-only account settings
+            for paymentMethod in accountSettings.paymentMethods {
+                let newStoragePaymentMethod = storage.insertNewObject(ofType: Storage.ShippingLabelPaymentMethod.self)
+                newStoragePaymentMethod.update(with: paymentMethod)
+                storageAccountSettings.addToPaymentMethods(newStoragePaymentMethod)
+            }
+        }, completion: onCompletion, on: .main)
+    }
 }
 
 /// Represents errors that can be returned when purchasing a shipping label

Modules/Tests/YosemiteTests/Stores/WooShippingStoreTests.swift

@@ -2,6 +2,7 @@ import XCTest
 @testable import Yosemite
 @testable import Networking
 import protocol Storage.StorageType
+import class Storage.ShippingLabelPaymentMethod
 
 final class WooShippingStoreTests: XCTestCase {
 
@@ -365,6 +366,90 @@ final class WooShippingStoreTests: XCTestCase {
         XCTAssertEqual(receivedValue, [samplePackage])
     }
 
+    // MARK: `loadAccountSettings`
+
+    func test_loadAccountSettings_returns_success_response() throws {
+        // Given
+        let remote = MockWooShippingRemote()
+        let expectedSettings = WooShippingAccountSettings.fake()
+        remote.whenLoadAccountSettings(siteID: sampleSiteID, thenReturn: .success(expectedSettings))
+        let store = WooShippingStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
+
+        // When
+        let result: Result<WooShippingAccountSettings, Error> = waitFor { promise in
+            let action = WooShippingAction.loadAccountSettings(siteID: self.sampleSiteID) { result in
+                promise(result)
+            }
+            store.onAction(action)
+        }
+
+        // Then
+        XCTAssertTrue(result.isSuccess)
+        let actualSettings = try result.get()
+        XCTAssertEqual(actualSettings, expectedSettings)
+    }
+
+    func test_loadAccountSettings_returns_error_on_failure() throws {
+        // Given
+        let remote = MockWooShippingRemote()
+        let expectedError = NetworkError.notFound()
+        remote.whenLoadAccountSettings(siteID: sampleSiteID, thenReturn: .failure(expectedError))
+        let store = WooShippingStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
+
+        // When
+        let result: Result<WooShippingAccountSettings, Error> = waitFor { promise in
+            let action = WooShippingAction.loadAccountSettings(siteID: self.sampleSiteID) { result in
+                promise(result)
+            }
+            store.onAction(action)
+        }
+
+        // Then
+        XCTAssertTrue(result.isFailure)
+        let error = try XCTUnwrap(result.failure)
+        XCTAssertEqual(error as? NetworkError, expectedError)
+    }
+
+    func test_loadAccountSettings_when_successful_then_upserts_settings_into_storage() throws {
+        // Given
+        let remote = MockWooShippingRemote()
+        let paymentMethod = Yosemite.ShippingLabelPaymentMethod(
+            paymentMethodID: 1434,
+            name: "James Dean",
+            cardType: .visa,
+            cardDigits: "2352",
+            expiry: DateFormatter.Defaults.yearMonthDayDateFormatter.date(from: "2030-12-31")
+        )
+        let accountSettings = ShippingLabelAccountSettings.fake().copy(
+            siteID: sampleSiteID,
+            paymentMethods: [paymentMethod],
+            isEmailReceiptsEnabled: true,
+            paperSize: .a4
+        )
+        let expectedSettings = WooShippingAccountSettings.fake().copy(accountSettings: accountSettings)
+        remote.whenLoadAccountSettings(siteID: sampleSiteID, thenReturn: .success(expectedSettings))
+        let store = WooShippingStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
+
+        // Confidence check
+        XCTAssertEqual(storageManager.viewStorage.countObjects(ofType: StorageShippingLabelAccountSettings.self), 0)
+
+        // When
+        let onSuccess: Bool = waitFor { promise in
+            let action = WooShippingAction.loadAccountSettings(siteID: self.sampleSiteID) { result in
+                promise(result.isSuccess)
+            }
+            store.onAction(action)
+        }
+
+        // Then
+        XCTAssertTrue(onSuccess)
+        XCTAssertEqual(storageManager.viewStorage.countObjects(ofType: StorageShippingLabelAccountSettings.self), 1)
+        let storedSettings = try XCTUnwrap(storageManager.viewStorage.loadShippingLabelAccountSettings(siteID: sampleSiteID))
+        XCTAssertEqual(storedSettings.siteID, sampleSiteID)
+        XCTAssertEqual(storedSettings.toReadOnly(), accountSettings)
+        XCTAssertEqual(storageManager.viewStorage.countObjects(ofType: Storage.ShippingLabelPaymentMethod.self), 1)
+    }
+
     // MARK: `loadPackages`
 
     func test_loadPackages_returns_success_response_with_rates() throws {

RELEASE-NOTES.txt

@@ -9,6 +9,7 @@
 - [*] Shipping Labels: Enable the confirm button on the payment method sheet even when there are no changes. [https://github.com/woocommerce/woocommerce-ios/pull/15856]
 - [*] POS: start a new cart by scanning a barcode on the payment success screen [https://github.com/woocommerce/woocommerce-ios/pull/15870]
 - [*] Watch app: Fixed connection issue upon fresh install [https://github.com/woocommerce/woocommerce-ios/pull/15867]
+- [*] Shipping Labels: Display label size from account settings as default [https://github.com/woocommerce/woocommerce-ios/pull/15873]
 
 22.7
 -----

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShipping Post-Purchase/WooShippingPostPurchaseViewModel.swift

@@ -3,9 +3,11 @@ import Foundation
 import UIKit
 import Yosemite
 import WooFoundation
+import protocol Storage.StorageManagerType
 
 final class WooShippingPostPurchaseViewModel: ObservableObject {
     private let stores: StoresManager
+    private let storageManager: StorageManagerType
     private let siteID: Int64
     private let labelID: Int64
 
@@ -26,14 +28,27 @@ final class WooShippingPostPurchaseViewModel: ObservableObject {
     /// Customs form URL for the shipping label
     let commercialInvoiceURL: URL?
 
+    /// Shipping Label Account Settings ResultsController
+    ///
+    private lazy var accountSettingsResultsController: ResultsController<StorageShippingLabelAccountSettings> = {
+        let predicate = NSPredicate(format: "siteID == %lld", siteID)
+        return ResultsController<StorageShippingLabelAccountSettings>(
+            storageManager: storageManager,
+            matching: predicate,
+            fetchLimit: 1,
+            sortedBy: []
+        )
+    }()
+
     init(siteID: Int64,
          labelID: Int64,
          labelSizes: [ShippingLabelPaperSize],
          isRefundable: Bool,
          trackingURL: URL?,
          pickupURL: URL?,
          commercialInvoiceURL: URL?,
-         stores: StoresManager = ServiceLocator.stores) {
+         stores: StoresManager = ServiceLocator.stores,
+         storageManager: StorageManagerType = ServiceLocator.storageManager) {
         self.siteID = siteID
         self.labelID = labelID
         self.labelSizes = labelSizes
@@ -42,15 +57,20 @@ final class WooShippingPostPurchaseViewModel: ObservableObject {
         self.pickupURL = pickupURL
         self.commercialInvoiceURL = commercialInvoiceURL
         self.stores = stores
+        self.storageManager = storageManager
+
+        configureAccountSettingsResultsController()
     }
 
     convenience init(shippingLabel: ShippingLabel,
                      siteAddress: SiteAddress = SiteAddress(),
-                     stores: StoresManager = ServiceLocator.stores) {
+                     stores: StoresManager = ServiceLocator.stores,
+                     storageManager: StorageManagerType = ServiceLocator.storageManager) {
         // Label sizes aren't provided by the API, so we can hard-code them to match the extension behavior:
+        // Ref: https://github.com/woocommerce/woocommerce-shipping/blob/trunk/client/components/label-purchase/label/utils.ts
         let labelSizes = {
             var availableLabelSizes: [ShippingLabelPaperSize] = [.label, .letter]
-            if [.US, .CA, .MX, .DO].contains(siteAddress.countryCode) {
+            if [.US, .CA, .MX, .DO].contains(siteAddress.countryCode) == false {
                 availableLabelSizes.append(.a4)
             }
             return availableLabelSizes
@@ -71,7 +91,8 @@ final class WooShippingPostPurchaseViewModel: ObservableObject {
                   trackingURL: trackingURL,
                   pickupURL: pickupURL,
                   commercialInvoiceURL: commercialInvoiceURL,
-                  stores: stores)
+                  stores: stores,
+                  storageManager: storageManager)
     }
 
     /// Fetches the shipping label in the selected paper size and presents the print dialog.
@@ -89,6 +110,26 @@ final class WooShippingPostPurchaseViewModel: ObservableObject {
 }
 
 private extension WooShippingPostPurchaseViewModel {
+    /// Shipping Label Account Settings ResultsController monitoring
+    ///
+    func configureAccountSettingsResultsController() {
+        accountSettingsResultsController.onDidChangeContent = { [weak self] in
+            self?.updateSelectedLabelSize()
+        }
+
+        accountSettingsResultsController.onDidResetContent = { [weak self] in
+            self?.updateSelectedLabelSize()
+        }
+
+        try? accountSettingsResultsController.performFetch()
+        updateSelectedLabelSize()
+    }
+
+    func updateSelectedLabelSize() {
+        guard let fetchedAccountSettings = accountSettingsResultsController.fetchedObjects.first else { return }
+        selectedLabelSize = fetchedAccountSettings.paperSize
+    }
+
     /// Requests the shipping label data for printing.
     @MainActor
     func requestPrintData() async throws -> ShippingLabelPrintData {

WooCommerce/WooCommerceTests/ViewRelated/Shipping Label/WooShipping Create Shipping Labels/WooShippingPostPurchaseViewModelTests.swift

@@ -4,6 +4,13 @@ import Yosemite
 
 final class WooShippingPostPurchaseViewModelTests: XCTestCase {
 
+    private var storageManager: MockStorageManager!
+
+    override func setUp() {
+        super.setUp()
+        storageManager = MockStorageManager()
+    }
+
     func test_inits_with_provided_properties() {
         // Given
         let labelSizes: [ShippingLabelPaperSize] = [.label, .letter, .a4]
@@ -27,30 +34,40 @@ final class WooShippingPostPurchaseViewModelTests: XCTestCase {
         XCTAssertEqual(viewModel.commercialInvoiceURL, customsFormURL)
     }
 
-    func test_labelSizes_includes_expected_default_values() {
-        // Given
-        let countrySetting = SiteSetting.fake().copy(settingID: "woocommerce_default_country",
-                                                  value: "GB")
-        let siteAddress = SiteAddress(siteSettings: [countrySetting])
+    func test_labelSizes_excludes_a4_for_north_american_countries() {
+        let northAmericanCountries = ["US", "CA", "MX", "DO"]
 
-        // When
-        let viewModel = WooShippingPostPurchaseViewModel(shippingLabel: ShippingLabel.fake(), siteAddress: siteAddress)
+        for countryCode in northAmericanCountries {
+            // Given
+            let countrySetting = SiteSetting.fake().copy(settingID: "woocommerce_default_country",
+                                                      value: countryCode)
+            let siteAddress = SiteAddress(siteSettings: [countrySetting])
 
-        // Then
-        assertEqual([.label, .letter], viewModel.labelSizes)
+            // When
+            let viewModel = WooShippingPostPurchaseViewModel(shippingLabel: ShippingLabel.fake(),
+                                                             siteAddress: siteAddress)
+
+            // Then
+            assertEqual([.label, .letter], viewModel.labelSizes)
+        }
     }
 
-    func test_labelSizes_includes_expected_values_for_country_with_a4_label_size() {
-        // Given
-        let countrySetting = SiteSetting.fake().copy(settingID: "woocommerce_default_country",
-                                                  value: "US:NY")
-        let siteAddress = SiteAddress(siteSettings: [countrySetting])
+    func test_labelSizes_includes_a4_for_non_north_american_countries() {
+        let nonNorthAmericanCountries = ["GB", "FR", "DE", "IT", "ES", "NL", "AU", "JP"]
 
-        // When
-        let viewModel = WooShippingPostPurchaseViewModel(shippingLabel: ShippingLabel.fake(), siteAddress: siteAddress)
+        for countryCode in nonNorthAmericanCountries {
+            // Given
+            let countrySetting = SiteSetting.fake().copy(settingID: "woocommerce_default_country",
+                                                      value: countryCode)
+            let siteAddress = SiteAddress(siteSettings: [countrySetting])
 
-        // Then
-        assertEqual([.label, .letter, .a4], viewModel.labelSizes)
+            // When
+            let viewModel = WooShippingPostPurchaseViewModel(shippingLabel: ShippingLabel.fake(),
+                                                             siteAddress: siteAddress)
+
+            // Then
+            assertEqual([.label, .letter, .a4], viewModel.labelSizes)
+        }
     }
 
     func test_trackingURL_parsed_from_shipping_label() {
@@ -111,4 +128,37 @@ final class WooShippingPostPurchaseViewModelTests: XCTestCase {
         // Then
         XCTAssertNotNil(printData)
     }
+
+    func test_selectedLabelSize_defaults_to_label() {
+        // Given & When
+        let viewModel = WooShippingPostPurchaseViewModel(shippingLabel: ShippingLabel.fake(), storageManager: storageManager)
+
+        // Then
+        XCTAssertEqual(viewModel.selectedLabelSize, .label)
+    }
+
+    func test_selectedLabelSize_initialized_from_account_settings() {
+        // Given
+        let siteID: Int64 = 123
+
+        // Insert account settings with A4 paper size
+        let settings = ShippingLabelAccountSettings.fake().copy(siteID: siteID, paperSize: .a4)
+        insertShippingLabelAccountSettings(readonlySettings: settings)
+
+        // When
+        let viewModel = WooShippingPostPurchaseViewModel(
+            shippingLabel: ShippingLabel.fake().copy(siteID: siteID),
+            storageManager: storageManager
+        )
+
+        // Then
+        XCTAssertEqual(viewModel.selectedLabelSize, .a4)
+    }
+}
+
+private extension WooShippingPostPurchaseViewModelTests {
+    func insertShippingLabelAccountSettings(readonlySettings: ShippingLabelAccountSettings) {
+        let storageSettings = storageManager.viewStorage.insertNewObject(ofType: StorageShippingLabelAccountSettings.self)
+        storageSettings.update(with: readonlySettings)
+    }
 }