Refactor CardPresentPaymentsOnboardingUseCase to handle both plugins installed better

Author: koke

WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/CardPresentPaymentsOnboardingUseCase.swift

@@ -77,18 +77,6 @@ final class CardPresentPaymentsOnboardingUseCase: CardPresentPaymentsOnboardingU
             return
         }
 
-        let wcPayPlugin = cardPresentPluginsDataProvider.getWCPayPlugin()
-        let stripePlugin = cardPresentPluginsDataProvider.getStripePlugin()
-        let paymentPluginsInstalledAndActiveStatus = cardPresentPluginsDataProvider.paymentPluginsInstalledAndActiveStatus(wcPay: wcPayPlugin,
-                                                                                                                           stripe: stripePlugin)
-
-        /// If both plugins are active, don't bother initializing the backend nor fetching
-        /// accounts. Fall through to updateState so the end user can fix the problem.
-        guard paymentPluginsInstalledAndActiveStatus != .bothAreInstalledAndActive else {
-            self.updateState()
-            return
-        }
-
         let paymentGatewayAccountsAction = CardPresentPaymentAction.loadAccounts(siteID: siteID) { [weak self] result in
             self?.updateState()
         }
@@ -155,52 +143,48 @@ private extension CardPresentPaymentsOnboardingUseCase {
 
         let wcPay = cardPresentPluginsDataProvider.getWCPayPlugin()
         let stripe = cardPresentPluginsDataProvider.getStripePlugin()
-        let isStripeSupported = configuration.paymentGateways.contains(StripeAccount.gatewayID)
 
         // If isSupportedCountry is false, IPP is not supported in the country through any
         // payment gateway
         guard configuration.isSupportedCountry else {
             return .countryNotSupported(countryCode: countryCode)
         }
 
-        let paymentPluginsInstalledAndActiveStatus = cardPresentPluginsDataProvider.paymentPluginsInstalledAndActiveStatus(wcPay: wcPay, stripe: stripe)
-
-        // If it is supported in the country, we might or might not support Stripe yet, only WCPay
-        guard isStripeSupported else {
-            if paymentPluginsInstalledAndActiveStatus == .bothAreInstalledAndActive {
-                // They have WCPay and Stripe installed and active at the same time.
-                // Deactivating Stripe is the advised way to proceed.
-                return .pluginShouldBeDeactivated(plugin: .stripe)
-            } else if paymentPluginsInstalledAndActiveStatus == .onlyStripeIsInstalledAndActive {
-                // If we only support WCPay, we don't want to ask users to set up WCPay if they already
-                // have Stripe. In that case, we can tell them that IPP is not supported for Stripe in
-                // their country yet.
-                return .countryNotSupportedStripe(plugin: .stripe, countryCode: countryCode)
-            } else {
-                return wcPayOnlyOnboardingState(plugin: wcPay)
-            }
+        switch (wcPay, stripe) {
+        case (.some(let wcPay), nil):
+            return wcPayOnlyOnboardingState(plugin: wcPay)
+        case (nil, .some(let stripe)):
+            return stripeGatewayOnlyOnboardingState(plugin: stripe)
+        case (.some(let wcPay), .some(let stripe)):
+            return bothPluginsInstalledOnboardingState(wcPay: wcPay, stripe: stripe)
+        case (nil, nil):
+            return .pluginNotInstalled
         }
+    }
 
-        // If both the Stripe plugin and WCPay are installed and activated, the user needs
-        // to deactivate one: pdfdoF-fW-p2#comment-683
-        if paymentPluginsInstalledAndActiveStatus == .bothAreInstalledAndActive {
-            return .selectPlugin
+    func bothPluginsInstalledOnboardingState(wcPay: SystemPlugin, stripe: SystemPlugin) -> CardPresentPaymentOnboardingState {
+        switch (wcPay.active, stripe.active) {
+        case (true, true):
+            return bothPluginsInstalledAndActiveOnboardingState(wcPay: wcPay, stripe: stripe)
+        case (true, false):
+            return wcPayOnlyOnboardingState(plugin: wcPay)
+        case (false, true):
+            return stripeGatewayOnlyOnboardingState(plugin: stripe)
+        case (false, false):
+            return .pluginNotActivated(plugin: .wcPay)
         }
+    }
 
-        // If only the Stripe extension is installed, skip to checking Stripe activation and version
-        if let stripe = stripe,
-           paymentPluginsInstalledAndActiveStatus != .onlyWCPayIsInstalledAndActive {
-            return stripeGatewayOnlyOnboardingState(plugin: stripe)
-        } else {
-            return wcPayOnlyOnboardingState(plugin: wcPay)
+    func bothPluginsInstalledAndActiveOnboardingState(wcPay: SystemPlugin, stripe: SystemPlugin) -> CardPresentPaymentOnboardingState {
+        if !isStripeSupportedInCountry {
+            return .pluginShouldBeDeactivated(plugin: .stripe)
         }
+
+        return .selectPlugin
     }
 
-    func wcPayOnlyOnboardingState(plugin: SystemPlugin?) -> CardPresentPaymentOnboardingState {
+    func wcPayOnlyOnboardingState(plugin: SystemPlugin) -> CardPresentPaymentOnboardingState {
         // Plugin checks
-        guard let plugin = plugin else {
-            return .pluginNotInstalled
-        }
         guard cardPresentPluginsDataProvider.isWCPayVersionSupported(plugin: plugin)
         else {
             return .pluginUnsupportedVersion(plugin: .wcPay)
@@ -214,6 +198,14 @@ private extension CardPresentPaymentsOnboardingUseCase {
     }
 
     func stripeGatewayOnlyOnboardingState(plugin: SystemPlugin) -> CardPresentPaymentOnboardingState {
+        guard isStripeSupportedInCountry else {
+            guard let countryCode = storeCountryCode else {
+                DDLogError("[CardPresentPaymentsOnboarding] Couldn't determine country for store")
+                return .genericError
+            }
+            return .countryNotSupportedStripe(plugin: .stripe, countryCode: countryCode)
+        }
+
         guard cardPresentPluginsDataProvider.isStripeVersionSupported(plugin: plugin)
         else {
             return .pluginUnsupportedVersion(plugin: .stripe)
@@ -274,6 +266,10 @@ private extension CardPresentPaymentsOnboardingUseCase {
         return storeCountryCode.nonEmptyString()
     }
 
+    var isStripeSupportedInCountry: Bool {
+        configurationLoader.configuration.paymentGateways.contains(StripeAccount.gatewayID)
+    }
+
     // Note: This counts on synchronizeStoreCountryAndPlugins having been called to get
     // the appropriate account for the site, be that Stripe or WCPay
     func getPaymentGatewayAccount() -> PaymentGatewayAccount? {

WooCommerce/WooCommerceTests/ViewRelated/CardPresentPayments/CardPresentPaymentsOnboardingUseCaseTests.swift

@@ -177,6 +177,20 @@ class CardPresentPaymentsOnboardingUseCaseTests: XCTestCase {
         XCTAssertEqual(state, .pluginNotActivated(plugin: .stripe))
     }
 
+    func test_onboarding_returns_select_wcpay_plugin_not_activated_when_both_stripe_and_wcpay_plugins_are_installed_but_not_active() {
+        // Given
+        setupCountry(country: .us)
+        setupWCPayPlugin(status: .inactive, version: WCPayPluginVersion.minimumSupportedVersion)
+        setupStripePlugin(status: .inactive, version: StripePluginVersion.minimumSupportedVersion)
+
+        // When
+        let useCase = CardPresentPaymentsOnboardingUseCase(storageManager: storageManager, stores: stores)
+        let state = useCase.state
+
+        // Then
+        XCTAssertEqual(state, .pluginNotActivated(plugin: .wcPay))
+    }
+
     func test_onboarding_returns_select_plugin_when_both_stripe_and_wcpay_plugins_are_active() {
         // Given
         setupCountry(country: .us)
@@ -300,6 +314,21 @@ class CardPresentPaymentsOnboardingUseCaseTests: XCTestCase {
         XCTAssertEqual(state, .completed(plugin: .wcPay))
     }
 
+    func test_onboarding_returns_complete_when_wcpay_active_and_stripe_plugin_installed_but_not_active() {
+        // Given
+        setupCountry(country: .us)
+        setupWCPayPlugin(status: .active, version: WCPayPluginVersion.minimumSupportedVersion)
+        setupStripePlugin(status: .inactive, version: StripePluginVersion.minimumSupportedVersion)
+        setupPaymentGatewayAccount(accountType: WCPayAccount.self, status: .complete)
+
+        // When
+        let useCase = CardPresentPaymentsOnboardingUseCase(storageManager: storageManager, stores: stores)
+        let state = useCase.state
+
+        // Then
+        XCTAssertEqual(state, .completed(plugin: .wcPay))
+    }
+
     func test_onboarding_returns_complete_when_stripe_active_and_wcpay_plugin_installed_but_not_active() {
         // Given
         setupCountry(country: .us)

Yosemite/Yosemite/Model/Enums/CardPresentPaymentsPlugin.swift

@@ -12,6 +12,19 @@ public enum CardPresentPaymentsPlugin: Equatable, CaseIterable {
             return "WooCommerce Stripe Gateway"
         }
     }
+
+    public var gatewayID: String {
+        switch self {
+        case .wcPay:
+            return WCPayAccount.gatewayID
+        case .stripe:
+            return StripeAccount.gatewayID
+        }
+    }
+
+    public static func with(gatewayID: String) -> Self? {
+        allCases.first(where: { $0.gatewayID == gatewayID })
+    }
 }
 
 public struct PaymentPluginVersionSupport {