Track automation history (#708)

ps2 · web-flow · commit 96c84814fa54 · 2024-09-20T07:27:59.000-05:00
diff --git a/Loop.xcodeproj/project.pbxproj b/Loop.xcodeproj/project.pbxproj
@@ -415,6 +415,8 @@
 		C138C6F82C1B8A2C00F08F1A /* GlucoseCondition.swift in Sources */ = {isa = PBXBuildFile; fileRef = C138C6F72C1B8A2C00F08F1A /* GlucoseCondition.swift */; };
 		C13DA2B024F6C7690098BB29 /* UIViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = C13DA2AF24F6C7690098BB29 /* UIViewController.swift */; };
 		C148CEE724FD91BD00711B3B /* DeliveryUncertaintyAlertManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = C148CEE624FD91BD00711B3B /* DeliveryUncertaintyAlertManager.swift */; };
+		C152B9F52C9C7D4A00ACBC06 /* AutomationHistoryEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = C152B9F42C9C7D4A00ACBC06 /* AutomationHistoryEntry.swift */; };
+		C152B9F72C9C7EF100ACBC06 /* AutomationHistoryEntryTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = C152B9F62C9C7EF100ACBC06 /* AutomationHistoryEntryTests.swift */; };
 		C159C82F286787EF00A86EC0 /* LoopKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C159C82E286787EF00A86EC0 /* LoopKit.framework */; };
 		C15A8C492A7305B1009D736B /* SwiftCharts in Frameworks */ = {isa = PBXBuildFile; productRef = C1E3DC4628595FAA00CA19FF /* SwiftCharts */; };
 		C165756F2534C468004AE16E /* SimpleBolusViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = C165756E2534C468004AE16E /* SimpleBolusViewModelTests.swift */; };
@@ -1347,6 +1349,8 @@
 		C13DA2AF24F6C7690098BB29 /* UIViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIViewController.swift; sourceTree = "<group>"; };
 		C148CEE624FD91BD00711B3B /* DeliveryUncertaintyAlertManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DeliveryUncertaintyAlertManager.swift; sourceTree = "<group>"; };
 		C14952142995822A0095AA84 /* ru */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = ru; path = ru.lproj/InfoPlist.strings; sourceTree = "<group>"; };
+		C152B9F42C9C7D4A00ACBC06 /* AutomationHistoryEntry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AutomationHistoryEntry.swift; sourceTree = "<group>"; };
+		C152B9F62C9C7EF100ACBC06 /* AutomationHistoryEntryTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AutomationHistoryEntryTests.swift; sourceTree = "<group>"; };
 		C155A8F32986396E009BD257 /* de */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = de; path = de.lproj/InfoPlist.strings; sourceTree = "<group>"; };
 		C155A8F42986396E009BD257 /* de */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = de; path = de.lproj/Localizable.strings; sourceTree = "<group>"; };
 		C155A8F52986396E009BD257 /* de */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = de; path = de.lproj/ckcomplication.strings; sourceTree = "<group>"; };
@@ -1860,6 +1864,7 @@
 				A987CD4824A58A0100439ADC /* ZipArchive.swift */,
 				C16F51182B891DB600EFD7A1 /* StoredDataAlgorithmInput.swift */,
 				C16F511A2B89363A00EFD7A1 /* SimpleInsulinDose.swift */,
+				C152B9F42C9C7D4A00ACBC06 /* AutomationHistoryEntry.swift */,
 			);
 			path = Models;
 			sourceTree = "<group>";
