Merge pull request #6151 from woocommerce/issue/6149-coupons-experimental-feature

Coupons: Add coupon management to experimental features

Author: itsmeichigo

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

@@ -13,6 +13,7 @@ extension GeneralAppSettings {
         isStripeInPersonPaymentsSwitchEnabled: CopiableProp<Bool> = .copy,
         isCanadaInPersonPaymentsSwitchEnabled: CopiableProp<Bool> = .copy,
         isProductSKUInputScannerSwitchEnabled: CopiableProp<Bool> = .copy,
+        isCouponManagementSwitchEnabled: CopiableProp<Bool> = .copy,
         knownCardReaders: CopiableProp<[String]> = .copy,
         lastEligibilityErrorInfo: NullableCopiableProp<EligibilityErrorInfo> = .copy,
         lastJetpackBenefitsBannerDismissedTime: NullableCopiableProp<Date> = .copy
@@ -24,6 +25,7 @@ extension GeneralAppSettings {
         let isStripeInPersonPaymentsSwitchEnabled = isStripeInPersonPaymentsSwitchEnabled ?? self.isStripeInPersonPaymentsSwitchEnabled
         let isCanadaInPersonPaymentsSwitchEnabled = isCanadaInPersonPaymentsSwitchEnabled ?? self.isCanadaInPersonPaymentsSwitchEnabled
         let isProductSKUInputScannerSwitchEnabled = isProductSKUInputScannerSwitchEnabled ?? self.isProductSKUInputScannerSwitchEnabled
+        let isCouponManagementSwitchEnabled = isCouponManagementSwitchEnabled ?? self.isCouponManagementSwitchEnabled
         let knownCardReaders = knownCardReaders ?? self.knownCardReaders
         let lastEligibilityErrorInfo = lastEligibilityErrorInfo ?? self.lastEligibilityErrorInfo
         let lastJetpackBenefitsBannerDismissedTime = lastJetpackBenefitsBannerDismissedTime ?? self.lastJetpackBenefitsBannerDismissedTime
@@ -36,6 +38,7 @@ extension GeneralAppSettings {
             isStripeInPersonPaymentsSwitchEnabled: isStripeInPersonPaymentsSwitchEnabled,
             isCanadaInPersonPaymentsSwitchEnabled: isCanadaInPersonPaymentsSwitchEnabled,
             isProductSKUInputScannerSwitchEnabled: isProductSKUInputScannerSwitchEnabled,
+            isCouponManagementSwitchEnabled: isCouponManagementSwitchEnabled,
             knownCardReaders: knownCardReaders,
             lastEligibilityErrorInfo: lastEligibilityErrorInfo,
             lastJetpackBenefitsBannerDismissedTime: lastJetpackBenefitsBannerDismissedTime

Storage/Storage/Model/GeneralAppSettings.swift

@@ -40,6 +40,10 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
     ///
     public let isProductSKUInputScannerSwitchEnabled: Bool
 
+    /// The state for the Coupon Management feature switch.
+    ///
+    public let isCouponManagementSwitchEnabled: Bool
+
     /// A list (possibly empty) of known card reader IDs - i.e. IDs of card readers that should be reconnected to automatically
     /// e.g. ["CHB204909005931"]
     ///
@@ -59,6 +63,7 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
                 isStripeInPersonPaymentsSwitchEnabled: Bool,
                 isCanadaInPersonPaymentsSwitchEnabled: Bool,
                 isProductSKUInputScannerSwitchEnabled: Bool,
+                isCouponManagementSwitchEnabled: Bool,
                 knownCardReaders: [String],
                 lastEligibilityErrorInfo: EligibilityErrorInfo? = nil,
                 lastJetpackBenefitsBannerDismissedTime: Date? = nil) {
@@ -69,6 +74,7 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
         self.isStripeInPersonPaymentsSwitchEnabled = isStripeInPersonPaymentsSwitchEnabled
         self.isCanadaInPersonPaymentsSwitchEnabled = isCanadaInPersonPaymentsSwitchEnabled
         self.isProductSKUInputScannerSwitchEnabled = isProductSKUInputScannerSwitchEnabled
+        self.isCouponManagementSwitchEnabled = isCouponManagementSwitchEnabled
         self.knownCardReaders = knownCardReaders
         self.lastEligibilityErrorInfo = lastEligibilityErrorInfo
         self.lastJetpackBenefitsBannerDismissedTime = lastJetpackBenefitsBannerDismissedTime
@@ -99,6 +105,7 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
             isStripeInPersonPaymentsSwitchEnabled: isStripeInPersonPaymentsSwitchEnabled,
             isCanadaInPersonPaymentsSwitchEnabled: isCanadaInPersonPaymentsSwitchEnabled,
             isProductSKUInputScannerSwitchEnabled: isProductSKUInputScannerSwitchEnabled,
+            isCouponManagementSwitchEnabled: isCouponManagementSwitchEnabled,
             knownCardReaders: knownCardReaders,
             lastEligibilityErrorInfo: lastEligibilityErrorInfo
         )
@@ -119,6 +126,7 @@ extension GeneralAppSettings {
         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.isCouponManagementSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isCouponManagementSwitchEnabled) ?? false
         self.knownCardReaders = try container.decodeIfPresent([String].self, forKey: .knownCardReaders) ?? []
         self.lastEligibilityErrorInfo = try container.decodeIfPresent(EligibilityErrorInfo.self, forKey: .lastEligibilityErrorInfo)
         self.lastJetpackBenefitsBannerDismissedTime = try container.decodeIfPresent(Date.self, forKey: .lastJetpackBenefitsBannerDismissedTime)

Storage/StorageTests/Model/AppSettings/GeneralAppSettingsTests.swift

@@ -65,6 +65,7 @@ final class GeneralAppSettingsTests: XCTestCase {
                                                   isStripeInPersonPaymentsSwitchEnabled: true,
                                                   isCanadaInPersonPaymentsSwitchEnabled: true,
                                                   isProductSKUInputScannerSwitchEnabled: true,
+                                                  isCouponManagementSwitchEnabled: true,
                                                   knownCardReaders: readers,
                                                   lastEligibilityErrorInfo: eligibilityInfo,
                                                   lastJetpackBenefitsBannerDismissedTime: jetpackBannerDismissedDate)
@@ -87,6 +88,7 @@ final class GeneralAppSettingsTests: XCTestCase {
         assertEqual(newSettings.isStripeInPersonPaymentsSwitchEnabled, true)
         assertEqual(newSettings.isCanadaInPersonPaymentsSwitchEnabled, true)
         assertEqual(newSettings.isProductSKUInputScannerSwitchEnabled, true)
+        assertEqual(newSettings.isCouponManagementSwitchEnabled, true)
         assertEqual(newSettings.lastJetpackBenefitsBannerDismissedTime, jetpackBannerDismissedDate)
     }
 }
@@ -99,6 +101,7 @@ private extension GeneralAppSettingsTests {
                                   isStripeInPersonPaymentsSwitchEnabled: Bool = false,
                                   isCanadaInPersonPaymentsSwitchEnabled: Bool = false,
                                   isProductSKUInputScannerSwitchEnabled: Bool = false,
+                                  isCouponManagementSwitchEnabled: Bool = false,
                                   knownCardReaders: [String] = [],
                                   lastEligibilityErrorInfo: EligibilityErrorInfo? = nil,
                                   lastJetpackBenefitsBannerDismissedTime: Date? = nil) -> GeneralAppSettings {
@@ -109,6 +112,7 @@ private extension GeneralAppSettingsTests {
                            isStripeInPersonPaymentsSwitchEnabled: isStripeInPersonPaymentsSwitchEnabled,
                            isCanadaInPersonPaymentsSwitchEnabled: isCanadaInPersonPaymentsSwitchEnabled,
                            isProductSKUInputScannerSwitchEnabled: isProductSKUInputScannerSwitchEnabled,
+                           isCouponManagementSwitchEnabled: isCouponManagementSwitchEnabled,
                            knownCardReaders: knownCardReaders,
                            lastEligibilityErrorInfo: lastEligibilityErrorInfo,
                            lastJetpackBenefitsBannerDismissedTime: lastJetpackBenefitsBannerDismissedTime)

WooCommerce/Classes/ViewRelated/Dashboard/Settings/Beta features/BetaFeaturesViewController.swift

@@ -76,7 +76,8 @@ private extension BetaFeaturesViewController {
             productsSection(),
             orderCreationSection(),
             inPersonPaymentsSection(),
-            productSKUInputScannerSection()
+            productSKUInputScannerSection(),
+            couponManagementSection()
         ].compactMap { $0 }
     }
 
@@ -117,6 +118,14 @@ private extension BetaFeaturesViewController {
                               .productSKUInputScannerDescription])
     }
 
