Merge pull request #7717 from woocommerce/issue/7714-widget-analytics

Widget:  Analytics

Author: Ecarrion

WooCommerce/Classes/Analytics/WooAnalytics.swift

@@ -1,6 +1,7 @@
 import Foundation
 import UIKit
 import WordPressShared
+import WidgetKit
 
 public class WooAnalytics: Analytics {
 
@@ -180,7 +181,10 @@ private extension WooAnalytics {
     }
 
     @objc func trackApplicationOpened() {
-        track(.applicationOpened)
+        WidgetCenter.shared.getCurrentConfigurations { [weak self] configurationResult in
+            guard let self = self else { return }
+            self.track(.applicationOpened, withProperties: self.applicationOpenedProperties(configurationResult))
+        }
         applicationOpenedTime = Date()
     }
 
@@ -211,6 +215,27 @@ private extension WooAnalytics {
         updatedProperties[PropertyKeys.wpcomStoreKey] = site?.isWordPressStore
         return updatedProperties
     }
+
+    /// Builds the necesary properties for the `application_opened` event.
+    ///
+    func applicationOpenedProperties(_ configurationResult: Result<[WidgetInfo], Error>) -> [String: [String]] {
+        guard let installedWidgets = try? configurationResult.get() else {
+            return ["widgets": []]
+        }
+
+        // Translate the widget kind into a name recognized by tracks.
+        let widgetAnalyticNames: [String] = installedWidgets.map { widgetInfo in
+            switch widgetInfo.kind {
+            case WooConstants.storeInfoWidgetKind:
+                return WooAnalyticsEvent.Widgets.Name.todayStats.rawValue
+            default:
+                DDLogWarn("⚠️ Make sure the widget: \(widgetInfo.kind), has the correct tracks name.")
+                return widgetInfo.kind
+            }
+        }
+
+        return ["widgets": widgetAnalyticNames]
+    }
 }
 
 

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -1605,3 +1605,22 @@ extension WooAnalyticsEvent {
         }
     }
 }
+
+// MARK: - Widgets {
+extension WooAnalyticsEvent {
+    enum Widgets {
+        enum Key: String {
+            case name = "name"
+        }
+
+        enum Name: String {
+            case todayStats = "today_stats"
+        }
+
+        /// Event when a widget is tapped and opens the app.
+        ///
+        static func widgetTapped(name: Name) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .widgetTapped, properties: [Key.name.rawValue: name.rawValue])
+        }
+    }
+}

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -688,6 +688,9 @@ public enum WooAnalyticsStat: String {
     case loginJetpackConnectDismissed = "login_jetpack_connect_dismissed"
     case loginJetpackConnectionURLFetchFailed = "login_jetpack_connection_url_fetch_failed"
     case loginJetpackConnectionVerificationFailed = "login_jetpack_connection_verification_failed"
+
+    // MARK: Widgets
+    case widgetTapped = "widget_tapped"
 }
 
 public extension WooAnalyticsStat {

WooCommerce/Classes/AppDelegate.swift

@@ -180,6 +180,8 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             handleWebActivity(userActivity)
         }
 
+        trackWidgetTappedIfNeeded(userActivity: userActivity)
+
         return true
     }
 }
@@ -374,6 +376,17 @@ private extension AppDelegate {
     func startABTesting() async {
         await ABTest.start()
     }
+
+    /// Tracks if the application was opened via a widget tap.
+    ///
+    func trackWidgetTappedIfNeeded(userActivity: NSUserActivity) {
+        switch userActivity.activityType {
+        case WooConstants.storeInfoWidgetKind:
+            ServiceLocator.analytics.track(event: .Widgets.widgetTapped(name: .todayStats))
+        default:
+            break
+        }
+    }
 }