@@ -2603,13 +2608,14 @@
 		A9E6DFED246A0460005B1A1C /* Models */ = {
 			isa = PBXGroup;
 			children = (
+				C152B9F62C9C7EF100ACBC06 /* AutomationHistoryEntryTests.swift */,
 				A9DFAFB224F0415E00950D1E /* CarbBackfillRequestUserInfoTests.swift */,
 				A963B279252CEBAE0062AA12 /* SetBolusUserInfoTests.swift */,
-				A9DFAFB424F048A000950D1E /* WatchHistoricalCarbsTests.swift */,
 				C19008FF252271BB00721625 /* SimpleBolusCalculatorTests.swift */,
-				A9C1719625366F780053BCBD /* WatchHistoricalGlucoseTest.swift */,
-				A9BD28E6272226B40071DF15 /* TestLocalizedError.swift */,
 				C129D3BE2B8697F100FEA6A9 /* TempBasalRecommendationTests.swift */,
+				A9BD28E6272226B40071DF15 /* TestLocalizedError.swift */,
+				A9DFAFB424F048A000950D1E /* WatchHistoricalCarbsTests.swift */,
+				A9C1719625366F780053BCBD /* WatchHistoricalGlucoseTest.swift */,
 			);
 			path = Models;
 			sourceTree = "<group>";
@@ -3438,6 +3444,7 @@
 				4F11D3C020DCBEEC006E072C /* GlucoseBackfillRequestUserInfo.swift in Sources */,
 				89E267FC2292456700A3F2AF /* FeatureFlags.swift in Sources */,
 				43A567691C94880B00334FAC /* LoopDataManager.swift in Sources */,
+				C152B9F52C9C7D4A00ACBC06 /* AutomationHistoryEntry.swift in Sources */,
 				1DA649A9244126DA00F61E75 /* InAppModalAlertScheduler.swift in Sources */,
 				43B260491ED248FB008CAA77 /* CarbEntryTableViewCell.swift in Sources */,
 				142CB75B2A60BFC30075748A /* FavoriteFoodsView.swift in Sources */,
@@ -3744,6 +3751,7 @@
 				C1777A6625A125F100595963 /* ManualEntryDoseViewModelTests.swift in Sources */,
 				C16B984026B4898800256B05 /* DoseEnactorTests.swift in Sources */,
 				A9A63F8E246B271600588D5B /* NSTimeInterval.swift in Sources */,
+				C152B9F72C9C7EF100ACBC06 /* AutomationHistoryEntryTests.swift in Sources */,
 				A9DFAFB324F0415E00950D1E /* CarbBackfillRequestUserInfoTests.swift in Sources */,
 				A963B27A252CEBAE0062AA12 /* SetBolusUserInfoTests.swift in Sources */,
 				A9DFAFB524F048A000950D1E /* WatchHistoricalCarbsTests.swift in Sources */,
diff --git a/Loop/Extensions/UserDefaults+Loop.swift b/Loop/Extensions/UserDefaults+Loop.swift
@@ -18,6 +18,7 @@ extension UserDefaults {
         case loopNotRunningNotifications = "com.loopkit.Loop.loopNotRunningNotifications"
         case inFlightAutomaticDose = "com.loopkit.Loop.inFlightAutomaticDose"
         case favoriteFoods = "com.loopkit.Loop.favoriteFoods"
+        case automationHistory = "com.loopkit.Loop.automationHistory"
     }
 
     var legacyPumpManagerRawValue: PumpManager.RawValue? {
@@ -110,4 +111,23 @@ extension UserDefaults {
             }
         }
     }
+
+    var automationHistory: [AutomationHistoryEntry] {
+        get {
+            let decoder = JSONDecoder()
+            guard let data = object(forKey: Key.automationHistory.rawValue) as? Data else {
+                return []
+            }
+            return (try? decoder.decode([AutomationHistoryEntry].self, from: data)) ?? []
+        }
+        set {
+            do {
+                let encoder = JSONEncoder()
+                let data = try encoder.encode(newValue)
+                set(data, forKey: Key.automationHistory.rawValue)
+            } catch {
+                assertionFailure("Unable to encode automation history")
+            }
+        }
+    }
 }
