Update PointOfSaleItemServiceProtocol.providePointOfSaleItems to al…

…so return `PagedItems`.
woocommerce · Dec 19, 2024 · 11b2b1f · 11b2b1f
1 parent a7e4cf3
commit 11b2b1f
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 16 deletions.
diff --git a/Networking/Networking/Remote/Remote.swift b/Networking/Networking/Remote/Remote.swift
@@ -370,6 +370,11 @@ private extension Remote {
 public struct PagedItems<T> {
     public let items: [T]
     public let hasMorePages: Bool
+
+    public init(items: [T], hasMorePages: Bool) {
+        self.items = items
+        self.hasMorePages = hasMorePages
+    }
 }
 
 // MARK: - Constants!

diff --git a/WooCommerce/Classes/POS/Controllers/PointOfSaleItemsController.swift b/WooCommerce/Classes/POS/Controllers/PointOfSaleItemsController.swift
@@ -79,12 +79,13 @@ class PointOfSaleItemsController: PointOfSaleItemsControllerProtocol {
     /// - Returns: A boolean that indicates whether there is next page for the paginated items.
     @MainActor
     private func fetchItems(pageNumber: Int) async throws -> Bool {
-        let (newItems, hasNextPage) = try await itemProvider.providePointOfSaleItems(pageNumber: pageNumber)
+        let pagedItems = try await itemProvider.providePointOfSaleItems(pageNumber: pageNumber)
+        let newItems = pagedItems.items
         let uniqueNewItems = newItems.filter { newItem in
             !allItems.contains(newItem)
         }
         allItems.append(contentsOf: uniqueNewItems)
-        return hasNextPage
+        return pagedItems.hasMorePages
     }
 
     private func updateItemListStateAfterLoadAttempt() {

diff --git a/WooCommerce/Classes/POS/Utils/PreviewHelpers.swift b/WooCommerce/Classes/POS/Utils/PreviewHelpers.swift
@@ -8,6 +8,7 @@ import protocol Yosemite.POSOrderableItem
 import protocol Yosemite.OrderSyncProductTypeProtocol
 import struct Yosemite.OrderSyncProductInput
 import enum Yosemite.ProductType
+import struct Yosemite.PagedItems
 import struct Yosemite.ProductBundleItem
 import struct Yosemite.OrderItem
 import Combine
@@ -37,8 +38,8 @@ struct POSProductPreview: POSOrderableItem, Equatable {
 }
 
 final class PointOfSalePreviewItemService: PointOfSaleItemServiceProtocol {
-    func providePointOfSaleItems(pageNumber: Int) async throws -> (items: [POSItem], hasNextPage: Bool) {
-        (items: [], hasNextPage: true)
+    func providePointOfSaleItems(pageNumber: Int) async throws -> PagedItems<POSItem> {
+        .init(items: [], hasMorePages: true)
     }
 
     func providePointOfSaleItems() -> [POSItem] {

diff --git a/Yosemite/Yosemite/Model/Model.swift b/Yosemite/Yosemite/Model/Model.swift
@@ -157,6 +157,7 @@ public typealias ShippingMethod = Networking.ShippingMethod
 public typealias Site = Networking.Site
 public typealias SiteVisibility = Networking.SiteVisibility
 public typealias SiteAPI = Networking.SiteAPI
+public typealias PagedItems = Networking.PagedItems
 public typealias Post = Networking.Post
 public typealias SitePlugin = Networking.SitePlugin
 public typealias SitePluginStatusEnum = Networking.SitePluginStatusEnum

diff --git a/Yosemite/Yosemite/PointOfSale/PointOfSaleItemServiceProtocol.swift b/Yosemite/Yosemite/PointOfSale/PointOfSaleItemServiceProtocol.swift
@@ -45,13 +45,13 @@ public extension Sequence where Element == POSOrderableItem {
 }
 
 public protocol PointOfSaleItemServiceProtocol {
-    func providePointOfSaleItems(pageNumber: Int) async throws -> (items: [POSItem], hasNextPage: Bool)
+    func providePointOfSaleItems(pageNumber: Int) async throws -> PagedItems<POSItem>
 }
 
 // Default implementation for convenience, so we do not need to pass the first page explicitly
 // if no pageNumber is given.
 extension PointOfSaleItemServiceProtocol {
-    func providePointOfSaleItems(pageNumber: Int = 1) async throws -> (items: [POSItem], hasNextPage: Bool) {
+    func providePointOfSaleItems(pageNumber: Int = 1) async throws -> PagedItems<POSItem> {
         try await providePointOfSaleItems(pageNumber: pageNumber)
     }
 }
diff --git a/Yosemite/Yosemite/PointOfSale/PointOfSaleProductService.swift b/Yosemite/Yosemite/PointOfSale/PointOfSaleProductService.swift
@@ -40,14 +40,14 @@ public final class PointOfSaleProductService: PointOfSaleItemServiceProtocol {
     ///
     /// - pageNumber: Number of the page that should be retrieved. If none given, defaults to 1
     ///
-    public func providePointOfSaleItems(pageNumber: Int = 1) async throws -> (items: [POSItem], hasNextPage: Bool) {
+    public func providePointOfSaleItems(pageNumber: Int = 1) async throws -> PagedItems<POSItem> {
         let productTypes: [ProductType] = isVariableProductsFeatureEnabled ?
         [.simple, .variable] : [.simple]
         let pagedProducts = try await productsRemote.loadProductsForPointOfSale(for: siteID, productTypes: productTypes, pageNumber: pageNumber)
         let products = pagedProducts.items
 
         if pageNumber != 1 && products.count == 0 {
-            return ([], false)
+            return .init(items: [], hasMorePages: false)
         }
 
         let eligibilityCriteria: [(Product) -> Bool] = [
@@ -57,7 +57,7 @@ public final class PointOfSaleProductService: PointOfSaleItemServiceProtocol {
         ]
         let filteredProducts = filterProducts(products: products, using: eligibilityCriteria)
 
-        return (items: mapProductsToPOSItems(products: filteredProducts), hasNextPage: pagedProducts.hasMorePages)
+        return .init(items: mapProductsToPOSItems(products: filteredProducts), hasMorePages: pagedProducts.hasMorePages)
     }
 
     // Maps result to POSItem, and populate the output with:

diff --git a/Yosemite/YosemiteTests/PointOfSale/POSProductProviderTests.swift b/Yosemite/YosemiteTests/PointOfSale/POSProductProviderTests.swift
@@ -45,20 +45,20 @@ final class PointOfSaleProductServiceTests: XCTestCase {
         network.simulateResponse(requestUrlSuffix: "products", filename: "empty-data-array")
 
         // When
-        let (items, hasNextPage) = try await itemProvider.providePointOfSaleItems(pageNumber: 2)
+        let pagedItems = try await itemProvider.providePointOfSaleItems(pageNumber: 2)
 
         // Then
-        XCTAssertTrue(items.isEmpty)
-        XCTAssertFalse(hasNextPage)
+        XCTAssertTrue(pagedItems.items.isEmpty)
+        XCTAssertFalse(pagedItems.hasMorePages)
     }
 
     func test_PointOfSaleItemServiceProtocol_provides_no_items_when_store_has_no_products() async throws {
         // Given/When
         network.simulateResponse(requestUrlSuffix: "products", filename: "empty-data-array")
-        let (expectedItems, _) = try await itemProvider.providePointOfSaleItems()
+        let pagedItems = try await itemProvider.providePointOfSaleItems()
 
         // Then
-        XCTAssertTrue(expectedItems.isEmpty)
+        XCTAssertTrue(pagedItems.items.isEmpty)
     }
 
     func test_PointOfSaleItemServiceProtocol_provides_items_when_store_has_eligible_products() async throws {
@@ -71,9 +71,10 @@ final class PointOfSaleProductServiceTests: XCTestCase {
 
         // When
         network.simulateResponse(requestUrlSuffix: "products", filename: "products-load-all-type-simple")
-        let (expectedItems, _) = try await itemProvider.providePointOfSaleItems()
+        let pagedItems = try await itemProvider.providePointOfSaleItems()
 
         // Then
+        let expectedItems = pagedItems.items
         guard let item = expectedItems.first,
             case .simpleProduct(let simpleProduct) = item else {
             return XCTFail("No eligible products")
@@ -92,9 +93,10 @@ final class PointOfSaleProductServiceTests: XCTestCase {
 
         // When
         network.simulateResponse(requestUrlSuffix: "products", filename: "products-load-all-for-eligibility-criteria")
-        let (expectedItems, _) = try await itemProvider.providePointOfSaleItems()
+        let pagedItems = try await itemProvider.providePointOfSaleItems()
 
         // Then
+        let expectedItems = pagedItems.items
         XCTAssertEqual(expectedItems.count, expectedNumberOfItems)
 
         guard case .simpleProduct(let firstEligibleSimpleProduct) = expectedItems.first,