AppSettingsAction: add setJetpackBenefitsBannerLastDismissedTime and loadJetpackBenefitsBannerVisibility for Jetpack banner visibility from dismissal.

Author: jaclync

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

Yosemite/Yosemite/Actions/AppSettingsAction.swift

@@ -1,3 +1,4 @@
+import Combine
 import Foundation
 import Storage
 
@@ -145,6 +146,14 @@ 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. The banner is not shown for five days after the last time it is dismissed.
+    ///
+    case loadJetpackBenefitsBannerVisibility(currentTime: Date, calendar: Calendar, onCompletion: (Bool) -> Void)
+
     // MARK: - General Store Settings
 
     /// Sets telemetry availability status information.

Yosemite/Yosemite/Stores/AppSettingsStore.swift

@@ -162,6 +162,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):
@@ -307,6 +311,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 {
@@ -749,6 +781,7 @@ enum AppSettingsStoreErrors: Error {
     case noProductsSettings
     case writeProductsSettings
     case noEligibilityErrorInfo
+    case noLastJetpackBenefitsBannerDismissedTime
 }
 
 

Yosemite/YosemiteTests/Stores/AppSettingsStoreTests.swift

@@ -519,6 +519,127 @@ final class AppSettingsStoreTests: XCTestCase {
         XCTAssertTrue(isEnabled)
     }
 
+    func test_loadJetpackBenefitsBannerVisibility_returns_true_on_new_generalAppSettings() throws {
+        // Given
+        try fileStorage?.deleteFile(at: expectedGeneralAppSettingsFileURL)
+
+        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
+        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 timeZoneWithoutDailySavingTime = TimeZone(identifier: "Asia/Taipei") else {
+                XCTFail("Unexpected time zone.")
+                return calendar
+            }
+            calendar.timeZone = timeZoneWithoutDailySavingTime
+            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 daily
+    /// 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 daily 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 timeZoneWithDailySavingTime = TimeZone(identifier: "America/New_York") else {
+                XCTFail("Unexpected time zone.")
+                return calendar
+            }
+            calendar.timeZone = timeZoneWithDailySavingTime
+            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 timeZoneWithoutDailySavingTime = TimeZone(identifier: "Asia/Taipei") else {
+                XCTFail("Unexpected time zone.")
+                return calendar
+            }
+            calendar.timeZone = timeZoneWithoutDailySavingTime
+            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 {