[PM-19546] Add enable flight recorder screen (#1479)

Author: matt-livefront

BitwardenShared/Core/Platform/Models/Enum/FlightRecorderLoggingDuration.swift

@@ -0,0 +1,24 @@
+/// An enum that represents how long to enable the flight recorder.
+///
+enum FlightRecorderLoggingDuration: CaseIterable, Menuable {
+    /// The flight recorder is enabled for one hour.
+    case oneHour
+
+    /// The flight recorder is enabled for eight hours.
+    case eightHours
+
+    /// The flight recorder is enabled for 24 hours.
+    case twentyFourHours
+
+    /// The flight recorder is enabled for one week.
+    case oneWeek
+
+    var localizedName: String {
+        switch self {
+        case .oneHour: Localizations.oneHour
+        case .eightHours: Localizations.xHours(8)
+        case .twentyFourHours: Localizations.xHours(24)
+        case .oneWeek: Localizations.oneWeek
+        }
+    }
+}

BitwardenShared/Core/Platform/Models/Enum/FlightRecorderLoggingDurationTests.swift

@@ -0,0 +1,15 @@
+import XCTest
+
+@testable import BitwardenShared
+
+class FlightRecorderLoggingDurationTests: BitwardenTestCase {
+    // MARK: Tests
+
+    /// `localizedName` returns the correct values.
+    func test_localizedName() {
+        XCTAssertEqual(FlightRecorderLoggingDuration.oneHour.localizedName, Localizations.oneHour)
+        XCTAssertEqual(FlightRecorderLoggingDuration.eightHours.localizedName, Localizations.xHours(8))
+        XCTAssertEqual(FlightRecorderLoggingDuration.twentyFourHours.localizedName, Localizations.xHours(24))
+        XCTAssertEqual(FlightRecorderLoggingDuration.oneWeek.localizedName, Localizations.oneWeek)
+    }
+}

BitwardenShared/UI/Platform/Application/Support/Localizations/en.lproj/Localizable.strings

@@ -1153,3 +1153,11 @@
 "VerifyYourIdentity"="Verify your identity";
 "ShareErrorDetails" = "Share error details";
 "FlightRecorder" = "Flight recorder";
+"EnableFlightRecorder" = "Enable flight recorder";
+"ExperiencingAnIssue" = "Experiencing an issue?";
+"EnableTemporaryLoggingDescriptionLong" = "Enable temporary logging to collect and inspect logs locally. When enabled, application states and network calls may be logged—never sensitive vault information.";
+"ToGetStartedSetALoggingDurationDescriptionLong" = "To get started, set a logging duration. Logging will automatically turn off after this period, giving you time to capture activity while reproducing any issues.";
+"LoggingDuration" = "Logging duration";
+"LogsWillBeAutomaticallyDeletedAfter30DaysDescriptionLong" = "Logs will be automatically deleted after 30 days. Bitwarden is only able to access your log data when you share it.";
+"ForDetailsOnWhatIsAndIsntLoggedVisitTheBitwardenHelpCenter" = "For details on what is and isn’t logged, visit the **[Bitwarden help center](%1$@)**.";
+"OneWeek" = "1 week";

BitwardenShared/UI/Platform/Settings/Settings/About/AboutProcessor.swift

@@ -78,7 +78,12 @@ final class AboutProcessor: StateProcessor<AboutState, AboutAction, AboutEffect>
         case let .toastShown(newValue):
             state.toast = newValue
         case let .toggleFlightRecorder(isOn):
-            state.isFlightRecorderToggleOn = isOn
+            if isOn {
+                coordinator.navigate(to: .enableFlightRecorder)
+            } else {
+                // TODO: PM-19577 Turn logging off
+                state.isFlightRecorderToggleOn = isOn
+            }
         case let .toggleSubmitCrashLogs(isOn):
             state.isSubmitCrashLogsToggleOn = isOn
             services.errorReporter.isEnabled = isOn

BitwardenShared/UI/Platform/Settings/Settings/About/AboutProcessorTests.swift

@@ -157,14 +157,25 @@ class AboutProcessorTests: BitwardenTestCase {
         XCTAssertNil(subject.state.toast)
     }
 
-    /// `receive(_:)` with action `.isFlightRecorderToggleOn` updates the toggle value in the state.
+    /// `receive(_:)` with action `.isFlightRecorderToggleOn` disables the flight recorder when toggled off.
     @MainActor
-    func test_receive_toggleFlightRecorder() {
+    func test_receive_toggleFlightRecorder_off() {
+        subject.state.isFlightRecorderToggleOn = true
+
+        subject.receive(.toggleFlightRecorder(false))
+
+        XCTAssertFalse(subject.state.isFlightRecorderToggleOn)
+    }
+
+    /// `receive(_:)` with action `.isFlightRecorderToggleOn` navigates to the enable flight
+    /// recorder screen when toggled on.
+    @MainActor
+    func test_receive_toggleFlightRecorder_on() {
         XCTAssertFalse(subject.state.isFlightRecorderToggleOn)
 
         subject.receive(.toggleFlightRecorder(true))
 
-        XCTAssertTrue(subject.state.isFlightRecorderToggleOn)
+        XCTAssertEqual(coordinator.routes, [.enableFlightRecorder])
     }
 
     /// `receive(_:)` with action `.isSubmitCrashLogsToggleOn` updates the toggle value in the state.

BitwardenShared/UI/Platform/Settings/Settings/About/EnableFlightRecorder/EnableFlightRecorderAction.swift

@@ -0,0 +1,11 @@
+// MARK: - EnableFlightRecorderAction
+
+/// Actions handled by the `EnableFlightRecorderProcessor`.
+///
+enum EnableFlightRecorderAction: Equatable {
+    /// Dismiss the sheet.
+    case dismiss
+
+    /// The logging duration value has changed.
+    case loggingDurationChanged(FlightRecorderLoggingDuration)
+}

BitwardenShared/UI/Platform/Settings/Settings/About/EnableFlightRecorder/EnableFlightRecorderEffect.swift

@@ -0,0 +1,8 @@
+// MARK: - EnableFlightRecorderEffect
+
+/// Effects that can be processed by the `EnableFlightRecorderProcessor`.
+///
+enum EnableFlightRecorderEffect: Equatable {
+    /// The save button was tapped.
+    case save
+}

BitwardenShared/UI/Platform/Settings/Settings/About/EnableFlightRecorder/EnableFlightRecorderProcessor.swift

@@ -0,0 +1,69 @@
+import Foundation
+
+// MARK: - EnableFlightRecorderProcessor
+
+/// The processor used to manage state and handle actions for the `EnableFlightRecorderView`.
+///
+final class EnableFlightRecorderProcessor: StateProcessor<
+    EnableFlightRecorderState,
+    EnableFlightRecorderAction,
+    EnableFlightRecorderEffect
+> {
+    // MARK: Types
+
+    typealias Services = HasErrorReporter
+
+    // MARK: Private Properties
+
+    /// The `Coordinator` that handles navigation.
+    private let coordinator: AnyCoordinator<SettingsRoute, SettingsEvent>
+
+    /// The services used by this processor.
+    private var services: Services
+
+    // MARK: Initialization
+
+    /// Creates a new `EnableFlightRecorderProcessor`.
+    ///
+    /// - Parameters:
+    ///   - coordinator: The `Coordinator` that handles navigation.
+    ///   - services: The services used by the processor.
+    ///   - state: The initial state of the processor.
+    ///
+    init(
+        coordinator: AnyCoordinator<SettingsRoute, SettingsEvent>,
+        services: Services,
+        state: EnableFlightRecorderState
+    ) {
+        self.coordinator = coordinator
+        self.services = services
+        super.init(state: state)
+    }
+
+    // MARK: Methods
+
+    override func perform(_ effect: EnableFlightRecorderEffect) async {
+        switch effect {
+        case .save:
+            await saveAndEnableFlightRecorder()
+        }
+    }
+
+    override func receive(_ action: EnableFlightRecorderAction) {
+        switch action {
+        case .dismiss:
+            coordinator.navigate(to: .dismiss)
+        case let .loggingDurationChanged(loggingDuration):
+            state.loggingDuration = loggingDuration
+        }
+    }
+
+    // MARK: Private Methods
+
+    /// Saves the logging duration and enables the flight recorder.
+    ///
+    private func saveAndEnableFlightRecorder() async {
+        // TODO: PM-19577 Enable logging
+        coordinator.navigate(to: .dismiss)
+    }
+}

BitwardenShared/UI/Platform/Settings/Settings/About/EnableFlightRecorder/EnableFlightRecorderProcessorTests.swift

@@ -0,0 +1,58 @@
+import SnapshotTesting
+import XCTest
+
+@testable import BitwardenShared
+
+class EnableFlightRecorderProcessorTests: BitwardenTestCase {
+    // MARK: Properties
+
+    var coordinator: MockCoordinator<SettingsRoute, SettingsEvent>!
+    var subject: EnableFlightRecorderProcessor!
+
+    // MARK: Setup & Teardown
+
+    override func setUp() {
+        super.setUp()
+
+        coordinator = MockCoordinator()
+
+        subject = EnableFlightRecorderProcessor(
+            coordinator: coordinator.asAnyCoordinator(),
+            services: ServiceContainer.withMocks(),
+            state: EnableFlightRecorderState()
+        )
+    }
+
+    override func tearDown() {
+        super.tearDown()
+
+        coordinator = nil
+        subject = nil
+    }
+
+    // MARK: Tests
+
+    /// `perform(_:)` with `.save` dismisses the view.
+    @MainActor
+    func test_perform_save() async {
+        await subject.perform(.save)
+        XCTAssertEqual(coordinator.routes.last, .dismiss)
+    }
+
+    /// `receive(_:)` with `.dismiss` dismisses the view.
+    @MainActor
+    func test_receive_dismiss() {
+        subject.receive(.dismiss)
+        XCTAssertEqual(coordinator.routes.last, .dismiss)
+    }
+
+    /// `receive(_:)` with `.loggingDurationChanged(:)` updates the state's logging duration value.
+    @MainActor
+    func test_receive_loggingDurationChanged() async throws {
+        subject.receive(.loggingDurationChanged(.oneHour))
+        XCTAssertEqual(subject.state.loggingDuration, .oneHour)
+
+        subject.receive(.loggingDurationChanged(.eightHours))
+        XCTAssertEqual(subject.state.loggingDuration, .eightHours)
+    }
+}

BitwardenShared/UI/Platform/Settings/Settings/About/EnableFlightRecorder/EnableFlightRecorderState.swift

@@ -0,0 +1,10 @@
+// MARK: - EnableFlightRecorderState
+
+/// An object that defines the current state of the `EnableFlightRecorderView`.
+///
+struct EnableFlightRecorderState {
+    // MARK: Properties
+
+    /// The selected logging duration value.
+    var loggingDuration = FlightRecorderLoggingDuration.twentyFourHours
+}