[PM-19577] Add flight recorder log creation (#1505)

Author: matt-livefront

BitwardenShared/Core/Platform/Extensions/FileManager+Extensions.swift

@@ -30,4 +30,13 @@ extension FileManager {
         )
         .appendingPathComponent("Exports", isDirectory: true)
     }
+
+    /// Returns a URL for the directory containing flight recorder logs.
+    ///
+    /// - Returns: A URL for a directory to store flight recorder logs.
+    ///
+    func flightRecorderLogURL() throws -> URL {
+        containerURL(forSecurityApplicationGroupIdentifier: Bundle.main.groupIdentifier)!
+            .appendingPathComponent("FlightRecorderLogs", isDirectory: true)
+    }
 }

BitwardenShared/Core/Platform/Extensions/URL.swift

@@ -80,4 +80,15 @@ extension URL {
             return components.url
         }
     }
+
+    /// Sets whether the file should be excluded from backups.
+    ///
+    /// - Parameter value: `true` if the file should be excluded from backups, or `false` otherwise.
+    ///
+    func setIsExcludedFromBackup(_ value: Bool) throws {
+        var url = self
+        var values = URLResourceValues()
+        values.isExcludedFromBackup = value
+        try url.setResourceValues(values)
+    }
 }

BitwardenShared/Core/Platform/Extensions/URLTests.swift

@@ -61,4 +61,28 @@ class URLTests: BitwardenTestCase {
 
         try XCTAssertFalse(XCTUnwrap(URL(string: "https://example.com")).isApp)
     }
+
+    /// `setIsExcludedFromBackup(_:)` sets whether the file is excluded from backups.
+    func test_setIsExcludedFromBackup() throws {
+        let fileName = UUID().uuidString
+        let url = try XCTUnwrap(URL(fileURLWithPath: NSTemporaryDirectory())).appendingPathComponent(fileName)
+        try Data().write(to: url)
+
+        try XCTAssertFalse(url.isExcludedFromBackups())
+
+        try url.setIsExcludedFromBackup(true)
+        try XCTAssertTrue(url.isExcludedFromBackups())
+
+        try url.setIsExcludedFromBackup(false)
+        try XCTAssertFalse(url.isExcludedFromBackups())
+
+        try FileManager.default.removeItem(at: url)
+    }
+}
+
+private extension URL {
+    func isExcludedFromBackups() throws -> Bool {
+        let values = try resourceValues(forKeys: [.isExcludedFromBackupKey])
+        return values.isExcludedFromBackup ?? false
+    }
 }

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

@@ -0,0 +1,69 @@
+import Foundation
+
+// MARK: - FlightRecorderData
+
+/// A data model containing the persisted data necessary for the flight recorder. This stores the
+/// metadata for the active and any archived logs.
+///
+struct FlightRecorderData: Codable, Equatable {
+    // MARK: Properties
+
+    /// The current log, if the flight recorder is active.
+    var activeLog: LogMetadata? {
+        didSet {
+            guard let oldValue else { return }
+            archivedLogs.append(oldValue)
+        }
+    }
+
+    /// A list of previously recorded and inactive logs, which remain available on device until they
+    /// are deleted by the user or expire and are deleted by the app.
+    var archivedLogs: [LogMetadata] = []
+
+    // MARK: Computed Properties
+
+    /// The full list of logs containing the active and any archived logs.
+    var allLogs: [LogMetadata] {
+        ([activeLog] + archivedLogs).compactMap { $0 }
+    }
+}
+
+extension FlightRecorderData {
+    /// A data model containing the metadata for a flight recorder log.
+    ///
+    struct LogMetadata: Codable, Equatable, Identifiable {
+        // MARK: Properties
+
+        /// The duration for how long the flight recorder was enabled for the log.
+        let duration: FlightRecorderLoggingDuration
+
+        /// The file name of the file on disk.
+        let fileName: String
+
+        /// The date the logging was started.
+        let startDate: Date
+
+        // MARK: Computed Properties
+
+        var id: String {
+            fileName
+        }
+
+        // MARK: Initialization
+
+        /// Initialize a `LogMetadata`.
+        ///
+        /// - Parameters:
+        ///   - duration: The duration for how long the flight recorder was enabled for the log.
+        ///   - startDate: The date the logging was started.
+        ///
+        init(duration: FlightRecorderLoggingDuration, startDate: Date) {
+            self.duration = duration
+            self.startDate = startDate
+
+            let dateFormatter = DateFormatter()
+            dateFormatter.dateFormat = "yyyy-MM-dd-HH-mm-ss"
+            fileName = "flight_recorder_\(dateFormatter.string(from: startDate)).txt"
+        }
+    }
+}

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

