[PM-19577] Add flight recorder and hook up to UI (#1500)

Author: matt-livefront

BitwardenShared/Core/Platform/Services/FlightRecorder.swift

@@ -0,0 +1,71 @@
+@preconcurrency import Combine
+
+// MARK: - FlightRecorder
+
+/// A protocol for a service which can temporarily be enabled to collect logs for debugging to a
+/// local file.
+///
+protocol FlightRecorder: Sendable {
+    /// Disables the collection of temporary debug logs.
+    ///
+    func disableFlightRecorder() async
+
+    /// Enables the collection of temporary debug logs to a local file for a set duration.
+    ///
+    /// - Parameter duration: The duration that logging should be enabled for.
+    ///
+    func enableFlightRecorder(duration: FlightRecorderLoggingDuration) async
+
+    /// A publisher which publishes the enabled status of the flight recorder.
+    ///
+    /// - Returns: A publisher for the enabled status of the flight recorder.
+    ///
+    func isEnabledPublisher() async -> AnyPublisher<Bool, Never>
+}
+
+// MARK: - DefaultFlightRecorder
+
+/// A default implementation of a `FlightRecorder`.
+///
+@MainActor
+final class DefaultFlightRecorder {
+    // MARK: Private Properties
+
+    /// A subject containing the enable status of the flight recorder.
+    private let isEnabledSubject = CurrentValueSubject<Bool, Never>(false)
+
+    /// The service used by the application to manage account state.
+    private let stateService: StateService
+
+    /// The service used to get the present time.
+    private let timeProvider: TimeProvider
+
+    // MARK: Initialization
+
+    /// Initialize a `DefaultFlightRecorder`.
+    ///
+    /// - Parameters:
+    ///   - stateService: The service used by the application to manage account state.
+    ///   - timeProvider: The service used to get the present time.
+    ///
+    init(stateService: StateService, timeProvider: TimeProvider) {
+        self.stateService = stateService
+        self.timeProvider = timeProvider
+    }
+}
+
+// MARK: - DefaultFlightRecorder + FlightRecorder
+
+extension DefaultFlightRecorder: FlightRecorder {
+    func disableFlightRecorder() async {
+        isEnabledSubject.send(false)
+    }
+
+    func enableFlightRecorder(duration: FlightRecorderLoggingDuration) async {
+        isEnabledSubject.send(true)
+    }
+
+    func isEnabledPublisher() async -> AnyPublisher<Bool, Never> {
+        isEnabledSubject.eraseToAnyPublisher()
+    }
+}

BitwardenShared/Core/Platform/Services/FlightRecorderTests.swift

@@ -0,0 +1,71 @@
+import XCTest
+
+@testable import BitwardenShared
+
+class FlightRecorderTests: BitwardenTestCase {
+    // MARK: Properties
+
+    var stateService: MockStateService!
+    var subject: FlightRecorder!
+    var timeProvider: MockTimeProvider!
+
+    // MARK: Setup & Teardown
+
+    override func setUp() {
+        super.setUp()
+
+        stateService = MockStateService()
+        timeProvider = MockTimeProvider(.mockTime(Date(year: 2025, month: 1, day: 1)))
+
+        subject = DefaultFlightRecorder(
+            stateService: stateService,
+            timeProvider: timeProvider
+        )
+    }
+
+    override func tearDown() {
+        super.tearDown()
+
+        stateService = nil
+        subject = nil
+        timeProvider = nil
+    }
+
+    // MARK: Tests
+
+    /// `disableFlightRecorder()` disables the flight recorder.
+    func test_disableFlightRecorder() async {
+        var isEnabledValues = [Bool]()
+        let publisher = await subject.isEnabledPublisher().sink { isEnabledValues.append($0) }
+        defer { publisher.cancel() }
+
+        await subject.enableFlightRecorder(duration: .twentyFourHours)
+        await subject.disableFlightRecorder()
+
+        XCTAssertEqual(isEnabledValues, [false, true, false])
+    }
+
+    /// `enableFlightRecorder(duration:)` enables the flight recorder for the specified duration.
+    func test_enableFlightRecorder() async {
+        var isEnabledValues = [Bool]()
+        let publisher = await subject.isEnabledPublisher().sink { isEnabledValues.append($0) }
+        defer { publisher.cancel() }
+
+        await subject.enableFlightRecorder(duration: .twentyFourHours)
+
+        XCTAssertEqual(isEnabledValues, [false, true])
+    }
+
+    /// `isEnabledPublisher()` publishes the enabled status of the flight recorder.
+    func test_isEnabledPublisher() async throws {
+        var isEnabled = false
+        let publisher = await subject.isEnabledPublisher().sink { isEnabled = $0 }
+        defer { publisher.cancel() }
+
+        await subject.enableFlightRecorder(duration: .eightHours)
+        XCTAssertTrue(isEnabled)
+
+        await subject.disableFlightRecorder()
+        XCTAssertFalse(isEnabled)
+    }
+}

BitwardenShared/Core/Platform/Services/ServiceContainer.swift

@@ -89,6 +89,9 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
     /// of the `Fido2UserInterface` from the SDK.
     let fido2UserInterfaceHelper: Fido2UserInterfaceHelper
 
+    /// The service used by the application for recording temporary debug logs.
+    let flightRecorder: FlightRecorder
+
     /// The repository used by the application to manage generator data for the UI layer.
     let generatorRepository: GeneratorRepository
 
@@ -209,6 +212,7 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
     ///   - fido2UserInterfaceHelper: A helper to be used on Fido2 flows that requires user interaction
     ///   and extends the capabilities of the `Fido2UserInterface` from the SDK.
     ///   - fido2CredentialStore: A store to be used on Fido2 flows to get/save credentials.
+    ///   - flightRecorder: The service used by the application for recording temporary debug logs.
     ///   - generatorRepository: The repository used by the application to manage generator data for the UI layer.
     ///   - importCiphersRepository: The repository used by the application to manage importing credential
     ///   in Credential Exhange flow.
@@ -264,6 +268,7 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
         exportVaultService: ExportVaultService,
         fido2CredentialStore: Fido2CredentialStore,
         fido2UserInterfaceHelper: Fido2UserInterfaceHelper,
+        flightRecorder: FlightRecorder,
         generatorRepository: GeneratorRepository,
         importCiphersRepository: ImportCiphersRepository,
         keychainRepository: KeychainRepository,
@@ -317,6 +322,7 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
         self.exportVaultService = exportVaultService
         self.fido2CredentialStore = fido2CredentialStore
         self.fido2UserInterfaceHelper = fido2UserInterfaceHelper
+        self.flightRecorder = flightRecorder
         self.generatorRepository = generatorRepository
         self.importCiphersRepository = importCiphersRepository
         self.keychainService = keychainService
@@ -478,6 +484,11 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
             timeProvider: timeProvider
         )
 
