Top Performers Card: Observe opened product and reload stats upon changes (#16380)

Author: itsmeichigo

Modules/Sources/Networking/Model/Stats/TopEarnerStatsItem.swift

@@ -73,3 +73,91 @@ extension TopEarnerStatsItem: Identifiable {
         productID
     }
 }
+
+// MARK: - Helper to init Product
+//
+public extension Product {
+    init(siteID: Int64,
+         productID: Int64,
+         name: String,
+         images: [ProductImage]) {
+        self.init(siteID: siteID,
+                  productID: productID,
+                  name: name,
+                  slug: "",
+                  permalink: "",
+                  date: Date(),
+                  dateCreated: Date(),
+                  dateModified: nil,
+                  dateOnSaleStart: nil,
+                  dateOnSaleEnd: nil,
+                  productTypeKey: ProductType.simple.rawValue,
+                  statusKey: ProductStatus.draft.rawValue,
+                  featured: false,
+                  catalogVisibilityKey: ProductCatalogVisibility.visible.rawValue,
+                  fullDescription: "",
+                  shortDescription: "",
+                  sku: "",
+                  globalUniqueID: "",
+                  price: "",
+                  regularPrice: "",
+                  salePrice: "",
+                  onSale: false,
+                  purchasable: false,
+                  totalSales: 0,
+                  virtual: false,
+                  downloadable: false,
+                  downloads: [],
+                  downloadLimit: -1,
+                  downloadExpiry: -1,
+                  buttonText: "",
+                  externalURL: "",
+                  taxStatusKey: ProductTaxStatus.taxable.rawValue,
+                  taxClass: "",
+                  manageStock: false,
+                  stockQuantity: nil,
+                  stockStatusKey: ProductStockStatus.inStock.rawValue,
+                  backordersKey: ProductBackordersSetting.notAllowed.rawValue,
+                  backordersAllowed: false,
+                  backordered: false,
+                  soldIndividually: false,
+                  weight: "",
+                  dimensions: ProductDimensions(length: "", width: "", height: ""),
+                  shippingRequired: true,
+                  shippingTaxable: true,
+                  shippingClass: "",
+                  shippingClassID: 0,
+                  productShippingClass: nil,
+                  reviewsAllowed: true,
+                  averageRating: "",
+                  ratingCount: 0,
+                  relatedIDs: [],
+                  upsellIDs: [],
+                  crossSellIDs: [],
+                  parentID: 0,
+                  purchaseNote: "",
+                  categories: [],
+                  tags: [],
+                  images: images,
+                  attributes: [],
+                  defaultAttributes: [],
+                  variations: [],
+                  groupedProducts: [],
+                  menuOrder: 0,
+                  addOns: [],
+                  isSampleItem: false,
+                  bundleStockStatus: nil,
+                  bundleStockQuantity: nil,
+                  bundleMinSize: nil,
+                  bundleMaxSize: nil,
+                  bundledItems: [],
+                  password: nil,
+                  compositeComponents: [],
+                  subscription: nil,
+                  minAllowedQuantity: nil,
+                  maxAllowedQuantity: nil,
+                  groupOfQuantity: nil,
+                  combineVariationQuantities: nil,
+                  customFields: [])
+    }
+}

RELEASE-NOTES.txt

@@ -5,6 +5,7 @@
 -----
 - [*] Better support site credential login for sites with captcha plugins [https://github.com/woocommerce/woocommerce-ios/pull/16372]
 - [*] Crash fix attempt to resolve the race condition in request authenticator swapping [https://github.com/woocommerce/woocommerce-ios/pull/16370]
+- [*] Update products on the Top Performers card when there are changes made to displayed products [https://github.com/woocommerce/woocommerce-ios/pull/16380]
 - [Internal] Fix broken navigation to a variable product selector [https://github.com/woocommerce/woocommerce-ios/pull/16363]
 
 23.7

WooCommerce/Classes/ViewRelated/Dashboard/TopPerformers/TopPerformersDashboardViewModel.swift

@@ -31,6 +31,11 @@ final class TopPerformersDashboardViewModel: ObservableObject {
 
     private var resultsController: ResultsController<StorageTopEarnerStats>?
 
+    // Map of product IDs and their listeners
+    private var entityListeners: [Int64: EntityListener<Product>] = [:]
+
+    private var hasProductChanges = PassthroughSubject<Void, Never>()
+
     private var currentDate: Date {
         Date()
     }
@@ -83,6 +88,7 @@ final class TopPerformersDashboardViewModel: ObservableObject {
         self.usageTracksEventEmitter = usageTracksEventEmitter
 
         observeSyncingCompletion()
+        observeProductChanges()
 
         Task { @MainActor in
             self.timeRange = await loadLastTimeRange() ?? .today
@@ -215,6 +221,57 @@ private extension TopPerformersDashboardViewModel {
             .store(in: &subscriptions)
     }
 
+    func observeProductChanges() {
+        hasProductChanges
+            .debounce(for: .milliseconds(300), scheduler: DispatchQueue.main)
+            .sink { [weak self] in
+                Task {
+                    await self?.reloadDataIfNeeded(forceRefresh: true)
+                }
+            }
+            .store(in: &subscriptions)
+    }
+
+    func observeProducts(for items: [TopEarnerStatsItem]) {
+        let ids = items.map { $0.productID }
+        entityListeners = entityListeners.filter { ids.contains($0.key) }
+        for item in items {
+            if entityListeners[item.productID] == nil {
+                let listener = createProductEntityListener(for: item)
+                entityListeners[item.productID] = listener
+            }
+        }
+    }
+
+    func createProductEntityListener(for item: TopEarnerStatsItem) -> EntityListener<Product> {
+        /// Mock product item out of details from top stat item
+        var product = Product(
+            siteID: siteID,
+            productID: item.productID,
+            name: item.productName ?? "",
+            images: [ProductImage(
+                imageID: -1,
+                dateCreated: Date(),
+                dateModified: nil,
+                src: item.imageUrl ?? "",
+                name: nil,
+                alt: nil)
+            ]
+        )
+        let entityListener = EntityListener(storageManager: ServiceLocator.storageManager, readOnlyEntity: product)
+        entityListener.onUpsert = { [weak self] updatedProduct in
+            // reload stats if there are changes to product
+            guard let self,
+                  updatedProduct.name != product.name ||
+                    updatedProduct.imageURL != product.imageURL else {
+                return
+            }
+            product = updatedProduct
+            hasProductChanges.send(())
+        }
+        return entityListener
+    }
+
     @MainActor
     func loadLastTimeRange() async -> StatsTimeRangeV4? {
         await withCheckedContinuation { continuation in
@@ -262,9 +319,11 @@ private extension TopPerformersDashboardViewModel {
             return
         }
         guard let items = topEarnerStats?.items?.sorted(by: >), items.isNotEmpty else {
+            entityListeners = [:]
             return periodViewModel.update(state: .loaded(rows: []))
         }
         periodViewModel.update(state: .loaded(rows: items))
+        observeProducts(for: items)
     }
 
     func createResultsController(timeRange: StatsTimeRangeV4) -> ResultsController<StorageTopEarnerStats> {