feat(appbadge): add setting for app badge

Author: timc-mozilla

PocketKit/Sources/PocketKit/AppBadgeTracker.swift

@@ -0,0 +1,71 @@
+import Foundation
+import Sync
+import UIKit
+import Combine
+
+protocol BadgeProvider: AnyObject {
+    var applicationIconBadgeNumber: Int { get set }
+}
+
+extension UIApplication: BadgeProvider { }
+
+class AppBadgeSetup {
+
+    private let source: Source
+    private let notificationCenter: NotificationCenter
+    private var subscriptions: Set<AnyCancellable> = []
+    private var userDefaults: UserDefaults
+    private let badgeProvider: BadgeProvider
+    /// This completion block is called once the badge value is updated. This completion block is not currently used in the app code, but is utilized in tests, since setting the badge needs to occur on the main thread (when using UIApplication as the provider), which is called asynchronously. Thus, this is added as async test support.
+    private let completion: (() -> Void)?
+
+    init(
+        source: Source,
+        userDefaults: UserDefaults,
+        notificationCenter: NotificationCenter = .default,
+        badgeProvider: BadgeProvider,
+        completion: (() -> Void)? = nil
+    ) {
+        self.source = source
+        self.notificationCenter = notificationCenter
+        self.userDefaults = userDefaults
+        self.badgeProvider = badgeProvider
+        self.completion = completion
+
+        setupNotificationSubscription()
+    }
+
+    private func setupNotificationSubscription() {
+        self.notificationCenter
+            .publisher(for: .listUpdated)
+            .sink { [weak self] _ in
+                self?.manualCheckForSavedCount()
+            }
+            .store(in: &subscriptions)
+    }
+
+    func manualCheckForSavedCount() {
+        let numberOfSavesRequest = Requests.fetchSavedItems()
+        var numberOfSaves: Int
+        let currentValue = userDefaults.bool(forKey: AccountViewModel.ToggleAppBadgeKey)
+        if currentValue == false {
+            numberOfSaves = 0
+        } else {
+            do {
+                numberOfSaves = try source.mainContext.fetch(numberOfSavesRequest).count
+                print(numberOfSaves)
+            } catch {
+                numberOfSaves = 0
+            }
+        }
+
+        updateBadgeValue(numberOfSaves: numberOfSaves)
+    }
+
+    private func updateBadgeValue(numberOfSaves: Int) {
+        DispatchQueue.main.async { [weak self] in
+            self?.badgeProvider.applicationIconBadgeNumber = numberOfSaves
+            self?.completion?()
+        }
+    }
+}

PocketKit/Sources/PocketKit/MyList/SavedItemsList/SavedItemsListViewModel.swift

