Denote stale glucose (LOOP-927)

Common/Models/WatchContext.swift

@@ -21,6 +21,7 @@ final class WatchContext: RawRepresentable {
     var glucose: HKQuantity?
     var glucoseTrendRawValue: Int?
     var glucoseDate: Date?
+    var glucoseSyncIdentifier: String?
 
     var predictedGlucose: WatchPredictedGlucose?
     var eventualGlucose: HKQuantity? {
@@ -57,6 +58,7 @@ final class WatchContext: RawRepresentable {
 
         glucoseTrendRawValue = rawValue["gt"] as? Int
         glucoseDate = rawValue["gd"] as? Date
+        glucoseSyncIdentifier = rawValue["gs"] as? String
         iob = rawValue["iob"] as? Double
         reservoir = rawValue["r"] as? Double
         reservoirPercentage = rawValue["rp"] as? Double
@@ -94,6 +96,7 @@ final class WatchContext: RawRepresentable {
 
         raw["gt"] = glucoseTrendRawValue
         raw["gd"] = glucoseDate
+        raw["gs"] = glucoseSyncIdentifier
         raw["iob"] = iob
         raw["ld"] = loopLastRunDate
         raw["r"] = reservoir
@@ -116,3 +119,12 @@ extension WatchContext {
         }
     }
 }
+
+extension WatchContext {
+    var newGlucoseSample: NewGlucoseSample? {
+        if let quantity = glucose, let date = glucoseDate, let syncIdentifier = glucoseSyncIdentifier {
+            return NewGlucoseSample(date: date, quantity: quantity, isDisplayOnly: false, syncIdentifier: syncIdentifier, syncVersion: 0)
+        }
+        return nil
+    }
+}

Loop Status Extension/StatusViewController.swift

@@ -256,11 +256,12 @@ class StatusViewController: UIViewController, NCWidgetProviding {
                 return
             }
 
-            if let lastGlucose = glucose.last {
+            if let lastGlucose = glucose.last, let recencyInterval = defaults.loopSettings?.inputDataRecencyInterval {
                 self.hudView.glucoseHUD.setGlucoseQuantity(
                     lastGlucose.quantity.doubleValue(for: unit),
                     at: lastGlucose.startDate,
                     unit: unit,
+                    staleGlucoseAge: recencyInterval,
                     sensor: context.sensor
                 )
             }

Loop.xcodeproj/project.pbxproj

@@ -364,6 +364,8 @@
 		C17824A51E1AD4D100D9D25C /* BolusRecommendation.swift in Sources */ = {isa = PBXBuildFile; fileRef = C17824A41E1AD4D100D9D25C /* BolusRecommendation.swift */; };
 		C17824A61E1AF91F00D9D25C /* BolusRecommendation.swift in Sources */ = {isa = PBXBuildFile; fileRef = C17824A41E1AD4D100D9D25C /* BolusRecommendation.swift */; };
 		C1814B86225E507C008D2D8E /* Sequence.swift in Sources */ = {isa = PBXBuildFile; fileRef = C1814B85225E507C008D2D8E /* Sequence.swift */; };
+		C19E96DF23D275F8003F79B0 /* LoopCompletionFreshness.swift in Sources */ = {isa = PBXBuildFile; fileRef = C19E96DD23D2733F003F79B0 /* LoopCompletionFreshness.swift */; };
+		C19E96E023D275FA003F79B0 /* LoopCompletionFreshness.swift in Sources */ = {isa = PBXBuildFile; fileRef = C19E96DD23D2733F003F79B0 /* LoopCompletionFreshness.swift */; };
 		C1A3EED2235233E1007672E3 /* DerivedAssets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = C1A3EED1235233E1007672E3 /* DerivedAssets.xcassets */; };
 		C1A3EED423523551007672E3 /* DerivedAssets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = C1A3EED323523551007672E3 /* DerivedAssets.xcassets */; };
 		C1A3EED523535FFF007672E3 /* DefaultAssets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 894F71E11FFEC4D8007D365C /* DefaultAssets.xcassets */; };
