Merge pull request #19586 from wordpress-mobile/task/19447-analytics

Jetpack Focus: Add analytics tracking for the Jetpack fullscreen overlay

Author: hassaanelgarem

WordPress/Classes/Utility/Analytics/WPAnalyticsEvent.swift

@@ -407,6 +407,10 @@ import Foundation
     case jetpackPoweredBadgeTapped
     case jetpackPoweredBannerTapped
     case jetpackPoweredBottomSheetButtonTapped
+    case jetpackFullscreenOverlayDisplayed
+    case jetpackFullscreenOverlayLinkTapped
+    case jetpackFullscreenOverlayButtonTapped
+    case jetpackFullscreenOverlayDismissed
 
     /// A String that represents the event
     var value: String {
@@ -1102,6 +1106,14 @@ import Foundation
             return "jetpack_powered_banner_tapped"
         case .jetpackPoweredBottomSheetButtonTapped:
             return "jetpack_powered_bottom_sheet_button_tapped"
+        case .jetpackFullscreenOverlayDisplayed:
+            return "remove_feature_overlay_displayed"
+        case .jetpackFullscreenOverlayLinkTapped:
+            return "remove_feature_overlay_link_tapped"
+        case .jetpackFullscreenOverlayButtonTapped:
+            return "remove_feature_overlay_button_tapped"
+        case .jetpackFullscreenOverlayDismissed:
+            return "remove_feature_overlay_dismissed"
         } // END OF SWITCH
     }
 

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

