[PM-19553] Add flight recorder banner to vault list (#1543)

Author: matt-livefront

BitwardenShared/Core/Platform/Models/Data/FlightRecorderData.swift

@@ -12,7 +12,7 @@ struct FlightRecorderData: Codable, Equatable {
     /// The current log, if the flight recorder is active.
     var activeLog: LogMetadata? {
         didSet {
-            guard let oldValue else { return }
+            guard let oldValue, oldValue.id != activeLog?.id else { return }
             inactiveLogs.insert(oldValue, at: 0)
         }
     }
@@ -42,6 +42,9 @@ extension FlightRecorderData {
     struct LogMetadata: Codable, Equatable, Identifiable {
         // MARK: Properties
 
+        /// A list of user IDs that have seen and dismissed the flight recorder toast banner for this log.
+        var bannerDismissedByUserIds: [String]
+
         /// The duration for how long the flight recorder was enabled for the log.
         let duration: FlightRecorderLoggingDuration
 
@@ -65,6 +68,22 @@ extension FlightRecorderData {
             ) ?? endDate
         }
 
+        /// The formatted end date for the log.
+        var formattedEndDate: String {
+            let dateFormatter = DateFormatter()
+            dateFormatter.dateStyle = .short
+            dateFormatter.timeStyle = .none
+            return dateFormatter.string(from: endDate)
+        }
+
+        /// The formatted end time for the log.
+        var formattedEndTime: String {
+            let dateFormatter = DateFormatter()
+            dateFormatter.dateStyle = .none
+            dateFormatter.timeStyle = .short
+            return dateFormatter.string(from: endDate)
+        }
+
         var id: String {
             fileName
         }
@@ -78,6 +97,7 @@ extension FlightRecorderData {
         ///   - startDate: The date the logging was started.
         ///
         init(duration: FlightRecorderLoggingDuration, startDate: Date) {
+            bannerDismissedByUserIds = []
             self.duration = duration
             self.startDate = startDate
 

BitwardenShared/Core/Platform/Models/Data/FlightRecorderDataTests.swift

@@ -89,16 +89,29 @@ class FlightRecorderDataTests: BitwardenTestCase {
 
     /// `activeLog` sets the active log, archiving an existing log if there's already one active.
     func test_setActiveLog_existingLog() {
-        let log1 = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now)
-        let log2 = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now)
+        let log1 = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: Date(year: 2025, month: 1, day: 1))
+        let log2 = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: Date(year: 2025, month: 1, day: 2))
         var subject = FlightRecorderData(activeLog: log2, inactiveLogs: [log1])
 
-        let log3 = FlightRecorderData.LogMetadata(duration: .oneWeek, startDate: .now)
+        let log3 = FlightRecorderData.LogMetadata(duration: .oneWeek, startDate: Date(year: 2025, month: 1, day: 3))
         subject.activeLog = log3
 
         XCTAssertEqual(subject, FlightRecorderData(activeLog: log3, inactiveLogs: [log2, log1]))
     }
 
+    /// Using `activeLog` to modify a property of the active log doesn't make the log inactive.
+    func test_setActiveLog_modifyExistingLogProperty() {
+        var subject = FlightRecorderData()
+        var log = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now)
+        subject.activeLog = log
+
+        subject.activeLog?.bannerDismissedByUserIds.append("123")
+        subject.activeLog?.bannerDismissedByUserIds.append("456")
+
+        log.bannerDismissedByUserIds.append(contentsOf: ["123", "456"])
+        XCTAssertEqual(subject, FlightRecorderData(activeLog: log))
+    }
+
     // MARK: FlightRecorderData.LogMetadata Tests
 
     /// `expirationDate` returns the date when the log will expire and be deleted.
@@ -119,6 +132,42 @@ class FlightRecorderDataTests: BitwardenTestCase {
         )
     }
 
