Merge branch 'trunk' into woomob-1141-woo-poshistorical-orders-order-details-analytics

Author: staskus

.swiftlint.yml

@@ -1,6 +1,7 @@
 swiftlint_version: 0.58.2
 
 excluded:
+  - build
   - BuildTools/.build
   - DerivedData
   - fastlane

Modules/Sources/Experiments/DefaultFeatureFlagService.swift

@@ -86,8 +86,6 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return false
         case .productImageOptimizedHandling:
             return true
-        case .pointOfSaleAsATabi2:
-            return true
         case .pointOfSaleOrdersi1:
             return true
         case .pointOfSaleOrdersi2:

Modules/Sources/Experiments/FeatureFlag.swift

@@ -179,10 +179,6 @@ public enum FeatureFlag: Int {
     ///
     case inventoryProductLabelsInPOS
 
-    /// Enables displaying POS as a tab in the tab bar for stores in eligible countries
-    ///
-    case pointOfSaleAsATabi2
-
     /// Enables displaying Point Of Sale details in order list and order details
     ///
     case pointOfSaleOrdersi1

Modules/Sources/WooFoundation/Utilities/WaitingTimeTracker.swift

@@ -0,0 +1,86 @@
+import Foundation
+
+/// Tracks the waiting time for a given scenario, allowing to evaluate as analytics
+/// how much time in seconds it took between the init and `end` function call
+///
+public class WaitingTimeTracker {
+    private let trackScenario: WooAnalyticsEvent.WaitingTime.Scenario
+    private let currentTimestampSeconds: () -> TimeInterval
+    private let waitingStartedTimestamp: TimeInterval
+
+    public enum TrackingUnit {
+        case seconds
+        case milliseconds
+    }
+
+    public init(trackScenario: WooAnalyticsEvent.WaitingTime.Scenario,
+                currentTimestampSeconds: @escaping () -> TimeInterval = { Date().timeIntervalSince1970 }
+    ) {
+        self.trackScenario = trackScenario
+        self.currentTimestampSeconds = currentTimestampSeconds
+        waitingStartedTimestamp = currentTimestampSeconds()
+    }
+
+    /// Default `end()` method to preserve interface compatibility. By default, tracks in `.seconds`
+    /// - Returns: The analytics event to be tracked.
+    ///
+    public func end() -> WooAnalyticsEvent {
+        end(using: .seconds)
+    }
+
+    /// End the waiting time by evaluating the elapsed time from the init,
+    /// and returning an analytics event for tracking.
+    ///
+    /// - Parameter trackingUnit: Defines whether the elapsed time should be tracked in `.seconds` or `.milliseconds` (default is `.seconds`).
+    /// - Returns: The analytics event to be tracked.
+    ///
+    public func end(using trackingUnit: TrackingUnit = .seconds) -> WooAnalyticsEvent {
+        let elapsedTime = calculateElapsedTime(in: trackingUnit)
+        return .WaitingTime.waitingFinished(scenario: trackScenario, elapsedTime: elapsedTime)
+    }
+
+    /// Calculates elapsed time in the specified tracking unit.
+    ///
+    private func calculateElapsedTime(in trackingUnit: TrackingUnit) -> TimeInterval {
+        let elapsedTime = currentTimestampSeconds() - waitingStartedTimestamp
+        return trackingUnit == .milliseconds ? elapsedTime * 1000 : elapsedTime
+    }
+}
+
+// MARK: - Waiting Time measurement
+//
+public extension WooAnalyticsEvent {
+    enum WaitingTime {
+        /// Possible Waiting time scenarios
+        public enum Scenario {
+            case orderDetails
+            case dashboardTopPerformers
+            case dashboardMainStats
+            case analyticsHub
+            case appStartup
+            case pointOfSaleLoaded
+        }
+
+        private enum Keys {
+            static let waitingTime = "waiting_time"
+            static let millisecondsTimeElapsedInSplashScreen = "milliseconds_time_elapsed_in_splash_screen"
+        }
+
+        static func waitingFinished(scenario: Scenario, elapsedTime: TimeInterval) -> WooAnalyticsEvent {
+            switch scenario {
+            case .orderDetails:
+                return WooAnalyticsEvent(statName: .orderDetailWaitingTimeLoaded, properties: [Keys.waitingTime: elapsedTime])
+            case .dashboardTopPerformers:
+                return WooAnalyticsEvent(statName: .dashboardTopPerformersWaitingTimeLoaded, properties: [Keys.waitingTime: elapsedTime])
+            case .dashboardMainStats:
+                return WooAnalyticsEvent(statName: .dashboardMainStatsWaitingTimeLoaded, properties: [Keys.waitingTime: elapsedTime])
+            case .analyticsHub:
+                return WooAnalyticsEvent(statName: .analyticsHubWaitingTimeLoaded, properties: [Keys.waitingTime: elapsedTime])
+            case .appStartup:
+                return WooAnalyticsEvent(statName: .applicationOpenedWaitingTimeLoaded, properties: [Keys.waitingTime: elapsedTime])
+            case .pointOfSaleLoaded:
+                return WooAnalyticsEvent(statName: .pointOfSaleLoaded, properties: [Keys.millisecondsTimeElapsedInSplashScreen: elapsedTime])
+            }
+        }
+    }
+}

Modules/Sources/Yosemite/Model/Model.swift

@@ -31,6 +31,7 @@ public typealias FallibleCancelable = Hardware.FallibleCancelable
 public typealias CommentStatus = Networking.CommentStatus
 public typealias CompositeComponentOptionType = Networking.CompositeComponentOptionType
 public typealias Coupon = Networking.Coupon
+public typealias CouponDiscountType = Networking.Coupon.DiscountType
 public typealias CouponReport = Networking.CouponReport
 public typealias Country = Networking.Country
 public typealias CreateAccountResult = Networking.CreateAccountResult

Modules/Sources/Yosemite/PointOfSale/Coupons/PointOfSaleCouponFetchStrategy.swift

@@ -8,7 +8,7 @@ public protocol PointOfSaleCouponFetchStrategy {
     func fetchLocalCoupons() async throws -> [POSItem]
 }
 
-public struct PointOfSaleDefaultCouponFetchStrategy: PointOfSaleCouponFetchStrategy {
+struct PointOfSaleDefaultCouponFetchStrategy: PointOfSaleCouponFetchStrategy {
     private let siteID: Int64
     private let currencySettings: CurrencySettings
     private let storage: StorageManagerType
@@ -24,7 +24,7 @@ public struct PointOfSaleDefaultCouponFetchStrategy: PointOfSaleCouponFetchStrat
         self.couponStoreMethods = couponStoreMethods
     }
 
-    public func fetchCoupons(pageNumber: Int) async throws -> PagedItems<POSItem> {
+    func fetchCoupons(pageNumber: Int) async throws -> PagedItems<POSItem> {
         // Update local storage with data from the remote
         let hasMorePages = try await syncCouponsFromRemote(pageNumber: pageNumber)
         // Return all local coupons, including updated ones from the remote
@@ -35,7 +35,7 @@ public struct PointOfSaleDefaultCouponFetchStrategy: PointOfSaleCouponFetchStrat
     /// fetchLocalCoupons provides an array of coupons that are stored locally
     /// It does not accept any sort of pagination
     /// Limited to default page size to match remote results
-    public func fetchLocalCoupons() async throws -> [POSItem] {
+    func fetchLocalCoupons() async throws -> [POSItem] {
         return await fetchLocalCoupons(limit: Constants.defaultPageSize)
     }
 }
@@ -66,7 +66,7 @@ extension PointOfSaleDefaultCouponFetchStrategy {
 
 // MARK: - Search Coupon Strategy
 
-public struct PointOfSaleSearchCouponFetchStrategy: PointOfSaleCouponFetchStrategy {
+struct PointOfSaleSearchCouponFetchStrategy: PointOfSaleCouponFetchStrategy {
     private let siteID: Int64
     private let couponStoreMethods: CouponStoreMethodsProtocol
     private let storage: StorageManagerType
@@ -89,7 +89,7 @@ public struct PointOfSaleSearchCouponFetchStrategy: PointOfSaleCouponFetchStrate
         self.analytics = analytics
     }
 
-    public func fetchCoupons(pageNumber: Int) async throws -> PagedItems<POSItem> {
+    func fetchCoupons(pageNumber: Int) async throws -> PagedItems<POSItem> {
         let startTime = Date()
         try await couponStoreMethods.searchCoupons(siteID: siteID,
                                                    keyword: searchTerm,
@@ -116,7 +116,7 @@ public struct PointOfSaleSearchCouponFetchStrategy: PointOfSaleCouponFetchStrate
         return resultsController.fetchCoupons(predicate: predicate)
     }
 
-    public func fetchLocalCoupons() async throws -> [POSItem] {
+    func fetchLocalCoupons() async throws -> [POSItem] {
         // No support for returning local search results
         return []
     }

Modules/Sources/Yosemite/PointOfSale/Coupons/PointOfSaleCouponFetchStrategyFactory.swift

@@ -6,7 +6,12 @@ import class Networking.AlamofireNetwork
 import struct Combine.AnyPublisher
 import struct NetworkingCore.JetpackSite
 
-public struct PointOfSaleCouponFetchStrategyFactory {
+public protocol PointOfSaleCouponFetchStrategyFactoryProtocol {
+    var defaultStrategy: PointOfSaleCouponFetchStrategy { get }
+    func searchStrategy(searchTerm: String, analytics: POSItemFetchAnalyticsTracking) -> PointOfSaleCouponFetchStrategy
+}
+
+public struct PointOfSaleCouponFetchStrategyFactory: PointOfSaleCouponFetchStrategyFactoryProtocol {
     private let siteID: Int64
     private let currencySettings: CurrencySettings
     private let storage: StorageManagerType
@@ -28,14 +33,14 @@ public struct PointOfSaleCouponFetchStrategyFactory {
         self.couponStoreMethods = CouponStoreMethods(storageManager: storage, remote: remote)
     }
 
-    public var defaultStrategy: PointOfSaleDefaultCouponFetchStrategy {
+    public var defaultStrategy: PointOfSaleCouponFetchStrategy {
         PointOfSaleDefaultCouponFetchStrategy(siteID: siteID,
                                               currencySettings: currencySettings,
                                               storage: storage,
                                               couponStoreMethods: couponStoreMethods)
     }
 
-    public func searchStrategy(searchTerm: String, analytics: POSItemFetchAnalyticsTracking) -> PointOfSaleSearchCouponFetchStrategy {
+    public func searchStrategy(searchTerm: String, analytics: POSItemFetchAnalyticsTracking) -> PointOfSaleCouponFetchStrategy {
         PointOfSaleSearchCouponFetchStrategy(siteID: siteID,
                                              currencySettings: currencySettings,
                                              storage: storage,

Modules/Sources/Yosemite/PointOfSale/Items/PointOfSaleItemFetchStrategyFactory.swift

@@ -10,8 +10,6 @@ public protocol PointOfSaleItemFetchStrategyFactoryProtocol {
 
     func searchStrategy(searchTerm: String,
                         analytics: POSItemFetchAnalyticsTracking) -> PointOfSalePurchasableItemFetchStrategy
-
-    func popularStrategy(pageSize: Int) -> PointOfSalePurchasableItemFetchStrategy
 }
 
 public final class PointOfSaleItemFetchStrategyFactory: PointOfSaleItemFetchStrategyFactoryProtocol {
@@ -69,8 +67,4 @@ public final class PointOfSaleFixedItemFetchStrategyFactory: PointOfSaleItemFetc
                                analytics: POSItemFetchAnalyticsTracking) -> PointOfSalePurchasableItemFetchStrategy {
         fixedStrategy
     }
-
-    public func popularStrategy(pageSize: Int) -> PointOfSalePurchasableItemFetchStrategy {
-        fixedStrategy
-    }
 }

Modules/Sources/Yosemite/Tools/POS/POSCatalogSettingsService.swift

@@ -0,0 +1,46 @@
+import Foundation
+import GRDB
+import protocol Storage.GRDBManagerProtocol
+
+public protocol POSCatalogSettingsServiceProtocol {
+    /// Gets catalog information for the specified site.
+    /// - Parameter siteID: The site ID to get catalog information for.
+    /// - Returns: Catalog information including statistics and sync dates.
+    func loadCatalogInfo(for siteID: Int64) async throws -> POSCatalogInfo
+}
+
+public struct POSCatalogInfo {
+    public let productCount: Int
+    public let variationCount: Int
+    public let lastFullSyncDate: Date?
+    public let lastIncrementalSyncDate: Date?
+
+    public init(productCount: Int, variationCount: Int, lastFullSyncDate: Date?, lastIncrementalSyncDate: Date?) {
+        self.productCount = productCount
+        self.variationCount = variationCount
+        self.lastFullSyncDate = lastFullSyncDate
+        self.lastIncrementalSyncDate = lastIncrementalSyncDate
+    }
+}
+
+public class POSCatalogSettingsService: POSCatalogSettingsServiceProtocol {
+    private let grdbManager: GRDBManagerProtocol
+
+    public init(grdbManager: GRDBManagerProtocol) {
+        self.grdbManager = grdbManager
+    }
+
+    public func loadCatalogInfo(for siteID: Int64) async throws -> POSCatalogInfo {
+        try await grdbManager.databaseConnection.read { db in
+            let productCount = try PersistedProduct.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationCount = try PersistedProductVariation.filter { $0.siteID == siteID }.fetchCount(db)
+            let site = try PersistedSite.filter(key: siteID).fetchOne(db)
+            return POSCatalogInfo(
+                productCount: productCount,
+                variationCount: variationCount,
+                lastFullSyncDate: site?.lastCatalogFullSyncDate,
+                lastIncrementalSyncDate: site?.lastCatalogIncrementalSyncDate
+            )
+        }
+    }
+}

Modules/Sources/Yosemite/Tools/Plugins/PluginsService.swift

@@ -1,17 +1,8 @@
 import Foundation
-import WooFoundation
 import protocol Storage.StorageManagerType
 
 /// A service for system plugins.
 public protocol PluginsServiceProtocol {
-    /// Waits for a specific plugin to be available in storage.
-    /// - Parameters:
-    ///   - siteID: The site ID to search for the plugin.
-    ///   - pluginPath: The plugin's file path (e.g., "woocommerce/woocommerce.php" for WooCommerce).
-    ///   - isActive: Whether the plugin is active or not.
-    /// - Returns: The SystemPlugin when found in storage.
-    func waitForPluginInStorage(siteID: Int64, pluginPath: String, isActive: Bool) async -> SystemPlugin
-
     /// Loads a specific plugin from storage synchronously.
     /// - Parameters:
     ///   - siteID: The site ID to search for the plugin.
@@ -37,36 +28,6 @@ public class PluginsService: PluginsServiceProtocol {
         self.storageManager = storageManager
     }
 
-    @MainActor
-    public func waitForPluginInStorage(siteID: Int64, pluginPath: String, isActive: Bool) async -> SystemPlugin {
-        let predicate = \StorageSystemPlugin.siteID == siteID && \StorageSystemPlugin.plugin == pluginPath && \StorageSystemPlugin.active == isActive
-        let pluginDescriptor = NSSortDescriptor(keyPath: \StorageSystemPlugin.plugin, ascending: true)
-        let resultsController = ResultsController<StorageSystemPlugin>(storageManager: storageManager,
-                                                                       matching: predicate,
-                                                                       fetchLimit: 1,
-                                                                       sortedBy: [pluginDescriptor])
-        do {
-            try resultsController.performFetch()
-            if let plugin = resultsController.fetchedObjects.first {
-                return plugin
-            }
-        } catch {
-            DDLogError("Error loading plugin \(pluginPath) for site \(siteID) initially: \(error.localizedDescription)")
-        }
-
-        return await withCheckedContinuation { continuation in
-            var hasResumed = false
-            resultsController.onDidChangeContent = {
-                guard let plugin = resultsController.fetchedObjects.first,
-                      !hasResumed else {
-                    return
-                }
-                hasResumed = true
-                continuation.resume(returning: plugin)
-            }
-        }
-    }
-
     @MainActor
     public func loadPluginInStorage(siteID: Int64, plugin: Plugin, isActive: Bool?) -> SystemPlugin? {
         storageManager.viewStorage.loadSystemPlugin(siteID: siteID,