Add carb entry override warning (#1892)

billybooth · web-flow · commit a12039736652 · 2023-01-10T11:56:14.000-06:00
If insulin needs are modified by an active override modified, present an appropriate warning cell.
diff --git a/Loop/View Controllers/CarbEntryViewController.swift b/Loop/View Controllers/CarbEntryViewController.swift
@@ -111,7 +111,31 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
     private var shouldDisplayAccurateCarbEntryWarning = false {
         didSet {
             if shouldDisplayAccurateCarbEntryWarning != oldValue {
-                self.displayAccuracyWarning()
+                if shouldDisplayOverrideEnabledWarning {
+                    self.displayWarningRow(rowType: WarningRow.carbEntry, isAddingRow: shouldDisplayAccurateCarbEntryWarning)
+                } else {
+                    self.shouldDisplayWarning = shouldDisplayAccurateCarbEntryWarning || shouldDisplayOverrideEnabledWarning
+                }
+            }
+        }
+    }
+    
+    private var shouldDisplayOverrideEnabledWarning = false {
+        didSet {
+            if shouldDisplayOverrideEnabledWarning != oldValue {
+                if shouldDisplayAccurateCarbEntryWarning {
+                    self.displayWarningRow(rowType: WarningRow.override, isAddingRow: shouldDisplayOverrideEnabledWarning)
+                } else {
+                    self.shouldDisplayWarning = shouldDisplayOverrideEnabledWarning || shouldDisplayAccurateCarbEntryWarning
+                }
+            }
+        }
+    }
+    
+    private var shouldDisplayWarning = false {
+        didSet {
+            if shouldDisplayWarning != oldValue {
+                self.displayWarning()
             }
         }
     }
@@ -183,18 +207,20 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
 
-        if shouldBeginEditingQuantity, let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.value.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayAccurateCarbEntryWarning))) as? DecimalTextFieldTableViewCell {
+        if shouldBeginEditingQuantity, let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.value.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayWarning))) as? DecimalTextFieldTableViewCell {
             shouldBeginEditingQuantity = false
             cell.textField.becomeFirstResponder()
         }
 
-        // check if the warning should be displayed
+        // check if either warning should be displayed
         updateDisplayAccurateCarbEntryWarning()
+        updateDisplayOverrideEnabledWarning()
         
         // monitor loop updates
         notificationObservers += [
             NotificationCenter.default.addObserver(forName: .LoopDataUpdated, object: deviceManager.loopManager, queue: nil) { [weak self] _ in
                 self?.updateDisplayAccurateCarbEntryWarning()
+                self?.updateDisplayOverrideEnabledWarning()
             }
         ]
     }
@@ -243,17 +269,46 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
         }
     }
     
