Merge pull request #19571 from wordpress-mobile/task/19447-phase-1

Jetpack Focus: Display phase one overlays for Stats, Reader, and Notifications

Author: hassaanelgarem

WordPress/Classes/ViewRelated/Jetpack/Branding/Coordinator/JetpackFeaturesRemovalCoordinator.swift

@@ -11,6 +11,19 @@ class JetpackFeaturesRemovalCoordinator {
         case three
         case four
         case newUsers
+
+        var frequencyConfig: JetpackOverlayFrequencyTracker.FrequencyConfig {
+            switch self {
+            case .one:
+                fallthrough
+            case .two:
+                return .init(featureSpecificInDays: 7, generalInDays: 2)
+            case .three:
+                return .init(featureSpecificInDays: 4, generalInDays: 1)
+            default:
+                return .defaultConfig
+            }
+        }
     }
 
     /// Enum descibing the current phase of the site creation flow removal
@@ -20,6 +33,15 @@ class JetpackFeaturesRemovalCoordinator {
         case two
     }
 
+    enum OverlaySource: String {
+        case stats
+        case notifications
+        case reader
+        case card
+        case login
+        case appOpen = "app_open"
+    }
+
     static func generalPhase(featureFlagStore: RemoteFeatureFlagStore = RemoteFeatureFlagStore()) -> GeneralPhase {
         if AppConfiguration.isJetpack {
             return .normal // Always return normal for Jetpack
@@ -61,4 +83,27 @@ class JetpackFeaturesRemovalCoordinator {
 
         return .normal
     }
+
+    /// Used to display feature-specific or feature-collection overlays.
+    /// - Parameters:
+    ///   - source: The source that triggers the display of the overlay.
+    ///   - viewController: View controller where the overlay should be presented in.
+    static func presentOverlayIfNeeded(from source: OverlaySource, in viewController: UIViewController) {
+        let phase = generalPhase()
+        let frequencyConfig = phase.frequencyConfig
+        let config = JetpackFullscreenOverlayGeneralConfig(phase: phase, source: source)
+        let frequencyTracker = JetpackOverlayFrequencyTracker(frequencyConfig: frequencyConfig, source: source)
+        guard config.shouldShowOverlay, frequencyTracker.shouldShow() else {
+            return
+        }
+        createAndPresentOverlay(with: config, in: viewController)
+        frequencyTracker.track()
+    }
+
+    private static func createAndPresentOverlay(with config: JetpackFullscreenOverlayConfig, in viewController: UIViewController) {
+        let overlay = JetpackFullscreenOverlayViewController(with: config)
+        let navigationViewController = UINavigationController(rootViewController: overlay)
+        navigationViewController.modalPresentationStyle = .formSheet
+        viewController.present(navigationViewController, animated: true)
+    }
 }

WordPress/Classes/ViewRelated/Jetpack/Branding/Coordinator/JetpackOverlayFrequencyTracker.swift

@@ -0,0 +1,106 @@
+import Foundation
+
+class JetpackOverlayFrequencyTracker {
+
+    private let frequencyConfig: FrequencyConfig
+    private let source: JetpackFeaturesRemovalCoordinator.OverlaySource
+    private let persistenceStore: UserPersistentRepository
+
+    private var lastSavedGenericDate: Date? {
+        get {
+            let key = Constants.lastDateKeyPrefix
+            return persistenceStore.object(forKey: key) as? Date
+        }
+        set {
+            let key = Constants.lastDateKeyPrefix
+            persistenceStore.set(newValue, forKey: key)
+        }
+    }
+
+    private var lastSavedSourceDate: Date? {
+        get {
+            let sourceKey = "\(Constants.lastDateKeyPrefix)-\(source.rawValue)"
+            return persistenceStore.object(forKey: sourceKey) as? Date
+        }
+        set {
+            let sourceKey = "\(Constants.lastDateKeyPrefix)-\(source.rawValue)"
+            persistenceStore.set(newValue, forKey: sourceKey)
+        }
+    }
+
+    init(frequencyConfig: FrequencyConfig = .defaultConfig,
+         source: JetpackFeaturesRemovalCoordinator.OverlaySource,
+         persistenceStore: UserPersistentRepository = UserDefaults.standard) {
+        self.frequencyConfig = frequencyConfig
+        self.source = source
+        self.persistenceStore = persistenceStore
+    }
+
+    func shouldShow() -> Bool {
+        switch source {
+        case .stats:
+            fallthrough
+        case .notifications:
+            fallthrough
+        case .reader:
+            return frequenciesPassed()
+        case .card:
+            return true
+        case .login:
+            fallthrough
+        case .appOpen:
+            return lastSavedSourceDate == nil
+        }
+    }
+
+    func track() {
+        let date = Date()
+        lastSavedSourceDate = date
+        lastSavedGenericDate = date
+    }
+
+    private func frequenciesPassed() -> Bool {
+        guard let lastSavedGenericDate = lastSavedGenericDate else {
+            return true // First overlay ever
+        }
+        let secondsSinceLastSavedGenericDate = -lastSavedGenericDate.timeIntervalSinceNow
+        let generalFreqPassed = secondsSinceLastSavedGenericDate > frequencyConfig.generalInSeconds
+        if generalFreqPassed == false {
+            return false // An overlay was shown recently so we can't show one now
+        }
+
+        guard let lastSavedSourceDate = lastSavedSourceDate else {
+            return true // This specific overlay was never shown, so we can show it
+        }
+
+        let secondsSinceLastSavedSourceDate = -lastSavedSourceDate.timeIntervalSinceNow
+        let featureSpecificFreqPassed = secondsSinceLastSavedSourceDate > frequencyConfig.featureSpecificInSeconds
+        // Check if this specific overlay was shown recently
+        return featureSpecificFreqPassed
+    }
+}
+
+extension JetpackOverlayFrequencyTracker {
+    struct FrequencyConfig {
+        // MARK: Instance Variables
+        let featureSpecificInDays: Int
+        let generalInDays: Int
+
+        // MARK: Static Variables
+        static let defaultConfig = FrequencyConfig(featureSpecificInDays: 0, generalInDays: 0)
+        private static let secondsInDay: TimeInterval = 86_400
+
+        // MARK: Computed Variables
+        var featureSpecificInSeconds: TimeInterval {
+            return TimeInterval(featureSpecificInDays) * Self.secondsInDay
+        }
+
+        var generalInSeconds: TimeInterval {
+            return TimeInterval(generalInDays) * Self.secondsInDay
+        }
+    }
+
+    enum Constants {
+        static let lastDateKeyPrefix = "JetpackOverlayLastDate"
+    }
+}

WordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayConfig.swift

@@ -1,16 +1,17 @@
 import Foundation
 
-struct JetpackFullscreenOverlayConfig {
-    let title: String
-    let subtitle: String
-    let animationLtr: String
-    let animationRtl: String
-    let footnote: String?
-    let shouldShowLearnMoreButton: Bool
-    let switchButtonText: String
-    let continueButtonText: String?
-    let shouldShowCloseButton: Bool
-    let analyticsSource: String
+/// Protocol used to configure `JetpackFullscreenOverlayViewController`
+protocol JetpackFullscreenOverlayConfig {
+    var title: String { get }
+    var subtitle: String { get }
+    var animationLtr: String { get }
+    var animationRtl: String { get }
+    var footnote: String? { get }
+    var shouldShowLearnMoreButton: Bool { get }
+    var switchButtonText: String { get }
+    var continueButtonText: String? { get }
+    var shouldShowCloseButton: Bool { get }
+    var analyticsSource: String { get }
 }
 
 extension JetpackFullscreenOverlayConfig {