@@ -4,7 +4,7 @@ import Foundation
 class JetpackFeaturesRemovalCoordinator {
 
     /// Enum descibing the current phase of the Jetpack features removal
-    enum GeneralPhase {
+    enum GeneralPhase: String {
         case normal
         case one
         case two
@@ -91,17 +91,17 @@ class JetpackFeaturesRemovalCoordinator {
     static func presentOverlayIfNeeded(from source: OverlaySource, in viewController: UIViewController) {
         let phase = generalPhase()
         let frequencyConfig = phase.frequencyConfig
-        let config = JetpackFullscreenOverlayGeneralConfig(phase: phase, source: source)
+        let viewModel = JetpackFullscreenOverlayGeneralViewModel(phase: phase, source: source)
         let frequencyTracker = JetpackOverlayFrequencyTracker(frequencyConfig: frequencyConfig, source: source)
-        guard config.shouldShowOverlay, frequencyTracker.shouldShow() else {
+        guard viewModel.shouldShowOverlay, frequencyTracker.shouldShow() else {
             return
         }
-        createAndPresentOverlay(with: config, in: viewController)
+        createAndPresentOverlay(with: viewModel, in: viewController)
         frequencyTracker.track()
     }
 
-    private static func createAndPresentOverlay(with config: JetpackFullscreenOverlayConfig, in viewController: UIViewController) {
-        let overlay = JetpackFullscreenOverlayViewController(with: config)
+    private static func createAndPresentOverlay(with viewModel: JetpackFullscreenOverlayViewModel, in viewController: UIViewController) {
+        let overlay = JetpackFullscreenOverlayViewController(with: viewModel)
         let navigationViewController = UINavigationController(rootViewController: overlay)
         navigationViewController.modalPresentationStyle = .formSheet
         viewController.present(navigationViewController, animated: true)

WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayGeneralViewModel+Analytics.swift

@@ -0,0 +1,56 @@
+import Foundation
+import AutomatticTracks
+
+extension JetpackFullscreenOverlayGeneralViewModel {
+
+    // MARK: Private Enum Decleration
+
+    private enum DismissalType: String {
+        case close, `continue`
+    }
+
+    // MARK: Static Property Keys
+
+    private static let phasePropertyKey = "phase"
+    private static let sourcePropertyKey = "source"
+    private static let dismiassalTypePropertyKey = "dismissal_type"
+
+    // MARK: Private Computed Property
+
+    private var defaultProperties: [String: String] {
+        return [
+            Self.phasePropertyKey: phase.rawValue,
+            Self.sourcePropertyKey: source.rawValue
+        ]
+    }
+
+    // MARK: Analytics Implementation
+
+    func trackOverlayDisplayed() {
+        WPAnalytics.track(.jetpackFullscreenOverlayDisplayed, properties: defaultProperties)
+    }
+
+    func trackLearnMoreTapped() {
+        WPAnalytics.track(.jetpackFullscreenOverlayLinkTapped, properties: defaultProperties)
+    }
+
+    func trackSwitchButtonTapped() {
+        WPAnalytics.track(.jetpackFullscreenOverlayButtonTapped, properties: defaultProperties)
+    }
+
+    func trackCloseButtonTapped() {
+        trackOverlayDismissed(dismissalType: .close)
+    }
+
+    func trackContinueButtonTapped() {
+        trackOverlayDismissed(dismissalType: .continue)
+    }
+
+    // MARK: Helpers
+
+    private func trackOverlayDismissed(dismissalType: DismissalType) {
+        var properties = defaultProperties
+        properties[Self.dismiassalTypePropertyKey] = dismissalType.rawValue
+        WPAnalytics.track(.jetpackFullscreenOverlayDismissed, properties: properties)
+    }
+}

…ullscreenOverlayGeneralPhaseConfig.swift …kFullscreenOverlayGeneralViewModel.swiftWordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayGeneralPhaseConfig.swift renamed to WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayGeneralViewModel.swift WordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayGeneralPhaseConfig.swift renamed to WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayGeneralViewModel.swift

@@ -1,8 +1,8 @@
 import Foundation
 
-/// Dynamic implementation of `JetpackFullscreenOverlayConfig`
+/// Dynamic implementation of `JetpackFullscreenOverlayViewModel` based on the general phase
 /// Should be used for feature-specific and feature-collection overlays.
-struct JetpackFullscreenOverlayGeneralConfig: JetpackFullscreenOverlayConfig {
+struct JetpackFullscreenOverlayGeneralViewModel: JetpackFullscreenOverlayViewModel {
 
     let phase: JetpackFeaturesRemovalCoordinator.GeneralPhase
     let source: JetpackFeaturesRemovalCoordinator.OverlaySource
@@ -161,7 +161,7 @@ struct JetpackFullscreenOverlayGeneralConfig: JetpackFullscreenOverlayConfig {
     }
 }
 
-private extension JetpackFullscreenOverlayGeneralConfig {
+private extension JetpackFullscreenOverlayGeneralViewModel {
     enum Constants {
         static let statsLogoAnimationLtr = "JetpackStatsLogoAnimation_ltr"
         static let statsLogoAnimationRtl = "JetpackStatsLogoAnimation_rtl"

…ackFullscreenOverlayViewController.swift …ackFullscreenOverlayViewController.swiftWordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayViewController.swift renamed to WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayViewController.swift WordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayViewController.swift renamed to WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayViewController.swift

@@ -5,13 +5,13 @@ class JetpackFullscreenOverlayViewController: UIViewController {
 
     // MARK: Variables
 
-    private let config: JetpackFullscreenOverlayConfig
+    private let viewModel: JetpackFullscreenOverlayViewModel
 
     /// Sets the animation based on the language orientation
     private var animation: Animation? {
         traitCollection.layoutDirection == .leftToRight ?
-        Animation.named(config.animationLtr) :
-        Animation.named(config.animationRtl)
+        Animation.named(viewModel.animationLtr) :
+        Animation.named(viewModel.animationRtl)
     }
 
     // MARK: Lazy Views
@@ -55,8 +55,8 @@ class JetpackFullscreenOverlayViewController: UIViewController {
 
     // MARK: Initializers
 
-    init(with config: JetpackFullscreenOverlayConfig) {
-        self.config = config
+    init(with viewModel: JetpackFullscreenOverlayViewModel) {
+        self.viewModel = viewModel
         super.init(nibName: nil, bundle: nil)
     }
 
@@ -78,6 +78,7 @@ class JetpackFullscreenOverlayViewController: UIViewController {
         setupFonts()
         setupButtonInsets()
         animationView.play()
+        viewModel.trackOverlayDisplayed()
     }
 
     // MARK: Helpers
@@ -97,7 +98,7 @@ class JetpackFullscreenOverlayViewController: UIViewController {
     }
 
     private func addCloseButtonIfNeeded() {
-        guard config.shouldShowCloseButton else {
+        guard viewModel.shouldShowCloseButton else {
             return
         }
 
@@ -117,13 +118,13 @@ class JetpackFullscreenOverlayViewController: UIViewController {
     private func setupContent() {
         animationView.animation = animation
         setTitle()
-        subtitleLabel.text = config.subtitle
-        footnoteLabel.text = config.footnote
-        switchButton.setTitle(config.switchButtonText, for: .normal)
-        continueButton.setTitle(config.continueButtonText, for: .normal)
-        footnoteLabel.isHidden = config.footnoteIsHidden
-        learnMoreButton.isHidden = config.learnMoreButtonIsHidden
-        continueButton.isHidden = config.continueButtonIsHidden
+        subtitleLabel.text = viewModel.subtitle
+        footnoteLabel.text = viewModel.footnote
+        switchButton.setTitle(viewModel.switchButtonText, for: .normal)
+        continueButton.setTitle(viewModel.continueButtonText, for: .normal)
+        footnoteLabel.isHidden = viewModel.footnoteIsHidden
+        learnMoreButton.isHidden = viewModel.learnMoreButtonIsHidden
+        continueButton.isHidden = viewModel.continueButtonIsHidden
         setupLearnMoreButton()
     }
 
@@ -136,7 +137,7 @@ class JetpackFullscreenOverlayViewController: UIViewController {
             .paragraphStyle: style,
             .kern: Metrics.titleKern
         ]
-        let attributedString = NSMutableAttributedString(string: config.title)
+        let attributedString = NSMutableAttributedString(string: viewModel.title)
         attributedString.addAttributes(defaultAttributes, range: NSRange(location: 0, length: attributedString.length))
         titleLabel.attributedText = attributedString
     }
@@ -203,26 +204,30 @@ class JetpackFullscreenOverlayViewController: UIViewController {
 
     @objc private func closeButtonPressed(sender: UIButton) {
         dismiss(animated: true, completion: nil)
+        viewModel.trackCloseButtonTapped()
     }
 
 
     @IBAction func switchButtonPressed(_ sender: Any) {
         // TODO: Add here action to redirect to the JP app
+        viewModel.trackSwitchButtonTapped()
     }
 
     @IBAction func continueButtonPressed(_ sender: Any) {
         dismiss(animated: true, completion: nil)
+        viewModel.trackContinueButtonTapped()
     }
 
     @IBAction func learnMoreButtonPressed(_ sender: Any) {
         guard let url = URL(string: Constants.learnMoreURLString) else {
             return
         }
 
-        let source = "jetpack_overlay_\(config.analyticsSource)"
+        let source = "jetpack_overlay_\(viewModel.analyticsSource)"
         let webViewController = WebViewControllerFactory.controller(url: url, source: source)
         let navController = UINavigationController(rootViewController: webViewController)
         present(navController, animated: true)
+        viewModel.trackLearnMoreTapped()
     }
 }
 

…tpackFullscreenOverlayViewController.xib …tpackFullscreenOverlayViewController.xibWordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayViewController.xib renamed to WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayViewController.xib WordPress/Classes/ViewRelated/Jetpack/Branding/Overlay/JetpackFullscreenOverlayViewController.xib renamed to WordPress/Classes/ViewRelated/Jetpack/Branding/Fullscreen Overlay/JetpackFullscreenOverlayViewController.xib

@@ -1,7 +1,7 @@
 import Foundation
 
 /// Protocol used to configure `JetpackFullscreenOverlayViewController`
-protocol JetpackFullscreenOverlayConfig {
+protocol JetpackFullscreenOverlayViewModel {
     var title: String { get }
     var subtitle: String { get }
     var animationLtr: String { get }
@@ -12,9 +12,15 @@ protocol JetpackFullscreenOverlayConfig {
     var continueButtonText: String? { get }
     var shouldShowCloseButton: Bool { get }
     var analyticsSource: String { get }
+
+    func trackOverlayDisplayed()
+    func trackLearnMoreTapped()
+    func trackSwitchButtonTapped()
+    func trackCloseButtonTapped()
+    func trackContinueButtonTapped()
 }
 
-extension JetpackFullscreenOverlayConfig {
+extension JetpackFullscreenOverlayViewModel {
     var learnMoreButtonIsHidden: Bool {
         !shouldShowLearnMoreButton
     }