Merge pull request #7739 from woocommerce/feat/3157-search-sku

Search products by SKU: add a segmented control to products search

Author: jaclync

Experiments/Experiments/DefaultFeatureFlagService.swift

@@ -33,6 +33,8 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return true
         case .promptToEnableCodInIppOnboarding:
             return true
+        case .searchProductsBySKU:
+            return buildConfig == .localDeveloper || buildConfig == .alpha
         case .orderCreationSearchCustomers:
             return buildConfig == .localDeveloper || buildConfig == .alpha
         default:

Experiments/Experiments/FeatureFlag.swift

@@ -70,6 +70,10 @@ public enum FeatureFlag: Int {
     ///
     case promptToEnableCodInIppOnboarding
 
+    /// Enables searching products by partial SKU for WC version 6.6+.
+    ///
+    case searchProductsBySKU
+
     /// Enables the Search Customers functionality in the Order Creation screen
     ///
     case orderCreationSearchCustomers

Networking/Networking.xcodeproj/project.pbxproj

@@ -30,6 +30,7 @@
 		025CA2C4238EBC4300B05C81 /* ProductShippingClassRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 025CA2C3238EBC4300B05C81 /* ProductShippingClassRemote.swift */; };
 		025CA2C6238F4F3500B05C81 /* ProductShippingClassRemoteTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 025CA2C5238F4F3500B05C81 /* ProductShippingClassRemoteTests.swift */; };
 		025CA2C8238F4FF400B05C81 /* product-shipping-classes-load-all.json in Resources */ = {isa = PBXBuildFile; fileRef = 025CA2C7238F4FF400B05C81 /* product-shipping-classes-load-all.json */; };
+		0261F5A928D4641500B7AC72 /* products-sku-search.json in Resources */ = {isa = PBXBuildFile; fileRef = 0261F5A828D4641500B7AC72 /* products-sku-search.json */; };
 		02698CF624C17FC1005337C4 /* product-alternative-types.json in Resources */ = {isa = PBXBuildFile; fileRef = 02698CF524C17FC1005337C4 /* product-alternative-types.json */; };
 		02698CF824C183A5005337C4 /* ProductVariationListMapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 02698CF724C183A5005337C4 /* ProductVariationListMapperTests.swift */; };
 		02698CFA24C188E9005337C4 /* product-variations-load-all-alternative-types.json in Resources */ = {isa = PBXBuildFile; fileRef = 02698CF924C188E8005337C4 /* product-variations-load-all-alternative-types.json */; };
@@ -727,6 +728,7 @@
 		025CA2C3238EBC4300B05C81 /* ProductShippingClassRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductShippingClassRemote.swift; sourceTree = "<group>"; };
 		025CA2C5238F4F3500B05C81 /* ProductShippingClassRemoteTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductShippingClassRemoteTests.swift; sourceTree = "<group>"; };
 		025CA2C7238F4FF400B05C81 /* product-shipping-classes-load-all.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "product-shipping-classes-load-all.json"; sourceTree = "<group>"; };
+		0261F5A828D4641500B7AC72 /* products-sku-search.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "products-sku-search.json"; sourceTree = "<group>"; };
 		02698CF524C17FC1005337C4 /* product-alternative-types.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "product-alternative-types.json"; sourceTree = "<group>"; };
 		02698CF724C183A5005337C4 /* ProductVariationListMapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductVariationListMapperTests.swift; sourceTree = "<group>"; };
 		02698CF924C188E8005337C4 /* product-variations-load-all-alternative-types.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "product-variations-load-all-alternative-types.json"; sourceTree = "<group>"; };
@@ -1999,6 +2001,7 @@
 				451274A525276C82009911FF /* product-variation.json */,
 				CE0A0F1E223998A00075ED8D /* products-load-all.json */,
 				0282DD90233A120A006A5FDB /* products-search-photo.json */,
+				0261F5A828D4641500B7AC72 /* products-sku-search.json */,
 				45D685F923D0C3CF005F87D0 /* product-search-sku.json */,
 				4599FC5B24A6276F0056157A /* product-tags-all.json */,
 				45AF57A824AB42CD0088E2F7 /* product-tags-extra.json */,
@@ -2518,6 +2521,7 @@
 				D865CE5F278CA183002C8520 /* stripe-payment-intent-requires-action.json in Resources */,
 				CCF48B2C2628AE160034EA83 /* shipping-label-account-settings.json in Resources */,
 				31A451D927863A2E00FE81AA /* stripe-account-live-test.json in Resources */,
+				0261F5A928D4641500B7AC72 /* products-sku-search.json in Resources */,
 				09885C8027C3FFD200910A62 /* product-variations-bulk-update.json in Resources */,
 				31054734262E36AB00C5C02B /* wcpay-payment-intent-error.json in Resources */,
 				02AF07EE27493AE700B2D81E /* media-upload-to-wordpress-site.json in Resources */,

Networking/Networking/Remote/ProductsRemote.swift

