Merge pull request #5505 from woocommerce/feat/5368-display-jetpack-banner-for-jcp-sites

Jetpack CP: display Jetpack benefits bottom banner for JCP sites and 5 days after the last dismissal

Author: jaclync

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

@@ -12,7 +12,8 @@ extension GeneralAppSettings {
         isSimplePaymentsSwitchEnabled: CopiableProp<Bool> = .copy,
         isOrderCreationSwitchEnabled: CopiableProp<Bool> = .copy,
         knownCardReaders: CopiableProp<[String]> = .copy,
-        lastEligibilityErrorInfo: NullableCopiableProp<EligibilityErrorInfo> = .copy
+        lastEligibilityErrorInfo: NullableCopiableProp<EligibilityErrorInfo> = .copy,
+        lastJetpackBenefitsBannerDismissedTime: NullableCopiableProp<Date> = .copy
     ) -> GeneralAppSettings {
         let installationDate = installationDate ?? self.installationDate
         let feedbacks = feedbacks ?? self.feedbacks
@@ -21,6 +22,7 @@ extension GeneralAppSettings {
         let isOrderCreationSwitchEnabled = isOrderCreationSwitchEnabled ?? self.isOrderCreationSwitchEnabled
         let knownCardReaders = knownCardReaders ?? self.knownCardReaders
         let lastEligibilityErrorInfo = lastEligibilityErrorInfo ?? self.lastEligibilityErrorInfo
+        let lastJetpackBenefitsBannerDismissedTime = lastJetpackBenefitsBannerDismissedTime ?? self.lastJetpackBenefitsBannerDismissedTime
 
         return GeneralAppSettings(
             installationDate: installationDate,
@@ -29,7 +31,8 @@ extension GeneralAppSettings {
             isSimplePaymentsSwitchEnabled: isSimplePaymentsSwitchEnabled,
             isOrderCreationSwitchEnabled: isOrderCreationSwitchEnabled,
             knownCardReaders: knownCardReaders,
-            lastEligibilityErrorInfo: lastEligibilityErrorInfo
+            lastEligibilityErrorInfo: lastEligibilityErrorInfo,
+            lastJetpackBenefitsBannerDismissedTime: lastJetpackBenefitsBannerDismissedTime
         )
     }
 }

Storage/Storage/Model/GeneralAppSettings.swift

@@ -41,20 +41,25 @@ public struct GeneralAppSettings: Codable, Equatable, GeneratedCopiable {
     ///
     public let lastEligibilityErrorInfo: EligibilityErrorInfo?
 
+    /// The last time the Jetpack benefits banner is dismissed.
+    public let lastJetpackBenefitsBannerDismissedTime: Date?
+
     public init(installationDate: Date?,
                 feedbacks: [FeedbackType: FeedbackSettings],
                 isViewAddOnsSwitchEnabled: Bool,
                 isSimplePaymentsSwitchEnabled: Bool,
                 isOrderCreationSwitchEnabled: Bool,
                 knownCardReaders: [String],
-                lastEligibilityErrorInfo: EligibilityErrorInfo? = nil) {
+                lastEligibilityErrorInfo: EligibilityErrorInfo? = nil,
+                lastJetpackBenefitsBannerDismissedTime: Date? = nil) {
         self.installationDate = installationDate
         self.feedbacks = feedbacks
         self.isViewAddOnsSwitchEnabled = isViewAddOnsSwitchEnabled
         self.isSimplePaymentsSwitchEnabled = isSimplePaymentsSwitchEnabled
         self.isOrderCreationSwitchEnabled = isOrderCreationSwitchEnabled
         self.knownCardReaders = knownCardReaders
         self.lastEligibilityErrorInfo = lastEligibilityErrorInfo
+        self.lastJetpackBenefitsBannerDismissedTime = lastJetpackBenefitsBannerDismissedTime
     }
 
     /// Returns the status of a given feedback type. If the feedback is not stored in the feedback array. it is assumed that it has a pending status.
@@ -100,6 +105,7 @@ extension GeneralAppSettings {
         self.isOrderCreationSwitchEnabled = try container.decodeIfPresent(Bool.self, forKey: .isOrderCreationSwitchEnabled) ?? 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)
 
         // Decode new properties with `decodeIfPresent` and provide a default value if necessary.
     }

Storage/StorageTests/Model/AppSettings/GeneralAppSettingsTests.swift

@@ -1,7 +1,7 @@
 import XCTest
 @testable import Storage
 
-class GeneralAppSettingsTests: XCTestCase {
+final class GeneralAppSettingsTests: XCTestCase {
 
     func test_it_returns_the_correct_status_of_a_stored_feedback() {
         // Given

WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewController.swift

@@ -15,7 +15,7 @@ final class DashboardViewController: UIViewController {
     private let siteID: Int64
 
     private let dashboardUIFactory: DashboardUIFactory
-    private var dashboardUI: DashboardUI?
+    @Published private var dashboardUI: DashboardUI?
 
     // Used to enable subtitle with store name
     private var shouldShowStoreNameAsSubtitle: Bool = false
@@ -110,6 +110,7 @@ final class DashboardViewController: UIViewController {
         configureDashboardUIContainer()
         configureBottomJetpackBenefitsBanner()
         observeSiteForUIUpdates()
+        observeBottomJetpackBenefitsBannerVisibilityUpdates()
     }
 
     override func viewWillAppear(_ animated: Bool) {
@@ -239,7 +240,9 @@ private extension DashboardViewController {
             }
             self.present(benefitsController, animated: true, completion: nil)
         } dismissAction: { [weak self] in
-            // TODO: 5362 - Persist dismiss state per site
+            let dismissAction = AppSettingsAction.setJetpackBenefitsBannerLastDismissedTime(time: Date())
+            ServiceLocator.stores.dispatch(dismissAction)
+
             self?.hideJetpackBenefitsBanner()
         }
     }
@@ -323,25 +326,25 @@ private extension DashboardViewController {
             remove(previousDashboardUI)
         }
 
-        dashboardUI = updatedDashboardUI
-
         let contentView = updatedDashboardUI.view!
         addChild(updatedDashboardUI)
         containerView.addSubview(contentView)
         updatedDashboardUI.didMove(toParent: self)
         addViewBelowHeaderStackView(contentView: contentView)
 
+        // Sets `dashboardUI` after its view is added to the view hierarchy so that observers can update UI based on its view.
+        dashboardUI = updatedDashboardUI
+
         updatedDashboardUI.onPullToRefresh = { [weak self] in
             self?.pullToRefresh()
         }
         updatedDashboardUI.displaySyncingError = { [weak self] in
             self?.showTopBannerView()
         }
+    }
 
-        // Bottom banner
-        // TODO: 5362 & 5368 - Display banner for JCP sites and if the banner has not been dismissed before.
-        let shouldShowJetpackBenefitsBanner = ServiceLocator.featureFlagService.isFeatureFlagEnabled(.jetpackConnectionPackageSupport)
-        if shouldShowJetpackBenefitsBanner {
+    func updateJetpackBenefitsBannerVisibility(isBannerVisible: Bool, contentView: UIView) {
+        if isBannerVisible {
             showJetpackBenefitsBanner(contentView: contentView)
         } else {
             hideJetpackBenefitsBanner()
@@ -426,6 +429,30 @@ private extension DashboardViewController {
             self.reloadData(forced: true)
         }.store(in: &cancellables)
     }
+
+    func observeBottomJetpackBenefitsBannerVisibilityUpdates() {
+        Publishers.CombineLatest(ServiceLocator.stores.site, $dashboardUI.eraseToAnyPublisher())
+            .sink { [weak self] site, dashboardUI in
+                guard let self = self else { return }
+
+                guard let contentView = dashboardUI?.view else {
+                    return
+                }
+
+                // Checks if Jetpack banner can be visible from app settings.
+                let action = AppSettingsAction.loadJetpackBenefitsBannerVisibility(currentTime: Date(),
+                                                                                   calendar: .current) { [weak self] isVisibleFromAppSettings in
+                    guard let self = self else { return }
+
+                    let shouldShowJetpackBenefitsBanner = ServiceLocator.featureFlagService.isFeatureFlagEnabled(.jetpackConnectionPackageSupport)
+                    && site?.isJetpackCPConnected == true
+                    && isVisibleFromAppSettings
+
+                    self.updateJetpackBenefitsBannerVisibility(isBannerVisible: shouldShowJetpackBenefitsBanner, contentView: contentView)
+                }
+                ServiceLocator.stores.dispatch(action)
+            }.store(in: &cancellables)
+    }
 }
 
 // MARK: Constants

Yosemite/Yosemite/Actions/AppSettingsAction.swift

@@ -163,6 +163,16 @@ public enum AppSettingsAction: Action {
     ///
     case resetEligibilityErrorInfo
 
+    /// Sets the last time when Jetpack benefits banner is dismissed in the Dashboard.
+    ///
+    case setJetpackBenefitsBannerLastDismissedTime(time: Date)
+
+    /// Loads the visibility of Jetpack benefits banner in the Dashboard based on the last dismissal time.
+    /// The banner is not shown for five days after the last time it is dismissed.
+    /// There are other conditions for showing the Jetpack banner, like when the site is Jetpack CP connected.
+    ///
+    case loadJetpackBenefitsBannerVisibility(currentTime: Date, calendar: Calendar, onCompletion: (Bool) -> Void)
+
     // MARK: - General Store Settings
 
     /// Sets telemetry availability status information.

Yosemite/Yosemite/Stores/AppSettingsStore.swift

@@ -181,6 +181,10 @@ public class AppSettingsStore: Store {
             setEligibilityErrorInfo(errorInfo: errorInfo, onCompletion: onCompletion)
         case .resetEligibilityErrorInfo:
             setEligibilityErrorInfo(errorInfo: nil)
+        case .setJetpackBenefitsBannerLastDismissedTime(time: let time):
+            setJetpackBenefitsBannerLastDismissedTime(time: time)
+        case .loadJetpackBenefitsBannerVisibility(currentTime: let currentTime, calendar: let calendar, onCompletion: let onCompletion):
+            loadJetpackBenefitsBannerVisibility(currentTime: currentTime, calendar: calendar, onCompletion: onCompletion)
         case .setTelemetryAvailability(siteID: let siteID, isAvailable: let isAvailable):
             setTelemetryAvailability(siteID: siteID, isAvailable: isAvailable)
         case .setTelemetryLastReportedTime(siteID: let siteID, time: let time):
@@ -326,6 +330,34 @@ private extension AppSettingsStore {
         }
     }
 
+    // Visibility of Jetpack benefits banner in the Dashboard
+
+    func setJetpackBenefitsBannerLastDismissedTime(time: Date, onCompletion: ((Result<Void, Error>) -> Void)? = nil) {
+        do {
+            let settings = loadOrCreateGeneralAppSettings().copy(lastJetpackBenefitsBannerDismissedTime: time)
+            try saveGeneralAppSettings(settings)
+            onCompletion?(.success(()))
+        } catch {
+            onCompletion?(.failure(error))
+        }
+    }
+
+    func loadJetpackBenefitsBannerVisibility(currentTime: Date, calendar: Calendar, onCompletion: (Bool) -> Void) {
+        let settings = loadOrCreateGeneralAppSettings()
+
+        guard let lastDismissedTime = settings.lastJetpackBenefitsBannerDismissedTime else {
+            // If the banner has not been dismissed before, the banner is default to be visible.
+            return onCompletion(true)
+        }
+
+        guard let numberOfDaysSinceLastDismissal = calendar.dateComponents([.day], from: lastDismissedTime, to: currentTime).day else {
+            return onCompletion(true)
+        }
+        onCompletion(numberOfDaysSinceLastDismissal >= 5)
+    }
+
+    // File operations
+
     /// Load the `GeneralAppSettings` from file or create an empty one if it doesn't exist.
     func loadOrCreateGeneralAppSettings() -> GeneralAppSettings {
         guard let settings: GeneralAppSettings = try? fileStorage.data(for: generalAppSettingsFileURL) else {

Yosemite/YosemiteTests/Stores/AppSettingsStoreTests.swift

@@ -519,6 +519,130 @@ final class AppSettingsStoreTests: XCTestCase {
         XCTAssertTrue(isEnabled)
     }
 
+    func test_loadJetpackBenefitsBannerVisibility_returns_true_on_new_generalAppSettings() throws {
+        // Given
+        // Deletes any pre-existing app settings.
+        try fileStorage?.deleteFile(at: expectedGeneralAppSettingsFileURL)
+
+        // GMT - Sunday, November 28, 2021 1:25:24 PM
+        let currentTime = Date(timeIntervalSince1970: 1638105924)
+        let calendar = Calendar(identifier: .gregorian)
+
+        // When
+        let isVisible: Bool = waitFor { promise in
+            let action = AppSettingsAction.loadJetpackBenefitsBannerVisibility(currentTime: currentTime, calendar: calendar) { isVisible in
+                promise(isVisible)
+            }
+            self.subject?.onAction(action)
+        }
+
+        // Then
+        // The banner is visible if there are no pre-existing app settings.
+        XCTAssertTrue(isVisible)
+    }
+
+    func test_loadJetpackBenefitsBannerVisibility_returns_true_after_setting_last_dismissed_date_exactly_five_days_ago_without_dst() throws {
+        // Given
+        try fileStorage?.deleteFile(at: expectedGeneralAppSettingsFileURL)
+
+        // GMT - Tuesday, November 23, 2021 1:25:24 PM
+        let lastDismissedTime = Date(timeIntervalSince1970: 1637673924)
+        // GMT - Sunday, November 28, 2021 1:25:24 PM - exactly five days after the last dismissed date without DST
+        let currentTime = Date(timeIntervalSince1970: 1638105924)
+        let calendar: Calendar = {
+            var calendar = Calendar(identifier: .gregorian)
+            guard let timeZoneWithoutDaylightSavingTime = TimeZone(identifier: "Asia/Taipei") else {
+                XCTFail("Unexpected time zone.")
+                return calendar
+            }
+            calendar.timeZone = timeZoneWithoutDaylightSavingTime
+            return calendar
+        }()
+
+        let updateAction = AppSettingsAction.setJetpackBenefitsBannerLastDismissedTime(time: lastDismissedTime)
+        subject?.onAction(updateAction)
+
+        // When
+        let isVisible: Bool = waitFor { promise in
+            let action = AppSettingsAction.loadJetpackBenefitsBannerVisibility(currentTime: currentTime, calendar: calendar) { isVisible in
+                promise(isVisible)
+            }
+            self.subject?.onAction(action)
+        }
+
+        // Then
+        XCTAssertTrue(isVisible)
+    }
+
+    /// Tests an edge case where the time interval since the last dismissed date is less than 5 24-hour days, but is exactly 5 days on calendar with daylight
+    /// saving time.
+    func test_loadJetpackBenefitsBannerVisibility_returns_false_after_setting_last_dismissed_date_exactly_five_24hr_days_ago() throws {
+        // Given
+        try fileStorage?.deleteFile(at: expectedGeneralAppSettingsFileURL)
+
+        // America/New York (EDT) - November 03, 2021 09:43:17 AM
+        let lastDismissedTime = Date(timeIntervalSince1970: 1635946997)
+        // America/New York (EST) - November 08, 2021 08:43:17 AM - exactly five 24-hour days after the last dismissed date.
+        // But with daylight saving time in America/New York, it is still less than five days.
+        let currentTime = Date(timeIntervalSince1970: 1636378997)
+        let calendar: Calendar = {
+            var calendar = Calendar(identifier: .gregorian)
+            guard let timeZoneWithDaylightSavingTime = TimeZone(identifier: "America/New_York") else {
+                XCTFail("Unexpected time zone.")
+                return calendar
+            }
+            calendar.timeZone = timeZoneWithDaylightSavingTime
+            return calendar
+        }()
+
+        let updateAction = AppSettingsAction.setJetpackBenefitsBannerLastDismissedTime(time: lastDismissedTime)
+        subject?.onAction(updateAction)
+
+        // When
+        let isVisible: Bool = waitFor { promise in
+            let action = AppSettingsAction.loadJetpackBenefitsBannerVisibility(currentTime: currentTime, calendar: calendar) { isVisible in
+                promise(isVisible)
+            }
+            self.subject?.onAction(action)
+        }
+
+        // Then
+        XCTAssertFalse(isVisible)
+    }
+
+    func test_loadJetpackBenefitsBannerVisibility_returns_false_after_setting_last_dismissed_date_less_than_five_days_ago() throws {
+        // Given
+        try fileStorage?.deleteFile(at: expectedGeneralAppSettingsFileURL)
+
+        // GMT - Tuesday, November 23, 2021 1:25:24 PM
+        let lastDismissedTime = Date(timeIntervalSince1970: 1637673924)
+        // GMT - Sunday, November 28, 2021 1:25:23 PM - exactly 1 second less than five days after the last dismissed date without DST
+        let currentTime = Date(timeIntervalSince1970: 1638105923)
+        let calendar: Calendar = {
+            var calendar = Calendar(identifier: .gregorian)
+            guard let timeZoneWithoutDaylightSavingTime = TimeZone(identifier: "Asia/Taipei") else {
+                XCTFail("Unexpected time zone.")
+                return calendar
+            }
+            calendar.timeZone = timeZoneWithoutDaylightSavingTime
+            return calendar
+        }()
+
+        let updateAction = AppSettingsAction.setJetpackBenefitsBannerLastDismissedTime(time: lastDismissedTime)
+        subject?.onAction(updateAction)
+
+        // When
+        let isVisible: Bool = waitFor { promise in
+            let action = AppSettingsAction.loadJetpackBenefitsBannerVisibility(currentTime: currentTime, calendar: calendar) { isVisible in
+                promise(isVisible)
+            }
+            self.subject?.onAction(action)
+        }
+
+        // Then
+        XCTAssertFalse(isVisible)
+    }
+
     // MARK: - General Store Settings
 
     func test_saving_isTelemetryAvailable_works_correctly() throws {