LogManager.swift 7.0 KB

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