Add: Implement analytics tracking in JP overlay config

Author: hassaanelgarem

WordPress/Classes/ViewRelated/Jetpack/Branding/Analytics/JetpackFullscreenOverlayGeneralConfig+Analytics.swift

@@ -0,0 +1,60 @@
+import Foundation
+import AutomatticTracks
+
+extension JetpackFullscreenOverlayGeneralConfig {
+
+    // MARK: Private Enum Decleration
+
+    private enum DismissalType: String {
+        case close, swipe, `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 trackOverlaySwippedDown() {
+        trackOverlayDismissed(dismissalType: .swipe)
+    }
+
+    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)
+    }
+}

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

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

@@ -12,6 +12,13 @@ protocol JetpackFullscreenOverlayConfig {
     var continueButtonText: String? { get }
     var shouldShowCloseButton: Bool { get }
     var analyticsSource: String { get }
+
+    func trackOverlayDisplayed()
+    func trackLearnMoreTapped()
+    func trackSwitchButtonTapped()
+    func trackCloseButtonTapped()
+    func trackOverlaySwippedDown()
+    func trackContinueButtonTapped()
 }
 
 extension JetpackFullscreenOverlayConfig {

WordPress/WordPress.xcodeproj/project.pbxproj

@@ -1504,8 +1504,8 @@
 		7EFF208620EAD918009C4699 /* FormattableUserContent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7EFF208520EAD918009C4699 /* FormattableUserContent.swift */; };
 		7EFF208A20EADCB6009C4699 /* NotificationTextContent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7EFF208920EADCB6009C4699 /* NotificationTextContent.swift */; };
 		7EFF208C20EADF68009C4699 /* FormattableCommentContent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7EFF208B20EADF68009C4699 /* FormattableCommentContent.swift */; };
-		800035BD291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift */; };
-		800035BE291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift */; };
+		800035BD291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift in Sources */ = {isa = PBXBuildFile; fileRef = 800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift */; };
+		800035BE291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift in Sources */ = {isa = PBXBuildFile; fileRef = 800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift */; };
 		801D94EF2919E7D70051993E /* JetpackFullscreenOverlayGeneralPhaseConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 801D94EE2919E7D70051993E /* JetpackFullscreenOverlayGeneralPhaseConfig.swift */; };
 		801D94F02919E7D70051993E /* JetpackFullscreenOverlayGeneralPhaseConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 801D94EE2919E7D70051993E /* JetpackFullscreenOverlayGeneralPhaseConfig.swift */; };
 		801D950D291AB3CF0051993E /* JetpackReaderLogoAnimation_ltr.json in Resources */ = {isa = PBXBuildFile; fileRef = 801D9507291AB3CD0051993E /* JetpackReaderLogoAnimation_ltr.json */; };
@@ -6751,7 +6751,7 @@
 		7EFF208520EAD918009C4699 /* FormattableUserContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FormattableUserContent.swift; sourceTree = "<group>"; };
 		7EFF208920EADCB6009C4699 /* NotificationTextContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationTextContent.swift; sourceTree = "<group>"; };
 		7EFF208B20EADF68009C4699 /* FormattableCommentContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FormattableCommentContent.swift; sourceTree = "<group>"; };
-		800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JetpackFullscreenOverlayAnalyticsHelper.swift; sourceTree = "<group>"; };
+		800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "JetpackFullscreenOverlayGeneralConfig+Analytics.swift"; sourceTree = "<group>"; };
 		801D94EE2919E7D70051993E /* JetpackFullscreenOverlayGeneralPhaseConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JetpackFullscreenOverlayGeneralPhaseConfig.swift; sourceTree = "<group>"; };
 		801D9507291AB3CD0051993E /* JetpackReaderLogoAnimation_ltr.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = JetpackReaderLogoAnimation_ltr.json; sourceTree = "<group>"; };
 		801D9508291AB3CD0051993E /* JetpackReaderLogoAnimation_rtl.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = JetpackReaderLogoAnimation_rtl.json; sourceTree = "<group>"; };
@@ -12267,7 +12267,7 @@
 			isa = PBXGroup;
 			children = (
 				C3FBF4E728AFEDF8003797DF /* JetpackBrandingAnalyticsHelper.swift */,
-				800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift */,
+				800035BC291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift */,
 			);
 			path = Analytics;
 			sourceTree = "<group>";
@@ -20553,7 +20553,7 @@
 				4A50668028B364CA00DD09F4 /* ContainerContextFactory.swift in Sources */,
 				B0F2EFBF259378E600C7EB6D /* SiteSuggestionService.swift in Sources */,
 				4388FF0020A4E19C00783948 /* NotificationsViewController+PushPrimer.swift in Sources */,
-				800035BD291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift in Sources */,
+				800035BD291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift in Sources */,
 				98517E5928220411001FFD45 /* BloggingPromptTableViewCell.swift in Sources */,
 				5D3D559718F88C3500782892 /* ReaderPostService.m in Sources */,
 				7EA30DB521ADA20F0092F894 /* EditorMediaUtility.swift in Sources */,
@@ -22937,7 +22937,7 @@
 				FABB23112602FC2C00C8785C /* PostingActivityLegend.swift in Sources */,
 				8B92D69727CD51FA001F5371 /* DashboardGhostCardCell.swift in Sources */,
 				FABB23122602FC2C00C8785C /* WPImmuTableRows.swift in Sources */,
-				800035BE291DD0D7007D2D26 /* JetpackFullscreenOverlayAnalyticsHelper.swift in Sources */,
+				800035BE291DD0D7007D2D26 /* JetpackFullscreenOverlayGeneralConfig+Analytics.swift in Sources */,
 				FABB23132602FC2C00C8785C /* WordPress-87-88.xcmappingmodel in Sources */,
 				FABB23142602FC2C00C8785C /* UsersService.swift in Sources */,
 				FABB23152602FC2C00C8785C /* SharePost+UIActivityItemSource.swift in Sources */,