Make logging a cross-cutting concern

Author: kean

ios/Demo-iOS/Sources/GutenbergApp.swift

@@ -1,7 +1,15 @@
 import SwiftUI
+import OSLog
+import GutenbergKit
 
 @main
 struct GutenbergApp: App {
+    init() {
+        // Configure logger for GutenbergKit
+        EditorLogger.shared = OSLogEditorLogger()
+        EditorLogger.logLevel = .debug
+    }
+
     var body: some Scene {
         WindowGroup {
             NavigationStack {
@@ -12,3 +20,20 @@ struct GutenbergApp: App {
         .environmentObject(AuthenticationManager())
     }
 }
+
+struct OSLogEditorLogger: GutenbergKit.EditorLogging {
+    private let logger: Logger
+
+    init(subsystem: String = "com.gutenbergkit.demo", category: String = "GutenbergKit") {
+        self.logger = Logger(subsystem: subsystem, category: category)
+    }
+
+    func log(_ level: GutenbergKit.EditorLogLevel, _ message: String) {
+        switch level {
+        case .debug: logger.debug("\(message)")
+        case .info: logger.info("\(message)")
+        case .warn: logger.warning("\(message)")
+        case .error: logger.error("\(message)")
+        }
+    }
+}

ios/Demo-iOS/Sources/Services/.swift

@@ -0,0 +1,21 @@
+import Foundation
+import OSLog
+import GutenbergKit
+
+/// An OSLog-based implementation of EditorLogging.
+struct OSLogEditorLogger: EditorLogging {
+    private let logger: Logger
+
+    init(subsystem: String = "com.gutenbergkit.demo", category: String = "GutenbergKit") {
+        self.logger = Logger(subsystem: subsystem, category: category)
+    }
+
+    func log(_ level: EditorLogLevel, _ message: String) {
+        switch level {
+        case .debug: logger.debug("\(message)")
+        case .info: logger.info("\(message)")
+        case .warn: logger.warning("\(message)")
+        case .error: logger.error("\(message)")
+        }
+    }
+}

ios/Demo-iOS/Sources/Views/AppRootView.swift

@@ -83,7 +83,6 @@ struct AppRootView: View {
                     .setSiteApiRoot(config.siteApiRoot)
                     .setAuthHeader(config.authHeader)
                     .setNativeInserterEnabled(isNativeInserterEnabled)
-                    .setLogLevel(.debug)
                     .build()
 
                 self.activeEditorConfiguration = updatedConfiguration

ios/Demo-iOS/Sources/Views/EditorView.swift

@@ -159,10 +159,6 @@ private struct _EditorView: UIViewControllerRepresentable {
             // No-op for demo
         }
 
-        func editor(_ viewController: EditorViewController, didLogMessage message: String, level: LogLevel) {
-            print("[\(level)]: \(message)")
-        }
-
         func editor(_ viewController: EditorViewController, didLogException error: GutenbergJSException) {
             // No-op for demo
         }

ios/Sources/GutenbergKit/Sources/EditorConfiguration.swift

@@ -30,8 +30,6 @@ public struct EditorConfiguration: Sendable {
     public let locale: String
     /// Enables the native inserter UI in the editor
     public let isNativeInserterEnabled: Bool
-    /// Logs emitted at or above this level will be printed to the debug console
-    public let logLevel: LogLevel
 
     /// Deliberately non-public – consumers should use `EditorConfigurationBuilder` to construct a configuration
     init(
@@ -48,8 +46,7 @@ public struct EditorConfiguration: Sendable {
         namespaceExcludedPaths: [String],
         authHeader: String,
         locale: String,
-        isNativeInserterEnabled: Bool,
-        logLevel: LogLevel
+        isNativeInserterEnabled: Bool
     ) {
         self.title = title
         self.content = content
@@ -65,7 +62,6 @@ public struct EditorConfiguration: Sendable {
         self.authHeader = authHeader
         self.locale = locale
         self.isNativeInserterEnabled = isNativeInserterEnabled
-        self.logLevel = logLevel
     }
 
     public func toBuilder() -> EditorConfigurationBuilder {
@@ -113,7 +109,6 @@ public struct EditorConfigurationBuilder {
     private var authHeader: String
     private var locale: String
     private var isNativeInserterEnabled: Bool
-    private var logLevel: LogLevel
 
     public init(
         title: String = "",
@@ -129,8 +124,7 @@ public struct EditorConfigurationBuilder {
         namespaceExcludedPaths: [String] = [],
         authHeader: String = "",
         locale: String = "en",
-        isNativeInserterEnabled: Bool = false,
-        logLevel: LogLevel = .error
+        isNativeInserterEnabled: Bool = false
     ){
         self.title = title
         self.content = content
@@ -146,7 +140,6 @@ public struct EditorConfigurationBuilder {
         self.authHeader = authHeader
         self.locale = locale
         self.isNativeInserterEnabled = isNativeInserterEnabled
-        self.logLevel = logLevel
     }
 
     public func setTitle(_ title: String) -> EditorConfigurationBuilder {
@@ -233,12 +226,6 @@ public struct EditorConfigurationBuilder {
         return copy
     }
 
-    public func setLogLevel(_ logLevel: LogLevel) -> EditorConfigurationBuilder {
-        var copy = self
-        copy.logLevel = logLevel
-        return copy
-    }
-
     /// Simplify conditionally applying a configuration change
     ///
     /// Sample Code:
@@ -276,8 +263,7 @@ public struct EditorConfigurationBuilder {
             namespaceExcludedPaths: namespaceExcludedPaths,
             authHeader: authHeader,
             locale: locale,
-            isNativeInserterEnabled: isNativeInserterEnabled,
-            logLevel: logLevel
+            isNativeInserterEnabled: isNativeInserterEnabled
         )
     }
 }

ios/Sources/GutenbergKit/Sources/EditorJSMessage.swift

@@ -100,6 +100,6 @@ struct EditorJSMessage {
 
     struct LogMessage: Decodable {
         let message: String
-        let level: LogLevel
+        let level: EditorLogLevel
     }
 }

ios/Sources/GutenbergKit/Sources/EditorLogging.swift

@@ -0,0 +1,45 @@
+import Foundation
+
+/// Protocol for logging editor-related messages.
+public protocol EditorLogging: Sendable {
+    /// Logs a message at the specified level.
+    func log(_ level: EditorLogLevel, _ message: String)
+}
+
+/// Global logger for GutenbergKit.
+///
+/// - warning: The shared properties are nonisolated and should be set once
+/// during the program lifetime before other editor APIs are used.
+public enum EditorLogger {
+    /// The shared logger instance used throughout GutenbergKit.
+    public nonisolated(unsafe) static var shared: EditorLogging?
+
+    /// The log level. Messages below this level are ignored.
+    public nonisolated(unsafe) static var logLevel: EditorLogLevel = .error
+}
+
+func log(_ level: EditorLogLevel, _ message: @autoclosure () -> String) {
+    guard level.priority >= EditorLogger.logLevel.priority,
+          let logger = EditorLogger.shared else {
+        return
+    }
+    logger.log(level, message())
+}
+
+public enum EditorLogLevel: String, Decodable, Sendable {
+    case error
+    case warn
+    case info
+    case debug
+
+    public static let all: EditorLogLevel = .debug
+
+    public var priority: Int {
+        switch self {
+        case .error: return 3
+        case .warn: return 2
+        case .info: return 1
+        case .debug: return 0
+        }
+    }
+}

ios/Sources/GutenbergKit/Sources/EditorViewController.swift

@@ -157,7 +157,7 @@ public final class EditorViewController: UIViewController, GutenbergEditorContro
                 title: '\(configuration.escapedTitle)',
                 content: '\(configuration.escapedContent)'
             },
-            logLevel: '\(configuration.logLevel)',
+            logLevel: '\(EditorLogger.logLevel.rawValue)',
             manifest: \(dependencies?.manifest ?? "undefined")
         };
 
@@ -460,8 +460,8 @@ public final class EditorViewController: UIViewController, GutenbergEditorContro
                 hideNavigationOverlay()
                 delegate?.editor(self, didCloseModalDialog: body.dialogType)
             case .log:
-                let log = try message.decode(EditorJSMessage.LogMessage.self)
-                delegate?.editor(self, didLogMessage: log.message, level: log.level)
+                let logMessage = try message.decode(EditorJSMessage.LogMessage.self)
+                log(logMessage.level, logMessage.message)
             }
         } catch {
             fatalError("failed to decode message: \(error)")

ios/Sources/GutenbergKit/Sources/EditorViewControllerDelegate.swift

@@ -35,9 +35,6 @@ public protocol EditorViewControllerDelegate: AnyObject {
     /// Notifies the client about an exception that occurred during the editor
     func editor(_ viewController: EditorViewController, didLogException error: GutenbergJSException)
 
-    /// Notifies the client about a log message emitted by the editor
-    func editor(_ viewController: EditorViewController, didLogMessage message: String, level: LogLevel)
-
     func editor(_ viewController: EditorViewController, didRequestMediaFromSiteMediaLibrary config: OpenMediaLibraryAction)
 
     /// Notifies the client that an autocompleter was triggered.