+    /// `formattedEndDate` returns the log's formatted end date.
+    func test_logMetadata_formattedEndDate() {
+        XCTAssertEqual(
+            FlightRecorderData.LogMetadata(
+                duration: .oneHour,
+                startDate: Date(year: 2025, month: 4, day: 3, hour: 10, minute: 30)
+            ).formattedEndDate,
+            "4/3/25"
+        )
+        XCTAssertEqual(
+            FlightRecorderData.LogMetadata(
+                duration: .eightHours,
+                startDate: Date(year: 2025, month: 4, day: 8, hour: 10, minute: 30)
+            ).formattedEndDate,
+            "4/8/25"
+        )
+    }
+
+    /// `formattedEndDate` returns the log's formatted end time.
+    func test_logMetadata_formattedEndTime() {
+        XCTAssertEqual(
+            FlightRecorderData.LogMetadata(
+                duration: .oneHour,
+                startDate: Date(year: 2025, month: 4, day: 8, hour: 10, minute: 30)
+            ).formattedEndTime,
+            "11:30 AM"
+        )
+        XCTAssertEqual(
+            FlightRecorderData.LogMetadata(
+                duration: .eightHours,
+                startDate: Date(year: 2025, month: 4, day: 8, hour: 10, minute: 30)
+            ).formattedEndTime,
+            "6:30 PM"
+        )
+    }
+
     /// `id` returns the log's file name as a unique identifier.
     func test_logMetadata_id() {
         let log1 = FlightRecorderData.LogMetadata(duration: .oneHour, startDate: .now)

BitwardenShared/Core/Platform/Services/FlightRecorder.swift

@@ -11,6 +11,12 @@ import OSLog
 /// local file.
 ///
 protocol FlightRecorder: Sendable, BitwardenLogger {
+    /// A publisher which publishes the active log of the flight recorder.
+    ///
+    /// - Returns: A publisher for the active log of the flight recorder.
+    ///
+    func activeLogPublisher() async -> AnyPublisher<FlightRecorderData.LogMetadata?, Never>
+
     /// Deletes all inactive flight recorder logs. This will not delete the currently active log.
     ///
     func deleteInactiveLogs() async throws
@@ -51,6 +57,13 @@ protocol FlightRecorder: Sendable, BitwardenLogger {
     ///   - line: The line number in the file that called the log method.
     ///
     func log(_ message: String, file: String, line: UInt) async
+
+    /// Sets a flag indicating that the flight recorder banner for the active log was viewed and
+    /// dismissed by the active user.
+    ///
+    /// - Parameter userId: The ID of the user who dismissed the banner.
+    ///
+    func setFlightRecorderBannerDismissed(userId: String) async
 }
 
 extension FlightRecorder {
@@ -350,6 +363,11 @@ actor DefaultFlightRecorder {
 // MARK: - DefaultFlightRecorder + FlightRecorder
 
 extension DefaultFlightRecorder: FlightRecorder {
+    func activeLogPublisher() async -> AnyPublisher<FlightRecorderData.LogMetadata?, Never> {
+        _ = await getFlightRecorderData() // Ensure data has already been loaded to the subject.
+        return dataSubject.map { $0?.activeLog }.eraseToAnyPublisher()
+    }
+
     func deleteInactiveLogs() async throws {
         guard var data = await getFlightRecorderData() else {
             throw FlightRecorderError.dataUnavailable
@@ -435,4 +453,10 @@ extension DefaultFlightRecorder: FlightRecorder {
             ))
         }
     }
+
+    func setFlightRecorderBannerDismissed(userId: String) async {
+        guard var data = await getFlightRecorderData(), data.activeLog != nil else { return }
+        data.activeLog?.bannerDismissedByUserIds.append(userId)
+        await setFlightRecorderData(data)
+    }
 }

BitwardenShared/Core/Platform/Services/FlightRecorderTests.swift

@@ -78,6 +78,40 @@ class FlightRecorderTests: BitwardenTestCase { // swiftlint:disable:this type_bo
 
     // MARK: Tests
 
+    /// `activeLogPublisher()` publishes the active log of the flight recorder when there's an
+    /// existing active log.
+    func test_activeLogPublisher_existingActiveLog() async throws {
+        stateService.flightRecorderData = FlightRecorderData(activeLog: activeLog)
+        subject = makeSubject()
+
+        var initialPublisher = await subject.activeLogPublisher().values.makeAsyncIterator()
+        let firstLog = await initialPublisher.next()
+        XCTAssertEqual(firstLog, activeLog)
+
+        // Once the data is cached by the flight recorder, it isn't re-read from state service on
+        // subsequent subscriptions. We can test this by modifying the flight recorder data in state
+        // service and observing that the flight recorder is still enabled.
+        stateService.flightRecorderData = nil
+
+        var secondPublisher = await subject.activeLogPublisher().values.makeAsyncIterator()
+        let secondLog = await secondPublisher.next()
+        XCTAssertEqual(secondLog, activeLog)
+    }
+
+    /// `activeLogPublisher()` publishes the active log of the flight recorder when there's no
+    /// existing flight recorder data.
+    func test_activeLogPublisher_noFlightRecorderData() async throws {
+        var publishedValues = [FlightRecorderData.LogMetadata?]()
+        let publisher = await subject.activeLogPublisher().sink { publishedValues.append($0) }
+        defer { publisher.cancel() }
+
+        try await subject.enableFlightRecorder(duration: .eightHours)
+        await subject.disableFlightRecorder()
+
+        let inactiveLog = try XCTUnwrap(stateService.flightRecorderData?.inactiveLogs.first)
+        XCTAssertEqual(publishedValues, [nil, inactiveLog, nil])
+    }
+
     /// `deleteInactiveLogs()` deletes all of the inactive logs and associated metadata.
     func test_deleteInactiveLogs() async throws {
         stateService.flightRecorderData = FlightRecorderData(
@@ -597,6 +631,27 @@ class FlightRecorderTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         XCTAssertNil(stateService.flightRecorderData)
     }
 
+    /// `setFlightRecorderBannerDismissed(userId:)` sets that the flight recorder banner was
+    /// dismissed by the user.
+    func test_setFlightRecorderBannerDismissed() async {
+        stateService.flightRecorderData = FlightRecorderData(activeLog: activeLog)
+        await subject.setFlightRecorderBannerDismissed(userId: "123")
+
+        var activeLogWithDismissedBanner = activeLog
+        activeLogWithDismissedBanner.bannerDismissedByUserIds.append("123")
+        XCTAssertEqual(
+            stateService.flightRecorderData,
+            FlightRecorderData(activeLog: activeLogWithDismissedBanner)
+        )
+    }
+
+    /// `setFlightRecorderBannerDismissed(userId:)` doesn't modify the flight recorder data if
+    /// there's no flight recorder data.
+    func test_setFlightRecorderBannerDismissed_noFlightRecorderData() async {
+        await subject.setFlightRecorderBannerDismissed(userId: "123")
+        XCTAssertNil(stateService.flightRecorderData)
+    }
+
     // MARK: DefaultFlightRecorder Tests
 
     /// `DefaultFlightRecorder` implements `BitwardenLogger.log()` which logs to the active log.

BitwardenShared/Core/Platform/Services/TestHelpers/MockFlightRecorder.swift

@@ -4,6 +4,7 @@ import Combine
 
 @MainActor
 final class MockFlightRecorder: FlightRecorder {
+    var activeLogSubject = CurrentValueSubject<FlightRecorderData.LogMetadata?, Never>(nil)
     var deleteInactiveLogsCalled = false
     var deleteInactiveLogsResult: Result<Void, Error> = .success(())
     var deleteLogResult: Result<Void, Error> = .success(())
@@ -16,9 +17,14 @@ final class MockFlightRecorder: FlightRecorder {
     var fetchLogsResult: Result<[FlightRecorderLogMetadata], Error> = .success([])
     var isEnabledSubject = CurrentValueSubject<Bool, Never>(false)
     var logMessages = [String]()
+    var setFlightRecorderBannerDismissedUserIds = [String]()
 
     nonisolated init() {}
 
+    func activeLogPublisher() async -> AnyPublisher<FlightRecorderData.LogMetadata?, Never> {
+        activeLogSubject.eraseToAnyPublisher()
+    }
+
     func deleteInactiveLogs() async throws {
         deleteInactiveLogsCalled = true
         try deleteInactiveLogsResult.get()
@@ -51,4 +57,8 @@ final class MockFlightRecorder: FlightRecorder {
     func log(_ message: String, file: String, line: UInt) async {
         logMessages.append(message)
     }
+
+    func setFlightRecorderBannerDismissed(userId: String) async {
+        setFlightRecorderBannerDismissedUserIds.append(userId)
+    }
 }

BitwardenShared/UI/Auth/CompleteRegistration/__Snapshots__/CompleteRegistrationViewTests/test_snapshot_textFields_populated.3.png

@@ -507,4 +507,8 @@ extension AppCoordinator: VaultCoordinatorDelegate {
     func presentLoginRequest(_ loginRequest: LoginRequest) {
         showLoginRequest(loginRequest)
     }
+
+    func switchToSettingsTab(route: SettingsRoute) {
+        navigate(to: .tab(.settings(route)))
+    }
 } // swiftlint:disable:this file_length

BitwardenShared/UI/Auth/StartRegistration/CheckEmail/__Snapshots__/CheckEmailViewTests/test_snapshot_empty.3.png

@@ -509,4 +509,11 @@ class AppCoordinatorTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         )
         XCTAssertEqual(module.authCoordinator.routes, [AuthRoute.landing])
     }
+
+    /// `switchToSettingsTab(route:)` switches to the settings tab and navigates to the settings route.
+    @MainActor
+    func test_switchToSettingsTab() {
+        subject.switchToSettingsTab(route: .about)
+        XCTAssertEqual(module.tabCoordinator.routes, [.settings(.about)])
+    }
 } // swiftlint:disable:this file_length

BitwardenShared/UI/Platform/Application/AppCoordinator.swift

@@ -42,7 +42,7 @@ struct PrimaryButtonStyle: ButtonStyle {
             .multilineTextAlignment(.center)
             .styleGuide(size.fontStyle, includeLinePadding: false, includeLineSpacing: false)
             .padding(.vertical, size.verticalPadding)
-            .padding(.horizontal, 20)
+            .padding(.horizontal, size.horizontalPadding)
             .frame(maxWidth: shouldFillWidth ? .infinity : nil, minHeight: size.minimumHeight)
             .background(backgroundColor)
             .clipShape(Capsule())