LogManager.swift 6.8 KB

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