Merge pull request #7781 from woocommerce/feat/3157-search-sku-cell-and-analytics

Search products by SKU: show SKU to search result cell, empty query optimization, analytics

Author: jaclync

Experiments/Experiments/DefaultFeatureFlagService.swift

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

RELEASE-NOTES.txt

@@ -3,6 +3,7 @@
 10.6
 -----
 
+- [**] Products tab: products search now has an option to search products by SKU. Stores with WC version 6.6+ support partial SKU search, otherwise the product(s) with the exact SKU match is returned. [https://github.com/woocommerce/woocommerce-ios/pull/7781]
 - [*] Fixed a rare crash when selecting a store in the store picker. [https://github.com/woocommerce/woocommerce-ios/pull/7765]
 - [*] Help center: Added help center web page with FAQs for "Not a WooCommerce site" and "Wrong WordPress.com account" error screens. [https://github.com/woocommerce/woocommerce-ios/pull/7767, https://github.com/woocommerce/woocommerce-ios/pull/7769]
 

WooCommerce/Classes/ViewRelated/Products/View Models/ProductsTabProductViewModel.swift

@@ -31,14 +31,15 @@ struct ProductsTabProductViewModel {
          productVariation: ProductVariation? = nil,
          isSelected: Bool = false,
          isDraggable: Bool = false,
+         isSKUShown: Bool = false,
          imageService: ImageService = ServiceLocator.imageService) {
 
         imageUrl = product.images.first?.src
         name = product.name.isEmpty ? Localization.noTitle : product.name
         self.productVariation = productVariation
         self.isSelected = isSelected
         self.isDraggable = isDraggable
-        detailsAttributedString = EditableProductModel(product: product).createDetailsAttributedString()
+        detailsAttributedString = EditableProductModel(product: product).createDetailsAttributedString(isSKUShown: isSKUShown)
 
         self.imageService = imageService
     }
@@ -57,16 +58,18 @@ struct ProductsTabProductViewModel {
 }
 
 private extension EditableProductModel {
-    func createDetailsAttributedString() -> NSAttributedString {
+    func createDetailsAttributedString(isSKUShown: Bool) -> NSAttributedString {
         let statusText = createStatusText()
         let stockText = createStockText()
         let variationsText = createVariationsText()
 
         let detailsText = [statusText, stockText, variationsText]
             .compactMap({ $0 })
             .joined(separator: " • ")
+        let skuText = isSKUShown ? createSKUText(): nil
+        let text = [detailsText, skuText].compactMap { $0 }.joined(separator: "\n")
 
-        let attributedString = NSMutableAttributedString(string: detailsText,
+        let attributedString = NSMutableAttributedString(string: text,
                                                          attributes: [
                                                             .foregroundColor: UIColor.textSubtle,
                                                             .font: StyleManager.footerLabelFont
@@ -97,6 +100,13 @@ private extension EditableProductModel {
                                       plural: Localization.VariationCount.plural)
         return String.localizedStringWithFormat(format, numberOfVariations)
     }
+
+    func createSKUText() -> String? {
+        guard let sku = product.sku, sku.isNotEmpty else {
+            return nil
+        }
+        return String.localizedStringWithFormat(Localization.skuFormat, sku)
+    }
 }
 
 // MARK: Localization
@@ -109,6 +119,7 @@ private extension EditableProductModel {
             static let plural = NSLocalizedString("%1$ld variations",
                                                   comment: "Label about number of variations shown on Products tab. Reads, `2 variations`")
         }
+        static let skuFormat = NSLocalizedString("SKU: %1$@", comment: "Label about the SKU of a product in the product list. Reads, `SKU: productSku`")
     }
 }
 

WooCommerce/Classes/ViewRelated/Search/Product/ProductSearchUICommand.swift

@@ -19,13 +19,16 @@ final class ProductSearchUICommand: SearchUICommand {
 
     private let siteID: Int64
     private let stores: StoresManager
+    private let analytics: Analytics
     private let isSearchProductsBySKUEnabled: Bool
 
     init(siteID: Int64,
          stores: StoresManager = ServiceLocator.stores,
+         analytics: Analytics = ServiceLocator.analytics,
          isSearchProductsBySKUEnabled: Bool = ServiceLocator.featureFlagService.isFeatureFlagEnabled(.searchProductsBySKU)) {
         self.siteID = siteID
         self.stores = stores
+        self.analytics = analytics
         self.isSearchProductsBySKUEnabled = isSearchProductsBySKUEnabled
     }
 
@@ -86,7 +89,7 @@ final class ProductSearchUICommand: SearchUICommand {
     }
 
     func createCellViewModel(model: Product) -> ProductsTabProductViewModel {
-        return ProductsTabProductViewModel(product: model)
+        ProductsTabProductViewModel(product: model, isSKUShown: true)
     }
 
     /// Synchronizes the Products matching a given Keyword
@@ -101,6 +104,11 @@ final class ProductSearchUICommand: SearchUICommand {
                 onCompletion?(true)
                 return
             }
+            // Skips the product search API request if the keyword is empty.
+            guard keyword.isNotEmpty else {
+                onCompletion?(true)
+                return
+            }
             lastSearchQueryByFilter[filter] = keyword
         }
 
@@ -118,7 +126,7 @@ final class ProductSearchUICommand: SearchUICommand {
 
         stores.dispatch(action)
 
-        ServiceLocator.analytics.track(.productListSearched)
+        analytics.track(.productListSearched, withProperties: isSearchProductsBySKUEnabled ? ["filter": filter.analyticsValue]: nil)
     }
 
     func didSelectSearchResult(model: Product, from viewController: UIViewController, reloadData: () -> Void, updateActionButton: () -> Void) {
@@ -158,4 +166,14 @@ private extension ProductSearchFilter {
             return NSLocalizedString("SKU", comment: "Title of the product search filter to search for products that match the SKU.")
         }
     }
+
+    /// The value that is set in the analytics event property.
+    var analyticsValue: String {
+        switch self {
+        case .all:
+            return "all"
+        case .sku:
+            return "sku"
+        }
+    }
 }

WooCommerce/WooCommerceTests/ViewRelated/Products/ProductsTabProductViewModelTests.swift

@@ -93,6 +93,33 @@ final class ProductsTabProductViewModelTests: XCTestCase {
         XCTAssertTrue(detailsText.contains(expectedStockDetail))
     }
 
+    func test_details_contain_sku_when_isSKUShown_is_true() {
+        // Given
+        let sku = "pear"
+        let product = productMock(name: "Yay").copy(sku: sku)
+
+        // When
+        let viewModel = ProductsTabProductViewModel(product: product, isSKUShown: true)
+        let detailsText = viewModel.detailsAttributedString.string
+
+        // Then
+        let expectedSKU = String.localizedStringWithFormat(Localization.skuFormat, sku)
+        XCTAssertTrue(detailsText.contains(expectedSKU))
+    }
+
+    func test_details_do_not_contain_sku_when_isSKUShown_is_false() {
+        // Given
+        let sku = "pear"
+        let product = productMock(name: "Yay").copy(sku: sku)
+
+        // When
+        let viewModel = ProductsTabProductViewModel(product: product, isSKUShown: false)
+        let detailsText = viewModel.detailsAttributedString.string
+
+        // Then
+        let skuText = String.localizedStringWithFormat(Localization.skuFormat, sku)
+        XCTAssertFalse(detailsText.contains(skuText))
+    }
 }
 
 extension ProductsTabProductViewModelTests {
@@ -109,3 +136,9 @@ extension ProductsTabProductViewModelTests {
                                    variations: variations)
     }
 }
+
+private extension ProductsTabProductViewModelTests {
+    enum Localization {
+        static let skuFormat = NSLocalizedString("SKU: %1$@", comment: "Label about the SKU of a product in the product list. Reads, `SKU: productSku`")
+    }
+}

WooCommerce/WooCommerceTests/ViewRelated/Search/Product/ProductSearchUICommandTests.swift

@@ -5,6 +5,20 @@ import Yosemite
 
 final class ProductSearchUICommandTests: XCTestCase {
     private let sampleSiteID: Int64 = 134
+    private var analyticsProvider: MockAnalyticsProvider!
+    private var analytics: WooAnalytics!
+
+    override func setUp() {
+        super.setUp()
+        analyticsProvider = MockAnalyticsProvider()
+        analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+    }
+
+    override func tearDown() {
+        analytics = nil
+        analyticsProvider = nil
+        super.tearDown()
+    }
 
     // MARK: - `createHeaderView`
 
@@ -112,4 +126,56 @@ final class ProductSearchUICommandTests: XCTestCase {
         }
         XCTAssertEqual(invocationCount, 2)
     }
+
+    func test_synchronizeModels_does_not_dispatch_search_action_when_keyword_is_empty() {
+        // Given
+        let stores = MockStoresManager(sessionManager: .testingInstance)
+        let command = ProductSearchUICommand(siteID: sampleSiteID, isSearchProductsBySKUEnabled: true)
+
+        var invocationCount = 0
+        stores.whenReceivingAction(ofType: ProductAction.self) { action in
+            guard case let .searchProducts(_, _, _, _, _, _, _, _, _, _, onCompletion) = action else {
+                return XCTFail("Unexpected action: \(action)")
+            }
+            invocationCount += 1
+            onCompletion(.success(()))
+        }
+
+        // When
+        waitFor { promise in
+            command.synchronizeModels(siteID: self.sampleSiteID, keyword: "", pageNumber: 1, pageSize: 10) { _ in
+                promise(())
+            }
+        }
+
+        // Then
+        XCTAssertEqual(invocationCount, 0)
+    }
+
+    // MARK: - Analytics
+
+    func test_productListSearched_is_tracked_when_synchronizing_models() throws {
+        // Given
+        let stores = MockStoresManager(sessionManager: .testingInstance)
+        let command = ProductSearchUICommand(siteID: sampleSiteID, stores: stores, analytics: analytics, isSearchProductsBySKUEnabled: true)
+        stores.whenReceivingAction(ofType: ProductAction.self) { action in
+            guard case let .searchProducts(_, _, _, _, _, _, _, _, _, _, onCompletion) = action else {
+                return XCTFail("Unexpected action: \(action)")
+            }
+            onCompletion(.success(()))
+        }
+
+        // When
+        waitFor { promise in
+            command.synchronizeModels(siteID: self.sampleSiteID, keyword: "coffee", pageNumber: 1, pageSize: 10) { _ in
+                promise(())
+            }
+        }
+
+        // Then
+        let event = try XCTUnwrap(analyticsProvider.receivedEvents.first)
+        XCTAssertEqual(event, "product_list_searched")
+        let eventProperties = try XCTUnwrap(analyticsProvider.receivedProperties.first)
+        XCTAssertEqual(eventProperties["filter"] as? String, "all")
+    }
 }