Update Release Notes and Re-Enable Periphery & CodeQL (#125)

# Update Release Notes and Re-Enable Periphery & CodeQL ## ⚙️ Release Notes - Update Release Notes and Re-Enable Periphery ### Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md).
StanfordBDHG · Jan 11, 2025 · d8903d6 · d8903d6
1 parent 5c57ffd
commit d8903d6
Show file tree

Hide file tree

Showing 30 changed files with 110 additions and 145 deletions.
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -28,15 +28,26 @@ jobs:
     uses: StanfordBDHG/.github/.github/workflows/swiftlint.yml@v2
     permissions:
       contents: read
-  # periphery:
-  #   name: Periphery
-  #   uses: StanfordBDHG/.github/.github/workflows/periphery.yml@v2
-  #   permissions:
-  #     contents: read
-  #   with:
-  #     runsonlabels: '["macOS", "self-hosted"]'
+  periphery:
+    name: Periphery
+    uses: StanfordBDHG/.github/.github/workflows/periphery.yml@v2
+    permissions:
+      contents: read
+    with:
+      runsonlabels: '["macOS", "self-hosted"]'
   markdownlinkcheck:
     name: Markdown Link Check
     uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@v2
     permissions:
       contents: read
+  # codeql:
+  #   name: CodeQL
+  #   uses: StanfordBDHG/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
+  #   permissions:
+  #     security-events: write
+  #     actions: read
+  #     contents: read
+  #   with:
+  #     codeql: true
+  #     fastlanelane: codeql
+
diff --git a/.periphery.yml b/.periphery.yml
@@ -9,7 +9,3 @@
 project: ENGAGEHF.xcodeproj
 schemes:
 - ENGAGEHF
-targets:
-- ENGAGEHF
-- ENGAGEHFTests
-- ENGAGEHFUITests
diff --git a/ENGAGEHF/ENGAGEHFStandard.swift b/ENGAGEHF/ENGAGEHFStandard.swift
@@ -23,12 +23,11 @@ import SwiftUI
 
 
 actor ENGAGEHFStandard: Standard, EnvironmentAccessible {
-    @Application(\.logger) private var logger
-
     @Dependency(Account.self) private var account: Account?
-    @Dependency(FirebaseAccountService.self) private var accountService: FirebaseAccountService?
-
-
+
+    @Application(\.logger) private var logger
+
+
     private var accountId: String {
         get async throws {
             guard let details = await account?.details else {

diff --git a/ENGAGEHF/HeartHealth/HeartHealth.swift b/ENGAGEHF/HeartHealth/HeartHealth.swift
@@ -14,7 +14,6 @@ struct HeartHealth: View {
     @Binding var presentingAccount: Bool
 
     @Environment(NavigationManager.self) private var navigationManager
-    @Environment(VitalsManager.self) private var vitalsManager
 
 
     var body: some View {

diff --git a/ENGAGEHF/HeartHealth/SelectionTypes/GraphSelection.swift b/ENGAGEHF/HeartHealth/SelectionTypes/GraphSelection.swift
@@ -51,27 +51,6 @@ enum GraphSelection: CaseIterable, Identifiable, CustomStringConvertible, Equata
         }
     }
 
-
-    init(collectionRef: CollectionReference?, for accountId: String) throws {
-        switch collectionRef {
-        case Firestore.symptomScoresCollectionReference(for: accountId):
-            self = .symptoms
-        case Firestore.collectionReference(for: accountId, type: HKQuantityType(.bodyMass)):
-            self = .weight
-        case Firestore.collectionReference(for: accountId, type: HKQuantityType(.heartRate)):
-            self = .heartRate
-        case Firestore.collectionReference(for: accountId, type: HKCorrelationType(.bloodPressure)):
-            self = .bloodPressure
-        default:
-            throw DecodingError.valueNotFound(
-                CollectionReference.self,
-                .init(
-                    codingPath: [],
-                    debugDescription: "No collection matches given reference."
-                )
-            )
-        }
-    }
 
     func collectionReference(for accountId: String) -> CollectionReference? {
         switch self {

diff --git a/ENGAGEHF/HeartHealth/SelectionTypes/SymptomsType.swift b/ENGAGEHF/HeartHealth/SelectionTypes/SymptomsType.swift
@@ -49,10 +49,6 @@ enum SymptomsType: String, CaseIterable, Identifiable, CustomStringConvertible,
         }
     }
 
-    var localizedEmptyHistoryWarning: String {
-        GraphSelection.symptoms.localizedEmptyHistoryWarning
-    }
-
     /// The localized description of the symptoms score
     var localizedExplanation: String {
         switch self {

diff --git a/ENGAGEHF/HeartHealth/SelectionTypes/VitalsType.swift b/ENGAGEHF/HeartHealth/SelectionTypes/VitalsType.swift
@@ -24,10 +24,6 @@ enum VitalsType: CustomStringConvertible {
         }
     }
 
-    var localizedEmptyHistoryWarning: String {
-        graphType.localizedEmptyHistoryWarning
-    }
-
     /// The localized description of the vitals type
     var localizedExplanation: String {
         switch self {

diff --git a/ENGAGEHF/HeartHealth/Shared/VitalsGraph/DataTypes/SeriesTarget.swift b/ENGAGEHF/HeartHealth/Shared/VitalsGraph/DataTypes/SeriesTarget.swift
@@ -11,7 +11,5 @@ import Foundation
 
 struct SeriesTarget {
     let value: Double
-    let unit: String
-    let date: Date
     let label: String
 }
diff --git a/ENGAGEHF/HeartHealth/Shared/VitalsGraph/Extensions/Double+Rounding.swift b/ENGAGEHF/HeartHealth/Shared/VitalsGraph/Extensions/Double+Rounding.swift
@@ -23,9 +23,4 @@ extension Double {
 
         return target * (((self + offsetSign * offsetMagnitude) / target).rounded(rule))
     }
-
-    /// Rounds `self` to the nearest multiple of the given target, in the direction determedin by the given rule.
-    func roundedToNearestMultipleOf(_ target: Double, rule: FloatingPointRoundingRule = .up) -> Self {
-        self.roundedToNthMultipleOf(target, skipping: 0, rule: rule)
-    }
 }
diff --git a/ENGAGEHF/HeartHealth/Shared/VitalsGraph/VitalsGraph.swift b/ENGAGEHF/HeartHealth/Shared/VitalsGraph/VitalsGraph.swift
@@ -13,7 +13,6 @@ import SwiftUI
 
 struct VitalsGraph: View {
     let data: SeriesDictionary
-    let targetValue: SeriesTarget?
     let options: VitalsGraphOptions
 
     @State private var viewModel = ViewModel()
@@ -35,9 +34,8 @@ struct VitalsGraph: View {
     }
 
 
-    init(data: SeriesDictionary, target: SeriesTarget? = nil, options: VitalsGraphOptions = .defaultOptions) {
+    init(data: SeriesDictionary, options: VitalsGraphOptions = .defaultOptions) {
         self.data = data
-        self.targetValue = target
         self.options = options
     }
 }

diff --git a/ENGAGEHF/HeartHealth/Vitals/HKSampleGraph/HKSampleGraph+ViewModel.swift b/ENGAGEHF/HeartHealth/Vitals/HKSampleGraph/HKSampleGraph+ViewModel.swift
@@ -28,7 +28,7 @@ extension HKSampleGraph {
                 return
             }
 
-            guard let (hkUnits, unitString) = getUnits(data: [target]) else {
+            guard let (hkUnits, _) = getUnits(data: [target]) else {
                 self.targetValue = nil
                 return
             }
@@ -39,8 +39,6 @@ extension HKSampleGraph {
                 case HKQuantityTypeIdentifier.bodyMass.rawValue:
                     self.targetValue = SeriesTarget(
                         value: quantitySample.quantity.doubleValue(for: hkUnits),
-                        unit: unitString,
-                        date: quantitySample.startDate,
                         label: "Dry Weight"
                     )
                 default:

diff --git a/ENGAGEHF/HeartHealth/VitalsList.swift b/ENGAGEHF/HeartHealth/VitalsList.swift
@@ -10,9 +10,7 @@ import SwiftUI
 
 
 struct VitalsList: View {
-    @Environment(VitalsManager.self) private var vitalsManager
-
-    var vitalSelection: GraphSelection
+    let vitalSelection: GraphSelection
 
 
     var body: some View {

diff --git a/ENGAGEHF/Managers/ManagerProtocol.swift b/ENGAGEHF/Managers/ManagerProtocol.swift
@@ -11,6 +11,7 @@ import Spezi
 
 /// A protocol to force refresh of the content of conforming Managers.
 protocol RefreshableContent {
+    // periphery:ignore - Actually used in the invitation code module.
     @MainActor
     func refreshContent()
 }

diff --git a/ENGAGEHF/Managers/MedicationsManager/MedicationsManager.swift b/ENGAGEHF/Managers/MedicationsManager/MedicationsManager.swift
@@ -19,12 +19,9 @@ import SpeziFirebaseAccount
 @Observable
 @MainActor
 final class MedicationsManager: Manager {
-    @ObservationIgnored @StandardActor private var standard: ENGAGEHFStandard
-
     @ObservationIgnored @Dependency(Account.self) private var account: Account?
     @ObservationIgnored @Dependency(AccountNotifications.self) private var accountNotifications: AccountNotifications?
-    @ObservationIgnored @Dependency(FirebaseAccountService.self) private var accountService: FirebaseAccountService?
-
+
     @Application(\.logger) @ObservationIgnored private var logger
 
     private var snapshotListener: ListenerRegistration?

diff --git a/ENGAGEHF/Managers/MessageManager/Message.swift b/ENGAGEHF/Managers/MessageManager/Message.swift
@@ -19,7 +19,9 @@ struct Message: Identifiable, Equatable {
     let description: String?
     let action: MessageAction
     let isDismissible: Bool
+    // periphery:ignore - Currently not used in the app but a complete representation of the model.
     let dueDate: Date?
+    // periphery:ignore - Currently not used in the app but a complete representation of the model.
     let completionDate: Date?
 
 

diff --git a/ENGAGEHF/Managers/MessageManager/MessageManager.swift b/ENGAGEHF/Managers/MessageManager/MessageManager.swift
@@ -22,12 +22,9 @@ import SpeziFirebaseAccount
 @Observable
 @MainActor
 final class MessageManager: Manager {
-    @ObservationIgnored @StandardActor var standard: ENGAGEHFStandard
-
     @ObservationIgnored @Dependency(Account.self) private var account: Account?
     @ObservationIgnored @Dependency(AccountNotifications.self) private var accountNotifications: AccountNotifications?
-    @ObservationIgnored @Dependency(FirebaseAccountService.self) private var accountService: FirebaseAccountService?
-
+
     @Application(\.logger) @ObservationIgnored private var logger
 
     private(set) var messages: [Message] = []
@@ -167,6 +164,7 @@ final class MessageManager: Manager {
 
 #if DEBUG || TEST
 extension MessageManager {
+    // periphery:ignore - Used in Previews across the application.
     /// Adds a mock message to self.messages
     /// Used for testing in previews
     func addMockMessage(dismissible: Bool = true, action: MessageAction = .showHealthSummary) {

diff --git a/ENGAGEHF/Managers/NotificationManager/NotificationManager.swift b/ENGAGEHF/Managers/NotificationManager/NotificationManager.swift
@@ -34,6 +34,7 @@ final class NotificationManager: Manager, NotificationHandler, NotificationToken
     @ObservationIgnored @Dependency(NavigationManager.self) private var navigationManager
     @ObservationIgnored @Dependency(Account.self) private var account: Account?
 
+    // periphery:ignore - Properly used then the TEST flag is not set.
     @ObservationIgnored @Application(\.registerRemoteNotifications) private var registerRemoteNotifications
     @ObservationIgnored @Application(\.logger) private var logger
 

diff --git a/ENGAGEHF/Managers/VitalsManager/Extensions/Decimal+IntConversion.swift b/ENGAGEHF/Managers/VitalsManager/Extensions/Decimal+IntConversion.swift
@@ -14,12 +14,12 @@ import Foundation
 /// Integer representation of the Decimal for use in creating Dates with time
 extension Decimal {
     /// Truncates the decimal and returns only the integer component as an Int
-    public var intValue: Int {
+    var intValue: Int {
         Int(truncating: self as NSNumber)
     }
 
     /// Removes the whole number and returns only the fractional component as an Int, truncated to a precision of 9 decimal places
-    public var fracValue: Int {
+    var fracValue: Int {
         NSDecimalNumber(decimal: self)
             .subtracting(NSDecimalNumber(value: self.intValue))
             .multiplying(byPowerOf10: 9)
@@ -31,7 +31,7 @@ extension Decimal {
 /// Conversion to Double
 extension Decimal {
     /// Returns a Double representation of the Decimal
-    public var doubleValue: Double {
+    var doubleValue: Double {
         NSDecimalNumber(decimal: self).doubleValue
     }
 }
diff --git a/ENGAGEHF/Managers/VitalsManager/Extensions/FHIRObservation+GetEffectiveDate.swift b/ENGAGEHF/Managers/VitalsManager/Extensions/FHIRObservation+GetEffectiveDate.swift
@@ -12,7 +12,7 @@ import ModelsR4
 
 extension Observation {
     /// Returns Observation.effective as a startDate and an endDate, if present, converting from FHIR Primitives to Swift Dates
-    public func getEffectiveDate() -> (start: Date, end: Date)? {
+    func getEffectiveDate() -> (start: Date, end: Date)? {
         guard let effective else {
             return nil
         }

diff --git a/ENGAGEHF/Managers/VitalsManager/Extensions/HKSample+GetDoubleValues.swift b/ENGAGEHF/Managers/VitalsManager/Extensions/HKSample+GetDoubleValues.swift
@@ -13,7 +13,7 @@ import HealthKit
 extension HKSample {
     /// Returns the Double value corresponding to each quantity in the Sample in the given units, if compatable
     /// For now, only supports HKQuantitySamples and HKCorrelations
-    public func getDoubleValues(for unit: HKUnit) -> [String: Double] {
+    func getDoubleValues(for unit: HKUnit) -> [String: Double] {
         switch self {
         case let quantitySample as HKQuantitySample:
             let quantity = quantitySample.quantity

diff --git a/ENGAGEHF/Managers/VitalsManager/SymptomScore.swift b/ENGAGEHF/Managers/VitalsManager/SymptomScore.swift
@@ -13,20 +13,20 @@ import Foundation
 /// The score representing the result of a patient's response to a KCCQ survey
 /// Parameters are specified in compliance with:
 /// https://github.com/StanfordBDHG/ENGAGE-HF-Firebase/tree/web-data-scheme
-public struct SymptomScore: Identifiable, Equatable {
-    @DocumentID public var id: String?
-    public let date: Date
-    public let overallScore: Double?
-    public let physicalLimitsScore: Double?
-    public let socialLimitsScore: Double?
-    public let qualityOfLifeScore: Double?
-    public let symptomFrequencyScore: Double?
-    public let dizzinessScore: Double?
+struct SymptomScore: Identifiable, Equatable {
+    @DocumentID var id: String?
+    let date: Date
+    let overallScore: Double?
+    let physicalLimitsScore: Double?
+    let socialLimitsScore: Double?
+    let qualityOfLifeScore: Double?
+    let symptomFrequencyScore: Double?
+    let dizzinessScore: Double?
 }
 
 
 extension SymptomScore: Codable {
-    public init(from decoder: any Decoder) throws {
+    init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
         self._id = try container.decode(DocumentID<String>.self, forKey: .id)

diff --git a/ENGAGEHF/Managers/VitalsManager/VitalsManager.swift b/ENGAGEHF/Managers/VitalsManager/VitalsManager.swift
@@ -23,44 +23,43 @@ import SpeziFirestore
 /// - Convert FHIR observations to HKQuantitySamples and HKCorrelations
 @Observable
 @MainActor
-public final class VitalsManager: Manager {
+final class VitalsManager: Manager {
     @ObservationIgnored @StandardActor private var standard: ENGAGEHFStandard
 
     @ObservationIgnored @Dependency(Account.self) private var account: Account?
     @ObservationIgnored @Dependency(AccountNotifications.self) private var accountNotifications: AccountNotifications?
-    @ObservationIgnored @Dependency(FirebaseAccountService.self) private var accountService: FirebaseAccountService?
-
+
     @Application(\.logger) @ObservationIgnored private var logger
 
     private var snapshotListeners: [ListenerRegistration] = []
     private var notificationsTask: Task<Void, Never>?
 
-    public var heartRateHistory: [HKQuantitySample] = []
-    public var bloodPressureHistory: [HKCorrelation] = []
-    public var weightHistory: [HKQuantitySample] = []
+    var heartRateHistory: [HKQuantitySample] = []
+    var bloodPressureHistory: [HKCorrelation] = []
+    var weightHistory: [HKQuantitySample] = []
 
-    public var symptomHistory: [SymptomScore] = []
+    var symptomHistory: [SymptomScore] = []
 
     private(set) var latestDryWeight: HKQuantitySample?
 
 
-    public var latestHeartRate: HKQuantitySample? {
+    var latestHeartRate: HKQuantitySample? {
         heartRateHistory.max { $0.startDate < $1.startDate }
     }
-    public var latestBloodPressure: HKCorrelation? {
+    var latestBloodPressure: HKCorrelation? {
         bloodPressureHistory.max { $0.startDate < $1.startDate }
     }
-    public var latestWeight: HKQuantitySample? {
+    var latestWeight: HKQuantitySample? {
         weightHistory.max { $0.startDate < $1.startDate }
     }
 
 
-    nonisolated public init() {}
+    nonisolated init() {}
 
 
     /// Call on initial configuration:
     /// - Add a snapshot listener to the three health data collections
-    public func configure() {
+    func configure() {
         if ProcessInfo.processInfo.isPreviewSimulator {
             self.setupPreview()
             return
@@ -94,7 +93,7 @@ public final class VitalsManager: Manager {
     }
 
 
-    public func refreshContent() {
+    func refreshContent() {
         updateSnapshotListener(for: account?.details)
     }
 

diff --git a/ENGAGEHF/Resources/Localizable.xcstrings b/ENGAGEHF/Resources/Localizable.xcstrings
@@ -850,7 +850,7 @@
         }
       }
     },
-    "You are not in this medication, but it might be helpful in the future." : {
+    "You are not on this medication, but it might be helpful in the future." : {
       "comment" : "No action required legend entry."
     },
     "You are on this medication, but may benefit from a higher dose." : {