Merge pull request #6574 from woocommerce/issue/2506-search-orders-with-hashtag

Orders: Support searching for orders with # prefix

Author: rachelmcr

WooCommerce/Classes/ViewRelated/Search/Order/OrderSearchUICommand.swift

@@ -79,6 +79,18 @@ final class OrderSearchUICommand: SearchUICommand {
 
         viewController.navigationController?.pushViewController(detailsViewController, animated: true)
     }
+
+    /// Removes the `#` from the start of the search keyword, if present.
+    ///
+    /// This allows searching for an order with `#123` and getting the results for order `123`.
+    /// See https://github.com/woocommerce/woocommerce-ios/issues/2506
+    ///
+    func sanitizeKeyword(_ keyword: String) -> String {
+        if keyword.starts(with: "#") {
+            return keyword.removing(at: keyword.startIndex)
+        }
+        return keyword
+    }
 }
 
 private extension OrderSearchUICommand {

WooCommerce/Classes/ViewRelated/Search/SearchUICommand.swift

@@ -84,13 +84,24 @@ protocol SearchUICommand {
 
     /// The Accessibility Identifier for the cancel button
     var cancelButtonAccessibilityIdentifier: String { get }
+
+    /// Optionally sanitizes the search keyword.
+    ///
+    /// - Parameter keyword: user-entered search keyword.
+    /// - Returns: sanitized search keyword.
+    func sanitizeKeyword(_ keyword: String) -> String
 }
 
 // MARK: - Default implementation
 extension SearchUICommand {
     func configureActionButton(_ button: UIButton, onDismiss: @escaping () -> Void) {
         // If not implemented, keeps the default cancel UI/UX
     }
+
+    func sanitizeKeyword(_ keyword: String) -> String {
+        // If not implemented, returns the keyword as entered
+        return keyword
+    }
 }
 
 // MARK: - SearchUICommand using EmptySearchResultsViewController

WooCommerce/Classes/ViewRelated/Search/SearchViewController.swift

@@ -362,15 +362,16 @@ extension SearchViewController: SyncingCoordinatorDelegate {
     /// Synchronizes the models for the Default Store (if any).
     ///
     func sync(pageNumber: Int, pageSize: Int, reason: String?, onCompletion: ((Bool) -> Void)? = nil) {
-        let keyword = self.keyword
+        let keyword = searchUICommand.sanitizeKeyword(self.keyword)
         searchUICommand.synchronizeModels(siteID: storeID,
                                           keyword: keyword,
                                           pageNumber: pageNumber,
                                           pageSize: pageSize,
-                                        onCompletion: { [weak self] isCompleted in
+                                          onCompletion: { [weak self] isCompleted in
+                                            guard let self = self else { return }
                                             // Disregard OPs that don't really match the latest keyword
-                                            if keyword == self?.keyword {
-                                                self?.transitionToResultsUpdatedState()
+                                            if keyword == self.searchUICommand.sanitizeKeyword(self.keyword) {
+                                                self.transitionToResultsUpdatedState()
                                             }
                                             onCompletion?(isCompleted)
         })
@@ -387,6 +388,7 @@ private extension SearchViewController {
     ///
     func synchronizeSearchResults(with keyword: String) {
         // When the search query changes, also includes the original results predicate in addition to the search keyword.
+        let keyword = searchUICommand.sanitizeKeyword(keyword)
         let searchResultsPredicate = NSPredicate(format: "ANY searchResults.keyword = %@", keyword)
         let subpredicates = [resultsPredicate].compactMap { $0 } + [searchResultsPredicate]
         resultsController.predicate = NSCompoundPredicate(andPredicateWithSubpredicates: subpredicates)