@@ -31,6 +31,11 @@ public protocol ProductsRemoteProtocol {
                         productCategory: ProductCategory?,
                         excludedProductIDs: [Int64],
                         completion: @escaping (Result<[Product], Error>) -> Void)
+    func searchProductsBySKU(for siteID: Int64,
+                             keyword: String,
+                             pageNumber: Int,
+                             pageSize: Int,
+                             completion: @escaping (Result<[Product], Error>) -> Void)
     func searchSku(for siteID: Int64,
                    sku: String,
                    completion: @escaping (Result<String, Error>) -> Void)
@@ -238,6 +243,30 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
         enqueue(request, mapper: mapper, completion: completion)
     }
 
+    /// Retrieves all of the `Product`s that match the SKU. Partial SKU search is supported for WooCommerce version 6.6+, otherwise full SKU match is performed.
+    /// - Parameters:
+    ///   - siteID: Site for which we'll fetch remote products
+    ///   - keyword: Search string that should be matched by the SKU (partial or full depending on the WC version).
+    ///   - pageNumber: Number of page that should be retrieved.
+    ///   - pageSize: Number of products to be retrieved per page.
+    ///   - completion: Closure to be executed upon completion.
+    public func searchProductsBySKU(for siteID: Int64,
+                                    keyword: String,
+                                    pageNumber: Int,
+                                    pageSize: Int,
+                                    completion: @escaping (Result<[Product], Error>) -> Void) {
+        let parameters = [
+            ParameterKey.sku: keyword,
+            ParameterKey.partialSKUSearch: keyword,
+            ParameterKey.page: String(pageNumber),
+            ParameterKey.perPage: String(pageSize)
+        ]
+        let path = Path.products
+        let request = JetpackRequest(wooApiVersion: .mark3, method: .get, siteID: siteID, path: path, parameters: parameters)
+        let mapper = ProductListMapper(siteID: siteID)
+        enqueue(request, mapper: mapper, completion: completion)
+    }
+
     /// Retrieves a product SKU if available.
     ///
     /// - Parameters:
