Localize loop error messages (#781)

* Localize loop error messages

* Refactor error strings into enums to separate out presentation concerns and avoid duplication

Author: ps2

Loop/Managers/DeviceDataManager.swift

@@ -311,7 +311,7 @@ extension DeviceDataManager: DoseStoreDelegate {
 extension DeviceDataManager {
     func enactBolus(units: Double, at startDate: Date = Date(), completion: @escaping (_ error: Error?) -> Void) {
         guard let pumpManager = pumpManager else {
-            completion(LoopError.configurationError("Pump Manager"))
+            completion(LoopError.configurationError(.pumpManager))
             return
         }
 
@@ -338,7 +338,7 @@ extension DeviceDataManager: LoopDataManagerDelegate {
         completion: @escaping (_ result: Result<DoseEntry>) -> Void
     ) {
         guard let pumpManager = pumpManager else {
-            completion(.failure(LoopError.configurationError("Pump Manager")))
+            completion(.failure(LoopError.configurationError(.pumpManager)))
             return
         }
 

Loop/Managers/LoopDataManager.swift

@@ -612,7 +612,7 @@ extension LoopDataManager {
         _ = updateGroup.wait(timeout: .distantFuture)
 
         guard let lastGlucoseDate = latestGlucoseDate else {
-            throw LoopError.missingDataError(details: "Glucose data not available", recovery: "Check your CGM data source")
+            throw LoopError.missingDataError(.glucose)
         }
 
         let retrospectiveStart = lastGlucoseDate.addingTimeInterval(-settings.retrospectiveCorrectionInterval)
@@ -738,7 +738,7 @@ extension LoopDataManager {
         dispatchPrecondition(condition: .onQueue(dataAccessQueue))
 
         guard let basalRates = basalRateSchedule else {
-            throw LoopError.configurationError("Basal Rate Schedule")
+            throw LoopError.configurationError(.basalRateSchedule)
         }
 
         let pendingTempBasalInsulin: Double
@@ -765,11 +765,11 @@ extension LoopDataManager {
         dispatchPrecondition(condition: .onQueue(dataAccessQueue))
 
         guard let model = insulinModelSettings?.model else {
-            throw LoopError.configurationError("Check settings")
+            throw LoopError.configurationError(.insulinModel)
         }
 
         guard let glucose = self.glucoseStore.latestGlucose else {
-            throw LoopError.missingDataError(details: "Cannot predict glucose due to missing input data", recovery: "Check your CGM data source")
+            throw LoopError.missingDataError(.glucose)
         }
 
         var momentum: [GlucoseEffect] = []
@@ -810,13 +810,15 @@ extension LoopDataManager {
      */
     private func updateRetrospectiveGlucoseEffect(effectDuration: TimeInterval = TimeInterval(minutes: 60)) throws {
         dispatchPrecondition(condition: .onQueue(dataAccessQueue))
+        
+        guard let carbEffect = self.carbEffect else {
+            self.retrospectivePredictedGlucose = nil
+            throw LoopError.missingDataError(.carbEffect)
+        }
 
-        guard
-            let carbEffect = self.carbEffect,
-            let insulinEffect = self.insulinEffect
-        else {
+        guard let insulinEffect = self.insulinEffect else {
             self.retrospectivePredictedGlucose = nil
-            throw LoopError.missingDataError(details: "Cannot retrospect glucose due to missing input data", recovery: nil)
+            throw LoopError.missingDataError(.insulinEffect)
         }
 
         guard let change = retrospectiveGlucoseChange else {
@@ -858,12 +860,12 @@ extension LoopDataManager {
 
         guard let glucose = glucoseStore.latestGlucose else {
             self.predictedGlucose = nil
-            throw LoopError.missingDataError(details: "Glucose", recovery: "Check your CGM data source")
+            throw LoopError.missingDataError(.glucose)
         }
 
         guard let pumpStatusDate = doseStore.lastReservoirValue?.startDate else {
             self.predictedGlucose = nil
-            throw LoopError.missingDataError(details: "Reservoir", recovery: "Check that your pump is in range")
+            throw LoopError.missingDataError(.reservoir)
         }
 
         let startDate = Date()
@@ -880,17 +882,17 @@ extension LoopDataManager {
 
         guard glucoseMomentumEffect != nil else {
             self.predictedGlucose = nil
-            throw LoopError.missingDataError(details: "Momentum effects", recovery: nil)
+            throw LoopError.missingDataError(.momentumEffect)
         }
 
         guard carbEffect != nil else {
             self.predictedGlucose = nil
-            throw LoopError.missingDataError(details: "Carb effects", recovery: nil)
+            throw LoopError.missingDataError(.carbEffect)
         }
 
         guard insulinEffect != nil else {
             self.predictedGlucose = nil
-            throw LoopError.missingDataError(details: "Insulin effects", recovery: nil)
+            throw LoopError.missingDataError(.insulinEffect)
         }
 
         let predictedGlucose = try predictGlucose(using: settings.enabledEffects)
@@ -904,7 +906,7 @@ extension LoopDataManager {
             let maxBolus = settings.maximumBolus,
             let model = insulinModelSettings?.model
         else {
-            throw LoopError.configurationError("Check settings")
+            throw LoopError.configurationError(.generalSettings)
         }
 
         guard lastRequestedBolus == nil

Loop/Models/LoopError.swift

@@ -9,19 +9,76 @@
 import Foundation
 import LoopKit
 
+enum ConfigurationErrorDetail {
+    case pumpManager
+    case basalRateSchedule
+    case insulinModel
+    case generalSettings
+    
+    func localized() -> String {
+        switch self {
+        case .pumpManager:
+            return NSLocalizedString("Pump Manager", comment: "Details for configuration error when pump manager is missing")
+        case .basalRateSchedule:
+            return NSLocalizedString("Basal Rate Schedule", comment: "Details for configuration error when basal rate schedule is missing")
+        case .insulinModel:
+            return NSLocalizedString("Insulin Model", comment: "Details for configuration error when insulin model is missing")
+        case .generalSettings:
+            return NSLocalizedString("Check settings", comment: "Details for configuration error when one or more loop settings are missing")
+        }
+    }
+}
+
+enum MissingDataErrorDetail {
+    case glucose
+    case reservoir
+    case momentumEffect
+    case carbEffect
+    case insulinEffect
+    
+    var localizedDetail: String {
+        switch self {
+        case .glucose:
+            return NSLocalizedString("Glucose data not available", comment: "Description of error when glucose data is missing")
+        case .reservoir:
+            return NSLocalizedString("Reservoir", comment: "Details for missing data error when reservoir data is missing")
+        case .momentumEffect:
+            return NSLocalizedString("Momentum effects", comment: "Details for missing data error when momentum effects are missing")
+        case .carbEffect:
+            return NSLocalizedString("Carb effects", comment: "Details for missing data error when carb effects are missing")
+        case .insulinEffect:
+            return NSLocalizedString("Insulin effects", comment: "Details for missing data error when insulin effects are missing")
+        }
+    }
+    
+    var localizedRecovery: String? {
+        switch self {
+        case .glucose:
+            return NSLocalizedString("Check your CGM data source", comment: "Recovery suggestion when glucose data is missing")
+        case .reservoir:
+            return NSLocalizedString("Check that your pump is in range", comment: "Recovery suggestion when reservoir data is missing")
+        case .momentumEffect:
+            return nil
+        case .carbEffect:
+            return nil
+        case .insulinEffect:
+            return nil
+        }
+    }
+}
 
 enum LoopError: Error {
     // A bolus failed to start
     case bolusCommand(SetBolusError)
 
     // Missing or unexpected configuration values
-    case configurationError(String)
+    case configurationError(ConfigurationErrorDetail)
 
     // No connected devices, or failure during device connection
     case connectionError
 
     // Missing data required to perform an action
-    case missingDataError(details: String, recovery: String?)
+    case missingDataError(MissingDataErrorDetail)
 
     // Glucose data is too old to perform action
     case glucoseTooOld(date: Date)
@@ -41,8 +98,8 @@ extension LoopError: LocalizedError {
 
     public var recoverySuggestion: String? {
         switch self {
-        case .missingDataError(_, let recovery):
-            return recovery;
+        case .missingDataError(let detail):
+            return detail.localizedRecovery;
         default:
             return nil;
         }
@@ -57,11 +114,11 @@ extension LoopError: LocalizedError {
         case .bolusCommand(let error):
             return error.errorDescription
         case .configurationError(let details):
-            return String(format: NSLocalizedString("Configuration Error: %1$@", comment: "The error message displayed for configuration errors. (1: configuration error details)"), details)
+            return String(format: NSLocalizedString("Configuration Error: %1$@", comment: "The error message displayed for configuration errors. (1: configuration error details)"), details.localized())
         case .connectionError:
             return NSLocalizedString("No connected devices, or failure during device connection", comment: "The error message displayed for device connection errors.")
-        case .missingDataError(let details, _):
-            return String(format: NSLocalizedString("Missing data: %1$@", comment: "The error message for missing data. (1: missing data details)"), details)
+        case .missingDataError(let details):
+            return String(format: NSLocalizedString("Missing data: %1$@", comment: "The error message for missing data. (1: missing data details)"), details.localizedDetail)
         case .glucoseTooOld(let date):
             let minutes = formatter.string(from: -date.timeIntervalSinceNow) ?? ""
             return String(format: NSLocalizedString("Glucose data is %1$@ old", comment: "The error message when glucose data is too old to be used. (1: glucose data age in minutes)"), minutes)