diff --git a/Loop/Managers/DeviceDataManager.swift b/Loop/Managers/DeviceDataManager.swift
@@ -19,6 +19,7 @@ protocol LoopControl {
     var lastLoopCompleted: Date? { get }
     func cancelActiveTempBasal(for reason: CancelActiveTempBasalReason) async throws
     func loop() async
+    func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>]
 }
 
 protocol ActiveServicesProvider {
@@ -1140,6 +1141,11 @@ extension DeviceDataManager: DoseStoreDelegate {
     func doseStoreHasUpdatedPumpEventData(_ doseStore: DoseStore) {
         uploadEventListener.triggerUpload(for: .pumpEvent)
     }
+
+    func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>] {
+        return try await loopControl.automationHistory(from: start, to: end)
+    }
+
 }
 
 // MARK: - DosingDecisionStoreDelegate
diff --git a/Loop/Managers/LoopDataManager.swift b/Loop/Managers/LoopDataManager.swift
@@ -146,6 +146,12 @@ final class LoopDataManager: ObservableObject {
 
     var usePositiveMomentumAndRCForManualBoluses: Bool
 
+    var automationHistory: [AutomationHistoryEntry] {
+        didSet {
+            UserDefaults.standard.automationHistory = automationHistory
+        }
+    }
+
     lazy private var cancellables = Set<AnyCancellable>()
 
     init(
@@ -177,10 +183,10 @@ final class LoopDataManager: ObservableObject {
         self.analyticsServicesManager = analyticsServicesManager
         self.carbAbsorptionModel = carbAbsorptionModel
         self.usePositiveMomentumAndRCForManualBoluses = usePositiveMomentumAndRCForManualBoluses
-        
         self.publishedMostRecentGlucoseDataDate = glucoseStore.latestGlucose?.startDate
         self.publishedMostRecentPumpDataDate = mostRecentPumpDataDate
-        
+        self.automationHistory = UserDefaults.standard.automationHistory
+
         // Required for device settings in stored dosing decisions
         UIDevice.current.isBatteryMonitoringEnabled = true
 
@@ -228,8 +234,20 @@ final class LoopDataManager: ObservableObject {
         automaticDosingStatus.$automaticDosingEnabled
             .removeDuplicates()
             .dropFirst()
-            .sink {
-                if !$0 {
+            .sink { [weak self] enabled in
+                guard let self else {
+                    return
+                }
+                if self.automationHistory.last?.enabled != enabled {
+                    self.automationHistory.append(AutomationHistoryEntry(startDate: Date(), enabled: enabled))
+
+                    // Clean up entries older than 36 hours; we should not be interpolating basal data before then.
+                    let now = Date()
+                    self.automationHistory = self.automationHistory.filter({ entry in
+                        now.timeIntervalSince(entry.startDate) < .hours(36)
+                    })
+                }
+                if !enabled {
                     self.temporaryPresetsManager.clearOverride(matching: .preMeal)
                     Task {
                         try? await self.cancelActiveTempBasal(for: .automaticDosingDisabled)
@@ -436,7 +454,7 @@ final class LoopDataManager: ObservableObject {
             logger.error("Error updating Loop state: %{public}@", String(describing: loopError))
         }
         displayState = newState
-        publishedMostRecentGlucoseDataDate = mostRecentGlucoseDataDate
+        publishedMostRecentGlucoseDataDate = glucoseStore.latestGlucose?.startDate
         publishedMostRecentPumpDataDate = mostRecentPumpDataDate
         await updateRemoteRecommendation()
     }
@@ -1444,7 +1462,11 @@ extension LoopDataManager: DiagnosticReportGenerator {
     }
 }
 
-extension LoopDataManager: LoopControl { }
+extension LoopDataManager: LoopControl {
+    func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>] {
+        return automationHistory.toTimeline(from: start, to: end)
+    }
+}
 
 extension CarbMath {
     public static let dateAdjustmentPast: TimeInterval = .hours(-12)
diff --git a/Loop/Models/AutomationHistoryEntry.swift b/Loop/Models/AutomationHistoryEntry.swift
@@ -0,0 +1,49 @@
+//
+//  AutomationHistoryEntry.swift
+//  Loop
+//
+//  Created by Pete Schwamb on 9/19/24.
+//  Copyright © 2024 LoopKit Authors. All rights reserved.
+//
+
+import Foundation
+import LoopAlgorithm
+
+struct AutomationHistoryEntry: Codable {
+    var startDate: Date
+    var enabled: Bool
+}
+
+extension Array where Element == AutomationHistoryEntry {
+    func toTimeline(from start: Date, to end: Date) -> [AbsoluteScheduleValue<Bool>] {
+        guard !isEmpty else {
+            return []
+        }
+
+        var out = [AbsoluteScheduleValue<Bool>]()
+
+        var iter = makeIterator()
+
+        var prev = iter.next()!
+
+        func addItem(start: Date, end: Date, enabled: Bool) {
+            out.append(AbsoluteScheduleValue(startDate: start, endDate: end, value: enabled))
+        }
+
+        while let cur = iter.next() {
+            guard cur.enabled != prev.enabled else {
+                continue
+            }
+            if cur.startDate > start {
+                addItem(start: Swift.max(prev.startDate, start), end: Swift.min(cur.startDate, end), enabled: prev.enabled)
+            }
+            prev = cur
+        }
+
+        if prev.startDate < end {
+            addItem(start: prev.startDate, end: end, enabled: prev.enabled)
+        }
+
+        return out
+    }
+}
diff --git a/LoopTests/Mocks/LoopControlMock.swift b/LoopTests/Mocks/LoopControlMock.swift
@@ -8,6 +8,7 @@
 
 import XCTest
 import Foundation
+import LoopAlgorithm
 @testable import Loop
 
 
@@ -25,4 +26,8 @@ class LoopControlMock: LoopControl {
 
     func loop() async {
     }
+
+    func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>] {
+        return []
+    }
 }
diff --git a/LoopTests/Models/AutomationHistoryEntryTests.swift b/LoopTests/Models/AutomationHistoryEntryTests.swift
@@ -0,0 +1,97 @@
+//
+//  AutomationHistoryEntryTests.swift
+//  LoopTests
+//
+//  Created by Pete Schwamb on 9/19/24.
+//  Copyright © 2024 LoopKit Authors. All rights reserved.
+//
+
+import XCTest
+
+@testable import Loop
+
+class TimelineTests: XCTestCase {
+
+    func testEmptyArray() {
+        let entries: [AutomationHistoryEntry] = []
+        let start = Date()
+        let end = start.addingTimeInterval(3600) // 1 hour later
+
+        let timeline = entries.toTimeline(from: start, to: end)
+
+        XCTAssertTrue(timeline.isEmpty, "Timeline should be empty for an empty array of entries")
+    }
+
+    func testSingleEntry() {
+        let start = Date()
+        let end = start.addingTimeInterval(3600) // 1 hour later
+        let entries = [AutomationHistoryEntry(startDate: start, enabled: true)]
+
+        let timeline = entries.toTimeline(from: start, to: end)
+
+        XCTAssertEqual(timeline.count, 1, "Timeline should have one entry")
+        XCTAssertEqual(timeline[0].startDate, start)
+        XCTAssertEqual(timeline[0].endDate, end)
+        XCTAssertEqual(timeline[0].value, true)
+    }
+
+    func testMultipleEntries() {
+        let start = Date()
+        let middleDate = start.addingTimeInterval(1800) // 30 minutes later
+        let end = start.addingTimeInterval(3600) // 1 hour later
+        let entries = [
+            AutomationHistoryEntry(startDate: start, enabled: true),
+            AutomationHistoryEntry(startDate: middleDate, enabled: false)
+        ]
+
+        let timeline = entries.toTimeline(from: start, to: end)
+
+        XCTAssertEqual(timeline.count, 2, "Timeline should have two entries")
+        XCTAssertEqual(timeline[0].startDate, start)
+        XCTAssertEqual(timeline[0].endDate, middleDate)
+        XCTAssertEqual(timeline[0].value, true)
+        XCTAssertEqual(timeline[1].startDate, middleDate)
+        XCTAssertEqual(timeline[1].endDate, end)
+        XCTAssertEqual(timeline[1].value, false)
+    }
+
+    func testEntriesOutsideRange() {
+        let start = Date()
+        let end = start.addingTimeInterval(3600) // 1 hour later
+        let beforeStart = start.addingTimeInterval(-1800) // 30 minutes before start
+        let afterEnd = end.addingTimeInterval(1800) // 30 minutes after end
+        let entries = [
+            AutomationHistoryEntry(startDate: beforeStart, enabled: true),
+            AutomationHistoryEntry(startDate: afterEnd, enabled: false)
+        ]
+
+        let timeline = entries.toTimeline(from: start, to: end)
+
+        XCTAssertEqual(timeline.count, 1, "Timeline should have one entry")
+        XCTAssertEqual(timeline[0].startDate, start)
+        XCTAssertEqual(timeline[0].endDate, end)
+        XCTAssertEqual(timeline[0].value, true)
+    }
+
+    func testConsecutiveEntriesWithSameValue() {
+        let start = Date()
+        let middle1 = start.addingTimeInterval(1200) // 20 minutes later
+        let middle2 = start.addingTimeInterval(2400) // 40 minutes later
+        let end = start.addingTimeInterval(3600) // 1 hour later
+        let entries = [
+            AutomationHistoryEntry(startDate: start, enabled: true),
+            AutomationHistoryEntry(startDate: middle1, enabled: true),
+            AutomationHistoryEntry(startDate: middle2, enabled: false)
+        ]
+
+        let timeline = entries.toTimeline(from: start, to: end)
+
+        XCTAssertEqual(timeline.count, 2, "Timeline should have two entries")
+        XCTAssertEqual(timeline[0].startDate, start)
+        XCTAssertEqual(timeline[0].endDate, middle2)
+        XCTAssertEqual(timeline[0].value, true)
+        XCTAssertEqual(timeline[1].startDate, middle2)
+        XCTAssertEqual(timeline[1].endDate, end)
+        XCTAssertEqual(timeline[1].value, false)
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ protocol LoopControl {`
`19`	`19`	`var lastLoopCompleted: Date? { get }`
`20`	`20`	`func cancelActiveTempBasal(for reason: CancelActiveTempBasalReason) async throws`
`21`	`21`	`func loop() async`
	`22`	`+ func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>]`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`protocol ActiveServicesProvider {`
`@@ -1140,6 +1141,11 @@ extension DeviceDataManager: DoseStoreDelegate {`
`1140`	`1141`	`func doseStoreHasUpdatedPumpEventData(_ doseStore: DoseStore) {`
`1141`	`1142`	`uploadEventListener.triggerUpload(for: .pumpEvent)`
`1142`	`1143`	`}`
	`1144`	`+`
	`1145`	`+ func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>] {`
	`1146`	`+ return try await loopControl.automationHistory(from: start, to: end)`
	`1147`	`+ }`
	`1148`	`+`
`1143`	`1149`	`}`
`1144`	`1150`
`1145`	`1151`	`// MARK: - DosingDecisionStoreDelegate`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`import XCTest`
`10`	`10`	`import Foundation`
	`11`	`+import LoopAlgorithm`
`11`	`12`	`@testable import Loop`
`12`	`13`
`13`	`14`
`@@ -25,4 +26,8 @@ class LoopControlMock: LoopControl {`
`25`	`26`
`26`	`27`	`func loop() async {`
`27`	`28`	`}`
	`29`	`+`
	`30`	`+ func automationHistory(from start: Date, to end: Date) async throws -> [AbsoluteScheduleValue<Bool>] {`
	`31`	`+ return []`
	`32`	`+ }`
`28`	`33`	`}`