LOOP-3785 Limits on bg input, additional warnings. (#444)

* Add glucose range restriction, and move max bolus warning earlier

* Add carbohydrateEntryTooLarge warning

* Cleanup alerts that happened after action button; now showing warnings instead

* Reorder enum to be alphabetical

Author: ps2

Loop/View Models/SimpleBolusViewModel.swift

@@ -16,7 +16,7 @@ import LoopCore
 import Intents
 import LocalAuthentication
 
-protocol SimpleBolusViewModelDelegate: class {
+protocol SimpleBolusViewModelDelegate: AnyObject {
 
     func addGlucose(_ samples: [NewGlucoseSample], completion: @escaping (Error?) -> Void)
 
@@ -43,20 +43,21 @@ class SimpleBolusViewModel: ObservableObject {
     var authenticate: AuthenticationChallenge = LocalAuthentication.deviceOwnerCheck
 
     enum Alert: Int {
-        case maxBolusExceeded
         case carbEntryPersistenceFailure
-        case carbEntrySizeTooLarge
-        case manualGlucoseEntryOutOfAcceptableRange
         case manualGlucoseEntryPersistenceFailure
         case infoPopup
     }
 
     @Published var activeAlert: Alert?
 
     enum Notice: Int {
-        case glucoseBelowSuspendThreshold
+        case carbohydrateEntryTooLarge
         case glucoseBelowRecommendationLimit
+        case glucoseBelowSuspendThreshold
+        case glucoseOutOfAllowedInputRange
         case glucoseWarning
+        case maxBolusExceeded
+        case recommendationExceedsMaxBolus
     }
 
     @Published var activeNotice: Notice?
@@ -106,17 +107,48 @@ class SimpleBolusViewModel: ObservableObject {
     }
 
     private func updateNotice() {
-        let minRecommendationGlucose = displayMealEntry ? LoopConstants.simpleBolusCalculatorMinGlucoseMealBolusRecommendation : LoopConstants.simpleBolusCalculatorMinGlucoseBolusRecommendation
+        
+        if let carbs = self.carbQuantity {
+            guard carbs <= LoopConstants.maxCarbEntryQuantity else {
+                activeNotice = .carbohydrateEntryTooLarge
+                return
+            }
+        }
+        
+        if let bolus = bolus {
+            guard bolus.doubleValue(for: .internationalUnit()) <= delegate.maximumBolus else {
+                activeNotice = .maxBolusExceeded
+                return
+            }
+        }
+
+        let isAddingCarbs: Bool
+        if let carbQuantity = carbQuantity, carbQuantity.doubleValue(for: .gram()) > 0 {
+            isAddingCarbs = true
+        } else {
+            isAddingCarbs = false
+        }
+        
+        let minRecommendationGlucose =
+            isAddingCarbs ?
+            LoopConstants.simpleBolusCalculatorMinGlucoseMealBolusRecommendation :
+            LoopConstants.simpleBolusCalculatorMinGlucoseBolusRecommendation
 
         switch manualGlucoseQuantity {
+        case let .some(g) where !LoopConstants.validManualGlucoseEntryRange.contains(g):
+            activeNotice = .glucoseOutOfAllowedInputRange
         case let g? where g < minRecommendationGlucose:
             activeNotice = .glucoseBelowRecommendationLimit
         case let g? where g < LoopConstants.simpleBolusCalculatorGlucoseWarningLimit:
             activeNotice = .glucoseWarning
         case let g? where g < suspendThreshold:
             activeNotice = .glucoseBelowSuspendThreshold
         default:
-            activeNotice = nil
+            if let recommendation = recommendation, recommendation > delegate.maximumBolus {
+                activeNotice = .recommendationExceedsMaxBolus
+            } else {
+                activeNotice = nil
+            }
         }
 
     }
@@ -139,13 +171,14 @@ class SimpleBolusViewModel: ObservableObject {
         }
     }
 
-    @Published var enteredBolusAmount: String {
+    @Published var enteredBolusString: String {
         didSet {
-            if let enteredBolusAmount = Self.doseAmountFormatter.number(from: enteredBolusAmount)?.doubleValue, enteredBolusAmount > 0 {
+            if let enteredBolusAmount = Self.doseAmountFormatter.number(from: enteredBolusString)?.doubleValue, enteredBolusAmount > 0 {
                 bolus = HKQuantity(unit: .internationalUnit(), doubleValue: enteredBolusAmount)
             } else {
                 bolus = nil
             }
+            updateNotice()
         }
     }
 
@@ -172,12 +205,12 @@ class SimpleBolusViewModel: ObservableObject {
 
     private var recommendation: Double? = nil {
         didSet {
-            if let recommendation = recommendation, let recommendationString = Self.doseAmountFormatter.string(from: recommendation) {
-                recommendedBolus = recommendationString
-                enteredBolusAmount = recommendationString
+            if let recommendation = recommendation {
+                recommendedBolus = Self.doseAmountFormatter.string(from: recommendation)!
+                enteredBolusString = Self.doseAmountFormatter.string(from: min(recommendation, delegate.maximumBolus))!
             } else {
                 recommendedBolus = NSLocalizedString("–", comment: "String denoting lack of a recommended bolus amount in the simple bolus calculator")
-                enteredBolusAmount = Self.doseAmountFormatter.string(from: 0.0)!
+                enteredBolusString = Self.doseAmountFormatter.string(from: 0.0)!
             }
         }
     }
@@ -223,6 +256,15 @@ class SimpleBolusViewModel: ObservableObject {
         }
     }
 
+    var actionButtonDisabled: Bool {
+        switch activeNotice {
+        case .glucoseOutOfAllowedInputRange, .maxBolusExceeded, .carbohydrateEntryTooLarge:
+            return true
+        default:
+            return false
+        }
+    }
+    
     var carbPlaceholder: String {
         Self.carbAmountFormatter.string(from: 0.0)!
     }
@@ -233,8 +275,9 @@ class SimpleBolusViewModel: ObservableObject {
 
     private lazy var bolusVolumeFormatter = QuantityFormatter(for: .internationalUnit())
 
-    var maximumBolusAmountString: String? {
-        return bolusVolumeFormatter.numberFormatter.string(from: delegate.maximumBolus) ?? String(delegate.maximumBolus)
+    var maximumBolusAmountString: String {
+        let maxBolusQuantity = HKQuantity(unit: .internationalUnit(), doubleValue: delegate.maximumBolus)
+        return bolusVolumeFormatter.string(from: maxBolusQuantity, for: .internationalUnit())!
     }
 
     init(delegate: SimpleBolusViewModelDelegate, displayMealEntry: Bool) {
@@ -243,13 +286,28 @@ class SimpleBolusViewModel: ObservableObject {
         let glucoseQuantityFormatter = QuantityFormatter()
         glucoseQuantityFormatter.setPreferredNumberFormatter(for: delegate.displayGlucoseUnitObservable.displayGlucoseUnit)
         cachedDisplayGlucoseUnit = delegate.displayGlucoseUnitObservable.displayGlucoseUnit
-        enteredBolusAmount = Self.doseAmountFormatter.string(from: 0.0)!
+        enteredBolusString = Self.doseAmountFormatter.string(from: 0.0)!
         updateRecommendation()
         dosingDecision = BolusDosingDecision()
     }
 
     func updateRecommendation() {
         let recommendationDate = Date()
+        
+        if let carbs = self.carbQuantity {
+            guard carbs <= LoopConstants.maxCarbEntryQuantity else {
+                recommendation = nil
+                return
+            }
+        }
+        
+        if let glucose = manualGlucoseQuantity {
+            guard LoopConstants.validManualGlucoseEntryRange.contains(glucose) else {
+                recommendation = nil
+                return
+            }
+        }
+        
         if carbQuantity != nil || manualGlucoseQuantity != nil {
             dosingDecision = delegate.computeSimpleBolusRecommendation(at: recommendationDate, mealCarbs: carbQuantity, manualGlucose: manualGlucoseQuantity)
             if let decision = dosingDecision, let bolusRecommendation = decision.recommendedBolus {
@@ -273,36 +331,13 @@ class SimpleBolusViewModel: ObservableObject {
     }
 
     func saveAndDeliver(completion: @escaping (Bool) -> Void) {
-        if let bolus = bolus {
-            guard bolus.doubleValue(for: .internationalUnit()) <= delegate.maximumBolus else {
-                presentAlert(.maxBolusExceeded)
-                completion(false)
-                return
-            }
-        }
-
-        if let manualGlucoseQuantity = manualGlucoseQuantity {
-            guard LoopConstants.validManualGlucoseEntryRange.contains(manualGlucoseQuantity) else {
-                presentAlert(.manualGlucoseEntryOutOfAcceptableRange)
-                completion(false)
-                return
-            }
-        }
-        
-        if let carbs = carbQuantity {
-            guard carbs <= LoopConstants.maxCarbEntryQuantity else {
-                presentAlert(.carbEntrySizeTooLarge)
-                completion(false)
-                return
-            }
-        }
 
         let saveDate = Date()
 
         // Authenticate the bolus before saving anything
         func authenticateIfNeeded(_ completion: @escaping (Bool) -> Void) {
             if let bolus = bolus, bolus.doubleValue(for: .internationalUnit()) > 0 {
-                let message = String(format: NSLocalizedString("Authenticate to Bolus %@ Units", comment: "The message displayed during a device authentication prompt for bolus specification"), enteredBolusAmount)
+                let message = String(format: NSLocalizedString("Authenticate to Bolus %@ Units", comment: "The message displayed during a device authentication prompt for bolus specification"), enteredBolusString)
                 authenticate(message) {
                     switch $0 {
                     case .success:

Loop/Views/SimpleBolusView.swift

@@ -74,6 +74,12 @@ struct SimpleBolusView: View {
         }
     }
 
+    let glucoseFormatter = QuantityFormatter()
+    
+    private func formatGlucose(_ quantity: HKQuantity) -> String {
+        return glucoseFormatter.string(from: quantity, for: displayGlucoseUnitObservable.displayGlucoseUnit)!
+    }
+    
     private func shouldAutoScroll(basedOn geometry: GeometryProxy) -> Bool {
         // Taking a guess of 640 to cover iPhone SE, iPod Touch, and other smaller devices.
         // Devices such as the iPhone 11 Pro Max do not need to auto-scroll.
@@ -197,7 +203,7 @@ struct SimpleBolusView: View {
             Spacer()
             HStack(alignment: .firstTextBaseline) {
                 DismissibleKeyboardTextField(
-                    text: $viewModel.enteredBolusAmount,
+                    text: $viewModel.enteredBolusString,
                     placeholder: "",
                     font: .preferredFont(forTextStyle: .title1),
                     textColor: .loopAccent,
@@ -269,42 +275,18 @@ struct SimpleBolusView: View {
                 }
             }
         )
+        .disabled(viewModel.actionButtonDisabled)
         .buttonStyle(ActionButtonStyle(.primary))
         .padding()
     }
 
     private func alert(for alert: SimpleBolusViewModel.Alert) -> SwiftUI.Alert {
         switch alert {
-        case .maxBolusExceeded:
-            guard let maximumBolusAmountString = viewModel.maximumBolusAmountString else {
-                fatalError("Impossible to exceed max bolus without a configured max bolus")
-            }
-            return SwiftUI.Alert(
-                title: Text("Exceeds Maximum Bolus", comment: "Alert title for a maximum bolus validation error"),
-                message: Text(String(format: NSLocalizedString("The maximum bolus amount is %1$@ U.", comment: "Format string for maximum bolus exceeded alert (1: maximumBolusAmount)"), maximumBolusAmountString))
-            )
         case .carbEntryPersistenceFailure:
             return SwiftUI.Alert(
                 title: Text("Unable to Save Carb Entry", comment: "Alert title for a carb entry persistence error"),
                 message: Text("An error occurred while trying to save your carb entry.", comment: "Alert message for a carb entry persistence error")
             )
-        case .carbEntrySizeTooLarge:
-            let message = String(
-                format: NSLocalizedString("The maximum allowed amount is %1$@ grams", comment: "Alert body displayed for quantity greater than max (1: maximum quantity in grams)"),
-                NumberFormatter.localizedString(from: NSNumber(value: LoopConstants.maxCarbEntryQuantity.doubleValue(for: .gram())), number: .none)
-            )
-            return SwiftUI.Alert(
-                title: Text("Carb Entry Too Large", comment: "Alert title for a carb entry too large error"),
-                message: Text(message)
-            )
-        case .manualGlucoseEntryOutOfAcceptableRange:
-            let formatter = QuantityFormatter(for: displayGlucoseUnitObservable.displayGlucoseUnit)
-            let acceptableLowerBound = formatter.string(from: LoopConstants.validManualGlucoseEntryRange.lowerBound, for: displayGlucoseUnitObservable.displayGlucoseUnit) ?? String(describing: LoopConstants.validManualGlucoseEntryRange.lowerBound)
-            let acceptableUpperBound = formatter.string(from: LoopConstants.validManualGlucoseEntryRange.upperBound, for: displayGlucoseUnitObservable.displayGlucoseUnit) ?? String(describing: LoopConstants.validManualGlucoseEntryRange.upperBound)
-            return SwiftUI.Alert(
-                title: Text("Glucose Entry Out of Range", comment: "Alert title for a manual glucose entry out of range error"),
-                message: Text(String(format: NSLocalizedString("A manual glucose entry must be between %1$@ and %2$@", comment: "Alert message for a manual glucose entry out of range error. (1: acceptable lower bound) (2: acceptable upper bound)"), acceptableLowerBound, acceptableUpperBound))
-            )
         case .manualGlucoseEntryPersistenceFailure:
             return SwiftUI.Alert(
                 title: Text("Unable to Save Manual Glucose Entry", comment: "Alert title for a manual glucose entry persistence error"),
@@ -315,7 +297,7 @@ struct SimpleBolusView: View {
         }
 
     }
-    
+        
     private func warning(for notice: SimpleBolusViewModel.Notice) -> some View {
 
         switch notice {
@@ -326,13 +308,13 @@ struct SimpleBolusView: View {
             } else {
                 title = Text("No Bolus Recommended", comment: "Title for bolus screen warning when glucose is below suspend threshold, and a bolus is not recommended")
             }
-            let suspendThresholdString = QuantityFormatter().string(from: viewModel.suspendThreshold, for: displayGlucoseUnitObservable.displayGlucoseUnit) ?? String(describing: viewModel.suspendThreshold)
+            let suspendThresholdString = formatGlucose(viewModel.suspendThreshold)
             return WarningView(
                 title: title,
                 caption: Text(String(format: NSLocalizedString("Your glucose is below your glucose safety limit, %1$@.", comment: "Format string for bolus screen warning when no bolus is recommended due input value below glucose safety limit. (1: suspendThreshold)"), suspendThresholdString))
             )
         case .glucoseWarning:
-            let warningThresholdString = QuantityFormatter().string(from: LoopConstants.simpleBolusCalculatorGlucoseWarningLimit, for: displayGlucoseUnitObservable.displayGlucoseUnit)!
+            let warningThresholdString = formatGlucose(LoopConstants.simpleBolusCalculatorGlucoseWarningLimit)
             return WarningView(
                 title: Text("Low Glucose", comment: "Title for bolus screen warning when glucose is below glucose warning limit."),
                 caption: Text(String(format: NSLocalizedString("Your glucose is below %1$@. Are you sure you want to bolus?", comment: "Format string for simple bolus screen warning when glucose is below glucose warning limit."), warningThresholdString))
@@ -342,12 +324,31 @@ struct SimpleBolusView: View {
             if viewModel.displayMealEntry {
                 caption = NSLocalizedString("Your glucose is low. Eat carbs and consider waiting to bolus until your glucose is in a safe range.", comment: "Format string for meal bolus screen warning when no bolus is recommended due to glucose input value below recommendation threshold")
             } else {
-                caption = NSLocalizedString("Your glucose is low. Eat carbs and monitor closely.", comment: "Format string for bolus screen warning when no bolus is recommended due to glucose input value below recommendation threshold for meal bolus")
+                caption = NSLocalizedString("Your glucose is low. Eat carbs and monitor closely.", comment: "Bolus screen warning when no bolus is recommended due to glucose input value below recommendation threshold for meal bolus")
             }
             return WarningView(
-                title: Text("No Bolus Recommended", comment: "Title for bolus screen notice when no bolus is recommended"),
+                title: Text("No Bolus Recommended", comment: "Title for bolus screen warning when no bolus is recommended"),
                 caption: Text(caption)
             )
+        case .glucoseOutOfAllowedInputRange:
+            let glucoseMinString = formatGlucose(LoopConstants.validManualGlucoseEntryRange.lowerBound)
+            let glucoseMaxString = formatGlucose(LoopConstants.validManualGlucoseEntryRange.upperBound)
+            return WarningView(
+                title: Text("Glucose Entry Out of Range", comment: "Title for bolus screen warning when glucose entry is out of range"),
+                caption: Text(String(format: NSLocalizedString("A manual glucose entry must be between %1$@ and %2$@.", comment: "Warning for simple bolus when glucose entry is out of range. (1: upper bound) (2: lower bound)"), glucoseMinString, glucoseMaxString)))
+        case .maxBolusExceeded:
+            return WarningView(
+                title: Text("Maximum Bolus Exceeded", comment: "Title for bolus screen warning when max bolus is exceeded"),
+                caption: Text(String(format: NSLocalizedString("Your maximum bolus amount is %1$@.", comment: "Warning for simple bolus when max bolus is exceeded. (1: maximum bolus)"), viewModel.maximumBolusAmountString )))
+        case .recommendationExceedsMaxBolus:
+            return WarningView(
+                title: Text("Recommended Bolus Exceeds Maximum Bolus", comment: "Title for bolus screen warning when recommended bolus exceeds max bolus"),
+                caption: Text(String(format: NSLocalizedString("Your recommended bolus exceeds your maximum bolus amount of %1$@.", comment: "Warning for simple bolus when recommended bolus exceeds max bolus. (1: maximum bolus)"), viewModel.maximumBolusAmountString )))
+        case .carbohydrateEntryTooLarge:
+            let maximumCarbohydrateString = QuantityFormatter().string(from: LoopConstants.maxCarbEntryQuantity, for: .gram())!
+            return WarningView(
+                title: Text("Carbohydrate Entry Too Large", comment: "Title for bolus screen warning when carbohydrate entry is too large"),
+                caption: Text(String(format: NSLocalizedString("The maximum amount allowed is %1$@.", comment: "Warning for simple bolus when carbohydrate entry is too large. (1: maximum carbohydrate entry)"), maximumCarbohydrateString)))
         }
     }