[BITAU-124] Refresh Item List When Foregrounding the App

AuthenticatorShared/Core/Platform/Services/NotificationCenterService.swift

@@ -0,0 +1,53 @@
+import Combine
+import UIKit
+
+// MARK: - NotificationCenterService
+
+/// A protocol for a `NotificationCenterService` which accesses the app's notification center.
+///
+protocol NotificationCenterService: AnyObject {
+    /// A publisher for when the app enters the background.
+    ///
+    func didEnterBackgroundPublisher() -> AnyPublisher<Void, Never>
+
+    /// A publisher for when the app enters the foreground.
+    ///
+    func willEnterForegroundPublisher() -> AnyPublisher<Void, Never>
+}
+
+// MARK: - DefaultNotificationCenterService
+
+/// A default implementation of the `NotificationCenterService` which accesses the app's notification center.
+///
+class DefaultNotificationCenterService: NotificationCenterService {
+    // MARK: Properties
+
+    /// The NotificationCenter to use in subscribing to notifications.
+    let notificationCenter: NotificationCenter
+
+    // MARK: Initialization
+
+    /// Initialize a `DefaultNotificationCenterService`.
+    ///
+    /// - Parameter notificationCenter: The NotificationCenter to use in subscribing to notifications.
+    ///
+    init(notificationCenter: NotificationCenter = NotificationCenter.default) {
+        self.notificationCenter = notificationCenter
+    }
+
+    // MARK: Methods
+
+    func didEnterBackgroundPublisher() -> AnyPublisher<Void, Never> {
+        notificationCenter
+            .publisher(for: UIApplication.didEnterBackgroundNotification)
+            .map { _ in }
+            .eraseToAnyPublisher()
+    }
+
+    func willEnterForegroundPublisher() -> AnyPublisher<Void, Never> {
+        notificationCenter
+            .publisher(for: UIApplication.willEnterForegroundNotification)
+            .map { _ in }
+            .eraseToAnyPublisher()
+    }
+}

AuthenticatorShared/Core/Platform/Services/NotificationCenterServiceTests.swift

@@ -0,0 +1,58 @@
+import XCTest
+
+@testable import AuthenticatorShared
+
+final class NotificationCenterServiceTests: AuthenticatorTestCase {
+    // MARK: Properties
+
+    var notificationCenter: NotificationCenter!
+    var subject: DefaultNotificationCenterService!
+
+    // MARK: Setup & Teardown
+
+    override func setUp() {
+        notificationCenter = NotificationCenter()
+        subject = DefaultNotificationCenterService(notificationCenter: notificationCenter)
+    }
+
+    override func tearDown() {
+        notificationCenter = nil
+        subject = nil
+    }
+
+    // MARK: Tests
+
+    /// `didEnterBackgroundPublisher` publishes a notification when the app enters the background.
+    func testDidEnterBackgroundPublisher() {
+        let expectation = XCTestExpectation(description: "Application entered background")
+        let cancellable = subject.didEnterBackgroundPublisher()
+            .sink { _ in
+                expectation.fulfill()
+            }
+
+        notificationCenter.post(
+            name: UIApplication.didEnterBackgroundNotification,
+            object: nil
+        )
+
+        wait(for: [expectation], timeout: 1)
+        cancellable.cancel()
+    }
+
+    /// `willEnterForegroundPublisher` publishes a notification when the app will enter the foreground.
+    func testWillEnterForegroundPublisher() {
+        let expectation = XCTestExpectation(description: "Application will enter foreground")
+        let cancellable = subject.willEnterForegroundPublisher()
+            .sink { _ in
+                expectation.fulfill()
+            }
+
+        notificationCenter.post(
+            name: UIApplication.willEnterForegroundNotification,
+            object: nil
+        )
+
+        wait(for: [expectation], timeout: 1)
+        cancellable.cancel()
+    }
+}

AuthenticatorShared/Core/Platform/Services/ServiceContainer.swift

@@ -55,6 +55,9 @@
     /// The service used to perform app data migrations.
     let migrationService: MigrationService
 
+    /// The service used to receive foreground and background notifications.
+    let notificationCenterService: NotificationCenterService
+
     /// The service used by the application for sharing data with other apps.
     let pasteboardService: PasteboardService
 
@@ -86,6 +89,7 @@
     ///   - exportItemsService: The service to export items.
     ///   - importItemsService: The service to import items.
     ///   - migrationService: The service to do data migrations
+    ///   - notificationCenterService:  The service used to receive foreground and background notifications.
     ///   - pasteboardService: The service used by the application for sharing data with other apps.
     ///   - stateService: The service for managing account state.
     ///   - timeProvider: Provides the present time for TOTP Code Calculation.
