Repository Public License
1// ORIX Alarm2// File: Packages/AlarmCore/Tests/AlarmCoreTests/SchedulingTests.swift3// Description: Recurrence across time zones and daylight saving, snooze policy, reconciliation, occurrence state machine and stable identifiers.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import XCTest8@testable import AlarmCore910final class SchedulingTests: XCTestCase {11 private func calendar(_ tz: String) -> Calendar {12 var c = Calendar(identifier: .gregorian); c.timeZone = TimeZone(identifier: tz)!; c.locale = Locale(identifier: "en_CA"); return c13 }14 private func date(_ c: Calendar, _ y: Int, _ mo: Int, _ d: Int, _ h: Int, _ mi: Int) -> Date {15 c.date(from: DateComponents(year: y, month: mo, day: d, hour: h, minute: mi))!16 }17 private func parts(_ c: Calendar, _ d: Date) -> [Int] {18 let p = c.dateComponents([.year, .month, .day, .hour, .minute, .weekday], from: d)19 return [p.year!, p.month!, p.day!, p.hour!, p.minute!, p.weekday!]20 }2122 // MARK: Recurrence23 func testOneTimeLaterTodayAndTomorrow() {24 let c = calendar("America/Toronto")25 let now = date(c, 2026, 11, 21, 6, 0)26 let later = Recurrence.nextFireDate(time: .init(hour: 7, minute: 30), weekdays: [], after: now, calendar: c)!27 XCTAssertEqual(parts(c, later).prefix(5), [2026, 11, 21, 7, 30])28 let tomorrow = Recurrence.nextFireDate(time: .init(hour: 5, minute: 0), weekdays: [], after: now, calendar: c)!29 XCTAssertEqual(parts(c, tomorrow).prefix(5), [2026, 11, 22, 5, 0])30 }3132 func testExactlyNowIsNotReturned() {33 let c = calendar("America/Toronto")34 let now = date(c, 2026, 11, 21, 7, 30)35 let next = Recurrence.nextFireDate(time: .init(hour: 7, minute: 30), weekdays: [], after: now, calendar: c)!36 XCTAssertEqual(parts(c, next).prefix(3), [2026, 11, 22])37 }3839 func testWeeklyPicksNearestSelectedDay() {40 let c = calendar("America/Toronto")41 let saturday = date(c, 2026, 11, 21, 12, 0) // a Saturday42 XCTAssertEqual(c.component(.weekday, from: saturday), 7)43 let next = Recurrence.nextFireDate(time: .init(hour: 6, minute: 30), weekdays: Weekday.weekdays, after: saturday, calendar: c)!44 XCTAssertEqual(parts(c, next), [2026, 11, 23, 6, 30, 2]) // Monday45 let weekend = Recurrence.nextFireDate(time: .init(hour: 9, minute: 0), weekdays: Weekday.weekend, after: saturday, calendar: c)!46 XCTAssertEqual(parts(c, weekend), [2026, 11, 22, 9, 0, 1]) // Sunday47 let sameDayLater = Recurrence.nextFireDate(time: .init(hour: 13, minute: 0), weekdays: [.saturday], after: saturday, calendar: c)!48 XCTAssertEqual(parts(c, sameDayLater).prefix(5), [2026, 11, 21, 13, 0])49 let sameDayEarlier = Recurrence.nextFireDate(time: .init(hour: 8, minute: 0), weekdays: [.saturday], after: saturday, calendar: c)!50 XCTAssertEqual(parts(c, sameDayEarlier).prefix(3), [2026, 11, 28])51 }5253 func testEveryWeekdayAlwaysWithin24Hours() {54 let c = calendar("Europe/Paris")55 var now = date(c, 2026, 1, 1, 0, 0)56 for _ in 0..<400 {57 let next = Recurrence.nextFireDate(time: .init(hour: 7, minute: 15), weekdays: Weekday.everyDay, after: now, calendar: c)!58 XCTAssertGreaterThan(next, now)59 XCTAssertLessThanOrEqual(next.timeIntervalSince(now), 25 * 3600 + 1)60 XCTAssertEqual(parts(c, next)[3...4], [7, 15])61 now = next62 }63 }6465 func testSpringForwardSkippedTimeFiresAfterGap() {66 let c = calendar("America/Toronto") // 2026-03-08: 02:00 -> 03:0067 let before = date(c, 2026, 3, 7, 12, 0)68 let next = Recurrence.nextFireDate(time: .init(hour: 2, minute: 30), weekdays: [], after: before, calendar: c)!69 XCTAssertEqual(parts(c, next).prefix(4), [2026, 3, 8, 3]) // first valid instant after the gap70 let following = Recurrence.nextFireDate(time: .init(hour: 2, minute: 30), weekdays: Weekday.everyDay, after: next, calendar: c)!71 XCTAssertEqual(parts(c, following).prefix(5), [2026, 3, 9, 2, 30])72 }7374 func testFallBackRepeatedTimeFiresOnce() {75 let c = calendar("America/Toronto") // 2026-11-01: 02:00 -> 01:0076 let before = date(c, 2026, 10, 31, 12, 0)77 let first = Recurrence.nextFireDate(time: .init(hour: 1, minute: 30), weekdays: Weekday.everyDay, after: before, calendar: c)!78 XCTAssertEqual(parts(c, first).prefix(5), [2026, 11, 1, 1, 30])79 let second = Recurrence.nextFireDate(time: .init(hour: 1, minute: 30), weekdays: Weekday.everyDay, after: first, calendar: c)!80 XCTAssertEqual(parts(c, second).prefix(5), [2026, 11, 2, 1, 30], "the repeated 01:30 must not fire twice")81 }8283 func testWallClockFollowsTimeZone() {84 let toronto = calendar("America/Toronto"), tokyo = calendar("Asia/Tokyo")85 let now = date(toronto, 2026, 11, 21, 12, 0)86 let a = Recurrence.nextFireDate(time: .init(hour: 7, minute: 0), weekdays: [], after: now, calendar: toronto)!87 let b = Recurrence.nextFireDate(time: .init(hour: 7, minute: 0), weekdays: [], after: now, calendar: tokyo)!88 XCTAssertEqual(parts(toronto, a)[3], 7); XCTAssertEqual(parts(tokyo, b)[3], 7)89 XCTAssertNotEqual(a, b)90 }9192 func testDisabledAlarmHasNoFireDateAndNextAlarmPicksSoonest() {93 let c = calendar("America/Toronto"); let now = date(c, 2026, 11, 21, 6, 0)94 var off = AlarmDefinition(time: .init(hour: 6, minute: 5)); off.isEnabled = false95 let early = AlarmDefinition(time: .init(hour: 6, minute: 45)), late = AlarmDefinition(time: .init(hour: 9, minute: 0))96 XCTAssertNil(Recurrence.nextFireDate(for: off, after: now, calendar: c))97 XCTAssertEqual(Recurrence.nextAlarm(in: [late, off, early], after: now, calendar: c)?.alarm.id, early.id)98 XCTAssertNil(Recurrence.nextAlarm(in: [off], after: now, calendar: c))99 }100101 func testUpcomingAndPrevious() {102 let c = calendar("America/Toronto"); let now = date(c, 2026, 11, 21, 6, 0)103 let weekly = AlarmDefinition(time: .init(hour: 7, minute: 0), weekdays: [.monday, .thursday])104 let up = Recurrence.upcoming(for: weekly, after: now, count: 4, calendar: c)105 XCTAssertEqual(up.count, 4); XCTAssertEqual(up, up.sorted())106 XCTAssertEqual(up.map { parts(c, $0)[5] }, [2, 5, 2, 5])107 XCTAssertEqual(Recurrence.upcoming(for: AlarmDefinition(time: .init(hour: 7, minute: 0)), after: now, count: 4, calendar: c).count, 1)108 let prev = Recurrence.previousFireDate(time: .init(hour: 7, minute: 0), weekdays: [.monday, .thursday], before: now, calendar: c)!109 XCTAssertEqual(parts(c, prev), [2026, 11, 19, 7, 0, 5])110 }111112 func testValidation() {113 let c = calendar("America/Toronto"); let now = date(c, 2026, 11, 21, 6, 0)114 var a = AlarmDefinition(time: .init(hour: 7, minute: 0))115 XCTAssertEqual(Recurrence.validate(a, qrTags: [], now: now, calendar: c), [])116 a.scenario.missions = [MissionStep(kind: .qrEscape)]117 XCTAssertEqual(Recurrence.validate(a, qrTags: [], now: now, calendar: c), [.qrTagMissing])118 let tag = QRTag(label: "Kitchen", payloadDigest: "x")119 a.scenario.missions[0].qrTagID = tag.id120 XCTAssertEqual(Recurrence.validate(a, qrTags: [tag], now: now, calendar: c), [])121 a.scenario.missions = (0..<8).map { _ in MissionStep(kind: .math) }122 XCTAssertEqual(Recurrence.validate(a, qrTags: [], now: now, calendar: c), [.tooManyMissionSteps])123 }124125 func testClockTimeClampsAndWraps() {126 XCTAssertEqual(ClockTime(hour: 30, minute: -4), ClockTime(hour: 23, minute: 0))127 XCTAssertEqual(ClockTime(hour: 23, minute: 50).adding(minutes: 20), ClockTime(hour: 0, minute: 10))128 XCTAssertEqual(ClockTime(hour: 0, minute: 10).adding(minutes: -30), ClockTime(hour: 23, minute: 40))129 XCTAssertEqual(Weekday.ordered(firstWeekday: 2).first, .monday); XCTAssertEqual(Weekday.ordered(firstWeekday: 2).last, .sunday)130 }131132 // MARK: Snooze133 func testSnoozePolicy() {134 let fixed = SnoozePolicy(mode: .fixed, baseMinutes: 9, maxCount: 3)135 XCTAssertEqual((1...4).map { fixed.duration(forSnooze: $0) }, [540, 540, 540, nil])136 XCTAssertNil(fixed.duration(forSnooze: 0))137 let decreasing = SnoozePolicy(mode: .decreasing, baseMinutes: 9, maxCount: 5)138 let d = (1...5).compactMap { decreasing.duration(forSnooze: $0) }139 XCTAssertEqual(d, [540, 360, 240, 180, 120])140 XCTAssertEqual(d, d.sorted(by: >))141 XCTAssertGreaterThanOrEqual(SnoozePolicy(mode: .decreasing, baseMinutes: 1, maxCount: 10).duration(forSnooze: 10)!, 60)142 XCTAssertNil(SnoozePolicy.none.duration(forSnooze: 1))143 XCTAssertEqual(fixed.remaining(afterSnoozes: 2), 1); XCTAssertEqual(fixed.remaining(afterSnoozes: 9), 0); XCTAssertEqual(SnoozePolicy.none.remaining(afterSnoozes: 0), 0)144 XCTAssertEqual(SnoozePolicy(baseMinutes: 500, maxCount: 99).baseMinutes, 30)145 }146147 func testIntensityCurves() {148 for curve in [IntensityCurve.linear, .exponential, .smoothstep, .multiStage] {149 XCTAssertEqual(curve.value(at: 0), 0, accuracy: 1e-9); XCTAssertEqual(curve.value(at: 1), 1, accuracy: 1e-9)150 var last = -1.0151 for i in 0...200 { let v = curve.value(at: Double(i) / 200); XCTAssertGreaterThanOrEqual(v, last - 1e-12, "\(curve.kindName) must be monotonic"); XCTAssert((0...1).contains(v)); last = v }152 XCTAssertEqual(curve.value(at: -3), 0, accuracy: 1e-9); XCTAssertEqual(curve.value(at: 7), 1, accuracy: 1e-9)153 }154 let custom = IntensityCurve.custom([0, 0.5, 0.25, 2])155 XCTAssertEqual(custom.value(at: 0), 0); XCTAssertEqual(custom.value(at: 1), 1)156 XCTAssertEqual(custom.value(at: 1.0 / 3), 0.5, accuracy: 1e-9); XCTAssertEqual(custom.value(at: 0.5), 0.375, accuracy: 1e-9)157 XCTAssertEqual(IntensityCurve.custom([]).value(at: 0.4), 0.4)158 }159160 // MARK: Reconciliation161 func testReconcileMissingMismatchedOrphanAndOff() {162 let ok = AlarmDefinition(time: .init(hour: 7, minute: 0), weekdays: Weekday.weekdays)163 let missing = AlarmDefinition(time: .init(hour: 8, minute: 0))164 let changed = AlarmDefinition(time: .init(hour: 9, minute: 0))165 var off = AlarmDefinition(time: .init(hour: 10, minute: 0)); off.isEnabled = false166 let orphan = UUID(), kept = UUID()167 let system: [SystemAlarmSnapshot] = [168 .init(id: ok.id, state: .scheduled, schedule: .relative(time: ok.time, weekdays: ok.weekdays)),169 .init(id: changed.id, state: .scheduled, schedule: .relative(time: .init(hour: 9, minute: 5), weekdays: [])),170 .init(id: off.id, state: .scheduled, schedule: .relative(time: off.time, weekdays: [])),171 .init(id: orphan, state: .scheduled, schedule: .none),172 .init(id: kept, state: .countdown, schedule: .none),173 .init(id: StableID.snoozeID(for: ok.id, number: 1), state: .countdown, schedule: .none),174 ]175 let r = Reconciler.reconcile(definitions: [ok, missing, changed, off], system: system, keep: [kept])176 XCTAssertEqual(r.statuses[ok.id], .confirmed); XCTAssertEqual(r.statuses[missing.id], .missing)177 XCTAssertEqual(r.statuses[changed.id], .mismatched); XCTAssertEqual(r.statuses[off.id], .off)178 XCTAssertEqual(Set(r.actions), [.schedule(missing.id), .reschedule(changed.id), .cancelOrphan(off.id), .cancelOrphan(orphan)])179 }180181 func testReconcileLeavesAlertingAlarmAloneAndHandlesUnreadableSystem() {182 let a = AlarmDefinition(time: .init(hour: 7, minute: 0))183 let alerting = Reconciler.reconcile(definitions: [a], system: [.init(id: a.id, state: .alerting, schedule: .relative(time: .init(hour: 1, minute: 1), weekdays: []))])184 XCTAssertEqual(alerting.statuses[a.id], .confirmed); XCTAssertTrue(alerting.actions.isEmpty)185 var off = a; off.id = UUID(); off.isEnabled = false186 let unreadable = Reconciler.reconcile(definitions: [a, off], system: nil)187 XCTAssertEqual(unreadable.statuses[a.id], .unverifiable); XCTAssertEqual(unreadable.statuses[off.id], .off); XCTAssertTrue(unreadable.actions.isEmpty)188 }189190 func testReconcileCancelsSnoozeOfDisabledAlarmUnlessKept() {191 var off = AlarmDefinition(time: .init(hour: 7, minute: 0)); off.isEnabled = false192 let sid = StableID.snoozeID(for: off.id, number: 2)193 let system = [SystemAlarmSnapshot(id: sid, state: .countdown, schedule: .none)]194 XCTAssertEqual(Reconciler.reconcile(definitions: [off], system: system).actions, [.cancelOrphan(sid)])195 XCTAssertEqual(Reconciler.reconcile(definitions: [off], system: system, keep: [sid]).actions, [])196 }197198 func testStableIDs() {199 let base = UUID()200 XCTAssertEqual(StableID.snoozeID(for: base, number: 1), StableID.snoozeID(for: base, number: 1))201 XCTAssertNotEqual(StableID.snoozeID(for: base, number: 1), StableID.snoozeID(for: base, number: 2))202 XCTAssertNotEqual(StableID.snoozeID(for: base, number: 1), StableID.snoozeID(for: UUID(), number: 1))203 XCTAssertEqual(Set(StableID.allSnoozeIDs(for: base)).count, StableID.maxSnoozeIDs)204 XCTAssertEqual(StableID.digest(of: "kitchen").count, 64); XCTAssertNotEqual(StableID.digest(of: "a"), StableID.digest(of: "b"))205 }206207 // MARK: Occurrences208 func testOccurrenceLifecycleWithSnooze() {209 var alarm = AlarmDefinition(time: .init(hour: 7, minute: 0))210 alarm.scenario.missions = [MissionStep(kind: .math)]211 var state = RuntimeState()212 let t0 = Date(timeIntervalSince1970: 1_800_000_000)213 let first = state.noteFired(alarmID: alarm.id, at: t0)214 XCTAssertTrue(first.isNew)215 XCTAssertFalse(state.needsMission(for: alarm, now: t0), "still alerting: no mission before the alert is stopped")216 // Snooze for 5 minutes.217 state.update(alarm.id) { $0.snoozesUsed = 1; $0.snoozedUntil = t0.addingTimeInterval(300) }218 XCTAssertFalse(state.needsMission(for: alarm, now: t0.addingTimeInterval(100)))219 let again = state.noteFired(alarmID: alarm.id, at: t0.addingTimeInterval(300))220 XCTAssertFalse(again.isNew); XCTAssertEqual(again.occurrence.id, first.occurrence.id); XCTAssertEqual(again.occurrence.snoozesUsed, 1)221 // Stop the alert: the mission is due.222 state.update(alarm.id) { $0.acknowledgedAt = t0.addingTimeInterval(310) }223 XCTAssertTrue(state.needsMission(for: alarm, now: t0.addingTimeInterval(320)))224 // Mission done, confirmation pending.225 state.update(alarm.id) { $0.missionFinishedAt = t0.addingTimeInterval(400) }226 XCTAssertTrue(state.needsMission(for: alarm, now: t0.addingTimeInterval(410)), "confirmation still required")227 state.update(alarm.id) { $0.confirmedAt = t0.addingTimeInterval(420) }228 XCTAssertFalse(state.needsMission(for: alarm, now: t0.addingTimeInterval(430)))229 // The next morning is a new occurrence.230 let next = state.noteFired(alarmID: alarm.id, at: t0.addingTimeInterval(86_400))231 XCTAssertTrue(next.isNew); XCTAssertNotEqual(next.occurrence.id, first.occurrence.id)232 }233234 func testOccurrenceWindowBypassAndNoMissionAlarm() {235 var alarm = AlarmDefinition(time: .init(hour: 7, minute: 0))236 alarm.scenario.missions = [MissionStep(kind: .maze)]237 var state = RuntimeState(); let t0 = Date(timeIntervalSince1970: 1_800_000_000)238 state.noteFired(alarmID: alarm.id, at: t0)239 state.update(alarm.id) { $0.acknowledgedAt = t0 }240 XCTAssertTrue(state.needsMission(for: alarm, now: t0.addingTimeInterval(3600)))241 XCTAssertFalse(state.needsMission(for: alarm, now: t0.addingTimeInterval(RuntimeState.openWindow + 60)), "stale occurrences are not proposed")242 state.update(alarm.id) { $0.missionFinishedAt = t0.addingTimeInterval(30); $0.bypassed = true }243 XCTAssertFalse(state.needsMission(for: alarm, now: t0.addingTimeInterval(60)), "after the emergency exit nothing more is asked")244 var plain = AlarmDefinition(time: .init(hour: 8, minute: 0)); plain.scenario.requiresConfirmation = false245 state.noteFired(alarmID: plain.id, at: t0); state.update(plain.id) { $0.acknowledgedAt = t0 }246 XCTAssertFalse(state.needsMission(for: plain, now: t0.addingTimeInterval(5)))247 state.prune(keeping: [plain.id])248 XCTAssertNil(state.occurrences[alarm.id]); XCTAssertNotNil(state.occurrences[plain.id])249 }250}251