LogManager.swift 6.9 KB

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