@@ -0,0 +1,88 @@
+import XCTest
+
+@testable import BitwardenShared
+
+class FlightRecorderDataTests: BitwardenTestCase {
+    // MARK: Tests
+
+    /// `allLogs` returns a list of all logs when there are no logs.
+    func test_allLogs_empty() {
+        let subject = FlightRecorderData()
+        XCTAssertEqual(subject.allLogs, [])
+    }
+
+    /// `allLogs` returns a list of all logs when there's active and archived logs.
+    func test_allLogs_activeAndArchivedLogs() {
+        let activeLog = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now)
+        let archivedLogs = [
+            FlightRecorderData.LogMetadata(duration: .oneHour, startDate: .now),
+            FlightRecorderData.LogMetadata(duration: .oneWeek, startDate: .now),
+        ]
+        let subject = FlightRecorderData(activeLog: activeLog, archivedLogs: archivedLogs)
+        XCTAssertEqual(subject.allLogs, [activeLog] + archivedLogs)
+    }
+
+    /// `allLogs` returns a list of all logs when there's an active log.
+    func test_allLogs_activeLog() {
+        let log = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now)
+        let subject = FlightRecorderData(activeLog: log)
+        XCTAssertEqual(subject.allLogs, [log])
+    }
+
+    /// `allLogs` returns a list of all logs when there are archived logs.
+    func test_allLogs_archivedLogs() {
+        let logs = [
+            FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now),
+            FlightRecorderData.LogMetadata(duration: .oneHour, startDate: .now),
+            FlightRecorderData.LogMetadata(duration: .oneWeek, startDate: .now),
+        ]
+        let subject = FlightRecorderData(archivedLogs: logs)
+        XCTAssertEqual(subject.allLogs, logs)
+    }
+
+    /// `activeLog` sets the active log.
+    func test_setActiveLog() {
+        var subject = FlightRecorderData()
+        let log = FlightRecorderData.LogMetadata(duration: .eightHours, startDate: .now)
+        subject.activeLog = log
+
+        XCTAssertEqual(subject, FlightRecorderData(activeLog: log))
+    }
+
+    /// `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)
+        var subject = FlightRecorderData(activeLog: log1)
+
+        let log2 = FlightRecorderData.LogMetadata(duration: .oneWeek, startDate: .now)
+        subject.activeLog = log2
+
+        XCTAssertEqual(subject, FlightRecorderData(activeLog: log2, archivedLogs: [log1]))
+    }
+
+    // MARK: FlightRecorderData.LogMetadata Tests
+
+    /// `id` returns the log's file name as a unique identifier.
+    func test_logMetadata_id() {
+        let log1 = FlightRecorderData.LogMetadata(duration: .oneHour, startDate: .now)
+        XCTAssertEqual(log1.id, log1.fileName)
+
+        let log2 = FlightRecorderData.LogMetadata(duration: .oneWeek, startDate: .now)
+        XCTAssertEqual(log2.id, log2.fileName)
+    }
+
+    /// `init(duration:startDate:)` creates a file name for the log based on the start date.
+    func test_logMetadata_init_fileName() {
+        let log1 = FlightRecorderData.LogMetadata(
+            duration: .oneHour,
+            startDate: Date(year: 2025, month: 4, day: 11, hour: 10, minute: 30, second: 20)
+        )
+        XCTAssertEqual(log1.fileName, "flight_recorder_2025-04-11-10-30-20.txt")
+
+        let log2 = FlightRecorderData.LogMetadata(
+            duration: .oneWeek,
+            startDate: Date(year: 2025, month: 1, day: 2, hour: 3, minute: 4, second: 5)
+        )
+        XCTAssertEqual(log2.fileName, "flight_recorder_2025-01-02-03-04-05.txt")
+    }
+}

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

@@ -2,7 +2,7 @@ import Foundation
 
 /// An enum that represents how long to enable the flight recorder.
 ///
-enum FlightRecorderLoggingDuration: CaseIterable, Menuable {
+enum FlightRecorderLoggingDuration: CaseIterable, Codable, Menuable {
     /// The flight recorder is enabled for one hour.
     case oneHour
 
@@ -23,6 +23,16 @@ enum FlightRecorderLoggingDuration: CaseIterable, Menuable {
         case .oneWeek: Localizations.oneWeek
         }
     }
+
+    /// A short string representation of the duration (e.g. 1h, 8h, 1w).
+    var shortDescription: String {
+        switch self {
+        case .oneHour: "1h"
+        case .eightHours: "8h"
+        case .twentyFourHours: "24h"
+        case .oneWeek: "1w"
+        }
+    }
 }
 
 // MARK: - Calendar + FlightRecorderLoggingDuration

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

@@ -29,4 +29,12 @@ class FlightRecorderLoggingDurationTests: BitwardenTestCase {
         XCTAssertEqual(FlightRecorderLoggingDuration.twentyFourHours.localizedName, Localizations.xHours(24))
         XCTAssertEqual(FlightRecorderLoggingDuration.oneWeek.localizedName, Localizations.oneWeek)
     }
+
+    /// `shortDescription` returns a short string representation of the logging duration.
+    func test_shortDescription() {
+        XCTAssertEqual(FlightRecorderLoggingDuration.oneHour.shortDescription, "1h")
+        XCTAssertEqual(FlightRecorderLoggingDuration.eightHours.shortDescription, "8h")
+        XCTAssertEqual(FlightRecorderLoggingDuration.twentyFourHours.shortDescription, "24h")
+        XCTAssertEqual(FlightRecorderLoggingDuration.oneWeek.shortDescription, "1w")
+    }
 }