@@ -1015,6 +1017,7 @@
 		C18A491322FCC22900FDA733 /* make_scenario.py */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.script.python; path = make_scenario.py; sourceTree = "<group>"; };
 		C18A491422FCC22900FDA733 /* build-derived-watch-assets.sh */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.script.sh; path = "build-derived-watch-assets.sh"; sourceTree = "<group>"; };
 		C18A491522FCC22900FDA733 /* copy-plugins.sh */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.script.sh; path = "copy-plugins.sh"; sourceTree = "<group>"; };
+		C19E96DD23D2733F003F79B0 /* LoopCompletionFreshness.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoopCompletionFreshness.swift; sourceTree = "<group>"; };
 		C1A3EED1235233E1007672E3 /* DerivedAssets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = DerivedAssets.xcassets; sourceTree = "<group>"; };
 		C1A3EED323523551007672E3 /* DerivedAssets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = DerivedAssets.xcassets; sourceTree = "<group>"; };
 		C1C6591B1E1B1FDA0025CC58 /* recommend_temp_basal_dropping_then_rising.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = recommend_temp_basal_dropping_then_rising.json; sourceTree = "<group>"; };
@@ -1427,6 +1430,7 @@
 				43C05CB721EBEA54006FB252 /* HKUnit.swift */,
 				434FF1E91CF26C29000DB779 /* IdentifiableClass.swift */,
 				430B298C2041F56500BA9F93 /* LoopSettings.swift */,
+				C19E96DD23D2733F003F79B0 /* LoopCompletionFreshness.swift */,
 				430B29892041F54A00BA9F93 /* NSUserDefaults.swift */,
 				431E73471FF95A900069B5F7 /* PersistenceController.swift */,
 				43D848AF1E7DCBE100DADCBC /* Result.swift */,