+        let flightRecorder = DefaultFlightRecorder(
+            stateService: stateService,
+            timeProvider: timeProvider
+        )
+
         let sendService = DefaultSendService(
             fileAPIService: apiService,
             sendAPIService: apiService,
@@ -788,6 +799,7 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
             exportVaultService: exportVaultService,
             fido2CredentialStore: fido2CredentialStore,
             fido2UserInterfaceHelper: fido2UserInterfaceHelper,
+            flightRecorder: flightRecorder,
             generatorRepository: generatorRepository,
             importCiphersRepository: importCiphersRepository,
             keychainRepository: keychainRepository,

BitwardenShared/Core/Platform/Services/Services.swift

@@ -29,6 +29,7 @@ typealias Services = HasAPIService
     & HasFido2CredentialStore
     & HasFido2UserInterfaceHelper
     & HasFileAPIService
+    & HasFlightRecorder
     & HasGeneratorRepository
     & HasImportCiphersRepository
     & HasLocalAuthService
@@ -232,6 +233,13 @@ protocol HasFileAPIService {
     var fileAPIService: FileAPIService { get }
 }
 
+/// Protocol for an object that provides a `FlightRecorder`.
+///
+protocol HasFlightRecorder {
+    /// The service used by the application for recording temporary debug logs.
+    var flightRecorder: FlightRecorder { get }
+}
+
 /// Protocol for an object that provides a `GeneratorRepository`.
 ///
 protocol HasGeneratorRepository {

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

@@ -0,0 +1,26 @@
+import Combine
+
+@testable import BitwardenShared
+
+@MainActor
+final class MockFlightRecorder: FlightRecorder {
+    var disableFlightRecorderCalled = false
+    var enableFlightRecorderCalled = false
+    var enableFlightRecorderDuration: FlightRecorderLoggingDuration?
+    var isEnabledSubject = CurrentValueSubject<Bool, Never>(false)
+
+    nonisolated init() {}
+
+    func disableFlightRecorder() {
+        disableFlightRecorderCalled = true
+    }
+
+    func enableFlightRecorder(duration: FlightRecorderLoggingDuration) async {
+        enableFlightRecorderCalled = true
+        enableFlightRecorderDuration = duration
+    }
+
+    func isEnabledPublisher() async -> AnyPublisher<Bool, Never> {
+        isEnabledSubject.eraseToAnyPublisher()
+    }
+}

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

@@ -29,6 +29,7 @@ extension ServiceContainer {
         exportVaultService: ExportVaultService = MockExportVaultService(),
         fido2CredentialStore: Fido2CredentialStore = MockFido2CredentialStore(),
         fido2UserInterfaceHelper: Fido2UserInterfaceHelper = MockFido2UserInterfaceHelper(),
+        flightRecorder: FlightRecorder = MockFlightRecorder(),
         generatorRepository: GeneratorRepository = MockGeneratorRepository(),
         importCiphersRepository: ImportCiphersRepository = MockImportCiphersRepository(),
         httpClient: HTTPClient = MockHTTPClient(),
@@ -87,6 +88,7 @@ extension ServiceContainer {
             exportVaultService: exportVaultService,
             fido2CredentialStore: fido2CredentialStore,
             fido2UserInterfaceHelper: fido2UserInterfaceHelper,
+            flightRecorder: flightRecorder,
             generatorRepository: generatorRepository,
             importCiphersRepository: importCiphersRepository,
             keychainRepository: keychainRepository,

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

@@ -24,9 +24,6 @@ enum AboutAction: Equatable {
     /// The toast was shown or hidden.
     case toastShown(Toast?)
 
-    /// The flight recorder toggle value changed.
-    case toggleFlightRecorder(Bool)
-
     /// The submit crash logs toggle value changed.
     case toggleSubmitCrashLogs(Bool)
 

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

@@ -5,4 +5,10 @@
 enum AboutEffect: Equatable {
     /// The view appeared so the initial data should be loaded.
     case loadData
+
+    /// Stream the enabled status of the flight recorder.
+    case streamFlightRecorderEnabled
+
+    /// The flight recorder toggle value changed.
+    case toggleFlightRecorder(Bool)
 }

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

@@ -11,6 +11,7 @@ final class AboutProcessor: StateProcessor<AboutState, AboutAction, AboutEffect>
         & HasConfigService
         & HasEnvironmentService
         & HasErrorReporter
+        & HasFlightRecorder
         & HasPasteboardService
 
     // MARK: Properties
@@ -52,6 +53,14 @@ final class AboutProcessor: StateProcessor<AboutState, AboutAction, AboutEffect>
         switch effect {
         case .loadData:
             await loadData()
+        case .streamFlightRecorderEnabled:
+            await streamFlightRecorderEnabled()
+        case let .toggleFlightRecorder(isOn):
+            if isOn {
+                coordinator.navigate(to: .enableFlightRecorder)
+            } else {
+                await services.flightRecorder.disableFlightRecorder()
+            }
         }
     }
 
@@ -77,13 +86,6 @@ final class AboutProcessor: StateProcessor<AboutState, AboutAction, AboutEffect>
             })
         case let .toastShown(newValue):
             state.toast = newValue
-        case let .toggleFlightRecorder(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
@@ -110,4 +112,11 @@ final class AboutProcessor: StateProcessor<AboutState, AboutAction, AboutEffect>
     private func loadData() async {
         state.isFlightRecorderFeatureFlagEnabled = await services.configService.getFeatureFlag(.flightRecorder)
     }
+
+    /// Streams the enabled status of the flight recorder.
+    private func streamFlightRecorderEnabled() async {
+        for await isEnabled in await services.flightRecorder.isEnabledPublisher().values {
+            state.isFlightRecorderToggleOn = isEnabled
+        }
+    }
 }