@@ -105,6 +109,7 @@
         exportItemsService: ExportItemsService,
         importItemsService: ImportItemsService,
         migrationService: MigrationService,
+        notificationCenterService: NotificationCenterService,
         pasteboardService: PasteboardService,
         stateService: StateService,
         timeProvider: TimeProvider,
@@ -123,6 +128,7 @@
         self.exportItemsService = exportItemsService
         self.importItemsService = importItemsService
         self.migrationService = migrationService
+        self.notificationCenterService = notificationCenterService
         self.pasteboardService = pasteboardService
         self.timeProvider = timeProvider
         self.stateService = stateService
@@ -189,6 +195,8 @@
             keychainRepository: keychainRepository
         )
 
+        let notificationCenterService = DefaultNotificationCenterService()
+
         let totpService = DefaultTOTPService(
             clientVault: clientService.clientVault(),
             errorReporter: errorReporter,
@@ -259,6 +267,7 @@
             exportItemsService: exportItemsService,
             importItemsService: importItemsService,
             migrationService: migrationService,
+            notificationCenterService: notificationCenterService,
             pasteboardService: pasteboardService,
             stateService: stateService,
             timeProvider: timeProvider,

AuthenticatorShared/Core/Platform/Services/Services.swift

@@ -11,6 +11,7 @@ typealias Services = HasAppSettingsStore
     & HasErrorReporter
     & HasExportItemsService
     & HasImportItemsService
+    & HasNotificationCenterService
     & HasPasteboardService
     & HasStateService
     & HasTOTPService
@@ -85,6 +86,13 @@ protocol HasImportItemsService {
     var importItemsService: ImportItemsService { get }
 }
 
+/// Protocol for an object that provides a `NotificationCenterService`.
+///
+protocol HasNotificationCenterService {
+    ///  The service used to receive foreground and background notifications.
+    var notificationCenterService: NotificationCenterService { get }
+}
+
 /// Protocol for an object that provides a `PasteboardService`.
 ///
 protocol HasPasteboardService {

AuthenticatorShared/Core/Platform/Services/TestHelpers/MockNotificationCenterService.swift

@@ -0,0 +1,17 @@
+import Combine
+import Foundation
+
+@testable import AuthenticatorShared
+
+class MockNotificationCenterService: NotificationCenterService {
+    var didEnterBackgroundSubject = PassthroughSubject<Void, Never>()
+    var willEnterForegroundSubject = PassthroughSubject<Void, Never>()
+
+    func didEnterBackgroundPublisher() -> AnyPublisher<Void, Never> {
+        didEnterBackgroundSubject.eraseToAnyPublisher()
+    }
+
+    func willEnterForegroundPublisher() -> AnyPublisher<Void, Never> {
+        willEnterForegroundSubject.eraseToAnyPublisher()
+    }
+}

AuthenticatorShared/Core/Platform/Services/TestHelpers/ServiceContainer+Mocks.swift

@@ -18,6 +18,7 @@ extension ServiceContainer {
         exportItemsService: ExportItemsService = MockExportItemsService(),
         importItemsService: ImportItemsService = MockImportItemsService(),
         migrationService: MigrationService = MockMigrationService(),
+        notificationCenterService: NotificationCenterService = MockNotificationCenterService(),
         pasteboardService: PasteboardService = MockPasteboardService(),
         stateService: StateService = MockStateService(),
         timeProvider: TimeProvider = MockTimeProvider(.currentTime),
@@ -37,6 +38,7 @@ extension ServiceContainer {
             exportItemsService: exportItemsService,
             importItemsService: importItemsService,
             migrationService: migrationService,
+            notificationCenterService: notificationCenterService,
             pasteboardService: pasteboardService,
             stateService: stateService,
             timeProvider: timeProvider,

AuthenticatorShared/UI/Vault/ItemList/ItemList/ItemListProcessor.swift

@@ -1,3 +1,4 @@
+import Combine
 import Foundation
 
 // swiftlint:disable file_length
@@ -6,6 +7,8 @@ import Foundation
 
 /// A `Processor` that can process `ItemListAction` and `ItemListEffect` objects.
 final class ItemListProcessor: StateProcessor<ItemListState, ItemListAction, ItemListEffect> {
+    // swiftlint:disable:previous type_body_length
+
     // MARK: Types
 
     typealias Services = HasAppSettingsStore
@@ -14,12 +17,16 @@ final class ItemListProcessor: StateProcessor<ItemListState, ItemListAction, Ite
         & HasCameraService
         & HasConfigService
         & HasErrorReporter
+        & HasNotificationCenterService
         & HasPasteboardService
         & HasTOTPService
         & HasTimeProvider
 
     // MARK: Private Properties
 
+    /// The set to hold Combine cancellables.
+    private var cancellables = Set<AnyCancellable>()
+
     /// The `Coordinator` for this processor.
     private var coordinator: AnyCoordinator<ItemListRoute, ItemListEvent>
 
@@ -56,6 +63,7 @@ final class ItemListProcessor: StateProcessor<ItemListState, ItemListAction, Ite
                 }
             }
         )
+        setupForegroundNotification()
     }
 
     deinit {
@@ -259,6 +267,20 @@ final class ItemListProcessor: StateProcessor<ItemListState, ItemListAction, Ite
         return []
     }
 
+    /// Subscribe to receive foreground notifications so that we can refresh the item list when the app is relaunched.
+    ///
+    private func setupForegroundNotification() {
+        services.notificationCenterService
+            .willEnterForegroundPublisher()
+            .sink { [weak self] in
+                guard let self else { return }
+                Task {
+                    await self.perform(.refresh)
+                }
+            }
+            .store(in: &cancellables)
+    }
+
     /// Determine if the user has synced with this account previously. If they have not synced previously,
     /// this method return `true` indicating that we should show the toast for a newly synced account. It
     /// also stores the fact that we've synced with this account in the `AppSettingsStore` for

AuthenticatorShared/UI/Vault/ItemList/ItemList/ItemListProcessorTests.swift

@@ -16,6 +16,7 @@ class ItemListProcessorTests: AuthenticatorTestCase { // swiftlint:disable:this
     var configService: MockConfigService!
     var coordinator: MockCoordinator<ItemListRoute, ItemListEvent>!
     var errorReporter: MockErrorReporter!
+    var notificationCenterService: MockNotificationCenterService!
     var pasteboardService: MockPasteboardService!
     var totpService: MockTOTPService!
     var subject: ItemListProcessor!
@@ -32,6 +33,7 @@ class ItemListProcessorTests: AuthenticatorTestCase { // swiftlint:disable:this
         configService = MockConfigService()
         coordinator = MockCoordinator()
         errorReporter = MockErrorReporter()
+        notificationCenterService = MockNotificationCenterService()
         pasteboardService = MockPasteboardService()
         totpService = MockTOTPService()
 
@@ -42,6 +44,7 @@ class ItemListProcessorTests: AuthenticatorTestCase { // swiftlint:disable:this
             cameraService: cameraService,
             configService: configService,
             errorReporter: errorReporter,
+            notificationCenterService: notificationCenterService,
             pasteboardService: pasteboardService,
             totpService: totpService
         )
@@ -56,6 +59,15 @@ class ItemListProcessorTests: AuthenticatorTestCase { // swiftlint:disable:this
     override func tearDown() {
         super.tearDown()
 
+        application = nil
+        appSettingsStore = nil
+        authItemRepository = nil
+        cameraService = nil
+        configService = nil
+        errorReporter = nil
+        notificationCenterService = nil
+        pasteboardService = nil
+        totpService = nil
         coordinator = nil
         subject = nil
     }
@@ -590,6 +602,20 @@ class ItemListProcessorTests: AuthenticatorTestCase { // swiftlint:disable:this
         XCTAssertNil(subject.state.url)
     }
 
+    /// `setupForegroundNotification()` is called as part of `init()` and subscribes to any
+    ///  foreground notification, performing `.refresh` when it receives a notification.
+    func test_setupForegroundNotification() async throws {
+        let item = ItemListItem.fixture()
+        let resultSection = ItemListSection(id: "", items: [item], name: "Items")
+        authItemRepository.itemListSubject.send([resultSection])
+        authItemRepository.refreshTotpCodesResult = .success([item])
+
+        notificationCenterService.willEnterForegroundSubject.send()
+
+        try await waitForAsync { self.subject.state.loadingState != .loading(nil) }
+        XCTAssertEqual(subject.state.loadingState, .data([resultSection]))
+    }
+
     // MARK: AuthenticatorKeyCaptureDelegate Tests
 
     /// `didCompleteAutomaticCapture` failure when the user has opted to save locally by default.
@@ -993,11 +1019,7 @@ class ItemListProcessorTests: AuthenticatorTestCase { // swiftlint:disable:this
         dismissAction?.action()
         waitFor(!authItemRepository.addAuthItemAuthItems.isEmpty)
         waitFor(subject.state.loadingState != .loading(nil))
-        guard let item = authItemRepository.addAuthItemAuthItems.first
-        else {
-            XCTFail("Unable to get authenticator item")
-            return
-        }
+        let item = try XCTUnwrap(authItemRepository.addAuthItemAuthItems.first)
         XCTAssertEqual(item.name, "name")
         XCTAssertEqual(item.totpKey, String.base32Key)
     }