LogManager.swift 6.9 KB

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