optional tag usage

Author: stevensJourney

Sources/PowerSync/Kotlin/DatabaseLogger.swift

@@ -9,7 +9,7 @@ private class KermitLogWriterAdapter: Kermit_coreLogWriter {
 
     /// Initializes a new adapter.
     ///
-    /// - Parameter adapter: A Swift log writer that will handle log output.
+    /// - Parameter logger: A Swift log writer that will handle log output.
     init(logger: any LoggerProtocol) {
         self.logger = logger
         super.init()
@@ -20,7 +20,7 @@ private class KermitLogWriterAdapter: Kermit_coreLogWriter {
     /// - Parameters:
     ///   - severity: The severity level of the log.
     ///   - message: The content of the log message.
-    ///   - tag: An optional string categorizing the log.
+    ///   - tag: A string categorizing the log.
     ///   - throwable: An optional Kotlin exception (ignored here).
     override func log(severity: Kermit_coreSeverity, message: String, tag: String, throwable: KotlinThrowable?) {
         switch severity {
@@ -40,7 +40,7 @@ private class KermitLogWriterAdapter: Kermit_coreLogWriter {
     }
 }
 
-/// A logger implementation that integrates with PowerSync's Kotlin backend using Kermit.
+/// A logger implementation that integrates with PowerSync's Kotlin core using Kermit.
 ///
 /// This class bridges Swift log writers with the Kotlin logging system and supports
 /// runtime configuration of severity levels and writer lists.
@@ -51,10 +51,10 @@ internal class DatabaseLogger: LoggerProtocol {
 
     /// Initializes a new logger with an optional list of writers.
     ///
-    /// - Parameter writers: An array of Swift log writers. Defaults to an empty array.
+    /// - Parameter logger: A logger which will be called for each internal log operation
     init(_ logger: any LoggerProtocol) {
         self.logger = logger
-        // Set to the lowest severity. The adapter downstream logger should filter by severity
+        // Set to the lowest severity. The provided logger should filter by severity
         kLogger.mutableConfig.setMinSeverity(Kermit_coreSeverity.verbose)
         kLogger.mutableConfig.setLogWriterList(
             [KermitLogWriterAdapter(logger: logger)]
@@ -80,27 +80,27 @@ internal class DatabaseLogger: LoggerProtocol {
     }
 
     /// Logs a debug-level message.
-    public func debug(_ message: String, tag: String) {
+    public func debug(_ message: String, tag: String?) {
         logger.debug(message, tag: tag)
     }
 
     /// Logs an info-level message.
-    public func info(_ message: String, tag: String) {
+    public func info(_ message: String, tag: String?) {
         logger.info(message, tag: tag)
     }
 
     /// Logs a warning-level message.
-    public func warning(_ message: String, tag: String) {
+    public func warning(_ message: String, tag: String?) {
         logger.warning(message, tag: tag)
     }
 
     /// Logs an error-level message.
-    public func error(_ message: String, tag: String) {
+    public func error(_ message: String, tag: String?) {
         logger.error(message, tag: tag)
     }
 
     /// Logs a fault (assert-level) message, typically used for critical issues.
-    public func fault(_ message: String, tag: String) {
+    public func fault(_ message: String, tag: String?) {
         logger.fault(message, tag: tag)
     }
 }

Sources/PowerSync/Logger.swift

@@ -11,8 +11,14 @@ public class PrintLogWriter: LogWriterProtocol {
        ///   - severity: The severity level of the message.
        ///   - message: The content of the log message.
        ///   - tag: An optional tag used to categorize the message. If empty, no brackets are shown.
-    public func log(severity: LogSeverity, message: String, tag: String) {
-        let tagPrefix = tag.isEmpty ? "" : "[\(tag)] "
+    public func log(severity: LogSeverity, message: String, tag: String?) {
+        let tagPrefix: String
+        if let tag, !tag.isEmpty {
+            tagPrefix = "[\(tag)] "
+        } else {
+            tagPrefix = ""
+        }
+        
         let message = "\(tagPrefix) \(message)"
         if #available(iOS 14.0, *) {
             let l = Logger()
@@ -30,21 +36,21 @@ public class PrintLogWriter: LogWriterProtocol {
                     l.fault("\(message)")
             }
         } else {
-            print("\(severity.rawValue): \(message)")
+            print("\(severity.stringValue): \(message)")
         }
     }
 }
 
-/// A default logger configuration that uses `SwiftLogWritter` and filters messages by minimum severity.
-///
-/// This logger integrates with your custom logging system and uses `os.Logger` under the hood.
+/// A default logger configuration that uses `PrintLogWritter` and filters messages by minimum severity.
 public class DefaultLogger: LoggerProtocol {
     public var minSeverirty: LogSeverity
     public var writers: [any LogWriterProtocol]
 
     /// Initializes the default logger with an optional minimum severity level.
     ///
-    /// - Parameter minSeverity: The minimum severity level to log. Defaults to `.debug`.
+    /// - Parameters
+    ///     - minSeverity: The minimum severity level to log. Defaults to `.debug`.
+    ///     - writers: Optional writers which logs should be written to. Defaults to a `PrintLogWriter`.
     public init(minSeverity: LogSeverity = .debug, writers: [any LogWriterProtocol]? = nil ) {
         self.writers = writers ?? [ PrintLogWriter() ]
         self.minSeverirty = minSeverity
@@ -59,27 +65,27 @@ public class DefaultLogger: LoggerProtocol {
     }
 
 
-    public func debug(_ message: String, tag: String) {
-        self.writeLog(message, tag: tag, severity: LogSeverity.debug)
+    public func debug(_ message: String, tag: String? = nil) {
+        self.writeLog(message, severity: LogSeverity.debug, tag: tag)
     }
 
-    public func error(_ message: String, tag: String) {
-        self.writeLog(message, tag: tag, severity: LogSeverity.error)
+    public func error(_ message: String, tag: String? = nil) {
+        self.writeLog(message, severity: LogSeverity.error, tag: tag)
     }
 
-    public func info(_ message: String, tag: String) {
-        self.writeLog(message, tag: tag, severity: LogSeverity.info)
+    public func info(_ message: String, tag: String? = nil) {
+        self.writeLog(message, severity: LogSeverity.info, tag: tag)
     }
 
-    public func warning(_ message: String, tag: String) {
-        self.writeLog(message, tag: tag, severity: LogSeverity.warning)
+    public func warning(_ message: String, tag: String? = nil) {
+        self.writeLog(message, severity: LogSeverity.warning, tag: tag)
     }
 
-    public func fault(_ message: String, tag: String) {
-        self.writeLog(message, tag: tag, severity: LogSeverity.fault)
+    public func fault(_ message: String, tag: String? = nil) {
+        self.writeLog(message, severity: LogSeverity.fault, tag: tag)
     }
 
-    private func writeLog(_ message: String, tag: String, severity: LogSeverity) {
+    private func writeLog(_ message: String, severity: LogSeverity, tag: String?) {
         if (severity.rawValue < self.minSeverirty.rawValue) {
             return
         }

Sources/PowerSync/LoggerProtocol.swift

@@ -41,7 +41,7 @@ public protocol LogWriterProtocol {
     ///   - severity: The severity level of the log message.
     ///   - message: The content of the log message.
     ///   - tag: An optional tag to categorize or group the log message.
-    func log(severity: LogSeverity, message: String, tag: String)
+    func log(severity: LogSeverity, message: String, tag: String?)
 }
 
 /// A protocol defining the interface for a logger that supports severity filtering and multiple writers.
@@ -65,33 +65,33 @@ public protocol LoggerProtocol {
     /// - Parameters:
     ///   - message: The content of the log message.
     ///   - tag: An optional tag to categorize the message.
-    func info(_ message: String, tag: String)
+    func info(_ message: String, tag: String?)
 
     /// Logs an error message.
     ///
     /// - Parameters:
     ///   - message: The content of the log message.
     ///   - tag: An optional tag to categorize the message.
-    func error(_ message: String, tag: String)
+    func error(_ message: String, tag: String?)
 
     /// Logs a debug message.
     ///
     /// - Parameters:
     ///   - message: The content of the log message.
     ///   - tag: An optional tag to categorize the message.
-    func debug(_ message: String, tag: String)
+    func debug(_ message: String, tag: String?)
 
     /// Logs a warning message.
     ///
     /// - Parameters:
     ///   - message: The content of the log message.
     ///   - tag: An optional tag to categorize the message.
-    func warning(_ message: String, tag: String)
+    func warning(_ message: String, tag: String?)
 
     /// Logs a fault message, typically used for critical system-level failures.
     ///
     /// - Parameters:
     ///   - message: The content of the log message.
     ///   - tag: An optional tag to categorize the message.
-    func fault(_ message: String, tag: String)
+    func fault(_ message: String, tag: String?)
 }

Tests/PowerSyncTests/Kotlin/TestLogger.swift

@@ -4,8 +4,8 @@
 class TestLogWriterAdapter: LogWriterProtocol {
     var logs = [String]()
 
-    func log(severity: LogSeverity, message: String, tag: String) {
-        logs.append("\(severity): \(message) (\(tag))")
+    func log(severity: LogSeverity, message: String, tag: String?) {
+        logs.append("\(severity): \(message) \(tag != nil ? "\(tag!)" : "")")
     }
 }