Bookings: Persist booking filters (#16316)

Author: itsmeichigo

Modules/Sources/Networking/Model/Bookings/Booking.swift

@@ -216,7 +216,7 @@ enum BookingDecodingError: Error {
 //
 
 /// Represents a Booking Status.
-public enum BookingStatus: String, CaseIterable {
+public enum BookingStatus: String, CaseIterable, Codable {
     case complete
     case paid
     case unpaid
@@ -226,7 +226,7 @@ public enum BookingStatus: String, CaseIterable {
     case unknown
 }
 
-public enum BookingAttendanceStatus: String, CaseIterable {
+public enum BookingAttendanceStatus: String, CaseIterable, Codable {
     case booked
     case checkedIn = "checked-in"
     case cancelled

Modules/Sources/Yosemite/Actions/AppSettingsAction.swift

@@ -105,6 +105,22 @@ public enum AppSettingsAction: Action {
     /// Clears all the product filter history for a given site
     case resetProductFilterHistory(siteID: Int64, onCompletion: (Error?) -> Void)
 
+    // MARK: - Bookings Filters
+
+    /// Loads the booking filters
+    ///
+    case loadBookingFilters(siteID: Int64, onCompletion: (Result<StoredBookingFilters.Filters, Error>) -> Void)
+
+    /// Add or Update booking filters
+    ///
+    case upsertBookingFilters(siteID: Int64,
+                              filters: StoredBookingFilters.Filters,
+                              onCompletion: (Error?) -> Void)
+
+    /// Clears all the booking filters
+    ///
+    case resetBookingFilters
+
     // MARK: - General App Settings
 
     /// Saves the `date` as the last known date that the app was installed. This does not do

Modules/Sources/Yosemite/Model/Bookings/BookingCustomerFilter.swift

@@ -4,7 +4,6 @@ import Foundation
 ///
 public struct BookingCustomerFilter: Codable, Hashable {
     /// ID of the customer
-    /// periphery:ignore - to be used later when applying filter
     ///
     public let customerID: Int64
 

Modules/Sources/Yosemite/Model/Bookings/BookingProductFilter.swift

@@ -4,7 +4,6 @@ import Foundation
 ///
 public struct BookingProductFilter: Codable, Hashable {
     /// ID of the product
-    /// periphery:ignore - to be used later when applying filter
     ///
     public let productID: Int64
 

Modules/Sources/Yosemite/Model/Bookings/BookingTeamMemberFilter.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+/// Used to filter bookings by team members
+///
+public struct BookingTeamMemberFilter: Codable, Hashable {
+    /// ID of the team member (booking resource)
+    ///
+    public let resourceID: Int64
+
+    /// Name of the team member
+    ///
+    public let name: String
+
+    public init(resourceID: Int64, name: String) {
+        self.resourceID = resourceID
+        self.name = name
+    }
+}

Modules/Sources/Yosemite/Model/Bookings/StoredBookingFilters.swift

@@ -0,0 +1,62 @@
+import Foundation
+import Codegen
+
+/// Models a dictionary of `siteID` and Booking Filters
+/// These entities will be serialised to a plist file
+///
+public struct StoredBookingFilters: Codable, Equatable, GeneratedFakeable {
+
+    /// SiteID: Booking Filters
+    public let filters: [Int64: Filters]
+
+    public init(filters: [Int64: Filters]) {
+        self.filters = filters
+    }
+
+    public struct Filters: Codable, Equatable {
+        public let teamMembers: [BookingTeamMemberFilter]
+        public let products: [BookingProductFilter]
+        public let attendanceStatuses: [BookingAttendanceStatus]
+        public let paymentStatuses: [BookingStatus]
+        public let customers: [BookingCustomerFilter]
+        public let dateRange: BookingDateRangeFilter?
+        public let numberOfActiveFilters: Int
+
+        public init(teamMembers: [BookingTeamMemberFilter],
+                    products: [BookingProductFilter],
+                    attendanceStatuses: [BookingAttendanceStatus],
+                    paymentStatuses: [BookingStatus],
+                    customers: [BookingCustomerFilter],
+                    dateRange: BookingDateRangeFilter?) {
+            self.teamMembers = teamMembers
+            self.products = products
+            self.attendanceStatuses = attendanceStatuses
+            self.paymentStatuses = paymentStatuses
+            self.customers = customers
+            self.dateRange = dateRange
+            self.numberOfActiveFilters = {
+                var total = 0
+                if teamMembers.isNotEmpty {
+                    total += 1
+                }
+                if products.isNotEmpty {
+                    total += 1
+                }
+                if attendanceStatuses.isNotEmpty {
+                    total += 1
+                }
+                if customers.isNotEmpty {
+                    total += 1
+                }
+                if paymentStatuses.isNotEmpty {
+                    total += 1
+                }
+                if dateRange != nil {
+                    total += 1
+                }
+
+                return total
+            }()
+        }
+    }
+}

Modules/Sources/Yosemite/Stores/AppSettingsStore.swift

@@ -83,6 +83,13 @@ public class AppSettingsStore: Store {
         return documents!.appendingPathComponent(Constants.productFilterHistory)
     }()
 
+    /// URL to the plist file that we use to determine the booking filters
+    ///
+    private lazy var bookingFiltersURL: URL = {
+        let documents = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first
+        return documents!.appendingPathComponent(Constants.bookingFilters)
+    }()
+
     /// Registers for supported Actions.
     ///
     override public func registerSupportedActions(in dispatcher: Dispatcher) {
@@ -179,6 +186,12 @@ public class AppSettingsStore: Store {
             removeFromProductFilterHistory(filter: filter, onCompletion: onCompletion)
         case let .resetProductFilterHistory(siteID, onCompletion):
             resetProductFilterHistory(siteID: siteID, onCompletion: onCompletion)
+        case .loadBookingFilters(let siteID, let onCompletion):
+            loadBookingFilters(siteID: siteID, onCompletion: onCompletion)
+        case .upsertBookingFilters(let siteID, let filters, let onCompletion):
+            upsertBookingFilters(siteID: siteID, filters: filters, onCompletion: onCompletion)
+        case .resetBookingFilters:
+            resetBookingFilters()
         case .setOrderAddOnsFeatureSwitchState(isEnabled: let isEnabled, onCompletion: let onCompletion):
             setOrderAddOnsFeatureSwitchState(isEnabled: isEnabled, onCompletion: onCompletion)
         case .loadOrderAddOnsSwitchState(onCompletion: let onCompletion):
@@ -1006,6 +1019,46 @@ private extension AppSettingsStore {
     }
 }
 
+// MARK: - Booking Filters
+//
+private extension AppSettingsStore {
+    func loadBookingFilters(siteID: Int64, onCompletion: (Result<StoredBookingFilters.Filters, Error>) -> Void) {
+        guard let allSavedFilters: StoredBookingFilters = try? fileStorage.data(for: bookingFiltersURL),
+              let filtersUnwrapped = allSavedFilters.filters[siteID] else {
+            let error = AppSettingsStoreErrors.noBookingFilters
+            onCompletion(.failure(error))
+            return
+        }
+
+        onCompletion(.success(filtersUnwrapped))
+    }
+
+    func upsertBookingFilters(siteID: Int64, filters: StoredBookingFilters.Filters, onCompletion: (Error?) -> Void) {
+        var existingFilters: [Int64: StoredBookingFilters.Filters] = [:]
+        if let storedFilters: StoredBookingFilters = try? fileStorage.data(for: bookingFiltersURL) {
+            existingFilters = storedFilters.filters
+        }
+
+        existingFilters[siteID] = filters
+
+        let newStoredBookingFilters = StoredBookingFilters(filters: existingFilters)
+        do {
+            try fileStorage.write(newStoredBookingFilters, to: bookingFiltersURL)
+            onCompletion(nil)
+        } catch {
+            onCompletion(AppSettingsStoreErrors.writeBookingFilters)
+        }
+    }
+
+    func resetBookingFilters() {
+        do {
+            try fileStorage.deleteFile(at: bookingFiltersURL)
+        } catch {
+            DDLogError("⛔️ Deleting the booking filters file failed. Error: \(error)")
+        }
+    }
+}
+
 // MARK: - Store settings
 //
 private extension AppSettingsStore {
@@ -1423,6 +1476,8 @@ enum AppSettingsStoreErrors: Error {
     case writeOrderFilterHistory
     case writeProductsSettings
     case writeProductFilterHistory
+    case noBookingFilters
+    case writeBookingFilters
     case noEligibilityErrorInfo
 }
 
@@ -1440,4 +1495,5 @@ private enum Constants {
     static let productsSettings = "products-settings.plist"
     static let orderFilterHistory = "order-filter-history.plist"
     static let productFilterHistory = "product-filter-history.plist"
+    static let bookingFilters = "booking-filters.plist"
 }