SPB Git

Repository Public License

PersistenceAnalyticsTests.swift 16.3 KB 221 lines swift

1// ORIX Alarm2// File: Packages/AlarmCore/Tests/AlarmCoreTests/PersistenceAnalyticsTests.swift3// Description: Storage (atomic save, backup recovery, corruption, migration, newer schema, export), event deduplication, statistics and adaptive difficulty.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import XCTest8@testable import AlarmCore910final class PersistenceAnalyticsTests: XCTestCase {11    private var dir: URL!12    override func setUp() { dir = FileManager.default.temporaryDirectory.appendingPathComponent("alarmcore-\(UUID().uuidString)") }13    override func tearDown() { try? FileManager.default.removeItem(at: dir) }1415    private func sampleLibrary() -> Library {16        var lib = Library()17        lib.alarms = ScenarioTemplates.all.map { $0.makeAlarm(now: Date(timeIntervalSince1970: 1_800_000_000)) }18        lib.alarms[0].scenario.progressive.curve = .custom([0, 0.2, 0.9, 1])19        lib.qrTags = [QRTag(label: "Salle de bain", payloadDigest: StableID.digest(of: "x"), createdAt: Date(timeIntervalSince1970: 1_800_000_000))]20        lib.savedScenarios = [SavedScenario(name: "Mine", scenario: lib.alarms[1].scenario)]21        lib.settings.clockStyle = .chronograph; lib.settings.use24HourClock = true22        return lib23    }2425    func testRoundTripAndEmpty() throws {26        let store = JSONFileStore<Library>(directory: dir, name: "library", schemaVersion: 1)27        XCTAssertEqual(store.load(default: Library()).outcome, .empty)28        let lib = sampleLibrary()29        try store.save(lib)30        let loaded = store.load(default: Library())31        XCTAssertEqual(loaded.outcome, .loaded); XCTAssertEqual(loaded.value, lib)32    }3334    func testCorruptMainFileRecoversFromBackup() throws {35        let store = JSONFileStore<Library>(directory: dir, name: "library", schemaVersion: 1)36        var lib = sampleLibrary()37        try store.save(lib)                      // v138        lib.settings.hapticsEnabled = false39        try store.save(lib)                      // v2 (backup now holds v1)40        try Data("{ truncated".utf8).write(to: store.fileURL)41        let recovered = store.load(default: Library())42        XCTAssertEqual(recovered.outcome, .recoveredFromBackup)43        XCTAssertEqual(recovered.value.alarms, lib.alarms); XCTAssertTrue(recovered.value.settings.hapticsEnabled, "backup is the previous good save")44        XCTAssertEqual(store.load(default: Library()).outcome, .loaded, "the recovered copy is written back")45        let quarantined = try FileManager.default.contentsOfDirectory(atPath: dir.path).filter { $0.contains("corrupt") }46        XCTAssertEqual(quarantined.count, 1, "the damaged file is kept aside, not destroyed")47    }4849    func testCorruptFileNeverOverwritesGoodBackup() throws {50        let store = JSONFileStore<Library>(directory: dir, name: "library", schemaVersion: 1)51        let lib = sampleLibrary()52        try store.save(lib); try store.save(lib)53        try Data("garbage".utf8).write(to: store.fileURL)54        try store.save(Library())               // saving over a corrupt main file must not replace the backup with garbage55        try Data("garbage again".utf8).write(to: store.fileURL)56        XCTAssertEqual(store.load(default: Library()).value.alarms, lib.alarms)57    }5859    func testBothCorruptResetsToDefault() throws {60        let store = JSONFileStore<Library>(directory: dir, name: "library", schemaVersion: 1)61        try FileManager.default.createDirectory(at: dir, withIntermediateDirectories: true)62        try Data("x".utf8).write(to: store.fileURL); try Data("y".utf8).write(to: store.backupURL)63        let r = store.load(default: Library())64        XCTAssertEqual(r.outcome, .resetAfterCorruption); XCTAssertEqual(r.value, Library())65    }6667    func testMigrationFromOlderSchema() throws {68        struct V2: Codable, Sendable, Equatable { var title: String; var count: Int }69        try FileManager.default.createDirectory(at: dir, withIntermediateDirectories: true)70        try Data(#"{"schemaVersion":1,"payload":{"name":"old"}}"#.utf8).write(to: dir.appendingPathComponent("thing.json"))71        let store = JSONFileStore<V2>(directory: dir, name: "thing", schemaVersion: 2) { from, payload in72            XCTAssertEqual(from, 1)73            let old = try JSONSerialization.jsonObject(with: payload) as! [String: Any]74            return try JSONSerialization.data(withJSONObject: ["title": old["name"]!, "count": 0])75        }76        let r = store.load(default: V2(title: "", count: -1))77        XCTAssertEqual(r.outcome, .loaded); XCTAssertEqual(r.value, V2(title: "old", count: 0))78    }7980    func testNewerSchemaIsNotReadAsCurrent() throws {81        try FileManager.default.createDirectory(at: dir, withIntermediateDirectories: true)82        try Data(#"{"schemaVersion":99,"payload":{}}"#.utf8).write(to: dir.appendingPathComponent("library.json"))83        let store = JSONFileStore<Library>(directory: dir, name: "library", schemaVersion: 1)84        XCTAssertEqual(store.load(default: Library()).outcome, .resetAfterCorruption)85        XCTAssertTrue(try FileManager.default.contentsOfDirectory(atPath: dir.path).contains { $0.contains("corrupt") }, "the newer file is preserved")86    }8788    func testExportImportRoundTripAndRejectsForeignFiles() throws {89        let archive = ExportArchive(exportedAt: Date(timeIntervalSince1970: 1_800_000_000), library: sampleLibrary(),90                                    history: History(events: [WakeEvent(alarmID: UUID(), occurrenceID: UUID(), kind: .wakeConfirmed, date: Date(timeIntervalSince1970: 1_800_000_100))]))91        XCTAssertEqual(try ExportArchive.decode(archive.encoded()), archive)92        XCTAssertThrowsError(try ExportArchive.decode(Data(#"{"format":"other","version":1}"#.utf8)))93        XCTAssertThrowsError(try ExportArchive.decode(Data("nope".utf8)))94    }9596    func testHistoryDeduplicatesAndCaps() {97        var h = History(); let a = UUID(), o = UUID(); let t = Date(timeIntervalSince1970: 1_800_000_000)98        h.record(WakeEvent(alarmID: a, occurrenceID: o, kind: .fired, date: t))99        h.record(WakeEvent(alarmID: a, occurrenceID: o, kind: .fired, date: t.addingTimeInterval(1)))     // duplicate fact100        h.record(WakeEvent(alarmID: a, occurrenceID: o, kind: .acknowledged, date: t.addingTimeInterval(1)))101        h.record(WakeEvent(alarmID: a, occurrenceID: o, kind: .fired, date: t.addingTimeInterval(600)))   // a later, distinct firing102        XCTAssertEqual(h.events.map(\.kind), [.fired, .acknowledged, .fired])103        for i in 0..<(History.maxEvents + 50) { h.record(WakeEvent(alarmID: a, occurrenceID: UUID(), kind: .snoozed, date: t.addingTimeInterval(Double(i) * 10))) }104        XCTAssertEqual(h.events.count, History.maxEvents)105    }106107    // MARK: Statistics108    private var utc: Calendar { var c = Calendar(identifier: .gregorian); c.timeZone = TimeZone(identifier: "UTC")!; return c }109110    func testStatisticsCountOnlyRecordedFacts() {111        let c = utc; let alarm = UUID()112        let base = c.startOfDay(for: Date(timeIntervalSince1970: 1_800_000_000))113        func at(_ d: Int, _ h: Double) -> Date { base.addingTimeInterval(Double(d) * 86_400 + h * 3600) }114        var events: [WakeEvent] = []115        // Day 0: fired, snoozed twice, stopped, mission completed, confirmed 10 minutes after firing.116        let o0 = UUID()117        events += [.init(alarmID: alarm, occurrenceID: o0, kind: .fired, date: at(0, 7)),118                   .init(alarmID: alarm, occurrenceID: o0, kind: .snoozed, date: at(0, 7.01)), .init(alarmID: alarm, occurrenceID: o0, kind: .snoozed, date: at(0, 7.1)),119                   .init(alarmID: alarm, occurrenceID: o0, kind: .acknowledged, date: at(0, 7.15)),120                   .init(alarmID: alarm, occurrenceID: o0, kind: .missionStepCompleted, date: at(0, 7.16), missionKind: .math, level: 2, duration: 30, mistakes: 0, rounds: 3),121                   .init(alarmID: alarm, occurrenceID: o0, kind: .missionCompleted, date: at(0, 7.16)),122                   .init(alarmID: alarm, occurrenceID: o0, kind: .wakeConfirmed, date: at(0, 7).addingTimeInterval(600))]123        // Day 1: fired and stopped only. Stopping is NOT a wake-up.124        let o1 = UUID()125        events += [.init(alarmID: alarm, occurrenceID: o1, kind: .fired, date: at(1, 7)), .init(alarmID: alarm, occurrenceID: o1, kind: .acknowledged, date: at(1, 7.01))]126        // Day 2: bypassed.127        let o2 = UUID()128        events += [.init(alarmID: alarm, occurrenceID: o2, kind: .fired, date: at(2, 7)), .init(alarmID: alarm, occurrenceID: o2, kind: .missionBypassed, date: at(2, 7.05)),129                   .init(alarmID: alarm, occurrenceID: o2, kind: .missionStepCompleted, date: at(2, 7.04), missionKind: .math, level: 2, duration: 50, mistakes: 2, rounds: 3)]130        let s = WakeStatistics.compute(events: events, from: at(0, 0), to: at(3, 0), calendar: c)131        XCTAssertEqual(s.alarmsFired, 3); XCTAssertEqual(s.acknowledgments, 2); XCTAssertEqual(s.snoozes, 2)132        XCTAssertEqual(s.missionsCompleted, 1); XCTAssertEqual(s.missionsBypassed, 1)133        XCTAssertEqual(s.wakeConfirmations, 1, "only explicit confirmations count as wake-ups")134        XCTAssertEqual(s.averageConfirmationDelay!, 600, accuracy: 0.001)135        XCTAssertEqual(s.days.count, 3); XCTAssertEqual(s.days[0].snoozes, 2); XCTAssertEqual(s.days[0].confirmationMinute, 7 * 60 + 10)136        XCTAssertEqual(s.days[1].confirmed, 0); XCTAssertNil(s.days[1].confirmationDelay)137        XCTAssertEqual(s.missions.count, 1); XCTAssertEqual(s.missions[0].completions, 2)138        XCTAssertEqual(s.missions[0].averageDuration, 40, accuracy: 0.001); XCTAssertEqual(s.missions[0].bestDuration, 30); XCTAssertEqual(s.missions[0].cleanRate, 0.5)139        XCTAssertEqual(s.accuracy, 0.5); XCTAssertNil(s.consistencyMinutes, "needs three confirmed days")140    }141142    func testStreaksAndConsistencyAndEmpty() {143        let c = utc; let a = UUID(); let base = c.startOfDay(for: Date(timeIntervalSince1970: 1_800_000_000))144        func confirm(_ d: Int, _ minute: Double) -> WakeEvent { .init(alarmID: a, occurrenceID: UUID(), kind: .wakeConfirmed, date: base.addingTimeInterval(Double(d) * 86_400 + minute * 60)) }145        let events = [confirm(0, 420), confirm(1, 430), confirm(2, 410), confirm(4, 420), confirm(5, 420)]146        let endOfDay5 = base.addingTimeInterval(5 * 86_400 + 12 * 3600)147        let s = WakeStatistics.compute(events: events, from: base, to: endOfDay5, calendar: c)148        XCTAssertEqual(s.longestStreak, 3); XCTAssertEqual(s.currentStreak, 2)149        XCTAssertEqual(s.consistencyMinutes!, 6.32, accuracy: 0.01)150        // A streak survives until the end of the following day.151        let nextMorning = WakeStatistics.compute(events: events, from: base, to: base.addingTimeInterval(6 * 86_400 + 3600), calendar: c)152        XCTAssertEqual(nextMorning.currentStreak, 2)153        let twoDaysLater = WakeStatistics.compute(events: events, from: base, to: base.addingTimeInterval(7 * 86_400 + 3600), calendar: c)154        XCTAssertEqual(twoDaysLater.currentStreak, 0)155        let empty = WakeStatistics.recent(events: [], days: 7, now: endOfDay5, calendar: c)156        XCTAssertEqual(empty.days.count, 7); XCTAssertEqual(empty.alarmsFired, 0); XCTAssertNil(empty.accuracy); XCTAssertNil(empty.averageConfirmationDelay); XCTAssertEqual(empty.currentStreak, 0)157    }158159    // MARK: Adaptive difficulty160    private func steps(_ kind: MissionKind, level: Int, perRound: Double, mistakes: Int, count: Int) -> [WakeEvent] {161        (0..<count).map { i in WakeEvent(alarmID: UUID(), occurrenceID: UUID(), kind: .missionStepCompleted, date: Date(timeIntervalSince1970: 1_800_000_000 + Double(i) * 86_400),162                                          missionKind: kind, level: level, duration: perRound * 3, mistakes: mistakes, rounds: 3) }163    }164165    func testAdaptiveLevels() {166        XCTAssertEqual(AdaptiveEngine.explain(kind: .math, history: []), .init(level: 2, sampleCount: 0, reason: .notEnoughData))167        XCTAssertEqual(AdaptiveEngine.explain(kind: .math, history: steps(.math, level: 2, perRound: 4, mistakes: 0, count: 5)).level, 3)168        XCTAssertEqual(AdaptiveEngine.explain(kind: .math, history: steps(.math, level: 4, perRound: 4, mistakes: 0, count: 5)).level, 4, "capped at expert")169        XCTAssertEqual(AdaptiveEngine.explain(kind: .math, history: steps(.math, level: 3, perRound: 30, mistakes: 1, count: 5)).level, 2)170        XCTAssertEqual(AdaptiveEngine.explain(kind: .math, history: steps(.math, level: 1, perRound: 30, mistakes: 4, count: 5)).level, 1, "floored at easy")171        XCTAssertEqual(AdaptiveEngine.explain(kind: .math, history: steps(.math, level: 3, perRound: 12, mistakes: 1, count: 5)).reason, .steady)172        XCTAssertEqual(AdaptiveEngine.explain(kind: .maze, history: steps(.math, level: 2, perRound: 4, mistakes: 0, count: 5)).reason, .notEnoughData, "other missions do not count")173    }174175    func testResolveUsesFixedLevelSnoozeEscalationAndDistinctSeeds() {176        let fixed = MissionStep(kind: .math, difficulty: .hard), adaptive = MissionStep(kind: .maze, difficulty: .adaptive)177        let escalating = SnoozePolicy(escalatesDifficulty: true)178        XCTAssertEqual(AdaptiveEngine.resolveLevel(for: fixed, history: [], snoozesUsed: 0, policy: escalating), 3)179        XCTAssertEqual(AdaptiveEngine.resolveLevel(for: fixed, history: [], snoozesUsed: 1, policy: escalating), 4)180        XCTAssertEqual(AdaptiveEngine.resolveLevel(for: fixed, history: [], snoozesUsed: 5, policy: escalating), 4)181        XCTAssertEqual(AdaptiveEngine.resolveLevel(for: fixed, history: [], snoozesUsed: 5, policy: SnoozePolicy()), 3)182        XCTAssertEqual(AdaptiveEngine.resolveLevel(for: adaptive, history: [], snoozesUsed: 0, policy: SnoozePolicy()), 2)183        let resolved = AdaptiveEngine.resolve([fixed, adaptive, fixed], history: [], snoozesUsed: 0, policy: SnoozePolicy(), seed: 7)184        XCTAssertEqual(resolved.map(\.level), [3, 2, 3]); XCTAssertEqual(Set(resolved.map(\.seed)).count, 3)185        XCTAssertEqual(resolved, AdaptiveEngine.resolve([fixed, adaptive, fixed], history: [], snoozesUsed: 0, policy: SnoozePolicy(), seed: 7))186    }187188    func testSuggestions() {189        var alarm = AlarmDefinition(time: .init(hour: 7, minute: 0)); alarm.scenario.missions = [MissionStep(kind: .math, difficulty: .normal)]190        let now = Date(timeIntervalSince1970: 1_800_000_000 + 6 * 86_400)191        var history = steps(.math, level: 2, perRound: 4, mistakes: 0, count: 5)192        for i in 0..<5 {193            let o = UUID(); let t = Date(timeIntervalSince1970: 1_800_000_000 + Double(i) * 86_400)194            history.append(.init(alarmID: alarm.id, occurrenceID: o, kind: .fired, date: t))195            for k in 0..<3 { history.append(.init(alarmID: alarm.id, occurrenceID: o, kind: .snoozed, date: t.addingTimeInterval(Double(k) * 300 + 10))) }196        }197        let s = AdaptiveEngine.suggestions(alarms: [alarm], history: history, now: now)198        XCTAssertTrue(s.contains(.raiseDifficulty(.math)))199        XCTAssertTrue(s.contains { if case .reduceSnoozes(let id, let avg) = $0 { return id == alarm.id && abs(avg - 3) < 0.001 }; return false })200        XCTAssertTrue(AdaptiveEngine.suggestions(alarms: [alarm], history: [], now: now).isEmpty)201    }202203    func testTemplatesAndCatalogs() {204        XCTAssertEqual(ScenarioTemplates.all.count, 8); XCTAssertEqual(Set(ScenarioTemplates.all.map(\.id)).count, 8)205        for t in ScenarioTemplates.all {206            XCTAssertTrue(SoundCatalog.alarmSounds.contains { $0.id == t.soundID }, t.id)207            XCTAssertTrue(SoundCatalog.soundscapes.contains { $0.id == t.scenario.progressive.soundscapeID }, t.id)208            XCTAssertLessThanOrEqual(t.scenario.missions.count, WakeScenario.maxMissionSteps)209            let a = t.makeAlarm(), b = t.makeAlarm()210            XCTAssertEqual(a.scenario.templateID, t.id); XCTAssertNotEqual(a.id, b.id)211            XCTAssertTrue(Set(a.scenario.missions.map(\.id)).isDisjoint(with: b.scenario.missions.map(\.id)))212        }213        XCTAssertEqual(Set(SoundCatalog.alarmSounds.map(\.fileName)).count, SoundCatalog.alarmSounds.count)214        XCTAssertEqual(Set(SoundAsset.Category.allCases), Set(SoundCatalog.alarmSounds.map(\.category)), "every sound category has an alarm sound")215        XCTAssertEqual(SoundCatalog.alarmSound("nope").id, SoundCatalog.defaultAlarmSoundID)216        var g1 = SeededGenerator(seed: 5), g2 = SeededGenerator(seed: 5), g3 = SeededGenerator(seed: 6)217        let a = (0..<8).map { _ in g1.next() }, b = (0..<8).map { _ in g2.next() }, c = (0..<8).map { _ in g3.next() }218        XCTAssertEqual(a, b); XCTAssertNotEqual(a, c)219    }220}221
Files main
Menu

Theme