Merge pull request #558 from tidepool-org/cameron/LOOP-4596-scenario-organization

[LOOP-4596] Scenario Organization

Author: Camji55

Loop/Managers/Alerts/AlertManager.swift

@@ -782,7 +782,7 @@ extension AlertManager {
         let alert = UIAlertController(title: "New Study Product Detected", message: "We've detected a new study product is selected. In order to show use this study product, Tidepool Loop will need to restart.", preferredStyle: .alert)
         alert.addAction(UIAlertAction(title: "Confirm", style: .default, handler: { _ in
             confirmAction()
-            exit(0)
+            fatalError("DEBUG: Resetting Loop")
         }))
         alert.addAction(UIAlertAction(title: "Cancel", style: .cancel))
 

Loop/Managers/LocalTestingScenariosManager.swift

@@ -30,6 +30,10 @@ final class LocalTestingScenariosManager: TestingScenariosManagerRequirements, D
             delegate?.testingScenariosManager(self, didUpdateScenarioURLs: scenarioURLs)
         }
     }
+    
+    var pluginManager: PluginManager {
+        deviceManager.pluginManager
+    }
 
     init(deviceManager: DeviceDataManager) {
         guard FeatureFlags.scenariosEnabled else {
@@ -63,7 +67,6 @@ final class LocalTestingScenariosManager: TestingScenariosManagerRequirements, D
         do {
             let scenarioURLs = try fileManager.contentsOfDirectory(at: scenariosSource, includingPropertiesForKeys: nil)
                 .filter { $0.pathExtension == "json" }
-                .sorted(by: { $0.lastPathComponent < $1.lastPathComponent })
             self.scenarioURLs = scenarioURLs
             delegate?.testingScenariosManager(self, didUpdateScenarioURLs: scenarioURLs)
             log.debug("Reloaded scenario URLs")

Loop/Managers/LoopAppManager.swift

@@ -370,45 +370,14 @@ class LoopAppManager: NSObject {
         return false
     }
 
-    private func resetLoop() {
-        deviceDataManager.pumpManager?.prepareForDeactivation({ _ in })
-        
-        resetLoopUserDefaults()
-        resetLoopDocuments()
-    }
-    
-    private func resetLoopUserDefaults() {
-        // Store values to persist
-        let allowDebugFeatures = UserDefaults.appGroup?.allowDebugFeatures
-        let studyProductSelection = UserDefaults.appGroup?.studyProductSelection
-        
-        // Wipe away whole domain
-        UserDefaults.appGroup?.removePersistentDomain(forName: Bundle.main.appGroupSuiteName)
-        
-        // Restore values to persist
-        UserDefaults.appGroup?.allowDebugFeatures = allowDebugFeatures ?? false
-        UserDefaults.appGroup?.studyProductSelection = studyProductSelection
-    }
-    
-    private func resetLoopDocuments() {
-        let appGroup = Bundle.main.appGroupSuiteName
-        guard let directoryURL = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: appGroup) else {
-            preconditionFailure("Could not get a container directory URL. Please ensure App Groups are set up correctly in entitlements.")
-        }
-        
-        let documents: URL = directoryURL.appendingPathComponent("com.loopkit.LoopKit", isDirectory: true)
-        try? FileManager.default.removeItem(at: documents)
-        
-        guard let localDocuments = try? FileManager.default.url(for: .documentDirectory, in: .userDomainMask, appropriateFor: nil, create: true) else {
-            preconditionFailure("Could not get a documents directory URL.")
-        }
-        try? FileManager.default.removeItem(at: localDocuments)
-    }
-    
     func askUserToConfirmCrashIfNecessary() {
-        if UserDefaults.appGroup?.resetLoop == true {
-            alertManager.presentConfirmCrashAlert() { [weak self] in
-                self?.resetLoop()
+        deviceDataManager.pluginManager.availableSupports.forEach { supportUI in
+            if supportUI.loopNeedsReset {
+                supportUI.loopNeedsReset = false
+                alertManager.presentConfirmCrashAlert() { [weak self] in
+                    self?.deviceDataManager.pumpManager?.prepareForDeactivation({ _ in })
+                    supportUI.resetLoop()
+                }
             }
         }
     }

Loop/Managers/OnboardingManager.swift

@@ -435,7 +435,12 @@ extension OnboardingManager: TherapySettingsProvider {
 
 extension OnboardingManager: OnboardingProvider {
     var allowDebugFeatures: Bool { FeatureFlags.allowDebugFeatures }   // NOTE: DEBUG FEATURES - DEBUG AND TEST ONLY
-    var studyProductSelection: StudyProduct { StudyProduct(rawValue: UserDefaults.appGroup?.studyProductSelection ?? "none") ?? .none }
+}
+
+// MARK: - SupportProvider
+
+extension OnboardingManager: SupportProvider {
+    var availableSupports: [SupportUI] { deviceDataManager.pluginManager.availableSupports }
 }
 
 // MARK: - OnboardingUI

Loop/Managers/TestingScenariosManager.swift

@@ -18,6 +18,7 @@ protocol TestingScenariosManager: AnyObject {
     var delegate: TestingScenariosManagerDelegate? { get set }
     var activeScenarioURL: URL? { get }
     var scenarioURLs: [URL] { get }
+    var pluginManager: PluginManager { get }
     func loadScenario(from url: URL, completion: @escaping (Error?) -> Void)
     func loadScenario(from url: URL, advancedByLoopIterations iterations: Int, completion: @escaping (Error?) -> Void)
     func loadScenario(from url: URL, rewoundByLoopIterations iterations: Int, completion: @escaping (Error?) -> Void)

Loop/View Controllers/TestingScenariosTableViewController.swift

@@ -14,9 +14,10 @@ final class TestingScenariosTableViewController: RadioSelectionTableViewControll
 
     private let scenariosManager: TestingScenariosManager
 
-    private var scenarioURLs: [URL] = [] {
+    private var scenarios: [LoopScenario] = [] {
         didSet {
-            options = scenarioURLs.map { $0.deletingPathExtension().lastPathComponent }
+            options = scenarios.map(\.name)
+            
             if isViewLoaded {
                 DispatchQueue.main.async {
                     self.updateLoadButtonEnabled()
@@ -58,14 +59,14 @@ final class TestingScenariosTableViewController: RadioSelectionTableViewControll
         contextHelp = "The scenarios directory location is available in the debug output of the Xcode console."
 
         if let activeScenarioURL = scenariosManager.activeScenarioURL {
-            selectedIndex = scenarioURLs.firstIndex(of: activeScenarioURL)
+            selectedIndex = scenarios.firstIndex(where: { $0.url == activeScenarioURL })
         }
 
         updateLoadButtonEnabled()
     }
 
     override func tableView(_ tableView: UITableView, leadingSwipeActionsConfigurationForRowAt indexPath: IndexPath) -> UISwipeActionsConfiguration? {
-        let url = scenarioURLs[indexPath.row]
+        let url = scenarios[indexPath.row].url
 
         let rewindScenario = contextualAction(
             rowTitle: "⏮ Rewind",
@@ -79,7 +80,7 @@ final class TestingScenariosTableViewController: RadioSelectionTableViewControll
     }
 
     override func tableView(_ tableView: UITableView, trailingSwipeActionsConfigurationForRowAt indexPath: IndexPath) -> UISwipeActionsConfiguration? {
-        let url = scenarioURLs[indexPath.row]
+        let url = scenarios[indexPath.row].url
 
         let advanceScenario = contextualAction(
             rowTitle: "Advance ⏭",
@@ -130,7 +131,7 @@ final class TestingScenariosTableViewController: RadioSelectionTableViewControll
     }
 
     private func updateLoadButtonEnabled() {
-        loadButtonItem.isEnabled = !scenarioURLs.isEmpty && selectedIndex != nil
+        loadButtonItem.isEnabled = !scenarios.isEmpty && selectedIndex != nil
     }
 
     @objc private func loadSelectedScenario() {
@@ -139,7 +140,7 @@ final class TestingScenariosTableViewController: RadioSelectionTableViewControll
             return
         }
 
-        let url = scenarioURLs[selectedIndex]
+        let url = scenarios[selectedIndex].url
 
         loadButtonItem.isEnabled = false
         loadButtonItem.title = "Loading..."
@@ -163,6 +164,13 @@ final class TestingScenariosTableViewController: RadioSelectionTableViewControll
 
 extension TestingScenariosTableViewController: TestingScenariosManagerDelegate {
     func testingScenariosManager(_ manager: TestingScenariosManager, didUpdateScenarioURLs scenarioURLs: [URL]) {
-        self.scenarioURLs = scenarioURLs
+        var filteredScenarios = Set<LoopScenario>()
+        manager.pluginManager.availableSupports.forEach { supportUI in
+            supportUI.getScenarios(from: scenarioURLs).forEach { scenario in
+                filteredScenarios.insert(scenario)
+            }
+        }
+        
+        self.scenarios = Array(filteredScenarios).sorted(by: { $0.name < $1.name })
     }
 }

LoopCore/NSUserDefaults.swift

@@ -20,8 +20,6 @@ extension UserDefaults {
         case lastProfileExpirationAlertDate = "com.loopkit.Loop.lastProfileExpirationAlertDate"
         case allowDebugFeatures = "com.loopkit.Loop.allowDebugFeatures"
         case allowSimulators = "com.loopkit.Loop.allowSimulators"
-        case studyProductSelection = "com.loopkit.Loop.studyProductSelection"
-        case resetLoop = "com.loopkit.Loop.resetLoop"
     }
 
     public static let appGroup = UserDefaults(suiteName: Bundle.main.appGroupSuiteName)
@@ -128,24 +126,6 @@ extension UserDefaults {
     public var allowSimulators: Bool {
         return bool(forKey: Key.allowSimulators.rawValue)
     }
-    
-    public var studyProductSelection: String? {
-        get {
-            string(forKey: Key.studyProductSelection.rawValue)
-        }
-        set {
-            set(newValue, forKey: Key.studyProductSelection.rawValue)
-        }
-    }
-    
-    public var resetLoop: Bool {
-        get {
-            bool(forKey: Key.resetLoop.rawValue)
-        }
-        set {
-            setValue(newValue, forKey: Key.resetLoop.rawValue)
-        }
-    }
 
     public func removeLegacyLoopSettings() {
         removeObject(forKey: "com.loudnate.Naterade.BasalRateSchedule")