Auto delete outdated logs & fix unit test

Author: Madimo

Sources/Logger/Handlers/SerializedLogHandler.swift

@@ -17,6 +17,8 @@ public final class SerializedLogHandler: LogHandler, LogPresentable {
     public var isEnabled: Bool = true
     public var filter: Filter?
     public let fileURL: URL
+    public var autoDeleteOutdatedLogs = true
+    public var outdatedLogDate = Date(timeIntervalSinceNow: -5 * 24 * 3600)
 
     public var isClosed: Bool {
         db == nil
@@ -54,7 +56,7 @@ public final class SerializedLogHandler: LogHandler, LogPresentable {
         var stmt: OpaquePointer?
         let sql = """
             SELECT message, date, level, tag, file, line, column, function FROM Logs ORDER BY id DESC
-        """
+            """
 
         if sqlite3_prepare_v2(db, sql, -1, &stmt, nil) == SQLITE_OK {
             while sqlite3_step(stmt) == SQLITE_ROW {
@@ -126,12 +128,20 @@ public final class SerializedLogHandler: LogHandler, LogPresentable {
                 column INTEGER,
                 function TEXT
             )
-        """
+            """
 
         if sqlite3_exec(db, sql, nil, nil, nil) != SQLITE_OK {
             let message = logErrorMessage()
             throw HandlerError(reason: .databaseOpenFailed, message: message)
         }
+
+        Logger.logQueue.asyncAfter(deadline: .now() + 5) { [weak self] in
+            guard let self = self else { return }
+
+            if self.autoDeleteOutdatedLogs {
+                self.deleteOutdatedLogs()
+            }
+        }
     }
 
     public func close() throws {
@@ -159,23 +169,46 @@ public final class SerializedLogHandler: LogHandler, LogPresentable {
                 \(log.column),
                 '\(encode(log.function))'
             )
-        """
+            """
 
         if sqlite3_exec(db, sql, nil, nil, nil) != SQLITE_OK {
             logErrorMessage()
         }
     }
 
-    public func truncate() throws {
+    public func deleteAllLogs() {
+        Logger.logQueue.async { [weak self] in
+            self?._deleteAllLogs()
+        }
+    }
+
+    private func _deleteAllLogs() {
         guard let db = db else { return }
 
         let sql = """
             DELETE FROM Logs
-        """
+            """
 
         if sqlite3_exec(db, sql, nil, nil, nil) != SQLITE_OK {
-            let message = logErrorMessage()
-            throw HandlerError(reason: .databaseTruncateFailed, message: message)
+            logErrorMessage()
+        }
+    }
+
+    public func deleteOutdatedLogs() {
+        Logger.logQueue.async { [weak self] in
+            self?._deleteOutdatedLogs()
+        }
+    }
+
+    private func _deleteOutdatedLogs() {
+        guard let db = db else { return }
+
+        let sql = """
+            DELETE FROM Logs WHERE date < \(outdatedLogDate.timeIntervalSince1970)
+            """
+
+        if sqlite3_exec(db, sql, nil, nil, nil) != SQLITE_OK {
+            logErrorMessage()
         }
     }
 

Sources/LoggerDemo/main.swift

@@ -11,6 +11,10 @@ import Foundation
 import Logger
 
 let logger = Logger()
+logger.add(trigger: CrashLogTrigger.shared)
 logger.add(handler: ConsoleLogHandler())
+logger.add(handler: try! SerializedLogHandler(fileURL: URL(fileURLWithPath: "/Users/Madimo/Desktop/logs.db")))
 
 logger.info("Hello World!")
+
+NSArray().object(at: 1)

Tests/LoggerTests/LoggerTests.swift

@@ -12,19 +12,19 @@ import XCTest
 
 final class LoggerTests: XCTestCase {
 
-//    func wait(_ logger: Logger, timeout: TimeInterval, file: String = #file, line: Int = #line) {
-//        let expectation = XCTestExpectation()
-//        logger.dispatchQueue.async {
-//            expectation.fulfill()
-//        }
-//
-//        switch XCTWaiter.wait(for: [expectation], timeout: timeout) {
-//        case .timedOut:
-//            recordFailure(withDescription: "Wait for logger timed out.", inFile: file, atLine: line, expected: true)
-//        default:
-//            break
-//        }
-//    }
+    func waitLogQueue(timeout: TimeInterval = 10, file: String = #file, line: Int = #line) {
+        let expectation = XCTestExpectation()
+        Logger.logQueue.async {
+            expectation.fulfill()
+        }
+
+        switch XCTWaiter.wait(for: [expectation], timeout: timeout) {
+        case .timedOut:
+            recordFailure(withDescription: "Wait for logger timed out.", inFile: file, atLine: line, expected: true)
+        default:
+            break
+        }
+    }
 
     func testAddAndRemoveLogHandler() {
         let logger = Logger()
@@ -208,6 +208,8 @@ final class LoggerTests: XCTestCase {
 
         do {
             let log = logger.debug("This is a log message.")
+            waitLogQueue()
+
             XCTAssertEqual(serializedLogHandler.logs.count, 1)
             XCTAssertEqual(serializedLogHandler.logs[0].message, log.message)
             XCTAssertEqual(Int(serializedLogHandler.logs[0].date.timeIntervalSince1970), Int(log.date.timeIntervalSince1970))
@@ -221,31 +223,41 @@ final class LoggerTests: XCTestCase {
 
         do {
             let log = logger.info("This is another\n\nlog message.")
+            waitLogQueue()
+
             XCTAssertEqual(serializedLogHandler.logs[0].message, log.message)
         }
 
         do {
             let log = logger.info("🎉 This is a log message contains Emoji 😄.")
+            waitLogQueue()
+
             XCTAssertEqual(serializedLogHandler.logs[0].message, log.message)
         }
 
         do {
             let log = logger.info("#//This is a log message contains '''?\"./*")
+            waitLogQueue()
+
             XCTAssertEqual(serializedLogHandler.logs[0].message, log.message)
         }
 
         do {
             let log = logger.info("This is a log message contains 中文")
+            waitLogQueue()
+
             XCTAssertEqual(serializedLogHandler.logs[0].message, log.message)
         }
 
-        try serializedLogHandler.truncate()
+        serializedLogHandler.deleteAllLogs()
+        waitLogQueue()
         XCTAssertTrue(serializedLogHandler.logs.isEmpty)
 
         try serializedLogHandler.close()
         XCTAssertTrue(serializedLogHandler.logs.isEmpty)
 
         logger.info("This is another log message.")
+        waitLogQueue()
         try serializedLogHandler.open()
         XCTAssertTrue(serializedLogHandler.logs.isEmpty)
     }
@@ -257,6 +269,7 @@ final class LoggerTests: XCTestCase {
         logger.add(handler: fileLoghandler)
 
         var log = logger.log("This is a message.", level: .debug)
+        waitLogQueue()
         fileLoghandler.close()
 
         var data = try XCTUnwrap(FileManager.default.contents(atPath: url.path))
@@ -266,6 +279,7 @@ final class LoggerTests: XCTestCase {
 
         try fileLoghandler.open()
         log = logger.log("This is another message.", level: .debug)
+        waitLogQueue()
         fileLoghandler.close()
 
         data = try XCTUnwrap(FileManager.default.contents(atPath: url.path))