+    func couponManagementSection() -> Section? {
+        guard ServiceLocator.featureFlagService.isFeatureFlagEnabled(.couponManagement) else {
+            return nil
+        }
+        return Section(rows: [.couponManagement,
+                              .couponManagementDescription])
+    }
+
     /// Register table cells.
     ///
     func registerTableViewCells() {
@@ -159,6 +168,10 @@ private extension BetaFeaturesViewController {
             configureProductSKUInputScannerSwitch(cell: cell)
         case let cell as BasicTableViewCell where row == .productSKUInputScannerDescription:
             configureProductSKUInputScannerDescription(cell: cell)
+        case let cell as SwitchTableViewCell where row == .couponManagement:
+            configureCouponManagementSwitch(cell: cell)
+        case let cell as BasicTableViewCell where row == .couponManagementDescription:
+            configureCouponManagementDescription(cell: cell)
         default:
             fatalError()
         }
@@ -322,6 +335,37 @@ private extension BetaFeaturesViewController {
         configureCommonStylesForDescriptionCell(cell)
         cell.textLabel?.text = Localization.productSKUInputScannerDescription
     }
+
+    func configureCouponManagementSwitch(cell: SwitchTableViewCell) {
+        configureCommonStylesForSwitchCell(cell)
+        cell.title = Localization.couponManagementTitle
+
+        // Fetch switch's state stored value.
+        let action = AppSettingsAction.loadCouponManagementFeatureSwitchState { 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.setCouponManagementFeatureSwitchState(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-coupon-management-cell"
+    }
+
+    func configureCouponManagementDescription(cell: BasicTableViewCell) {
+        configureCommonStylesForDescriptionCell(cell)
+        cell.textLabel?.text = Localization.couponManagementDescription
+    }
 }
 
 // MARK: - Shared Configurations
@@ -402,12 +446,16 @@ private enum Row: CaseIterable {
     case productSKUInputScanner
     case productSKUInputScannerDescription
 
+    // Coupon management
+    case couponManagement
+    case couponManagementDescription
+
     var type: UITableViewCell.Type {
         switch self {
-        case .orderAddOns, .orderCreation, .stripeExtensionInPersonPayments, .canadaInPersonPayments, .productSKUInputScanner:
+        case .orderAddOns, .orderCreation, .stripeExtensionInPersonPayments, .canadaInPersonPayments, .productSKUInputScanner, .couponManagement:
             return SwitchTableViewCell.self
         case .orderAddOnsDescription, .orderCreationDescription, .stripeExtensionInPersonPaymentsDescription, .canadaInPersonPaymentsDescription,
-                .productSKUInputScannerDescription:
+                .productSKUInputScannerDescription, .couponManagementDescription:
             return BasicTableViewCell.self
         }
     }
@@ -455,5 +503,11 @@ private extension BetaFeaturesViewController {
         static let productSKUInputScannerDescription = NSLocalizedString(
             "Test out scanning a barcode for a product SKU in the product inventory settings",
             comment: "Cell description on beta features screen to enable product SKU input scanner in inventory settings.")
+
+        static let couponManagementTitle = NSLocalizedString("Coupon Management", comment: "Cell title on beta features screen to enable coupon management")
+        static let couponManagementDescription = NSLocalizedString(
+            "Test out managing coupons as we get ready to launch",
+            comment: "Cell description on beta features screen to enable coupon management"
+        )
     }
 }

WooCommerce/Classes/ViewRelated/Hub Menu/HubMenu.swift

@@ -80,6 +80,9 @@ struct HubMenu: View {
         }
         .navigationBarHidden(true)
         .background(Color(.listBackground).edgesIgnoringSafeArea(.all))
+        .onAppear {
+            viewModel.setupMenuElements()
+        }
     }
 
     func pushReviewDetailsView(using parcel: ProductReviewFromNoteParcel) {

WooCommerce/Classes/ViewRelated/Hub Menu/HubMenuViewModel.swift

@@ -16,22 +16,25 @@ final class HubMenuViewModel: ObservableObject {
     private(set) unowned var navigationController: UINavigationController?
 
     var avatarURL: URL? {
-        guard let urlString = ServiceLocator.stores.sessionManager.defaultAccount?.gravatarUrl, let url = URL(string: urlString) else {
+        guard let urlString = stores.sessionManager.defaultAccount?.gravatarUrl, let url = URL(string: urlString) else {
             return nil
         }
         return url
     }
+
     var storeTitle: String {
-        ServiceLocator.stores.sessionManager.defaultSite?.name ?? Localization.myStore
+        stores.sessionManager.defaultSite?.name ?? Localization.myStore
     }
+
     var storeURL: URL {
-        guard let urlString = ServiceLocator.stores.sessionManager.defaultSite?.url, let url = URL(string: urlString) else {
+        guard let urlString = stores.sessionManager.defaultSite?.url, let url = URL(string: urlString) else {
             return WooConstants.URLs.blog.asURL()
         }
         return url
     }
+
     var woocommerceAdminURL: URL {
-        guard let urlString = ServiceLocator.stores.sessionManager.defaultSite?.adminURL, let url = URL(string: urlString) else {
+        guard let urlString = stores.sessionManager.defaultSite?.adminURL, let url = URL(string: urlString) else {
             return WooConstants.URLs.blog.asURL()
         }
         return url
@@ -43,24 +46,47 @@ final class HubMenuViewModel: ObservableObject {
 
     @Published var showingReviewDetail = false
 
+    private let stores: StoresManager
+    private let featureFlagService: FeatureFlagService
+
     private var productReviewFromNoteParcel: ProductReviewFromNoteParcel?
 
     private var storePickerCoordinator: StorePickerCoordinator?
 
     private var cancellables = Set<AnyCancellable>()
 
-    init(siteID: Int64, navigationController: UINavigationController? = nil, featureFlagService: FeatureFlagService = ServiceLocator.featureFlagService) {
+    init(siteID: Int64,
+         navigationController: UINavigationController? = nil,
+         featureFlagService: FeatureFlagService = ServiceLocator.featureFlagService,
+         stores: StoresManager = ServiceLocator.stores) {
         self.siteID = siteID
         self.navigationController = navigationController
+        self.stores = stores
+        self.featureFlagService = featureFlagService
+        observeSiteForUIUpdates()
+    }
+
+    /// Resets the menu elements displayed on the menu.
+    ///
+    func setupMenuElements() {
         menuElements = [.woocommerceAdmin, .viewStore]
         if featureFlagService.isFeatureFlagEnabled(.inbox) {
             menuElements.append(.inbox)
         }
-        if featureFlagService.isFeatureFlagEnabled(.couponManagement) {
-            menuElements.append(.coupons)
-        }
         menuElements.append(.reviews)
-        observeSiteForUIUpdates()
+
+        let action = AppSettingsAction.loadCouponManagementFeatureSwitchState { [weak self] result in
+            guard let self = self else { return }
+            guard case let .success(enabled) = result, enabled else {
+                return
+            }
+            if let index = self.menuElements.firstIndex(of: .reviews) {
+                self.menuElements.insert(.coupons, at: index)
+            } else {
+                self.menuElements.append(.coupons)
+            }
+        }
+        stores.dispatch(action)
     }
 
     /// Present the `StorePickerViewController` using the `StorePickerCoordinator`, passing the navigation controller from the entry point.
@@ -87,7 +113,7 @@ final class HubMenuViewModel: ObservableObject {
     }
 
     private func observeSiteForUIUpdates() {
-        ServiceLocator.stores.site.sink { site in
+        stores.site.sink { site in
             // This will be useful in the future for updating some info of the screen depending on the store site info
         }.store(in: &cancellables)
     }

WooCommerce/WooCommerceTests/ViewRelated/HubMenu/HubMenuViewModelTests.swift

@@ -1,6 +1,7 @@
 import XCTest
 
 @testable import WooCommerce
+@testable import Yosemite
 
 final class HubMenuViewModelTests: XCTestCase {
     private let sampleSiteID: Int64 = 606
@@ -22,8 +23,51 @@ final class HubMenuViewModelTests: XCTestCase {
 
         // When
         let viewModel = HubMenuViewModel(siteID: sampleSiteID, featureFlagService: featureFlagService)
+        viewModel.setupMenuElements()
 
         // Then
         XCTAssertEqual(viewModel.menuElements, [.woocommerceAdmin, .viewStore, .inbox, .reviews])
     }
+
+    func test_menuElements_include_coupons_when_couponManagement_is_enabled_in_app_settings() {
+        // Given
+        let stores = MockStoresManager(sessionManager: .makeForTesting())
+        let featureFlagService = MockFeatureFlagService(isInboxOn: true)
+
+        // When
+        stores.whenReceivingAction(ofType: AppSettingsAction.self) { action in
+            switch action {
+            case .loadCouponManagementFeatureSwitchState(let onCompletion):
+                onCompletion(.success(true))
+            default:
+                break
+            }
+        }
+        let viewModel = HubMenuViewModel(siteID: sampleSiteID, featureFlagService: featureFlagService, stores: stores)
+        viewModel.setupMenuElements()
+
+        // Then
+        XCTAssertEqual(viewModel.menuElements, [.woocommerceAdmin, .viewStore, .inbox, .coupons, .reviews])
+    }
+
+    func test_menuElements_do_not_include_coupons_when_couponManagement_is_not_enabled_in_app_settings() {
+        // Given
+        let stores = MockStoresManager(sessionManager: .makeForTesting())
+        let featureFlagService = MockFeatureFlagService(isInboxOn: false)
+
+        // When
+        stores.whenReceivingAction(ofType: AppSettingsAction.self) { action in
+            switch action {
+            case .loadCouponManagementFeatureSwitchState(let onCompletion):
+                onCompletion(.success(false))
+            default:
+                break
+            }
+        }
+        let viewModel = HubMenuViewModel(siteID: sampleSiteID, featureFlagService: featureFlagService, stores: stores)
+        viewModel.setupMenuElements()
+
+        // Then
+        XCTAssertEqual(viewModel.menuElements, [.woocommerceAdmin, .viewStore, .reviews])
+    }
 }

Yosemite/Yosemite/Actions/AppSettingsAction.swift

@@ -152,6 +152,14 @@ public enum AppSettingsAction: Action {
     ///
     case loadProductSKUInputScannerFeatureSwitchState(onCompletion: (Result<Bool, Error>) -> Void)
 
+    /// Sets the state for the Coupon Management beta feature switch.
+    ///
+    case setCouponManagementFeatureSwitchState(isEnabled: Bool, onCompletion: (Result<Void, Error>) -> Void)
+
+    /// Loads the most recent state for the Coupon Management beta feature switch
+    ///
+    case loadCouponManagementFeatureSwitchState(onCompletion: (Result<Bool, Error>) -> Void)
+
     /// Remember the given card reader (to support automatic reconnection)
     /// where `cardReaderID` is a String e.g. "CHB204909005931"
     ///