JetpackStatsWidgets (#24221)

* Move WidgetAnalytics to the app

* Remove LockScreenSingleStatViewModel and other types from WordPress

* Move AllTimeWidgetStats to JetpackStatsWidgetsCore

* Fix

* Move JetpackStatsWidgetConfiguration to JetpackStatsWidgetCore

* Move TodayWidgetStats

* Move HomeWidgetAllTimeData

* Move HomeWidgetThisWeekData

* Cleanup formatting in HomeWidgetThisWeek

* Fix WordPressTest compilation

Author: kean

Modules/Sources/JetpackStatsWidgetsCore/Model/AllTimeWidgetStats.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+/// This struct contains data for the Insights All Time stats to be displayed in the corresponding widget.
+///
+
+public struct AllTimeWidgetStats: Codable, Equatable {
+    public let views: Int
+    public let visitors: Int
+    public let posts: Int
+    public let bestViews: Int
+
+    public init(views: Int? = 0, visitors: Int? = 0, posts: Int? = 0, bestViews: Int? = 0) {
+        self.views = views ?? 0
+        self.visitors = visitors ?? 0
+        self.posts = posts ?? 0
+        self.bestViews = bestViews ?? 0
+    }
+}

Modules/Sources/JetpackStatsWidgetsCore/Model/HomeWidgetAllTimeData.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public struct HomeWidgetAllTimeData: HomeWidgetData {
+    public let siteID: Int
+    public let siteName: String
+    public let url: String
+    public let timeZone: TimeZone
+    public let date: Date
+    public let stats: AllTimeWidgetStats
+    public static let filename = WidgetStatsConfiguration.allTimeFilename
+
+    public var statsURL: URL? {
+        guard let statsUrl = URL(string: "https://wordpress.com/stats/insights/") else {
+            return nil
+        }
+        return statsUrl.appendingPathComponent(String(siteID))
+    }
+
+    public init(siteID: Int, siteName: String, url: String, timeZone: TimeZone, date: Date, stats: AllTimeWidgetStats) {
+        self.siteID = siteID
+        self.siteName = siteName
+        self.url = url
+        self.timeZone = timeZone
+        self.date = date
+        self.stats = stats
+    }
+}

Modules/Sources/JetpackStatsWidgetsCore/Model/HomeWidgetThisWeekData.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public struct HomeWidgetThisWeekData: HomeWidgetData {
+    public let siteID: Int
+    public let siteName: String
+    public let url: String
+    public let timeZone: TimeZone
+    public let date: Date
+    public let stats: ThisWeekWidgetStats
+    public static let filename = WidgetStatsConfiguration.thisWeekFilename
+
+    public var statsURL: URL? {
+        guard let statsUrl = URL(string: "https://wordpress.com/stats/week/") else {
+            return nil
+        }
+        return statsUrl.appendingPathComponent(String(siteID))
+    }
+
+    public init(siteID: Int, siteName: String, url: String, timeZone: TimeZone, date: Date, stats: ThisWeekWidgetStats) {
+        self.siteID = siteID
+        self.siteName = siteName
+        self.url = url
+        self.timeZone = timeZone
+        self.date = date
+        self.stats = stats
+    }
+}

Modules/Sources/JetpackStatsWidgetsCore/Model/HomeWidgetTodayData.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public struct HomeWidgetTodayData: HomeWidgetData {
+    public let siteID: Int
+    public let siteName: String
+    public let url: String
+    public let timeZone: TimeZone
+    public let date: Date
+    public let stats: TodayWidgetStats
+    public static let filename = WidgetStatsConfiguration.todayFilename
+
+    public var statsURL: URL? {
+        guard let statsUrl = URL(string: "https://wordpress.com/stats/day/") else {
+            return nil
+        }
+        return statsUrl.appendingPathComponent(String(siteID))
+    }
+
+    public init(siteID: Int, siteName: String, url: String, timeZone: TimeZone, date: Date, stats: TodayWidgetStats) {
+        self.siteID = siteID
+        self.siteName = siteName
+        self.url = url
+        self.timeZone = timeZone
+        self.date = date
+        self.stats = stats
+    }
+}

Modules/Sources/JetpackStatsWidgetsCore/Model/TodayWidgetStats.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+/// This struct contains data for the Insights Today stats to be displayed in the corresponding widget.
+///
+
+public struct TodayWidgetStats: Codable, Equatable {
+    public let views: Int
+    public let visitors: Int
+    public let likes: Int
+    public let comments: Int
+
+    public init(views: Int? = 0, visitors: Int? = 0, likes: Int? = 0, comments: Int? = 0) {
+        self.views = views ?? 0
+        self.visitors = visitors ?? 0
+        self.likes = likes ?? 0
+        self.comments = comments ?? 0
+    }
+}

Modules/Sources/JetpackStatsWidgetsCore/WidgetStatsConfiguration.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public enum WidgetStatsConfiguration {
+    public static let keychainTokenKey = "OAuth2Token"
+    public static let keychainServiceName = "JetpackTodayWidget"
+    public static let userDefaultsSiteIdKey = "JetpackHomeWidgetsSiteId"
+    public static let userDefaultsLoggedInKey = "JetpackHomeWidgetsLoggedIn"
+    public static let todayFilename = "JetpackHomeWidgetTodayData.plist"
+    public static let allTimeFilename = "JetpackHomeWidgetAllTimeData.plist"
+    public static let thisWeekFilename = "JetpackHomeWidgetThisWeekData.plist"
+
+    public enum Kind: String {
+        case homeToday = "JetpackHomeWidgetToday"
+        case homeAllTime = "JetpackHomeWidgetAllTime"
+        case homeThisWeek = "JetpackHomeWidgetThisWeek"
+        case lockScreenTodayViews = "JetpackLockScreenWidgetTodayViews"
+        case lockScreenTodayLikesComments = "JetpackLockScreenWidgetTodayLikesComments"
+        case lockScreenTodayViewsVisitors = "JetpackLockScreenWidgetTodayViewsVisitors"
+        case lockScreenAllTimeViews = "JetpackLockScreenWidgetAllTimeViews"
+        case lockScreenAllTimeViewsVisitors = "JetpackLockScreenWidgetAllTimeViewsVisitors"
+        case lockScreenAllTimePostsBestViews = "JetpackLockScreenWidgetAllTimePostsBestViews"
+
+        public var countKey: String {
+            return rawValue + "Properties"
+        }
+    }
+}

WordPress/Classes/Stores/StatsInsightsStore.swift

@@ -2,6 +2,7 @@ import Foundation
 import WordPressKit
 import WordPressFlux
 import WidgetKit
+import JetpackStatsWidgetsCore
 
 enum InsightAction: Action {
 

WordPress/Classes/Stores/StatsPeriodStore.swift

@@ -1,6 +1,7 @@
 import Foundation
 import WordPressFlux
 import WidgetKit
+import JetpackStatsWidgetsCore
 
 enum PeriodType: CaseIterable {
     case timeIntervalsSummary

WordPress/Classes/Stores/StatsWidgetsStore.swift

@@ -1,3 +1,4 @@
+import Foundation
 import JetpackStatsWidgetsCore
 import SFHFKeychainUtils
 import WidgetKit
@@ -36,8 +37,8 @@ class StatsWidgetsStore {
 
     /// Initialize the local cache for widgets, if it does not exist
     @objc func initializeStatsWidgetsIfNeeded() {
-        UserDefaults(suiteName: WPAppGroupName)?.setValue(AccountHelper.isLoggedIn, forKey: AppConfiguration.Widget.Stats.userDefaultsLoggedInKey)
-        UserDefaults(suiteName: WPAppGroupName)?.setValue(AccountHelper.defaultSiteId, forKey: AppConfiguration.Widget.Stats.userDefaultsSiteIdKey)
+        UserDefaults(suiteName: WPAppGroupName)?.setValue(AccountHelper.isLoggedIn, forKey: WidgetStatsConfiguration.userDefaultsLoggedInKey)
+        UserDefaults(suiteName: WPAppGroupName)?.setValue(AccountHelper.defaultSiteId, forKey: WidgetStatsConfiguration.userDefaultsSiteIdKey)
         storeCredentials()
 
         var isReloadRequired = false
@@ -269,15 +270,15 @@ private extension StatsWidgetsStore {
     @objc func handleAccountChangedNotification() {
         let isLoggedIn = AccountHelper.isLoggedIn
         let userDefaults = UserDefaults(suiteName: WPAppGroupName)
-        userDefaults?.setValue(isLoggedIn, forKey: AppConfiguration.Widget.Stats.userDefaultsLoggedInKey)
+        userDefaults?.setValue(isLoggedIn, forKey: WidgetStatsConfiguration.userDefaultsLoggedInKey)
 
         guard !isLoggedIn else { return }
 
         HomeWidgetTodayData.delete()
         HomeWidgetThisWeekData.delete()
         HomeWidgetAllTimeData.delete()
 
-        userDefaults?.setValue(nil, forKey: AppConfiguration.Widget.Stats.userDefaultsSiteIdKey)
+        userDefaults?.setValue(nil, forKey: WidgetStatsConfiguration.userDefaultsSiteIdKey)
 
         WidgetCenter.shared.reloadAllTimelines()
     }
@@ -308,12 +309,12 @@ private extension StatsWidgetsStore {
         guard let account = try? WPAccount.lookupDefaultWordPressComAccount(in: coreDataStack.mainContext),
               let siteId = account.defaultBlog?.dotComID,
               let userDefaults = UserDefaults(suiteName: WPAppGroupName),
-              userDefaults.value(forKey: AppConfiguration.Widget.Stats.userDefaultsSiteIdKey) == nil else {
+              userDefaults.value(forKey: WidgetStatsConfiguration.userDefaultsSiteIdKey) == nil else {
             return
         }
 
-        userDefaults.setValue(AccountHelper.isLoggedIn, forKey: AppConfiguration.Widget.Stats.userDefaultsLoggedInKey)
-        userDefaults.setValue(siteId, forKey: AppConfiguration.Widget.Stats.userDefaultsSiteIdKey)
+        userDefaults.setValue(AccountHelper.isLoggedIn, forKey: WidgetStatsConfiguration.userDefaultsLoggedInKey)
+        userDefaults.setValue(siteId, forKey: WidgetStatsConfiguration.userDefaultsSiteIdKey)
         initializeStatsWidgetsIfNeeded()
     }
 
@@ -329,9 +330,9 @@ private extension StatsWidgetsStore {
 
         do {
             try SFHFKeychainUtils.storeUsername(
-                AppConfiguration.Widget.Stats.keychainTokenKey,
+                WidgetStatsConfiguration.keychainTokenKey,
                 andPassword: token,
-                forServiceName: AppConfiguration.Widget.Stats.keychainServiceName,
+                forServiceName: WidgetStatsConfiguration.keychainServiceName,
                 accessGroup: WPAppKeychainAccessGroup,
                 updateExisting: true
             )

…tatsWidgets/Tracks/WidgetAnalytics.swift …/Utility/Analytics/WidgetAnalytics.swiftWordPress/JetpackStatsWidgets/Tracks/WidgetAnalytics.swift renamed to WordPress/Classes/Utility/Analytics/WidgetAnalytics.swift WordPress/JetpackStatsWidgets/Tracks/WidgetAnalytics.swift renamed to WordPress/Classes/Utility/Analytics/WidgetAnalytics.swift

@@ -1,5 +1,6 @@
 import Foundation
 import WidgetKit
+import JetpackStatsWidgetsCore
 
 @objcMembers class WidgetAnalytics: NSObject {
     static func trackLoadedWidgetsOnApplicationOpened() {
@@ -17,7 +18,7 @@ import WidgetKit
         }
 
         let widgetAnalyticNames: [String] = installedWidgets.map { widgetInfo in
-            guard let eventKind = AppConfiguration.Widget.Stats.Kind(rawValue: widgetInfo.kind) else {
+            guard let eventKind = WidgetStatsConfiguration.Kind(rawValue: widgetInfo.kind) else {
                 DDLogWarn("⚠️ Make sure the widget: \(widgetInfo.kind), has the correct kind.")
                 return "\(widgetInfo.kind)_\(widgetInfo.family)"
             }
@@ -42,7 +43,7 @@ import WidgetKit
         case lockScreenAllTimeViewsVisitorsWidget = "widget_all_time_views_visitors_lockscreen"
         case lockScreenAllTimePostsBestViewsWidget = "widget_all_time_posts_best_views_lockscreen"
 
-        static func eventPrefix(for widgetKind: AppConfiguration.Widget.Stats.Kind) -> Events {
+        static func eventPrefix(for widgetKind: WidgetStatsConfiguration.Kind) -> Events {
             switch widgetKind {
             case .homeToday:
                 return .homeTodayWidget