LogManager.swift 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. // LoopFollow
  2. // LogManager.swift
  3. import Foundation
  4. import UIKit
  5. class LogManager {
  6. static let shared = LogManager()
  7. private let fileManager = FileManager.default
  8. private let logDirectory: URL
  9. private let dateFormatter: DateFormatter
  10. private let consoleQueue = DispatchQueue(label: "com.loopfollow.log.console", qos: .background)
  11. private let rateLimitQueue = DispatchQueue(label: "com.loopfollow.log.ratelimit")
  12. private var lastLoggedTimestamps: [String: Date] = [:]
  13. private var shouldLogVersionHeader: Bool = true
  14. enum Category: String, CaseIterable {
  15. case bluetooth = "Bluetooth"
  16. case nightscout = "Nightscout"
  17. case apns = "APNS"
  18. case general = "General"
  19. case contact = "Contact"
  20. case taskScheduler = "Task Scheduler"
  21. case dexcom = "Dexcom"
  22. case alarm = "Alarm"
  23. case volumeButtonSnooze = "Volume Button Snooze"
  24. case calendar = "Calendar"
  25. case deviceStatus = "Device Status"
  26. case remote = "Remote"
  27. case telemetry = "Telemetry"
  28. }
  29. init() {
  30. let documentsDirectory = fileManager.urls(for: .documentDirectory, in: .userDomainMask).first!
  31. logDirectory = documentsDirectory.appendingPathComponent("Logs")
  32. if !fileManager.fileExists(atPath: logDirectory.path) {
  33. try? fileManager.createDirectory(at: logDirectory, withIntermediateDirectories: true, attributes: nil)
  34. }
  35. dateFormatter = DateFormatter()
  36. dateFormatter.dateFormat = "yyyy-MM-dd"
  37. }
  38. private func formattedLogMessage(for category: Category, message: String) -> String {
  39. let timestamp = DateFormatter.localizedString(from: Date(), dateStyle: .none, timeStyle: .medium)
  40. return "[\(timestamp)] [\(category.rawValue)] \(message)"
  41. }
  42. /// Logs a message with an optional rate limit.
  43. ///
  44. /// - Parameters:
  45. /// - category: The log category.
  46. /// - message: The message to log.
  47. /// - isDebug: Indicates if this is a debug log.
  48. /// - limitIdentifier: Optional key to rate-limit similar log messages.
  49. /// - limitInterval: Time interval (in seconds) to wait before logging the same type again.
  50. func log(category: Category, message: String, isDebug: Bool = false, limitIdentifier: String? = nil, limitInterval: TimeInterval = 300) {
  51. let safeMessage = LogRedactor.sweep(message)
  52. let logMessage = formattedLogMessage(for: category, message: safeMessage)
  53. consoleQueue.async {
  54. print(logMessage)
  55. }
  56. if category == .taskScheduler && isDebug {
  57. return
  58. }
  59. if let key = limitIdentifier, !Storage.shared.debugLogLevel.value {
  60. let shouldLog: Bool = rateLimitQueue.sync {
  61. if let lastLogged = lastLoggedTimestamps[key] {
  62. let interval = Date().timeIntervalSince(lastLogged)
  63. if interval < limitInterval {
  64. return false
  65. }
  66. }
  67. lastLoggedTimestamps[key] = Date()
  68. return true
  69. }
  70. if !shouldLog {
  71. return
  72. }
  73. }
  74. if !isDebug || Storage.shared.debugLogLevel.value {
  75. let logFileURL = currentLogFileURL
  76. writeVersionHeaderIfNeeded(for: logFileURL)
  77. append(logMessage + "\n", to: logFileURL)
  78. }
  79. }
  80. /// Helper method: checks if the log file is empty.
  81. private func isLogFileEmpty(at fileURL: URL) -> Bool {
  82. if !fileManager.fileExists(atPath: fileURL.path) { return true }
  83. if let attributes = try? fileManager.attributesOfItem(atPath: fileURL.path),
  84. let fileSize = attributes[.size] as? UInt64
  85. {
  86. return fileSize == 0
  87. }
  88. return false
  89. }
  90. /// Helper method: writes the version header if needed.
  91. private func writeVersionHeaderIfNeeded(for fileURL: URL) {
  92. if shouldLogVersionHeader || isLogFileEmpty(at: fileURL) {
  93. let versionManager = AppVersionManager()
  94. let version = versionManager.version()
  95. // Retrieve build details
  96. let buildDetails = BuildDetails.default
  97. let formattedBuildDate = dateTimeUtils.formattedDate(from: buildDetails.buildDate())
  98. let branchAndSha = buildDetails.branchAndSha
  99. let expiration = dateTimeUtils.formattedDate(from: buildDetails.calculateExpirationDate())
  100. let expirationHeaderString = buildDetails.expirationHeaderString
  101. let isMacApp = buildDetails.isMacApp()
  102. let isSimulatorBuild = buildDetails.isSimulatorBuild()
  103. let osLabel: String
  104. let osVersion: String
  105. if isMacApp {
  106. osLabel = "macOS"
  107. let v = ProcessInfo.processInfo.operatingSystemVersion
  108. osVersion = "\(v.majorVersion).\(v.minorVersion).\(v.patchVersion)"
  109. } else {
  110. osLabel = "iOS"
  111. osVersion = UIDevice.current.systemVersion
  112. }
  113. // Assemble header information
  114. var headerLines = [String]()
  115. headerLines.append("LoopFollow Version: \(version)")
  116. if !isMacApp, !isSimulatorBuild {
  117. headerLines.append("\(expirationHeaderString): \(expiration)")
  118. }
  119. headerLines.append("Built: \(formattedBuildDate)")
  120. headerLines.append("Branch: \(branchAndSha)")
  121. headerLines.append("\(osLabel): \(osVersion)")
  122. let headerMessage = headerLines.joined(separator: ", ") + "\n"
  123. let logMessage = formattedLogMessage(for: .general, message: headerMessage)
  124. append(logMessage, to: fileURL)
  125. shouldLogVersionHeader = false
  126. }
  127. }
  128. func cleanupOldLogs() {
  129. let today = dateFormatter.string(from: Date())
  130. let yesterday = dateFormatter.string(from: Calendar.current.date(byAdding: .day, value: -1, to: Date())!)
  131. do {
  132. let logFiles = try fileManager.contentsOfDirectory(at: logDirectory, includingPropertiesForKeys: nil)
  133. for logFile in logFiles {
  134. let filename = logFile.lastPathComponent
  135. if !filename.contains(today), !filename.contains(yesterday) {
  136. try fileManager.removeItem(at: logFile)
  137. }
  138. }
  139. } catch {
  140. print("Failed to clean up old logs: \(error)")
  141. }
  142. }
  143. func logFileURL(for date: Date) -> URL {
  144. let dateString = dateFormatter.string(from: date)
  145. return logDirectory.appendingPathComponent("LoopFollow \(dateString).log")
  146. }
  147. func logFilesForTodayAndYesterday() -> [URL] {
  148. let today = logFileURL(for: Date())
  149. let yesterday = logFileURL(for: Calendar.current.date(byAdding: .day, value: -1, to: Date())!)
  150. return [today, yesterday].filter { fileManager.fileExists(atPath: $0.path) }
  151. }
  152. var currentLogFileURL: URL {
  153. return logFileURL(for: Date())
  154. }
  155. private func append(_ message: String, to fileURL: URL) {
  156. if !fileManager.fileExists(atPath: fileURL.path) {
  157. fileManager.createFile(atPath: fileURL.path, contents: nil, attributes: nil)
  158. }
  159. if let fileHandle = try? FileHandle(forWritingTo: fileURL) {
  160. defer { fileHandle.closeFile() }
  161. fileHandle.seekToEndOfFile()
  162. if let data = message.data(using: .utf8) {
  163. fileHandle.write(data)
  164. }
  165. } else {
  166. print("Failed to open log file at \(fileURL.path)")
  167. }
  168. }
  169. }