-    private func displayAccuracyWarning() {
+    private func updateDisplayOverrideEnabledWarning() {
+        DispatchQueue.main.async {
+            if let managerSettings = self.deviceManager?.settings {
+                if !managerSettings.scheduleOverrideEnabled(at: Date()) {
+                    self.shouldDisplayOverrideEnabledWarning = false
+                } else if let overrideSettings = managerSettings.scheduleOverride?.settings {
+                    self.shouldDisplayOverrideEnabledWarning = overrideSettings.effectiveInsulinNeedsScaleFactor != 1.0
+                }
+            }
+        }
+    }
+    
+    private func displayWarning() {
         tableView.beginUpdates()
 
-        if shouldDisplayAccurateCarbEntryWarning {
+        if shouldDisplayWarning {
             tableView.insertSections([Sections.warning.rawValue], with: .top)
         } else {
             tableView.deleteSections([Sections.warning.rawValue], with: .top)
         }
         
         tableView.endUpdates()
     }
+    
+    private func displayWarningRow(rowType: WarningRow, isAddingRow: Bool = true ) {
+        if shouldDisplayWarning {
+            tableView.beginUpdates()
+            
+            // If the accurate carb entry warning is shown, use the positional index of the given row type.
+            let rowIndex = shouldDisplayAccurateCarbEntryWarning ? rowType.rawValue : 0
+            
+            if isAddingRow {
+                tableView.insertRows(at: [IndexPath(row: rowIndex, section: Sections.warning.rawValue)], with: UITableView.RowAnimation.top)
+            } else {
+                tableView.deleteRows(at: [IndexPath(row: rowIndex, section: Sections.warning.rawValue)], with: UITableView.RowAnimation.top)
+            }
+            
+            tableView.endUpdates()
+        }
+    }
 
     // MARK: - Table view data source
     fileprivate enum Sections: Int, CaseIterable {
@@ -272,9 +327,9 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
             return displayWarningSection ? indexPath.section : indexPath.section + 1
         }
         
-        static func numberOfRows(for section: Int, displayWarningSection: Bool) -> Int {
-            if section == Sections.warning.rawValue && displayWarningSection {
-                return 1
+        static func numberOfRows(for section: Int, displayCarbEntryWarning: Bool, displayOverrideWarning: Bool) -> Int {
+            if section == Sections.warning.rawValue && (displayCarbEntryWarning || displayOverrideWarning) {
+                return displayCarbEntryWarning && displayOverrideWarning ? WarningRow.allCases.count : WarningRow.allCases.count - 1
             }
 
             return DetailsRow.allCases.count
@@ -307,32 +362,54 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
         case foodType
         case absorptionTime
     }
+    
+    fileprivate enum WarningRow: Int, CaseIterable {
+        case carbEntry
+        case override
+    }
 
     override func numberOfSections(in tableView: UITableView) -> Int {
-        return Sections.numberOfSections(displayWarningSection: shouldDisplayAccurateCarbEntryWarning)
+        return Sections.numberOfSections(displayWarningSection: shouldDisplayWarning)
     }
 
     override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
-        return Sections.numberOfRows(for: section, displayWarningSection: shouldDisplayAccurateCarbEntryWarning)
+        return Sections.numberOfRows(for: section, displayCarbEntryWarning: shouldDisplayAccurateCarbEntryWarning, displayOverrideWarning: shouldDisplayOverrideEnabledWarning)
     }
 
     override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
-        switch Sections(rawValue: Sections.section(for: indexPath, displayWarningSection: shouldDisplayAccurateCarbEntryWarning))! {
+        switch Sections(rawValue: Sections.section(for: indexPath, displayWarningSection: shouldDisplayWarning))! {
         case .warning:
             let cell: UITableViewCell
-            if let existingCell = tableView.dequeueReusableCell(withIdentifier: "CarbEntryAccuracyWarningCell") {
-                cell = existingCell
+            // if no accurate carb entry warning should be shown OR if the given indexPath is for the override warning row, return the override warning cell.
+            if !shouldDisplayAccurateCarbEntryWarning || WarningRow(rawValue: indexPath.row)! == .override {
+                if let existingCell = tableView.dequeueReusableCell(withIdentifier: "CarbEntryOverrideEnabledWarningCell") {
+                    cell = existingCell
+                } else {
+                    cell = UITableViewCell(style: .default, reuseIdentifier: "CarbEntryOverrideEnabledWarningCell")
+                }
+                
+                cell.imageView?.image = UIImage(systemName: "exclamationmark.triangle.fill")
+                cell.imageView?.tintColor = .warning
+                cell.textLabel?.numberOfLines = 0
+                cell.textLabel?.text = NSLocalizedString("An active override is modifying your carb ratio and insulin sensitivity. If you don't want this to affect your bolus calculation and projected glucose, consider turning off the override.", comment: "Warning to ensure the carb entry is accurate during an override")
+                cell.textLabel?.font = UIFont.preferredFont(forTextStyle: .caption1)
+                cell.textLabel?.textColor = .secondaryLabel
+                cell.isUserInteractionEnabled = false
             } else {
-                cell = UITableViewCell(style: .default, reuseIdentifier: "CarbEntryAccuracyWarningCell")
+                if let existingCell = tableView.dequeueReusableCell(withIdentifier: "CarbEntryAccuracyWarningCell") {
+                    cell = existingCell
+                } else {
+                    cell = UITableViewCell(style: .default, reuseIdentifier: "CarbEntryAccuracyWarningCell")
+                }
+                
+                cell.imageView?.image = UIImage(systemName: "exclamationmark.triangle.fill")
+                cell.imageView?.tintColor = .destructive
+                cell.textLabel?.numberOfLines = 0
+                cell.textLabel?.text = NSLocalizedString("Your glucose is rapidly rising. Check that any carbs you've eaten were logged. If you logged carbs, check that the time you entered lines up with when you started eating.", comment: "Warning to ensure the carb entry is accurate")
+                cell.textLabel?.font = UIFont.preferredFont(forTextStyle: .caption1)
+                cell.textLabel?.textColor = .secondaryLabel
+                cell.isUserInteractionEnabled = false
             }
-            
-            cell.imageView?.image = UIImage(systemName: "exclamationmark.triangle.fill")
-            cell.imageView?.tintColor = .destructive
-            cell.textLabel?.numberOfLines = 0
-            cell.textLabel?.text = NSLocalizedString("Your glucose is rapidly rising. Check that any carbs you've eaten were logged. If you logged carbs, check that the time you entered lines up with when you started eating.", comment: "Warning to ensure the carb entry is accurate")
-            cell.textLabel?.font = UIFont.preferredFont(forTextStyle: .caption1)
-            cell.textLabel?.textColor = .secondaryLabel
-            cell.isUserInteractionEnabled = false
             return cell
         case .details:
             switch DetailsRow(rawValue: indexPath.row)! {
@@ -415,7 +492,7 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
     }
 
     override func tableView(_ tableView: UITableView, willDisplay cell: UITableViewCell, forRowAt indexPath: IndexPath) {
-        switch Sections(rawValue: Sections.section(for: indexPath, displayWarningSection: shouldDisplayAccurateCarbEntryWarning)) {
+        switch Sections(rawValue: Sections.section(for: indexPath, displayWarningSection: shouldDisplayWarning)) {
         case .details:
             switch DetailsRow(rawValue: indexPath.row)! {
             case .value, .date:
@@ -434,15 +511,15 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
     }
 
     override func tableView(_ tableView: UITableView, titleForFooterInSection section: Int) -> String? {
-        return Sections.footer(for: section, displayWarningSection: shouldDisplayAccurateCarbEntryWarning)
+        return Sections.footer(for: section, displayWarningSection: shouldDisplayWarning)
     }
     
     override func tableView(_ tableView: UITableView, heightForHeaderInSection section: Int) -> CGFloat {
-        return Sections.headerHeight(for: section, displayWarningSection: shouldDisplayAccurateCarbEntryWarning)
+        return Sections.headerHeight(for: section, displayWarningSection: shouldDisplayWarning)
     }
     
     override func tableView(_ tableView: UITableView, heightForFooterInSection section: Int) -> CGFloat {
-        return Sections.footerHeight(for: section, displayWarningSection: shouldDisplayAccurateCarbEntryWarning)
+        return Sections.footerHeight(for: section, displayWarningSection: shouldDisplayWarning)
     }
     
     // MARK: - UITableViewDelegate
@@ -459,7 +536,7 @@ final class CarbEntryViewController: LoopChartsTableViewController, Identifiable
         case is FoodTypeShortcutCell:
             usesCustomFoodType = true
             shouldBeginEditingFoodType = true
-            tableView.reloadRows(at: [IndexPath(row: DetailsRow.foodType.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayAccurateCarbEntryWarning))], with: .none)
+            tableView.reloadRows(at: [IndexPath(row: DetailsRow.foodType.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayWarning))], with: .none)
         default:
             break
         }
@@ -686,14 +763,14 @@ extension CarbEntryViewController: FoodTypeShortcutCellDelegate {
             tableView.beginUpdates()
             usesCustomFoodType = true
             shouldBeginEditingFoodType = true
-            tableView.reloadRows(at: [IndexPath(row: DetailsRow.foodType.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayAccurateCarbEntryWarning))], with: .fade)
+            tableView.reloadRows(at: [IndexPath(row: DetailsRow.foodType.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayWarning))], with: .fade)
             tableView.endUpdates()
         }
 
         if let absorptionTime = absorptionTime {
             self.absorptionTime = absorptionTime
 
-            if let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.absorptionTime.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayAccurateCarbEntryWarning))) as? DateAndDurationTableViewCell {
+            if let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.absorptionTime.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayWarning))) as? DateAndDurationTableViewCell {
                 cell.duration = absorptionTime
             }
         }
