Repository Public License
1// ORIX Alarm2// File: Packages/AlarmCore/Tests/AlarmCoreTests/SleepPlannerTests.swift3// Description: Tests of the sleep-planner arithmetic: midnight wrap-around, noon rollover of the evening, reminders, weekly consistency.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import XCTest8@testable import AlarmCore910final class SleepPlannerTests: XCTestCase {11 private let calendar: Calendar = {12 var c = Calendar(identifier: .gregorian)13 c.timeZone = TimeZone(identifier: "America/Toronto")!14 return c15 }()1617 private func date(_ y: Int, _ mo: Int, _ d: Int, _ h: Int, _ mi: Int) -> Date {18 calendar.date(from: DateComponents(year: y, month: mo, day: d, hour: h, minute: mi))!19 }2021 func testMinutesAcrossMidnight() {22 XCTAssertEqual(SleepPlanner.minutes(from: .init(hour: 23, minute: 0), to: .init(hour: 7, minute: 0)), 480)23 XCTAssertEqual(SleepPlanner.minutes(from: .init(hour: 1, minute: 30), to: .init(hour: 9, minute: 0)), 450)24 XCTAssertEqual(SleepPlanner.minutes(from: .init(hour: 7, minute: 0), to: .init(hour: 7, minute: 0)), 0)25 XCTAssertEqual(SleepPlanner.minutes(from: .init(hour: 7, minute: 1), to: .init(hour: 7, minute: 0)), 1439)26 // Agrees with the model's own definition.27 let plan = SleepPlan(bedtime: .init(hour: 22, minute: 45), wakeTime: .init(hour: 6, minute: 15))28 XCTAssertEqual(SleepPlanner.minutes(from: plan.bedtime, to: plan.wakeTime), plan.opportunityMinutes)29 }3031 func testSuggestedBedtimeWrapsAroundMidnight() {32 XCTAssertEqual(SleepPlanner.suggestedBedtime(wake: .init(hour: 6, minute: 30), desiredMinutes: 480), ClockTime(hour: 22, minute: 30))33 XCTAssertEqual(SleepPlanner.suggestedBedtime(wake: .init(hour: 9, minute: 0), desiredMinutes: 450), ClockTime(hour: 1, minute: 30))34 XCTAssertEqual(SleepPlanner.suggestedBedtime(wake: .init(hour: 8, minute: 0), desiredMinutes: 480), ClockTime(hour: 0, minute: 0))35 XCTAssertEqual(SleepPlanner.suggestedBedtime(wake: .init(hour: 0, minute: 10), desiredMinutes: 30), ClockTime(hour: 23, minute: 40))36 }3738 func testSuggestedBedtimeDate() {39 let wake = date(2026, 11, 22, 6, 30)40 XCTAssertEqual(SleepPlanner.suggestedBedtimeDate(wakeDate: wake, desiredMinutes: 480), date(2026, 11, 21, 22, 30))41 }4243 func testWindDownStartWrapsAroundMidnight() {44 XCTAssertEqual(SleepPlanner.windDownStart(bedtime: .init(hour: 23, minute: 0), windDownMinutes: 30), ClockTime(hour: 22, minute: 30))45 XCTAssertEqual(SleepPlanner.windDownStart(bedtime: .init(hour: 0, minute: 15), windDownMinutes: 45), ClockTime(hour: 23, minute: 30))46 XCTAssertEqual(SleepPlanner.windDownStart(bedtime: .init(hour: 22, minute: 0), windDownMinutes: 0), ClockTime(hour: 22, minute: 0))47 XCTAssertEqual(SleepPlanner.windDownStart(bedtime: .init(hour: 22, minute: 0), windDownMinutes: -5), ClockTime(hour: 22, minute: 0))48 }4950 func testSignedDifferenceTakesTheShortestWay() {51 XCTAssertEqual(SleepPlanner.signedDifference(minute: 430, from: 420), 10)52 XCTAssertEqual(SleepPlanner.signedDifference(minute: 410, from: 420), -10)53 XCTAssertEqual(SleepPlanner.signedDifference(minute: 5, from: 1435), 10) // 00:05 vs 23:5554 XCTAssertEqual(SleepPlanner.signedDifference(minute: 1435, from: 5), -10)55 XCTAssertEqual(SleepPlanner.signedDifference(minute: 720, from: 0), -720)56 }5758 func testSnapping() {59 XCTAssertEqual(SleepPlanner.snapped(minute: 1438, step: 5), 0) // rounds up through midnight60 XCTAssertEqual(SleepPlanner.snapped(minute: 422, step: 5), 420)61 XCTAssertEqual(SleepPlanner.snapped(minute: 423, step: 5), 425)62 XCTAssertEqual(SleepPlanner.snapped(minute: -10, step: 15), 1425)63 XCTAssertEqual(SleepPlanner.snapped(minute: 61, step: 1), 61)64 }6566 func testEveningDayKeyRollsOverAtNoon() {67 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 21, 21, 0), calendar: calendar), "2026-11-21")68 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 21, 23, 59), calendar: calendar), "2026-11-21")69 // After midnight it is still the same evening.70 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 22, 0, 30), calendar: calendar), "2026-11-21")71 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 22, 11, 59), calendar: calendar), "2026-11-21")72 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 22, 12, 0), calendar: calendar), "2026-11-22")73 // Month and year boundaries.74 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 12, 1, 1, 0), calendar: calendar), "2026-11-30")75 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2027, 1, 1, 2, 0), calendar: calendar), "2026-12-31")76 }7778 func testEveningDayKeyAcrossDaylightSavingChange() {79 // Clocks go back on 2026-11-01 in Toronto: the early morning still belongs to the previous evening.80 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 1, 1, 30), calendar: calendar), "2026-10-31")81 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 11, 1, 13, 0), calendar: calendar), "2026-11-01")82 // Clocks go forward on 2026-03-08.83 XCTAssertEqual(SleepPlanner.eveningDayKey(for: date(2026, 3, 8, 3, 30), calendar: calendar), "2026-03-07")84 }8586 func testCheckedItemsResetWhenTheEveningChanges() {87 let routine = SleepPlan.defaultRoutine88 let checked: Set<UUID> = [routine[0].id, routine[2].id, UUID()] // one stale identifier89 XCTAssertEqual(SleepPlanner.checkedItems(storedDay: "2026-11-21", stored: checked, key: "2026-11-21", routine: routine), [routine[0].id, routine[2].id])90 XCTAssertEqual(SleepPlanner.checkedItems(storedDay: "2026-11-20", stored: checked, key: "2026-11-21", routine: routine), [])91 XCTAssertEqual(SleepPlanner.checkedItems(storedDay: "", stored: checked, key: "2026-11-21", routine: routine), [])92 }9394 func testRemindersFollowThePlan() {95 var plan = SleepPlan(isEnabled: true, bedtime: .init(hour: 0, minute: 10), wakeTime: .init(hour: 8, minute: 0), windDownMinutes: 30, remindersEnabled: true)96 let both = SleepPlanner.reminders(for: plan)97 XCTAssertEqual(both.map(\.kind), [.windDown, .bedtime])98 XCTAssertEqual(both.map(\.time), [ClockTime(hour: 23, minute: 40), ClockTime(hour: 0, minute: 10)])99 XCTAssertEqual(both.map(\.id), ["sleep.windDown", "sleep.bedtime"])100 plan.windDownMinutes = 0101 XCTAssertEqual(SleepPlanner.reminders(for: plan).map(\.kind), [.bedtime])102 plan.remindersEnabled = false103 XCTAssertTrue(SleepPlanner.reminders(for: plan).isEmpty)104 plan.remindersEnabled = true; plan.isEnabled = false105 XCTAssertTrue(SleepPlanner.reminders(for: plan).isEmpty)106 }107108 func testNextReminderDatesAcrossMidnight() {109 let plan = SleepPlan(isEnabled: true, bedtime: .init(hour: 0, minute: 10), wakeTime: .init(hour: 8, minute: 0), windDownMinutes: 30, remindersEnabled: true)110 // At 22:00 the wind-down (23:40) comes tonight and bedtime (00:10) just after midnight.111 var next = SleepPlanner.nextReminderDates(for: plan, after: date(2026, 11, 21, 22, 0), calendar: calendar)112 XCTAssertEqual(next.map(\.reminder.kind), [.windDown, .bedtime])113 XCTAssertEqual(next.map(\.date), [date(2026, 11, 21, 23, 40), date(2026, 11, 22, 0, 10)])114 // At 23:50 the wind-down has passed: bedtime comes first, the wind-down tomorrow night.115 next = SleepPlanner.nextReminderDates(for: plan, after: date(2026, 11, 21, 23, 50), calendar: calendar)116 XCTAssertEqual(next.map(\.reminder.kind), [.bedtime, .windDown])117 XCTAssertEqual(next.map(\.date), [date(2026, 11, 22, 0, 10), date(2026, 11, 22, 23, 40)])118 // Exactly at the reminder time, the next one is tomorrow.119 next = SleepPlanner.nextReminderDates(for: plan, after: date(2026, 11, 22, 0, 10), calendar: calendar)120 XCTAssertEqual(next.first?.date, date(2026, 11, 22, 23, 40))121 XCTAssertEqual(next.last?.date, date(2026, 11, 23, 0, 10))122 XCTAssertTrue(SleepPlanner.nextReminderDates(for: SleepPlan(), after: date(2026, 11, 21, 22, 0), calendar: calendar).isEmpty)123 }124125 func testWeeklyConsistencySeries() {126 let alarm = UUID()127 let now = date(2026, 11, 21, 15, 0)128 let events: [WakeEvent] = [129 .init(alarmID: alarm, occurrenceID: UUID(), kind: .wakeConfirmed, date: date(2026, 11, 21, 7, 12)),130 .init(alarmID: alarm, occurrenceID: UUID(), kind: .wakeConfirmed, date: date(2026, 11, 21, 9, 0)), // later the same day: ignored131 .init(alarmID: alarm, occurrenceID: UUID(), kind: .wakeConfirmed, date: date(2026, 11, 19, 6, 50)),132 .init(alarmID: alarm, occurrenceID: UUID(), kind: .acknowledged, date: date(2026, 11, 18, 7, 0)), // a dismissal is not a confirmation133 .init(alarmID: alarm, occurrenceID: UUID(), kind: .wakeConfirmed, date: date(2026, 11, 14, 7, 0)), // outside the window134 .init(alarmID: alarm, occurrenceID: UUID(), kind: .wakeConfirmed, date: date(2026, 11, 21, 18, 0)), // in the future135 ]136 let series = SleepPlanner.weeklyConsistency(events: events, plannedWake: .init(hour: 7, minute: 0), now: now, calendar: calendar)137 XCTAssertEqual(series.count, 7)138 XCTAssertEqual(series.first?.day, date(2026, 11, 15, 0, 0))139 XCTAssertEqual(series.last?.day, date(2026, 11, 21, 0, 0))140 XCTAssertEqual(series.map(\.confirmedMinute), [nil, nil, nil, nil, 410, nil, 432])141 XCTAssertEqual(series.map(\.deviationMinutes), [nil, nil, nil, nil, -10, nil, 12])142 XCTAssertTrue(series.allSatisfy { $0.plannedMinute == 420 })143144 let summary = SleepPlanner.summarize(series, toleranceMinutes: 10)145 XCTAssertEqual(summary.recordedDays, 2)146 XCTAssertEqual(summary.averageAbsoluteDeviation, 11)147 XCTAssertEqual(summary.daysWithinTolerance, 1)148 XCTAssertNil(SleepPlanner.summarize([]).averageAbsoluteDeviation)149 }150151 func testConsistencyDeviationAroundMidnight() {152 // Planned wake at 00:10 (night shift), confirmed at 23:55 the same calendar day: 15 minutes early, not 23 h 45 late.153 let day = SleepPlanner.ConsistencyDay(day: date(2026, 11, 21, 0, 0), plannedMinute: 10, confirmedMinute: 1435)154 XCTAssertEqual(day.deviationMinutes, -15)155 }156}157