Merge pull request #590 from woocommerce/fix/563-mark-as-read-notice

Reapply updates from "marked as read" notice PR (#579)

Author: bummytime

WooCommerce/Classes/Extensions/UserDefaults+Woo.swift

@@ -17,6 +17,7 @@ extension UserDefaults {
         case versionOfLastRun
         case analyticsUsername
         case notificationsLastSeenTime
+        case notificationsMarkAsReadCount
     }
 }
 

WooCommerce/Classes/ViewRelated/Notifications/NotificationsViewController.swift

@@ -122,6 +122,17 @@ class NotificationsViewController: UIViewController {
         }
     }
 
+    /// The number of times the "Mark all as read" button was tapped
+    ///
+    private var markAsReadCount: Int {
+        get {
+            return UserDefaults.standard.integer(forKey: UserDefaults.Key.notificationsMarkAsReadCount.rawValue)
+        }
+        set {
+            return UserDefaults.standard[.notificationsMarkAsReadCount] = newValue
+        }
+    }
+
     // MARK: - View Lifecycle
 
     deinit {
@@ -252,7 +263,6 @@ private extension NotificationsViewController {
         }
 
         markAsRead(notes: unreadNotes)
-        hapticGenerator.notificationOccurred(.success)
     }
 
     @IBAction func displayFiltersAlert() {
@@ -350,7 +360,11 @@ private extension NotificationsViewController {
         let identifiers = notes.map { $0.noteId }
         let action = NotificationAction.updateMultipleReadStatus(noteIds: identifiers, read: true) { [weak self] error in
             if let error = error {
-                DDLogError("⛔️ Error marking notifications as read: \(error)")
+                DDLogError("⛔️ Error marking multiple notifications as read: \(error)")
+                self?.hapticGenerator.notificationOccurred(.error)
+            } else {
+                self?.hapticGenerator.notificationOccurred(.success)
+                self?.displayMarkAllAsReadNoticeIfNeeded()
             }
             self?.updateMarkAllReadButtonState()
         }
@@ -785,6 +799,20 @@ private extension NotificationsViewController {
     func updateMarkAllReadButtonState() {
         leftBarButton.isEnabled = !unreadNotes.isEmpty
     }
+
+    /// Displays the `Mark all as read` Notice if the number of times it was previously displayed is lower than the
+    /// `Settings.markAllAsReadNoticeMaxViews` value.
+    ///
+    func displayMarkAllAsReadNoticeIfNeeded() {
+        guard markAsReadCount < Settings.markAllAsReadNoticeMaxViews else {
+            return
+        }
+
+        markAsReadCount += 1
+        let message = NSLocalizedString("All notifications marked as read", comment: "Mark all notifications as read notice")
+        let notice = Notice(title: message, feedbackType: .success)
+        AppDelegate.shared.noticePresenter.enqueue(notice: notice)
+    }
 }
 
 
@@ -816,8 +844,9 @@ private extension NotificationsViewController {
     }
 
     enum Settings {
-        static let estimatedRowHeight = CGFloat(88)
-        static let placeholderRowsPerSection = [3]
+        static let estimatedRowHeight             = CGFloat(88)
+        static let placeholderRowsPerSection      = [3]
+        static let markAllAsReadNoticeMaxViews    = 2
     }
 
     enum State {