Add experimental flag for In-Person Payments in Canada

koke · koke · commit 2ebd5755228e · 2022-02-01T13:40:01.000+01:00
diff --git a/Storage/Storage/Model/Copiable/Models+Copiable.generated.swift b/Storage/Storage/Model/Copiable/Models+Copiable.generated.swift
@@ -11,6 +11,7 @@ extension GeneralAppSettings {
         isViewAddOnsSwitchEnabled: CopiableProp<Bool> = .copy,
         isOrderCreationSwitchEnabled: CopiableProp<Bool> = .copy,
         isStripeInPersonPaymentsSwitchEnabled: CopiableProp<Bool> = .copy,
+        isCanadaInPersonPaymentsSwitchEnabled: CopiableProp<Bool> = .copy,
         isProductSKUInputScannerSwitchEnabled: CopiableProp<Bool> = .copy,
         knownCardReaders: CopiableProp<[String]> = .copy,
         lastEligibilityErrorInfo: NullableCopiableProp<EligibilityErrorInfo> = .copy,
@@ -21,6 +22,7 @@ extension GeneralAppSettings {
         let isViewAddOnsSwitchEnabled = isViewAddOnsSwitchEnabled ?? self.isViewAddOnsSwitchEnabled
         let isOrderCreationSwitchEnabled = isOrderCreationSwitchEnabled ?? self.isOrderCreationSwitchEnabled
         let isStripeInPersonPaymentsSwitchEnabled = isStripeInPersonPaymentsSwitchEnabled ?? self.isStripeInPersonPaymentsSwitchEnabled
+        let isCanadaInPersonPaymentsSwitchEnabled = isCanadaInPersonPaymentsSwitchEnabled ?? self.isCanadaInPersonPaymentsSwitchEnabled
         let isProductSKUInputScannerSwitchEnabled = isProductSKUInputScannerSwitchEnabled ?? self.isProductSKUInputScannerSwitchEnabled
         let knownCardReaders = knownCardReaders ?? self.knownCardReaders
         let lastEligibilityErrorInfo = lastEligibilityErrorInfo ?? self.lastEligibilityErrorInfo
@@ -32,6 +34,7 @@ extension GeneralAppSettings {
             isViewAddOnsSwitchEnabled: isViewAddOnsSwitchEnabled,
             isOrderCreationSwitchEnabled: isOrderCreationSwitchEnabled,
             isStripeInPersonPaymentsSwitchEnabled: isStripeInPersonPaymentsSwitchEnabled,
+            isCanadaInPersonPaymentsSwitchEnabled: isCanadaInPersonPaymentsSwitchEnabled,
             isProductSKUInputScannerSwitchEnabled: isProductSKUInputScannerSwitchEnabled,
             knownCardReaders: knownCardReaders,
             lastEligibilityErrorInfo: lastEligibilityErrorInfo,
diff --git a/Storage/Storage/Model/GeneralAppSettings.swift b/Storage/Storage/Model/GeneralAppSettings.swift
@@ -32,6 +32,10 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
     ///
     public let isStripeInPersonPaymentsSwitchEnabled: Bool
 
+    /// The state for the In-Person Payments in Canada feature switch
+    ///
+    public let isCanadaInPersonPaymentsSwitchEnabled: Bool
+
     /// The state(`true` or `false`) for the Product SKU Input Scanner feature switch.
     ///
     public let isProductSKUInputScannerSwitchEnabled: Bool
@@ -53,6 +57,7 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
                 isViewAddOnsSwitchEnabled: Bool,
                 isOrderCreationSwitchEnabled: Bool,
                 isStripeInPersonPaymentsSwitchEnabled: Bool,
+                isCanadaInPersonPaymentsSwitchEnabled: Bool,
                 isProductSKUInputScannerSwitchEnabled: Bool,
                 knownCardReaders: [String],
                 lastEligibilityErrorInfo: EligibilityErrorInfo? = nil,
@@ -62,6 +67,7 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
         self.isViewAddOnsSwitchEnabled = isViewAddOnsSwitchEnabled
         self.isOrderCreationSwitchEnabled = isOrderCreationSwitchEnabled
         self.isStripeInPersonPaymentsSwitchEnabled = isStripeInPersonPaymentsSwitchEnabled
+        self.isCanadaInPersonPaymentsSwitchEnabled = isCanadaInPersonPaymentsSwitchEnabled
         self.isProductSKUInputScannerSwitchEnabled = isProductSKUInputScannerSwitchEnabled
         self.knownCardReaders = knownCardReaders
         self.lastEligibilityErrorInfo = lastEligibilityErrorInfo
@@ -91,6 +97,7 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
             isViewAddOnsSwitchEnabled: isViewAddOnsSwitchEnabled,
             isOrderCreationSwitchEnabled: isOrderCreationSwitchEnabled,
             isStripeInPersonPaymentsSwitchEnabled: isStripeInPersonPaymentsSwitchEnabled,
+            isCanadaInPersonPaymentsSwitchEnabled: isCanadaInPersonPaymentsSwitchEnabled,
             isProductSKUInputScannerSwitchEnabled: isProductSKUInputScannerSwitchEnabled,
             knownCardReaders: knownCardReaders,
             lastEligibilityErrorInfo: lastEligibilityErrorInfo
@@ -110,6 +117,7 @@ extension GeneralAppSettings {
         self.isViewAddOnsSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isViewAddOnsSwitchEnabled) ?? false
         self.isOrderCreationSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isOrderCreationSwitchEnabled) ?? false
         self.isStripeInPersonPaymentsSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isStripeInPersonPaymentsSwitchEnabled) ?? false
+        self.isCanadaInPersonPaymentsSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isCanadaInPersonPaymentsSwitchEnabled) ?? false
         self.isProductSKUInputScannerSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isProductSKUInputScannerSwitchEnabled) ?? false
         self.knownCardReaders = try container.decodeIfPresent([String].self, forKey: .knownCardReaders) ?? []
         self.lastEligibilityErrorInfo = try container.decodeIfPresent(EligibilityErrorInfo.self, forKey: .lastEligibilityErrorInfo)