@@ -59,14 +59,16 @@ class SavedItemsListViewModel: NSObject, ItemsListViewModel {
 
     private var selectedFilters: Set<ItemsListFilter>
     private let availableFilters: [ItemsListFilter]
+    private let notificationCenter: NotificationCenter
 
-    init(source: Source, tracker: Tracker, listOptions: ListOptions) {
+    init(source: Source, tracker: Tracker, listOptions: ListOptions, notificationCenter: NotificationCenter) {
         self.source = source
         self.tracker = tracker
         self.selectedFilters = [.all]
         self.availableFilters = ItemsListFilter.allCases
         self.itemsController = source.makeItemsController()
         self.listOptions = listOptions
+        self.notificationCenter = notificationCenter
 
         super.init()
 
@@ -531,14 +533,14 @@ extension SavedItemsListViewModel: SavedItemsControllerDelegate {
         guard .update == type else {
             return
         }
-
         var snapshot = buildSnapshot()
         snapshot.reloadItems([ItemsListCell<ItemIdentifier>.item(savedItem.objectID)])
         _snapshot = snapshot
     }
 
     func controllerDidChangeContent(_ controller: SavedItemsController) {
         itemsLoaded()
+        notificationCenter.post(name: .listUpdated, object: nil)
     }
 }
 

PocketKit/Sources/PocketKit/NotificationCenter+EventNames.swift

@@ -3,4 +3,5 @@ import Foundation
 extension Notification.Name {
     static let userLoggedIn = Notification.Name("com.mozilla.pocket.userLoggedIn")
     static let userLoggedOut = Notification.Name("com.mozilla.pocket.userLoggedOut")
+    static let listUpdated = Notification.Name("com.mozilla.pocket.listUpdated")
 }

PocketKit/Sources/PocketKit/PocketSceneDelegate.swift

@@ -18,7 +18,8 @@ public class PocketSceneDelegate: UIResponder, UIWindowSceneDelegate {
                         savedItemsList: SavedItemsListViewModel(
                             source: Services.shared.source,
                             tracker: Services.shared.tracker.childTracker(hosting: .saves.saves),
-                            listOptions: .saved
+                            listOptions: .saved,
+                            notificationCenter: .default
                         ),
                         archivedItemsList: ArchivedItemsListViewModel(
                             source: Services.shared.source,
@@ -34,7 +35,9 @@ public class PocketSceneDelegate: UIResponder, UIWindowSceneDelegate {
                     ),
                     account: AccountViewModel(
                         appSession: Services.shared.appSession,
-                        user: Services.shared.user
+                        user: Services.shared.user,
+                        userDefaults: Services.shared.userDefaults,
+                        notificationCenter: .default
                     )
                 ),
                 source: Services.shared.source,

PocketKit/Sources/PocketKit/Services.swift

@@ -29,6 +29,7 @@ struct Services {
     let v3Client: V3ClientProtocol
     let instantSync: InstantSyncProtocol
     let braze: BrazeProtocol
+    let appBadgeSetup: AppBadgeSetup
 
     private let persistentContainer: PersistentContainer
 
@@ -66,6 +67,7 @@ struct Services {
         )
 
         sceneTracker = SceneTracker(tracker: tracker, userDefaults: userDefaults)
+
         refreshCoordinator = RefreshCoordinator(
             notificationCenter: .default,
             taskScheduler: BGTaskScheduler.shared,
@@ -103,6 +105,12 @@ struct Services {
             braze: braze,
             instantSync: instantSync
         )
+
+        appBadgeSetup = AppBadgeSetup(
+            source: source,
+            userDefaults: userDefaults,
+            badgeProvider: UIApplication.shared
+        )
     }
 }
 

PocketKit/Sources/PocketKit/Settings/AccountViewController.swift

@@ -6,6 +6,7 @@ enum AccountSection {
 
 enum AccountItem {
     case signOut
+    case toggleAppBadge
 }
 
 class AccountViewController: UIViewController {
@@ -32,6 +33,8 @@ class AccountViewController: UIViewController {
 
                 cell.contentConfiguration = content
                 cell.backgroundConfiguration?.backgroundColor = UIColor(.ui.white1)
+            case .toggleAppBadge:
+                model.toggleAppBadge()
             }
         }
 
@@ -74,6 +77,8 @@ extension AccountViewController: UICollectionViewDelegate {
         switch dataSource.itemIdentifier(for: indexPath) {
         case .signOut:
             model.signOut()
+        case .toggleAppBadge:
+            model.toggleAppBadge()
         default:
             break
         }

PocketKit/Sources/PocketKit/Settings/AccountViewModel.swift

@@ -6,11 +6,19 @@ import SharedPocketKit
 import SwiftUI
 
 class AccountViewModel: ObservableObject {
+    static let ToggleAppBadgeKey = "AccountViewModel.ToggleAppBadge"
     private let appSession: AppSession
     private let user: User
+    private let userDefaults: UserDefaults
+    private let notificationCenter: NotificationCenter
 
-    init(appSession: AppSession, user: User) {
+    @AppStorage("Settings.ToggleAppBadge")
+    public var appBadgeToggle: Bool = false
+
+    init(appSession: AppSession, user: User, userDefaults: UserDefaults, notificationCenter: NotificationCenter) {
         self.appSession = appSession
+        self.userDefaults = userDefaults
+        self.notificationCenter = notificationCenter
         self.user = user
     }
 
@@ -21,6 +29,23 @@ class AccountViewModel: ObservableObject {
         appSession.currentSession = nil
     }
 
+    func toggleAppBadge() {
+        UNUserNotificationCenter.current().requestAuthorization(options: .badge) {
+            (granted, error) in
+            guard error == nil && granted == true else {
+                self.userDefaults.set(false, forKey: AccountViewModel.ToggleAppBadgeKey)
+                DispatchQueue.main.async { [weak self] in
+                    self?.appBadgeToggle = false
+                }
+                return
+            }
+
+            let currentValue = self.userDefaults.bool(forKey: AccountViewModel.ToggleAppBadgeKey)
+            self.userDefaults.setValue(!currentValue, forKey: AccountViewModel.ToggleAppBadgeKey)
+            self.notificationCenter.post(name: .listUpdated, object: nil)
+        }
+    }
+
     @Published var isPresentingHelp = false
     @Published var isPresentingTerms = false
     @Published var isPresentingPrivacy = false

PocketKit/Sources/PocketKit/Settings/Components/SettingsRowToggle.swift

@@ -0,0 +1,27 @@
+import SwiftUI
+import Textile
+
+struct SettingsRowToggle: View {
+
+    private var title: String
+
+    @ObservedObject
+    private var model: AccountViewModel
+
+    let action: () -> Void
+
+    init(title: String, model: AccountViewModel, action: @escaping () -> Void) {
+        self.title = title
+        self.model = model
+        self.action = action
+    }
+
+    var body: some View {
+        VStack {
+            Toggle(title, isOn: model.$appBadgeToggle)
+                .onChange(of: model.appBadgeToggle) { newValue in
+                    self.action()
+                }
+        }
+    }
+}

PocketKit/Sources/PocketKit/Settings/SettingsView.swift

@@ -64,6 +64,12 @@ struct SettingsForm: View {
                 })
                 .textCase(nil)
 
+                Section(header: Text("App Customization").style(.settings.header)) {
+                    SettingsRowToggle(title: "Show App Badge Count", model: model) {
+                        model.toggleAppBadge()
+                    }
+                }.textCase(nil)
+
                 Section(header: Text("About & Support").style(.settings.header)) {
                     SettingsRowButton(title: "Help", icon: SFIconModel("questionmark.circle")) { model.isPresentingHelp.toggle() }
                         .sheet(isPresented: $model.isPresentingHelp) {
@@ -80,7 +86,6 @@ struct SettingsForm: View {
                             SFSafariView(url: URL(string: "https://getpocket.com/en/privacy/")!)
                                 .edgesIgnoringSafeArea(.bottom)
                         }
-
                 }.textCase(nil)
             }
             .listRowBackground(Color(.ui.grey7))

PocketKit/Tests/PocketKitTests/AppBadgeTrackerTests.swift

@@ -0,0 +1,88 @@
+import XCTest
+import CoreData
+@testable import PocketKit
+import Combine
+import SharedPocketKit
+@testable import Sync
+
+class MockBadgeProvider: BadgeProvider {
+    var applicationIconBadgeNumber: Int = 0
+}
+
+final class AppBadgeTrackerTests: XCTestCase {
+    private var space: Space!
+    private var source: MockSource!
+    private var userDefaults: UserDefaults!
+    private var accountViewModel: AccountViewModel!
+    private var badgeProvider: MockBadgeProvider!
+    private var savedItem: NSManagedObject!
+    private var archivedItem: NSManagedObject!
+
+    override func setUp() {
+        space = .testSpace()
+        source = MockSource()
+        source.mainContext = space.context
+        savedItem = space.buildSavedItem()
+        archivedItem = space.buildSavedItem(isArchived: true)
+
+        userDefaults = UserDefaults()
+        badgeProvider = MockBadgeProvider()
+    }
+
+    private func subject(completion: (() -> Void)? = nil) -> AppBadgeSetup {
+        return AppBadgeSetup(source: source, userDefaults: userDefaults, badgeProvider: badgeProvider, completion: completion)
+    }
+
+    override func tearDown() {
+        userDefaults.removeObject(forKey: AccountViewModel.ToggleAppBadgeKey)
+    }
+
+    func test_on_savedItemsUpdated_noSubscriberCalled() {
+        userDefaults.setValue(false, forKey: AccountViewModel.ToggleAppBadgeKey)
+
+        source.mainContext.insert(savedItem)
+
+        NotificationCenter.default.post(name: .listUpdated, object: nil)
+
+        XCTAssertEqual(badgeProvider.applicationIconBadgeNumber, 0)
+        source.mainContext.delete(savedItem)
+    }
+
+    func test_on_savedItemsUpdated_subscribersCalledAddingElement() {
+        let badgeExpectation = expectation(description: "expected badge count to be updated")
+        let subject = subject {
+            badgeExpectation.fulfill()
+        }
+        badgeExpectation.assertForOverFulfill = false
+
+        userDefaults.setValue(true, forKey: AccountViewModel.ToggleAppBadgeKey)
+
+        source.mainContext.insert(savedItem)
+        source.mainContext.insert(archivedItem)
+
+        NotificationCenter.default.post(name: .listUpdated, object: nil)
+
+        wait(for: [badgeExpectation], timeout: 1)
+        XCTAssertEqual(badgeProvider.applicationIconBadgeNumber, 1)
+        source.mainContext.delete(savedItem)
+        source.mainContext.delete(archivedItem)
+    }
+
+    func test_on_savedItemsUpdated_subscribersCalledAddingAndDeleting() {
+        let badgeExpectation = expectation(description: "expected badge count to be updated")
+        let subject = subject {
+            badgeExpectation.fulfill()
+        }
+        badgeExpectation.assertForOverFulfill = false
+
+        userDefaults.setValue(true, forKey: AccountViewModel.ToggleAppBadgeKey)
+
+        source.mainContext.insert(savedItem)
+
+        source.mainContext.delete(savedItem)
+        NotificationCenter.default.post(name: .listUpdated, object: nil)
+
+        wait(for: [badgeExpectation], timeout: 1)
+        XCTAssertEqual(badgeProvider.applicationIconBadgeNumber, 0)
+    }
+}

PocketKit/Tests/PocketKitTests/Notifications/PushNotificationServiceTests.swift

@@ -82,5 +82,4 @@ final class PushNotificationServiceTests: XCTestCase {
         XCTAssertEqual(braze.loggedOutCalls(), 1)
         XCTAssertEqual(instantSync.loggedOutCalls(), 1)
     }
-
 }

PocketKit/Tests/PocketKitTests/SavedItemsListViewModelTests.swift

@@ -41,7 +41,8 @@ class SavedItemsListViewModelTests: XCTestCase {
         SavedItemsListViewModel(
             source: source ?? self.source,
             tracker: tracker ?? self.tracker,
-            listOptions: listOptions ?? self.listOptions
+            listOptions: listOptions ?? self.listOptions,
+            notificationCenter: .default
         )
     }