Minor cleanup

Author: eonist

Package.resolved

@@ -120,4 +120,23 @@ Then add `Logger` as a dependency for your targets:
 - Add support for oslog in the framework. We currently support it in the ad-hoc callback. Add this to unit test as well as instructions on Console.app usage and limitations.
 - Consider adding another log type called "important"
 - Add usage gif exploring system console, google-analytics, xcode consol
-- Add problem / solution to readme
+- Add problem / solution to readme
+- Add a note about apples OS.Logger. And its limitations.
+- Add protocol oriented design: 
+
+```swift
+protocol LoggerProtocol {
+    func log(message: String, level: LogLevel, tag: LogTag)
+}
+
+// Implementations
+class ConsoleLogger: LoggerProtocol {
+    func log(message: String, level: LogLevel, tag: LogTag) {
+        Swift.print(message)
+    }
+}
+
+class FileLogger: LoggerProtocol {
+    // File logging implementation...
+}
+```

README.md

@@ -62,7 +62,9 @@ extension Logger {
     *   - tag: Type of logging, e.g., payment, network, database, etc.
     */
    fileprivate static func log(_ msg: String, level: LogLevel, tag: LogTag) {
+      // fixme after using set, do guard mode.level.contains(level) else { return }
       guard mode.level.contains(where: { $0 == level }) else { return } // Filter level
+      // fixme after using set, do guard mode.level.contains(level) else { return }
       guard mode.tag.contains(where: { $0 == tag }) else { return } // Filter tag
       let text: String = text(msg, level: level, tag: tag) // Get formatted print output
       type.log(msg: text, level: level, tag: tag) // Log to console or file

Sources/Logger/Logger+Command.swift

@@ -49,13 +49,15 @@ extension String {
    }
    /**
     * removePrefix function removes the specified prefix from the string.
+    * fixme: rename trimmingPrefix
     */
    fileprivate func removePrefix(prefix: String) -> String {
       guard self.hasPrefix(prefix) else { return self } // Check if the trace message has the specified prefix
       return "\(self.dropFirst(prefix.count))" // Remove the prefix from the trace message and return the result
    }
    /**
     * removeSuffix function removes the specified suffix from the string.
+    * fixme: rename trimmingSuffix
     */
    fileprivate func removeSuffix(suffix: String) -> String {
       guard self.hasSuffix(suffix) else { return self } // Check if the trace message has the specified suffix

Sources/Logger/helper/Trace.swift

@@ -31,6 +31,9 @@ extension LogConfig {
     * ss: The second of the minute with two digits (00-59).
     */
    public static let defaultDateFormat: String = "yyyy-MM-dd' 'HH:mm:ss"
+   // fixme add doc
+   // Creating a new DateFormatter every time a date is formatted can be expensive. Caching the DateFormatter instance using a lazy property improves performance.
+   private static var cachedDateFormatter: DateFormatter?
    /**
     * DateFormatter is used to format the date in the log.
     * - Descriptino: It uses the dateFormat specified in the LogConfig, sets the timezone to UTC, and sets the locale to "en_US_POSIX".
@@ -40,11 +43,16 @@ extension LogConfig {
     * - Note: In the context of the LogConfig struct, the en_US_POSIX locale is used to ensure that the date and time formatting is consistent regardless of the user's locale settings
     */
    var dateFormatter: DateFormatter {
-      let format: DateFormatter = .init() // Create a new DateFormatter instance
-      format.dateFormat = dateFormat // Set the date format to the specified format
-      format.timeZone = TimeZone(identifier: "UTC") // Set the time zone to UTC
-      format.locale = Locale(identifier: "en_US_POSIX") // Set the locale to US English
-      return format // Return the DateFormatter instance
+      if let formatter = Self.cachedDateFormatter {
+         return formatter
+      } else {
+         let format = DateFormatter()
+         format.dateFormat = dateFormat
+         format.timeZone = TimeZone(identifier: "UTC")
+         format.locale = Locale(identifier: "en_US_POSIX")
+         Self.cachedDateFormatter = format
+         return format
+      }
    }
 }
 // Extension of LogConfig for predefined configurations.

Sources/Logger/util/LogConfig.swift

@@ -50,12 +50,14 @@ extension LogMode {
  * It is used to specify the types of logs to be displayed.
  * ## Examples:
  * LogTag.allCases.filter { $0 != .net && $0 != .db && $0 != .security }
+ * fixme: use set
  */
 public typealias TagFilter = [LogTag] // [.db, .net, .file, .ui, .security, .other]
 /**
  * `LevelFilter` is a type alias for an array of `LogLevel`.
  * It is used to specify the severity of logs to be displayed.
  * ## Examples:
  * LogLevel.allCases.filter({ $0 != .info })
+ * fixme: use set
  */
 public typealias LevelFilter = [LogLevel] // [.error, .warning, .info, .critical]

Sources/Logger/util/LogMode.swift

@@ -85,15 +85,44 @@ extension LogType {
     *   - filePath: Destination file path, usually temp folder path etc
     */
    public static func writeToFile(string: String, filePath: String) {
-      var content: String = ""
-      if !FileAsserter.exists(path: filePath) { // Assert if filePath doesn't exist
-         FileModifier.write(filePath, content: "New file created" + "\n") // Create new file if non exists
+    let queue = DispatchQueue(label: "com.logger.fileWriteQueue", attributes: .concurrent)
+      queue.async(flags: .barrier) {
+         do {
+               if !FileManager.default.fileExists(atPath: filePath) {
+                  try "New file created\n".write(toFile: filePath, atomically: true, encoding: .utf8)
+               }
+               if isNewLogSession == false {
+                  try "New session started\n".appendLineToURL(fileURL: URL(fileURLWithPath: filePath))
+                  isNewLogSession = true
+               }
+               try (string + "\n").appendLineToURL(fileURL: URL(fileURLWithPath: filePath))
+         } catch {
+               print("Failed to write to log file: \(error.localizedDescription)")
+         }
       }
-      if isNewLogSession == false { // Indicates new app session
-         content += "New session started" + "\n"
-         isNewLogSession = true // only trigger once per app session
-      }
-      content += string + "\n" // Add string
-      FileModifier.append(filePath, text: content) // Append content to end of file
    }
 }
+
+// Helper extension
+extension String {
+    func appendLineToURL(fileURL: URL) throws {
+        try self.appendToURL(fileURL: fileURL)
+    }
+
+    func appendToURL(fileURL: URL) throws {
+        let data = self.data(using: .utf8)!
+        try data.append(fileURL: fileURL)
+    }
+}
+
+extension Data {
+    func append(fileURL: URL) throws {
+        if let fileHandle = try? FileHandle(forWritingTo: fileURL) {
+            defer { fileHandle.closeFile() }
+            fileHandle.seekToEndOfFile()
+            fileHandle.write(self)
+        } else {
+            try write(to: fileURL, options: .atomic)
+        }
+    }
+}