[POS Orders] Handle filtering for POS orders

Modules/Sources/NetworkingCore/Remote/OrdersRemote.swift

@@ -22,6 +22,7 @@ public class OrdersRemote: Remote {
     ///     This method will convert it to UTC ISO 8601 before calling the REST API.
     ///     - customerID: If given, limit response to orders placed by a customer.
     ///     - productID: If given, limit response to orders including the given product.
+    ///     - createdVia: If given, limit response to orders created via the specified source (e.g. "pos-rest-api" for Point of Sale).
     ///     - pageNumber: Number of page that should be retrieved.
     ///     - pageSize: Number of Orders to be retrieved per page.
     ///     - completion: Closure to be executed upon completion.
@@ -33,6 +34,7 @@ public class OrdersRemote: Remote {
                               modifiedAfter: Date? = nil,
                               customerID: Int64? = nil,
                               productID: Int64? = nil,
+                              createdVia: String? = nil,
                               pageNumber: Int = Defaults.pageNumber,
                               pageSize: Int = Defaults.pageSize,
                               completion: @escaping (Result<[Order], Error>) -> Void) {
@@ -66,6 +68,10 @@ public class OrdersRemote: Remote {
                 parameters[ParameterKeys.product] = productID
             }
 
+            if let createdVia {
+                parameters[ParameterKeys.createdVia] = createdVia
+            }
+
             return parameters
         }()
 
@@ -470,6 +476,7 @@ public extension OrdersRemote {
         static let usesGMTDates: String     = "dates_are_gmt"
         static let customer = "customer"
         static let product = "product"
+        static let createdVia = "created_via"
     }
 
     enum ParameterValues {

Modules/Sources/Yosemite/Actions/OrderAction.swift

@@ -33,6 +33,7 @@ public enum OrderAction: Action {
     ///               doesn't matter. It will be converted to UTC later.
     ///     - customerID: Only include orders placed by the given customer.
     ///     - productID: Only include orders with `lineItems` including the given product.
+    ///     - createdVia: Only include orders created via the specified source (e.g. "pos-rest-api" for Point of Sale).
     ///
     case fetchFilteredOrders(
         siteID: Int64,
@@ -42,6 +43,7 @@ public enum OrderAction: Action {
         modifiedAfter: Date? = nil,
         customerID: Int64? = nil,
         productID: Int64? = nil,
+        createdVia: String? = nil,
         writeStrategy: OrdersStorageWriteStrategy,
         pageSize: Int,
         onCompletion: (TimeInterval, Result<[Order], Error>) -> Void
@@ -58,6 +60,7 @@ public enum OrderAction: Action {
     ///               doesn't matter. It will be converted to UTC later.
     ///     - customerID: Only include orders placed by the given customer.
     ///     - productID: Only include orders with `lineItems` including the given product.
+    ///     - createdVia: Only include orders created via the specified source (e.g. "pos-rest-api" for Point of Sale).
     ///
     case synchronizeOrders(siteID: Int64,
                            statuses: [String]?,
@@ -66,6 +69,7 @@ public enum OrderAction: Action {
                            modifiedAfter: Date? = nil,
                            customerID: Int64? = nil,
                            productID: Int64? = nil,
+                           createdVia: String? = nil,
                            pageNumber: Int,
                            pageSize: Int,
                            onCompletion: (TimeInterval, Error?) -> Void)

Modules/Sources/Yosemite/Model/Mocks/ActionHandlers/MockOrderActionHandler.swift

@@ -10,7 +10,7 @@ struct MockOrderActionHandler: MockActionHandler {
 
     func handle(action: ActionType) {
         switch action {
-        case .fetchFilteredOrders(let siteID, _, _, _, _, _, _, let writeStrategy, let pageSize, let onCompletion):
+        case .fetchFilteredOrders(let siteID, _, _, _, _, _, _, _, let writeStrategy, let pageSize, let onCompletion):
             fetchFilteredAndAllOrders(siteID: siteID,
                                       writeStrategy: writeStrategy,
                                       pageSize: pageSize,
@@ -25,7 +25,7 @@ struct MockOrderActionHandler: MockActionHandler {
             } else {
                 onCompletion(.failure(NSError(domain: "", code: 0)))
             }
-        case .updateOrderStatus(let siteID, let orderID, let status, let onCompletion):
+        case .updateOrderStatus(_, _, _, let onCompletion):
             onCompletion(nil)
 
         default: unimplementedAction(action: action)

Modules/Sources/Yosemite/Stores/OrderStore.swift

@@ -37,31 +37,32 @@ public class OrderStore: Store {
             retrieveOrderRemotely(siteID: siteID, orderID: orderID, onCompletion: onCompletion)
         case .searchOrders(let siteID, let keyword, let pageNumber, let pageSize, let onCompletion):
             searchOrders(siteID: siteID, keyword: keyword, pageNumber: pageNumber, pageSize: pageSize, onCompletion: onCompletion)
-        case let .fetchFilteredOrders(siteID, statuses, after, before, modifiedAfter, customerID, productID, writeStrategy, pageSize, onCompletion):
+        case let .fetchFilteredOrders(siteID, statuses, after, before, modifiedAfter, customerID, productID, createdVia, writeStrategy, pageSize, onCompletion):
             fetchFilteredOrders(siteID: siteID,
                                 statuses: statuses,
                                 after: after,
                                 before: before,
                                 modifiedAfter: modifiedAfter,
                                 customerID: customerID,
                                 productID: productID,
+                                createdVia: createdVia,
                                 writeStrategy: writeStrategy,
                                 pageSize: pageSize,
                                 onCompletion: onCompletion)
-        case let .synchronizeOrders(siteID, statuses, after, before, modifiedAfter, customerID, productID, pageNumber, pageSize, onCompletion):
+        case let .synchronizeOrders(siteID, statuses, after, before, modifiedAfter, customerID, productID, createdVia, pageNumber, pageSize, onCompletion):
             synchronizeOrders(siteID: siteID,
                               statuses: statuses,
                               after: after,
                               before: before,
                               modifiedAfter: modifiedAfter,
                               customerID: customerID,
                               productID: productID,
+                              createdVia: createdVia,
                               pageNumber: pageNumber,
                               pageSize: pageSize,
                               onCompletion: onCompletion)
         case .updateOrderStatus(let siteID, let orderID, let statusKey, let onCompletion):
             updateOrder(siteID: siteID, orderID: orderID, status: statusKey, onCompletion: onCompletion)
-
         case let .updateOrder(siteID, order, giftCard, fields, onCompletion):
             updateOrder(siteID: siteID, order: order, giftCard: giftCard, fields: fields, onCompletion: onCompletion)
         case let .updateOrderOptimistically(siteID, order, fields, onCompletion):
@@ -70,7 +71,6 @@ public class OrderStore: Store {
             createSimplePaymentsOrder(siteID: siteID, status: status, amount: amount, taxable: taxable, onCompletion: onCompletion)
         case let .createOrder(siteID, order, giftCard, onCompletion):
             createOrder(siteID: siteID, order: order, giftCard: giftCard, onCompletion: onCompletion)
-
         case let .updateSimplePaymentsOrder(siteID, orderID, feeID, status, amount, amountName, taxable, orderNote, email, onCompletion):
             updateSimplePaymentsOrder(siteID: siteID,
                                       orderID: orderID,
@@ -148,6 +148,7 @@ private extension OrderStore {
                              modifiedAfter: Date?,
                              customerID: Int64?,
                              productID: Int64?,
+                             createdVia: String?,
                              writeStrategy: OrderAction.OrdersStorageWriteStrategy,
                              pageSize: Int,
                              onCompletion: @escaping (TimeInterval, Result<[Order], Error>) -> Void) {
@@ -161,6 +162,7 @@ private extension OrderStore {
                                   modifiedAfter: modifiedAfter,
                                   customerID: customerID,
                                   productID: productID,
+                                  createdVia: createdVia,
                                   pageNumber: pageNumber,
                                   pageSize: pageSize) { [weak self] result in
             switch result {
@@ -189,6 +191,7 @@ private extension OrderStore {
                            modifiedAfter: Date?,
                            customerID: Int64?,
                            productID: Int64?,
+                           createdVia: String?,
                            pageNumber: Int,
                            pageSize: Int,
                            onCompletion: @escaping (TimeInterval, Error?) -> Void) {
@@ -200,6 +203,7 @@ private extension OrderStore {
                              modifiedAfter: modifiedAfter,
                              customerID: customerID,
                              productID: productID,
+                             createdVia: createdVia,
                              pageNumber: pageNumber,
                              pageSize: pageSize) { [weak self] result in
             switch result {

WooCommerce/Classes/ViewRelated/Filters/FilterListViewController.swift

@@ -92,8 +92,6 @@ enum FilterListValueSelectorConfig {
     case products(siteID: Int64)
     // Filter list selector for customer
     case customer(siteID: Int64)
-    // Filter list selector for sales channel
-    case salesChannel
 
 }
 
@@ -299,10 +297,6 @@ private extension FilterListViewController {
                     self.listSelector.reloadData()
                 }
                 self.listSelector.navigationController?.pushViewController(statusesFilterVC, animated: true)
-            case .salesChannel:
-                // TODO: Make OrderSalesChannelFilterViewController, and handle filtering selection WOOMOB-711
-                let emptyViewController = EmptyStateViewController(style: .list)
-                self.listSelector.navigationController?.pushViewController(emptyViewController, animated: true)
             case .ordersDateRange:
                 let selectedOrderFilter = selected.selectedValue as? OrderDateRangeFilter
                 let datesFilterVC = OrderDatesFilterViewController(selected: selectedOrderFilter) { dateRangeFilter in

WooCommerce/Classes/ViewRelated/Orders/Order Filters/FilterOrderListViewModel.swift

@@ -159,6 +159,7 @@ final class FilterOrderListViewModel: FilterListViewModel {
         dateRangeFilterViewModel.selectedValue = filter.dateRange
         productFilterViewModel.selectedValue = filter.product
         customerFilterViewModel.selectedValue = filter.customer
+        salesChannelFilterViewModel.selectedValue = filter.salesChannel
         analytics.track(event: .FilterHistory.trackPastFilterApplied(source: source))
     }
 
@@ -210,6 +211,9 @@ final class FilterOrderListViewModel: FilterListViewModel {
 
         let clearedCustomer: CustomerFilter? = nil
         customerFilterViewModel.selectedValue = clearedCustomer
+
+        let clearSalesChannel: SalesChannelFilter? = nil
+        salesChannelFilterViewModel.selectedValue = clearSalesChannel
     }
 }
 
@@ -262,8 +266,9 @@ extension FilterOrderListViewModel.OrderListFilter {
                                        listSelectorConfig: .customer(siteID: siteID),
                                        selectedValue: filters.customer)
         case .salesChannel:
+            let salesChannelOptions: [FilterOrderListViewModel.SalesChannelFilter] = [.any, .pointOfSale]
             return FilterTypeViewModel(title: title,
-                                       listSelectorConfig: .salesChannel,
+                                       listSelectorConfig: .staticOptions(options: salesChannelOptions),
                                        selectedValue: filters.salesChannel)
         }
     }
@@ -375,16 +380,30 @@ extension CustomerFilter: FilterType {
 extension FilterOrderListViewModel {
     enum SalesChannelFilter: FilterType {
         case pointOfSale
+        case any
 
         var description: String {
             switch self {
             case .pointOfSale:
-                return "POS"
+                return NSLocalizedString(
+                    "salesChannelFilter.row.pos.description",
+                    value: "Point of Sale",
+                    comment: "Description for the Sales channel filter option, when selecting 'Point of Sale' orders")
+            case .any:
+                return NSLocalizedString(
+                    "salesChannelFilter.row.any.description",
+                    value: "Any",
+                    comment: "Description for the Sales channel filter option, when selecting 'Any' order")
             }
         }
 
         var isActive: Bool {
-            return true
+            switch self {
+            case .pointOfSale:
+                return true
+            case .any:
+                return false
+            }
         }
     }
 }

WooCommerce/Classes/ViewRelated/Orders/OrderListSyncActionUseCase.swift

@@ -63,6 +63,7 @@ struct OrderListSyncActionUseCase {
         let endDate = filters?.dateRange?.computedEndDate
         let productID = filters?.product?.id
         let customerID = filters?.customer?.id
+        let createdVia = filters?.salesChannel == .pointOfSale ? "pos-rest-api" : nil
 
         if pageNumber == Defaults.pageFirstIndex {
             let deleteAllBeforeSaving = reason == SyncReason.pullToRefresh || reason == SyncReason.newFiltersApplied
@@ -76,6 +77,7 @@ struct OrderListSyncActionUseCase {
                 modifiedAfter: modifiedAfter,
                 customerID: customerID,
                 productID: productID,
+                createdVia: createdVia,
                 writeStrategy: deleteAllBeforeSaving ? .deleteAllBeforeSaving : .save,
                 pageSize: pageSize,
                 onCompletion: { timeInterval, result in
@@ -96,6 +98,7 @@ struct OrderListSyncActionUseCase {
             before: endDate,
             customerID: customerID,
             productID: productID,
+            createdVia: createdVia,
             pageNumber: pageNumber,
             pageSize: pageSize,
             onCompletion: completionHandler

WooCommerce/Classes/ViewRelated/Orders/OrderListViewModel.swift

@@ -250,8 +250,23 @@ final class OrderListViewModel {
             return NSCompoundPredicate(andPredicateWithSubpredicates: predicates)
         }()
 
+        let predicateSalesChannel: NSPredicate? = {
+            guard let salesChannelFilter = filters?.salesChannel else {
+                return nil
+            }
+
+            switch salesChannelFilter {
+            case .pointOfSale:
+                let predicate = NSPredicate(format: "createdVia == %@", "pos-rest-api")
+                return predicate
+            case .any:
+                return nil
+            }
+        }()
+
         let siteIDPredicate = NSPredicate(format: "siteID = %lld", siteID)
-        let queryPredicate = NSCompoundPredicate(andPredicateWithSubpredicates: [siteIDPredicate, predicateStatus, predicateDateRanges])
+        let allPredicates = [siteIDPredicate, predicateStatus, predicateDateRanges, predicateSalesChannel].compactMap { $0 }
+        let queryPredicate = NSCompoundPredicate(andPredicateWithSubpredicates: allPredicates)
 
         return FetchResultSnapshotsProvider<StorageOrder>.Query(
             sortDescriptor: NSSortDescriptor(keyPath: \StorageOrder.dateCreated, ascending: false),

WooCommerce/Classes/ViewRelated/Orders/OrdersRootViewController.swift

@@ -312,7 +312,6 @@ final class OrdersRootViewController: UIViewController {
         let viewModel = FilterOrderListViewModel(filters: filters, allowedStatuses: allowedStatuses, siteID: siteID)
         let filterOrderListViewController = FilterListViewController(viewModel: viewModel, onFilterAction: { [weak self] filters in
             self?.filters = filters
-
             self?.analytics.track(event: .OrdersFilter.onFilterOrders(filters: filters))
         }, onClearAction: {
         }, onDismissAction: {

WooCommerce/WooCommerceTests/Notifications/PushNotificationBackgroundSynchronizerTests.swift

@@ -95,7 +95,7 @@ private extension PushNotificationBackgroundSynchronizerTests {
         // Mock sync order list
         stores.whenReceivingAction(ofType: OrderAction.self) { action in
             switch action {
-            case let .fetchFilteredOrders(_, _, _, _, _, _, _, _, _, onCompletion):
+            case let .fetchFilteredOrders(_, _, _, _, _, _, _, _, _, _, onCompletion):
                 self.storage.insertSampleOrder(readOnlyOrder: order)
                 onCompletion(0, .success([order]))
             default:
@@ -112,7 +112,7 @@ private extension PushNotificationBackgroundSynchronizerTests {
         // Mock sync order list & single order
         stores.whenReceivingAction(ofType: OrderAction.self) { action in
             switch action {
-            case let .fetchFilteredOrders(_, _, _, _, _, _, _, _, _, onCompletion):
+            case let .fetchFilteredOrders(_, _, _, _, _, _, _, _, _, _, onCompletion):
                 onCompletion(0, .success([]))
             case let .retrieveOrderRemotely(_, _, onCompletion):
                 self.storage.insertSampleOrder(readOnlyOrder: order)
@@ -129,7 +129,7 @@ private extension PushNotificationBackgroundSynchronizerTests {
         // Mock sync order list & single order
         stores.whenReceivingAction(ofType: OrderAction.self) { action in
             switch action {
-            case let .fetchFilteredOrders(_, _, _, _, _, _, _, _, _, onCompletion):
+            case let .fetchFilteredOrders(_, _, _, _, _, _, _, _, _, _, onCompletion):
                 onCompletion(0, .success([]))
             case let .retrieveOrderRemotely(_, _, onCompletion):
                 self.storage.insertSampleOrder(readOnlyOrder: Self.sampleOrderWithNoteFullDataOrderID)