diff --git a/Storage/StorageTests/Model/AppSettings/GeneralAppSettingsTests.swift b/Storage/StorageTests/Model/AppSettings/GeneralAppSettingsTests.swift
@@ -63,6 +63,7 @@ final class GeneralAppSettingsTests: XCTestCase {
                                                   isViewAddOnsSwitchEnabled: true,
                                                   isOrderCreationSwitchEnabled: true,
                                                   isStripeInPersonPaymentsSwitchEnabled: true,
+                                                  isCanadaInPersonPaymentsSwitchEnabled: true,
                                                   isProductSKUInputScannerSwitchEnabled: true,
                                                   knownCardReaders: readers,
                                                   lastEligibilityErrorInfo: eligibilityInfo,
@@ -84,6 +85,7 @@ final class GeneralAppSettingsTests: XCTestCase {
         assertEqual(newSettings.isViewAddOnsSwitchEnabled, false)
         assertEqual(newSettings.isOrderCreationSwitchEnabled, true)
         assertEqual(newSettings.isStripeInPersonPaymentsSwitchEnabled, true)
+        assertEqual(newSettings.isCanadaInPersonPaymentsSwitchEnabled, true)
         assertEqual(newSettings.isProductSKUInputScannerSwitchEnabled, true)
         assertEqual(newSettings.lastJetpackBenefitsBannerDismissedTime, jetpackBannerDismissedDate)
     }
@@ -95,6 +97,7 @@ private extension GeneralAppSettingsTests {
                                   isViewAddOnsSwitchEnabled: Bool = false,
                                   isOrderCreationSwitchEnabled: Bool = false,
                                   isStripeInPersonPaymentsSwitchEnabled: Bool = false,
+                                  isCanadaInPersonPaymentsSwitchEnabled: Bool = false,
                                   isProductSKUInputScannerSwitchEnabled: Bool = false,
                                   knownCardReaders: [String] = [],
                                   lastEligibilityErrorInfo: EligibilityErrorInfo? = nil,
@@ -104,6 +107,7 @@ private extension GeneralAppSettingsTests {
                            isViewAddOnsSwitchEnabled: isViewAddOnsSwitchEnabled,
                            isOrderCreationSwitchEnabled: isOrderCreationSwitchEnabled,
                            isStripeInPersonPaymentsSwitchEnabled: isStripeInPersonPaymentsSwitchEnabled,
+                           isCanadaInPersonPaymentsSwitchEnabled: isCanadaInPersonPaymentsSwitchEnabled,
                            isProductSKUInputScannerSwitchEnabled: isProductSKUInputScannerSwitchEnabled,
                            knownCardReaders: knownCardReaders,
                            lastEligibilityErrorInfo: lastEligibilityErrorInfo,
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/Settings/Beta features/BetaFeaturesViewController.swift b/WooCommerce/Classes/ViewRelated/Dashboard/Settings/Beta features/BetaFeaturesViewController.swift
@@ -95,12 +95,21 @@ private extension BetaFeaturesViewController {
     }
 
     func inPersonPaymentsSection() -> Section? {
-        guard ServiceLocator.featureFlagService.isFeatureFlagEnabled(.stripeExtensionInPersonPayments) else {
+        var rows: [Row] = []
+
+        if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.stripeExtensionInPersonPayments) {
+            rows += [.stripeExtensionInPersonPayments, .stripeExtensionInPersonPaymentsDescription]
+        }
+
+        if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.canadaInPersonPayments) {
+            rows += [.canadaInPersonPayments, .canadaInPersonPaymentsDescription]
+        }
+
+        guard rows.isNotEmpty else {
             return nil
         }
 
-        return Section(rows: [.stripeExtensionInPersonPayments,
-                              .stripeExtensionInPersonPaymentsDescription])
+        return Section(rows: rows)
     }
 
     func productSKUInputScannerSection() -> Section? {
@@ -144,6 +153,11 @@ private extension BetaFeaturesViewController {
             configureStripeExtensionInPersonPaymentsSwitch(cell: cell)
         case let cell as BasicTableViewCell where row == .stripeExtensionInPersonPaymentsDescription:
             configureStripeExtensionInPersonPaymentsDescription(cell: cell)
+        // In-Person Payments in Canada
+        case let cell as SwitchTableViewCell where row == .canadaInPersonPayments:
+            configureCanadaInPersonPaymentsSwitch(cell: cell)
+        case let cell as BasicTableViewCell where row == .canadaInPersonPaymentsDescription:
+            configureCanadaInPersonPaymentsDescription(cell: cell)
         // Product SKU Input Scanner
         case let cell as SwitchTableViewCell where row == .productSKUInputScanner:
             configureProductSKUInputScannerSwitch(cell: cell)
@@ -251,6 +265,37 @@ private extension BetaFeaturesViewController {
         cell.textLabel?.text = Localization.stripeExtensionInPersonPaymentsDescription
     }
 
+    func configureCanadaInPersonPaymentsSwitch(cell: SwitchTableViewCell) {
+        configureCommonStylesForSwitchCell(cell)
+        cell.title = Localization.canadaExtensionInPersonPaymentsTitle
+
+        // Fetch switch's state stored value.
+        let action = AppSettingsAction.loadCanadaInPersonPaymentsSwitchState { result in
+            guard let isEnabled = try? result.get() else {
+                return cell.isOn = false
+            }
+            cell.isOn = isEnabled
+        }
+        ServiceLocator.stores.dispatch(action)
+
+        // Change switch's state stored value
+        cell.onChange = { isSwitchOn in
+            let action = AppSettingsAction.setCanadaInPersonPaymentsSwitchState(isEnabled: isSwitchOn, onCompletion: { result in
+                // Roll back toggle if an error occurred
+                if result.isFailure {
+                    cell.isOn.toggle()
+                }
+            })
+            ServiceLocator.stores.dispatch(action)
+        }
+        cell.accessibilityIdentifier = "beta-features-canada-in-person-payments-cell"
+    }
+
+    func configureCanadaInPersonPaymentsDescription(cell: BasicTableViewCell) {
+        configureCommonStylesForDescriptionCell(cell)
+        cell.textLabel?.text = Localization.canadaExtensionInPersonPaymentsDescription
+    }
+
     func configureProductSKUInputScannerSwitch(cell: SwitchTableViewCell) {
         configureCommonStylesForSwitchCell(cell)
         cell.title = Localization.productSKUInputScannerTitle
@@ -353,15 +398,19 @@ private enum Row: CaseIterable {
     case stripeExtensionInPersonPayments
     case stripeExtensionInPersonPaymentsDescription
 
+    // In-Person Payments in Canada
+    case canadaInPersonPayments
+    case canadaInPersonPaymentsDescription
+
     // Product SKU Input Scanner
     case productSKUInputScanner
     case productSKUInputScannerDescription
 
     var type: UITableViewCell.Type {
         switch self {
-        case .orderAddOns, .orderCreation, .stripeExtensionInPersonPayments, .productSKUInputScanner:
+        case .orderAddOns, .orderCreation, .stripeExtensionInPersonPayments, .canadaInPersonPayments, .productSKUInputScanner:
             return SwitchTableViewCell.self
-        case .orderAddOnsDescription, .orderCreationDescription, .stripeExtensionInPersonPaymentsDescription, .productSKUInputScannerDescription:
+        case .orderAddOnsDescription, .orderCreationDescription, .stripeExtensionInPersonPaymentsDescription, .canadaInPersonPaymentsDescription, .productSKUInputScannerDescription:
             return BasicTableViewCell.self
         }
     }
@@ -396,6 +445,13 @@ private extension BetaFeaturesViewController {
             comment: "Cell description on beta features screen to enable accepting in-person payments for stores with " +
             "the WooCommerce Stripe Payment Gateway extension")
 
+        static let canadaExtensionInPersonPaymentsTitle = NSLocalizedString(
+            "In-Person Payments in Canada",
+            comment: "Cell title on beta features screen to enable accepting in-person payments for stores in Canada ")
+        static let canadaExtensionInPersonPaymentsDescription = NSLocalizedString(
+            "Test out In-Person Payments in Canada",
+            comment: "Cell description on beta features screen to enable accepting in-person payments for stores in Canada")
+
         static let productSKUInputScannerTitle = NSLocalizedString(
             "Product SKU Scanner",
             comment: "Cell title on beta features screen to enable product SKU input scanner in inventory settings.")
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/CardPresentPaymentsOnboardingUseCase.swift b/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/CardPresentPaymentsOnboardingUseCase.swift
@@ -31,6 +31,7 @@ final class CardPresentPaymentsOnboardingUseCase: CardPresentPaymentsOnboardingU
     let storageManager: StorageManagerType
     let stores: StoresManager
     private var stripeGatewayIPPEnabled: Bool?
+    private var canadaIPPEnabled: Bool?
 
     @Published var state: CardPresentPaymentOnboardingState = .loading
 
@@ -44,16 +45,31 @@ final class CardPresentPaymentsOnboardingUseCase: CardPresentPaymentsOnboardingU
     ) {
         self.storageManager = storageManager
         self.stores = stores
-        let action = AppSettingsAction.loadStripeInPersonPaymentsSwitchState(onCompletion: { [weak self] result in
+
+        let stripeAction = AppSettingsAction.loadStripeInPersonPaymentsSwitchState(onCompletion: { [weak self] result in
             switch result {
             case .success(let stripeGatewayIPPEnabled):
                 self?.stripeGatewayIPPEnabled = stripeGatewayIPPEnabled
             default:
                 break
             }
-            self?.updateState()
         })
-        stores.dispatch(action)
+        stores.dispatch(stripeAction)
+
+        let canadaAction = AppSettingsAction.loadCanadaInPersonPaymentsSwitchState(onCompletion: { [weak self]  result in
+            switch result {
+            case .success(let canadaIPPEnabled):
+                self?.canadaIPPEnabled = canadaIPPEnabled
+            default:
+                break
+            }
+        })
+        stores.dispatch(canadaAction)
+
+        // At the time of writing, actions are dispatched and processed synchronously, so the completion blocks for
+        // loadStripeInPersonPaymentsSwitchState and loadCanadaInPersonPaymentsSwitchState should have been called already.
+        // We defer updating the state until all settings are read to prevent unnecessary checks.
+        updateState()
     }
 
     func refresh() {
@@ -256,7 +272,7 @@ private extension CardPresentPaymentsOnboardingUseCase {
     }
 
     func isCountrySupported(plugin: CardPresentPaymentsPlugins, countryCode: String) -> Bool {
-        return plugin.supportedCountryCodes.contains(countryCode)
+        return supportedCountryCodes(plugin: plugin).contains(countryCode)
     }
 
     func getWCPayPlugin() -> SystemPlugin? {
@@ -362,13 +378,13 @@ private extension PaymentGatewayAccount {
     }
 }
 
-private extension CardPresentPaymentsPlugins {
+private extension CardPresentPaymentsOnboardingUseCase {
     // This was moved from Yosemite so it can check the feature flag
-    // In a future iteration, we might want to store all the configuration in the WooCommerce layer
-    var supportedCountryCodes: [String] {
-        switch self {
+    // In a future iteration, we might want to store all the configuration in a better place
+    func supportedCountryCodes(plugin: CardPresentPaymentsPlugins) -> [String] {
+        switch plugin {
         case .wcPay:
-            if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.canadaInPersonPayments) {
+            if canadaIPPEnabled == true {
                 return ["US", "CA"]
             } else {
                 return ["US"]
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/CardPresentPayments/CardPresentPaymentsOnboardingUseCaseTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/CardPresentPayments/CardPresentPaymentsOnboardingUseCaseTests.swift
@@ -24,6 +24,8 @@ class CardPresentPaymentsOnboardingUseCaseTests: XCTestCase {
             switch action {
             case .loadStripeInPersonPaymentsSwitchState(let completion):
                 completion(.success(true))
+            case .loadCanadaInPersonPaymentsSwitchState(let completion):
+                completion(.success(true))
             default:
                 break
             }
@@ -323,7 +325,11 @@ class CardPresentPaymentsOnboardingUseCaseTests: XCTestCase {
         _ = CardPresentPaymentsOnboardingUseCase(storageManager: storageManager, stores: stores)
 
         // Then
-        XCTAssertEqual(stores.receivedActions.count, 2)
+
+        // AppSettingsAction.loadStripeInPersonPaymentsSwitchState
+        // + AppSettingsAction.loadCanadaInPersonPaymentsSwitchState
+        // + CardPresentPaymentAction.use
+        XCTAssertEqual(stores.receivedActions.count, 3)
         let action = try XCTUnwrap(stores.receivedActions.last as? CardPresentPaymentAction)
 
         switch action {
@@ -369,7 +375,11 @@ class CardPresentPaymentsOnboardingUseCaseTests: XCTestCase {
         _ = CardPresentPaymentsOnboardingUseCase(storageManager: storageManager, stores: stores)
 
         // Then
-        XCTAssertEqual(stores.receivedActions.count, 2)
+
+        // AppSettingsAction.loadStripeInPersonPaymentsSwitchState
+        // + AppSettingsAction.loadCanadaInPersonPaymentsSwitchState
+        // + CardPresentPaymentAction.use
+        XCTAssertEqual(stores.receivedActions.count, 3)
         let action = try XCTUnwrap(stores.receivedActions.last as? CardPresentPaymentAction)
 
         switch action {
diff --git a/Yosemite/Yosemite/Actions/AppSettingsAction.swift b/Yosemite/Yosemite/Actions/AppSettingsAction.swift
@@ -136,6 +136,14 @@ public enum AppSettingsAction: Action {
     ///
     case setStripeInPersonPaymentsSwitchState(isEnabled: Bool, onCompletion: (Result<Void, Error>) -> Void)
 
+    /// Loads the most recent state for the In-Person Payments in Canada beta feature switch
+    ///
+    case loadCanadaInPersonPaymentsSwitchState(onCompletion: (Result<Bool, Error>) -> Void)
+
+    /// Sets the state for the In-Person Payments in Canada beta feature switch
+    ///
+    case setCanadaInPersonPaymentsSwitchState(isEnabled: Bool, onCompletion: (Result<Void, Error>) -> Void)
+
     /// Sets the state for the Product SKU Input Scanner beta feature switch.
     ///
     case setProductSKUInputScannerFeatureSwitchState(isEnabled: Bool, onCompletion: (Result<Void, Error>) -> Void)
diff --git a/Yosemite/Yosemite/Stores/AppSettingsStore.swift b/Yosemite/Yosemite/Stores/AppSettingsStore.swift
diff --git a/Yosemite/YosemiteTests/Stores/AppSettings/InAppFeedbackCardVisibilityUseCaseTests.swift b/Yosemite/YosemiteTests/Stores/AppSettings/InAppFeedbackCardVisibilityUseCaseTests.swift
diff --git a/Yosemite/YosemiteTests/Stores/AppSettingsStoreTests.swift b/Yosemite/YosemiteTests/Stores/AppSettingsStoreTests.swift
