[PM-19577] Log ErrorReporter errors to the flight recorder (#1547)

Author: matt-livefront

Authenticator/Application/AppDelegate.swift

@@ -1,4 +1,5 @@
 import AuthenticatorShared
+import BitwardenKit
 import UIKit
 
 /// A protocol for an `AppDelegate` that can be used by the `SceneDelegate` to look up the

Authenticator/Application/Services/ErrorReporter/CrashlyticsErrorReporter.swift

@@ -6,6 +6,11 @@ import FirebaseCrashlytics
 /// An `ErrorReporter` that logs non-fatal errors to Crashlytics for investigation.
 ///
 final class CrashlyticsErrorReporter: ErrorReporter {
+    // MARK: Properties
+
+    /// A list of additional loggers that errors will be logged to.
+    private var additionalLoggers: [any BitwardenLogger] = []
+
     // MARK: ErrorReporter Properties
 
     var isEnabled: Bool {
@@ -25,7 +30,16 @@ final class CrashlyticsErrorReporter: ErrorReporter {
 
     // MARK: ErrorReporter
 
+    public func add(logger: any BitwardenLogger) {
+        additionalLoggers.append(logger)
+    }
+
     func log(error: Error) {
+        let callStack = Thread.callStackSymbols.joined(separator: "\n")
+        for logger in additionalLoggers {
+            logger.log("Error: \(error)\n\(callStack)")
+        }
+
         // Don't log networking related errors to Crashlytics.
         guard !error.isNetworkingError else { return }
 

Bitwarden/Application/AppDelegate.swift

@@ -1,3 +1,4 @@
+import BitwardenKit
 import BitwardenShared
 import UIKit
 

Bitwarden/Application/Services/ErrorReporter/CrashlyticsErrorReporter.swift

@@ -6,6 +6,11 @@ import FirebaseCrashlytics
 /// An `ErrorReporter` that logs non-fatal errors to Crashlytics for investigation.
 ///
 final class CrashlyticsErrorReporter: ErrorReporter {
+    // MARK: Properties
+
+    /// A list of additional loggers that errors will be logged to.
+    private var additionalLoggers: [any BitwardenLogger] = []
+
     // MARK: ErrorReporter Properties
 
     var isEnabled: Bool {
@@ -25,7 +30,16 @@ final class CrashlyticsErrorReporter: ErrorReporter {
 
     // MARK: ErrorReporter
 
+    public func add(logger: any BitwardenLogger) {
+        additionalLoggers.append(logger)
+    }
+
     func log(error: Error) {
+        let callStack = Thread.callStackSymbols.joined(separator: "\n")
+        for logger in additionalLoggers {
+            logger.log("Error: \(error)\n\(callStack)")
+        }
+
         // Don't log networking related errors to Crashlytics.
         guard !error.isNetworkingError else { return }
 

BitwardenActionExtension/ActionViewController.swift

@@ -1,3 +1,4 @@
+import BitwardenKit
 import BitwardenShared
 import MobileCoreServices
 import UIKit

BitwardenAutoFillExtension/CredentialProviderViewController.swift

@@ -1,4 +1,5 @@
 import AuthenticationServices
+import BitwardenKit
 import BitwardenSdk
 import BitwardenShared
 import Combine

BitwardenKit/Core/Platform/Services/ErrorReporter/ErrorReporter.swift

@@ -8,6 +8,12 @@ public protocol ErrorReporter: AnyObject {
 
     // MARK: Methods
 
+    /// Add an additional logger that will any errors will be logged to.
+    ///
+    /// - Parameter logger: The additional logger that any errors will be logged to.
+    ///
+    func add(logger: BitwardenLogger)
+
     /// Logs an error to be reported.
     ///
     /// - Parameter error: The error to log.

BitwardenKit/Core/Platform/Services/ErrorReporter/Mocks/MockErrorReporter.swift

@@ -1,13 +1,18 @@
 @testable import BitwardenKit
 
 public class MockErrorReporter: ErrorReporter {
+    public var additionalLoggers = [any BitwardenLogger]()
     public var currentUserId: String?
     public var errors = [Error]()
     public var isEnabled = false
     public var region: (region: String, isPreAuth: Bool)?
 
     public init() {}
 
+    public func add(logger: any BitwardenLogger) {
+        additionalLoggers.append(logger)
+    }
+
     public func log(error: Error) {
         errors.append(error)
     }

BitwardenKit/Core/Platform/Utilities/BitwardenLogger.swift

@@ -0,0 +1,25 @@
+/// A protocol for an object that handles logging app messages.
+///
+public protocol BitwardenLogger {
+    /// Logs a message.
+    ///
+    /// - Parameters:
+    ///   - message: The message to log.
+    ///   - file: The file that called the log method.
+    ///   - line: The line number in the file that called the log method.
+    ///
+    func log(_ message: String, file: String, line: UInt)
+}
+
+public extension BitwardenLogger {
+    /// Logs a message.
+    ///
+    /// - Parameters:
+    ///   - message: The message to log.
+    ///   - file: The file that called the log method.
+    ///   - line: The line number in the file that called the log method.
+    ///
+    func log(_ message: String, file: String = #file, line: UInt = #line) {
+        log(message, file: file, line: line)
+    }
+}

AuthenticatorShared/Core/Platform/Utilities/OSLogErrorReporter.swift renamed to BitwardenKit/Core/Platform/Utilities/OSLogErrorReporter.swift

@@ -1,11 +1,13 @@
-import BitwardenKit
 import OSLog
 
 /// An `ErrorReporter` that logs non-fatal errors to the console via OSLog.
 ///
 public final class OSLogErrorReporter: ErrorReporter {
     // MARK: Properties
 
+    /// A list of additional loggers that errors will be logged to.
+    private var additionalLoggers: [any BitwardenLogger] = []
+
     /// The logger instance to log local messages.
     let logger = Logger(subsystem: Bundle.main.bundleIdentifier!, category: "ErrorReporter")
 
@@ -21,9 +23,18 @@ public final class OSLogErrorReporter: ErrorReporter {
 
     // MARK: ErrorReporter
 
+    public func add(logger: any BitwardenLogger) {
+        additionalLoggers.append(logger)
+    }
+
     public func log(error: Error) {
         logger.error("Error: \(error)")
 
+        let callStack = Thread.callStackSymbols.joined(separator: "\n")
+        for logger in additionalLoggers {
+            logger.log("Error: \(error as NSError)\n\(callStack)")
+        }
+
         // Don't crash for networking related errors.
         guard !error.isNetworkingError else { return }
 

BitwardenShareExtension/ShareViewController.swift

@@ -1,3 +1,4 @@
+import BitwardenKit
 import BitwardenShared
 import Social
 import UIKit

BitwardenShared/Core/Platform/Services/FlightRecorder.swift

@@ -424,3 +424,13 @@ extension DefaultFlightRecorder: FlightRecorder {
         }
     }
 }
+
+// MARK: DefaultFlightRecorder + BitwardenLogger
+
+extension DefaultFlightRecorder: BitwardenLogger {
+    nonisolated func log(_ message: String, file: String, line: UInt) {
+        Task {
+            await log(message, file: file, line: line)
+        }
+    }
+}

BitwardenShared/Core/Platform/Services/FlightRecorderTests.swift

@@ -598,4 +598,18 @@ class FlightRecorderTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         await subject.log("Hello world!")
         XCTAssertNil(stateService.flightRecorderData)
     }
+
+    // MARK: DefaultFlightRecorder Tests
+
+    /// `DefaultFlightRecorder` implements `BitwardenLogger.log()` which logs to the active log.
+    func test_log_bitwardenLogger() throws {
+        stateService.flightRecorderData = FlightRecorderData(activeLog: activeLog)
+
+        (subject as? DefaultFlightRecorder)?.log("Hello world!")
+        waitFor { self.fileManager.appendDataData != nil }
+
+        let appendedMessage = try String(data: XCTUnwrap(fileManager.appendDataData), encoding: .utf8)
+        XCTAssertEqual(appendedMessage, "2025-01-01T00:00:00Z: Hello world!\n")
+        XCTAssertEqual(stateService.flightRecorderData, FlightRecorderData(activeLog: activeLog))
+    }
 }

BitwardenShared/Core/Platform/Services/ServiceContainer.swift

@@ -398,6 +398,7 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
             stateService: stateService,
             timeProvider: timeProvider
         )
+        errorReporter.add(logger: flightRecorder)
 
         let rehydrationHelper = DefaultRehydrationHelper(
             errorReporter: errorReporter,