@@ -2675,6 +2679,7 @@
 			files = (
 				43C05CB821EBEA54006FB252 /* HKUnit.swift in Sources */,
 				4345E3F421F036FC009E00E5 /* Result.swift in Sources */,
+				C19E96E023D275FA003F79B0 /* LoopCompletionFreshness.swift in Sources */,
 				43D9002021EB209400AF44BF /* NSTimeInterval.swift in Sources */,
 				43C05CA921EB2B26006FB252 /* PersistenceController.swift in Sources */,
 				431EA87221EB29150076EC1A /* InsulinModelSettings.swift in Sources */,
@@ -2726,6 +2731,7 @@
 			files = (
 				43C05CB921EBEA54006FB252 /* HKUnit.swift in Sources */,
 				4345E3F521F036FC009E00E5 /* Result.swift in Sources */,
+				C19E96DF23D275F8003F79B0 /* LoopCompletionFreshness.swift in Sources */,
 				43D9FFFB21EAF3D300AF44BF /* NSTimeInterval.swift in Sources */,
 				43C05CA821EB2B26006FB252 /* PersistenceController.swift in Sources */,
 				431EA87321EB29160076EC1A /* InsulinModelSettings.swift in Sources */,

Loop/Managers/LoopDataManager.swift

@@ -687,7 +687,7 @@ extension LoopDataManager {
         // Fetch glucose effects as far back as we want to make retroactive analysis
         var latestGlucoseDate: Date?
         updateGroup.enter()
-        glucoseStore.getCachedGlucoseSamples(start: Date(timeIntervalSinceNow: -settings.recencyInterval)) { (values) in
+        glucoseStore.getCachedGlucoseSamples(start: Date(timeIntervalSinceNow: -settings.inputDataRecencyInterval)) { (values) in
             latestGlucoseDate = values.last?.startDate
             updateGroup.leave()
         }
@@ -904,7 +904,7 @@ extension LoopDataManager {
         retrospectiveGlucoseEffect = retrospectiveCorrection.computeEffect(
             startingAt: glucose,
             retrospectiveGlucoseDiscrepanciesSummed: retrospectiveGlucoseDiscrepanciesSummed,
-            recencyInterval: settings.recencyInterval,
+            recencyInterval: settings.inputDataRecencyInterval,
             insulinSensitivitySchedule: insulinSensitivitySchedule,
             basalRateSchedule: basalRateSchedule,
             glucoseCorrectionRangeSchedule: settings.glucoseTargetRangeSchedule,
@@ -933,12 +933,12 @@ extension LoopDataManager {
 
         let startDate = Date()
 
-        guard startDate.timeIntervalSince(glucose.startDate) <= settings.recencyInterval else {
+        guard startDate.timeIntervalSince(glucose.startDate) <= settings.inputDataRecencyInterval else {
             self.predictedGlucose = nil
             throw LoopError.glucoseTooOld(date: glucose.startDate)
         }
 
-        guard startDate.timeIntervalSince(pumpStatusDate) <= settings.recencyInterval else {
+        guard startDate.timeIntervalSince(pumpStatusDate) <= settings.inputDataRecencyInterval else {
             self.predictedGlucose = nil
             throw LoopError.pumpDataTooOld(date: pumpStatusDate)
         }

Loop/Managers/WatchDataManager.swift

@@ -160,6 +160,18 @@ final class WatchDataManager: NSObject {
             if let trend = self.deviceManager.cgmManager?.sensorState?.trendType {
                 context.glucoseTrendRawValue = trend.rawValue
             }
+
+            if let glucose = glucose {
+                updateGroup.enter()
+                manager.glucoseStore.getCachedGlucoseSamples(start: glucose.startDate) { (samples) in
+                    if let sample = samples.last {
+                        context.glucose = sample.quantity
+                        context.glucoseDate = sample.startDate
+                        context.glucoseSyncIdentifier = sample.syncIdentifier
+                    }
+                    updateGroup.leave()
+                }
+            }
 
             updateGroup.enter()
             manager.doseStore.insulinOnBoard(at: Date()) { (result) in

Loop/View Controllers/StatusTableViewController.swift

@@ -487,6 +487,7 @@ final class StatusTableViewController: ChartsTableViewController {
                     hudView.glucoseHUD.setGlucoseQuantity(glucose.quantity.doubleValue(for: unit),
                         at: glucose.startDate,
                         unit: unit,
+                        staleGlucoseAge: self.deviceManager.loopManager.settings.inputDataRecencyInterval,
                         sensor: self.deviceManager.sensorState
                     )
                 }

LoopCore/LoopCompletionFreshness.swift

@@ -0,0 +1,57 @@
+//
+//  LoopCompletionFreshness.swift
+//  Loop
+//
+//  Created by Pete Schwamb on 1/17/20.
+//  Copyright © 2020 LoopKit Authors. All rights reserved.
+//
+
+import Foundation
+
+public enum LoopCompletionFreshness {
+    case fresh
+    case aging
+    case stale
+    case unknown
+
+    public var maxAge: TimeInterval? {
+        switch self {
+        case .fresh:
+            return TimeInterval(minutes: 6)
+        case .aging:
+            return TimeInterval(minutes: 16)
+        case .stale:
+            return TimeInterval(hours: 12)
+        case .unknown:
+            return nil
+        }
+    }
+
+    public init(age: TimeInterval?) {
+        guard let age = age else {
+            self = .unknown
+            return
+        }
+
+        switch age {
+        case let t where t <= LoopCompletionFreshness.fresh.maxAge!:
+            self = .fresh
+        case let t where t <= LoopCompletionFreshness.aging.maxAge!:
+            self = .aging
+        case let t where t <= LoopCompletionFreshness.stale.maxAge!:
+            self = .stale
+        default:
+            self = .unknown
+        }
+    }
+
+    public init(lastCompletion: Date?, at date: Date = Date()) {
+        guard let lastCompletion = lastCompletion else {
+            self = .unknown
+            return
+        }
+
+        self = LoopCompletionFreshness(age: date.timeIntervalSince(lastCompletion))
+    }
+
+}

LoopCore/LoopSettings.swift

@@ -36,8 +36,13 @@ public struct LoopSettings: Equatable {
     /// The interval over which to aggregate changes in glucose for retrospective correction
     public let retrospectiveCorrectionGroupingInterval = TimeInterval(minutes: 30)
 
-    /// The amount of time since a given date that data should be considered valid
-    public let recencyInterval = TimeInterval(minutes: 15)
+    /// The amount of time since a given date that input data should be considered valid
+    public let inputDataRecencyInterval = TimeInterval(minutes: 15)
+
+    /// Loop completion aging category limits
+    public let completionFreshLimit = TimeInterval(minutes: 6)
+    public let completionAgingLimit = TimeInterval(minutes: 16)
+    public let completionStaleLimit = TimeInterval(hours: 12)
 
     public let batteryReplacementDetectionThreshold = 0.5
 

LoopUI/Views/GlucoseHUDView.swift

@@ -91,27 +91,27 @@ public final class GlucoseHUDView: BaseHUDView {
         }
     }
 
-    public func setGlucoseQuantity(_ glucoseQuantity: Double, at glucoseStartDate: Date, unit: HKUnit, sensor: SensorDisplayable?) {
+    public func setGlucoseQuantity(_ glucoseQuantity: Double, at glucoseStartDate: Date, unit: HKUnit, staleGlucoseAge: TimeInterval, sensor: SensorDisplayable?) {
         var accessibilityStrings = [String]()
 
         let time = timeFormatter.string(from: glucoseStartDate)
         caption?.text = time
 
-        let sensorDataCurrent = glucoseStartDate.timeIntervalSinceNow > TimeInterval(minutes: -15)
+        let glucoseValueCurrent = glucoseStartDate.timeIntervalSinceNow > -staleGlucoseAge
 
         let numberFormatter = NumberFormatter.glucoseFormatter(for: unit)
         if let valueString = numberFormatter.string(from: glucoseQuantity) {
-            if sensorDataCurrent {
+            if glucoseValueCurrent {
                 glucoseLabel.text = valueString
             } else {
-                glucoseLabel.text = "-"
+                glucoseLabel.text = "---"
             }
             accessibilityStrings.append(String(format: LocalizedString("%1$@ at %2$@", comment: "Accessbility format value describing glucose: (1: glucose number)(2: glucose time)"), valueString, time))
         }
 
         var unitStrings = [unit.localizedShortUnitString]
 
-        if let trend = sensor?.trendType, sensorDataCurrent {
+        if let trend = sensor?.trendType, glucoseValueCurrent {
             unitStrings.append(trend.symbol)
             accessibilityStrings.append(trend.localizedDescription)
         }

LoopUI/Views/LoopCompletionHUDView.swift

@@ -8,6 +8,7 @@
 
 import UIKit
 import LoopKitUI
+import LoopCore
 
 public final class LoopCompletionHUDView: BaseHUDView {
 
@@ -17,14 +18,7 @@ public final class LoopCompletionHUDView: BaseHUDView {
         return 1
     }
 
-    enum Freshness {
-        case fresh
-        case aging
-        case stale
-        case unknown
-    }
-
-    private(set) var freshness = Freshness.unknown {
+    private(set) var freshness = LoopCompletionFreshness.unknown {
         didSet {
             updateTintColor()
         }
@@ -128,17 +122,8 @@ public final class LoopCompletionHUDView: BaseHUDView {
     @objc private func updateDisplay(_: Timer?) {
         if let date = lastLoopCompleted {
             let ago = abs(min(0, date.timeIntervalSinceNow))
-
-            switch ago {
-            case let t where t <= .minutes(6):
-                freshness = .fresh
-            case let t where t <= .minutes(16):
-                freshness = .aging
-            case let t where t <= .hours(12):
-                freshness = .stale
-            default:
-                freshness = .unknown
-            }
+
+            freshness = LoopCompletionFreshness(age: ago)
 
             if let timeString = formatter.string(from: ago) {
                 switch traitCollection.preferredContentSizeCategory {