@@ -705,7 +782,7 @@ extension CarbEntryViewController: FoodTypeShortcutCellDelegate {
 
 extension CarbEntryViewController: EmojiInputControllerDelegate {
     func emojiInputControllerDidAdvanceToStandardInputMode(_ controller: EmojiInputController) {
-        if let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.foodType.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayAccurateCarbEntryWarning))) as? TextFieldTableViewCell, let textField = cell.textField as? CustomInputTextField, textField.customInput != nil {
+        if let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.foodType.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayWarning))) as? TextFieldTableViewCell, let textField = cell.textField as? CustomInputTextField, textField.customInput != nil {
             let customInput = textField.customInput
             textField.customInput = nil
             textField.resignFirstResponder()
@@ -723,7 +800,7 @@ extension CarbEntryViewController: EmojiInputControllerDelegate {
             // only adjust the absorption time if it wasn't already set.
             absorptionTime = orderedAbsorptionTimes[section]
             
-            if let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.absorptionTime.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayAccurateCarbEntryWarning))) as? DateAndDurationTableViewCell {
+            if let cell = tableView.cellForRow(at: IndexPath(row: DetailsRow.absorptionTime.rawValue, section: Sections.indexForDetailsSection(displayWarningSection: shouldDisplayWarning))) as? DateAndDurationTableViewCell {
                 cell.duration = orderedAbsorptionTimes[section]
             }
         }