@@ -329,6 +358,7 @@ public extension ProductsRemote {
         static let orderBy: String    = "orderby"
         static let order: String      = "order"
         static let sku: String        = "sku"
+        static let partialSKUSearch: String = "search_sku"
         static let productStatus: String = "status"
         static let productType: String = "type"
         static let stockStatus: String = "stock_status"

Networking/NetworkingTests/Remote/ProductsRemoteTests.swift

@@ -395,7 +395,7 @@ final class ProductsRemoteTests: XCTestCase {
 
     /// Verifies that searchProducts properly relays Networking Layer errors.
     ///
-    func test_searchProducts_properly_relays_netwoking_errors() {
+    func test_searchProducts_properly_relays_networking_errors() {
         // Given
         let remote = ProductsRemote(network: network)
 
@@ -413,6 +413,47 @@ final class ProductsRemoteTests: XCTestCase {
         XCTAssertTrue(result.isFailure)
     }
 
+    // MARK: - Search Products by SKU
+
+    func test_searchProductsBySKU_properly_returns_parsed_products() throws {
+        // Given
+        let remote = ProductsRemote(network: network)
+        network.simulateResponse(requestUrlSuffix: "products", filename: "products-sku-search")
+
+        // When
+        let result: Result<[Product], Error> = waitFor { promise in
+            remote.searchProductsBySKU(for: self.sampleSiteID,
+                                       keyword: "choco",
+                                       pageNumber: 0,
+                                       pageSize: 100) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        XCTAssertTrue(result.isSuccess)
+        let products = try result.get()
+        XCTAssertEqual(products.count, 1)
+    }
+
+    func test_searchProductsBySKU_properly_relays_networking_errors() {
+        // Given
+        let remote = ProductsRemote(network: network)
+
+        // When
+        let result: Result<[Product], Error> = waitFor { promise in
+            remote.searchProductsBySKU(for: self.sampleSiteID,
+                                       keyword: String(),
+                                       pageNumber: 0,
+                                       pageSize: 100) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        XCTAssertTrue(result.isFailure)
+    }
+
 
     // MARK: - Search Product SKU tests
 

Networking/NetworkingTests/Responses/products-sku-search.json

@@ -0,0 +1,82 @@
+{
+    "data": [
+        {
+            "id": 2783,
+            "name": "Chocolate bars",
+            "slug": "variable-chocolate-bar",
+            "permalink": "",
+            "date_created": "2020-06-12T22:36:02",
+            "date_created_gmt": "2020-06-12T14:36:02",
+            "date_modified": "2021-02-23T10:46:54",
+            "date_modified_gmt": "2021-02-23T02:46:54",
+            "type": "variation",
+            "status": "publish",
+            "featured": false,
+            "catalog_visibility": "visible",
+            "description": "<p>Tasty!!</p>\n",
+            "short_description": "",
+            "sku": "chocobars",
+            "price": "22",
+            "regular_price": "999",
+            "sale_price": "22",
+            "date_on_sale_from": null,
+            "date_on_sale_from_gmt": null,
+            "date_on_sale_to": null,
+            "date_on_sale_to_gmt": null,
+            "on_sale": true,
+            "purchasable": true,
+            "total_sales": "0",
+            "virtual": false,
+            "downloadable": false,
+            "downloads": [],
+            "download_limit": -1,
+            "download_expiry": -1,
+            "external_url": "",
+            "button_text": "",
+            "tax_status": "taxable",
+            "tax_class": "reduced-rate",
+            "manage_stock": "parent",
+            "stock_quantity": 7774,
+            "backorders": "no",
+            "backorders_allowed": false,
+            "backordered": false,
+            "low_stock_amount": null,
+            "sold_individually": false,
+            "weight": "67",
+            "dimensions": {
+                "length": "6",
+                "width": "",
+                "height": "1"
+            },
+            "shipping_required": true,
+            "shipping_taxable": true,
+            "shipping_class": "10-day-shipping",
+            "shipping_class_id": 96987521,
+            "reviews_allowed": false,
+            "average_rating": "0.00",
+            "rating_count": 0,
+            "upsell_ids": [],
+            "cross_sell_ids": [],
+            "parent_id": 846,
+            "purchase_note": "",
+            "categories": [],
+            "tags": [],
+            "images": [],
+            "attributes": [
+                {
+                    "id": 0,
+                    "name": "Darkness",
+                    "option": "87%"
+                }
+            ],
+            "default_attributes": [],
+            "variations": [],
+            "grouped_products": [],
+            "menu_order": 6,
+            "related_ids": [],
+            "meta_data": [],
+            "stock_status": "instock",
+            "has_options": false,
+        }
+    ]
+}

Storage/Storage/Tools/StorageType+Extensions.swift

@@ -345,8 +345,8 @@ public extension StorageType {
 
     /// Retrieves the Stored ProductSearchResults Lookup.
     ///
-    func loadProductSearchResults(keyword: String) -> ProductSearchResults? {
-        let predicate = \ProductSearchResults.keyword == keyword
+    func loadProductSearchResults(keyword: String, filterKey: String) -> ProductSearchResults? {
+        let predicate = \ProductSearchResults.keyword == keyword && \ProductSearchResults.filterKey == filterKey
         return firstObject(ofType: ProductSearchResults.self, matching: predicate)
     }
 

Storage/StorageTests/Tools/StorageTypeExtensionsTests.swift

@@ -692,11 +692,13 @@ final class StorageTypeExtensionsTests: XCTestCase {
     func test_loadProductSearchResult_by_keyboard() throws {
         // Given
         let keyword = "Keyword"
+        let filterKey = "all"
         let searchResult = storage.insertNewObject(ofType: ProductSearchResults.self)
         searchResult.keyword = keyword
+        searchResult.filterKey = filterKey
 
         // When
-        let storedSearchResult = try XCTUnwrap(storage.loadProductSearchResults(keyword: keyword))
+        let storedSearchResult = try XCTUnwrap(storage.loadProductSearchResults(keyword: keyword, filterKey: filterKey))
 
         // Then
         XCTAssertEqual(searchResult, storedSearchResult)

WooCommerce/Classes/ViewRelated/Coupons/CouponSearchUICommand.swift

@@ -15,6 +15,8 @@ final class CouponSearchUICommand: SearchUICommand {
 
     let cancelButtonAccessibilityIdentifier = "coupon-search-screen-cancel-button"
 
+    var resynchronizeModels: (() -> Void) = {}
+
     private let siteID: Int64
 
     init(siteID: Int64) {
@@ -80,6 +82,10 @@ final class CouponSearchUICommand: SearchUICommand {
 
         viewController.configure(.simple(message: message, image: .emptySearchResultsImage))
     }
+
+    func searchResultsPredicate(keyword: String) -> NSPredicate? {
+        NSPredicate(format: "ANY searchResults.keyword = %@", keyword)
+    }
 }
 
 // MARK: - Subtypes

WooCommerce/Classes/ViewRelated/Products/Edit Product/Linked Products List Selector/ProductListSelector/ProductListMultiSelectorSearchUICommand.swift

@@ -12,6 +12,8 @@ final class ProductListMultiSelectorSearchUICommand: NSObject, SearchUICommand {
 
     let cancelButtonAccessibilityIdentifier = "product-search-screen-cancel-button"
 
+    var resynchronizeModels: (() -> Void) = {}
+
     private let siteID: Int64
 
     private let excludedProductIDs: [Int64]
@@ -90,6 +92,10 @@ final class ProductListMultiSelectorSearchUICommand: NSObject, SearchUICommand {
         reloadData()
         updateActionButton()
     }
+
+    func searchResultsPredicate(keyword: String) -> NSPredicate? {
+        NSPredicate(format: "ANY searchResults.keyword = %@", keyword)
+    }
 }
 
 extension ProductListMultiSelectorSearchUICommand {