Setup a convenience protocol and funnel all logging through it

Author: allenhumphreys

Packages/ConfCore/ConfCore/BookmarkSyncObject.swift

@@ -22,7 +22,8 @@ public struct BookmarkSyncObject: CustomCloudKitCodable, BelongsToSession {
     var isDeleted: Bool
 }
 
-extension Bookmark: SyncObjectConvertible, BelongsToSession {
+extension Bookmark: SyncObjectConvertible, BelongsToSession, Logging {
+    public static let log = makeLogger(subsystem: "ConfCore", category: "\(String(describing: Bookmark.self))+Sync")
 
     public static var syncThrottlingInterval: TimeInterval {
         return 0
@@ -50,7 +51,7 @@ extension Bookmark: SyncObjectConvertible, BelongsToSession {
             do {
                 bookmark.snapshot = try Data(contentsOf: snapshotURL)
             } catch {
-                Logger.default.fault("Failed to load bookmark snapshot from CloudKit: \(String(describing: error), privacy: .public)")
+                log.fault("Failed to load bookmark snapshot from CloudKit: \(String(describing: error), privacy: .public)")
                 bookmark.snapshot = Data()
             }
         } else {
@@ -62,7 +63,7 @@ extension Bookmark: SyncObjectConvertible, BelongsToSession {
 
     public var syncObject: BookmarkSyncObject? {
         guard let sessionId = session.first?.identifier else {
-            Logger.default.fault("Bookmark \(self.identifier) is not associated to a session. That's illegal!")
+            log.fault("Bookmark \(self.identifier) is not associated to a session. That's illegal!")
 
             return nil
         }

Packages/ConfCore/ConfCore/ContributorsFetcher.swift

@@ -9,11 +9,11 @@
 import Cocoa
 import OSLog
 
-public final class ContributorsFetcher {
+public final class ContributorsFetcher: Logging {
 
     public static let shared: ContributorsFetcher = ContributorsFetcher()
 
-    private let log = Logger(subsystem: "WWDC", category: "ContributorsFetcher")
+    public static let log = makeLogger()
 
     fileprivate struct Constants {
         static let contributorsURL = "https://api.github.com/repos/insidegui/WWDC/contributors"
@@ -55,7 +55,7 @@ public final class ContributorsFetcher {
                 return
             }
 
-            self.syncQueue.async {
+            self.syncQueue.async { [log] in
                 do {
                     self.names += try self.parseResponse(data)
                 } catch {

Packages/ConfCore/ConfCore/Environment.swift

@@ -48,7 +48,7 @@ public struct Environment: Equatable {
 
         if shouldNotify {
             DispatchQueue.main.async {
-                Logger.default.info("Environment base URL: \(environment.baseURL)")
+                log.info("Environment base URL: \(environment.baseURL)")
 
                 NotificationCenter.default.post(name: .WWDCEnvironmentDidChange, object: environment)
             }
@@ -113,3 +113,7 @@ extension Environment {
                                                featuredSectionsPath: "/explore.json")
 
 }
+
+extension Environment: Logging {
+    public static let log = makeLogger()
+}

Packages/ConfCore/ConfCore/Error+CloudKit.swift

@@ -10,6 +10,9 @@ import Foundation
 import CloudKit
 import OSLog
 
+// TODO: Where to?
+let ckLog = makeLogger(subsystem: "WWDC", category: "CloudKit")
+
 extension Error {
 
     var isCloudKitConflict: Bool {
@@ -20,30 +23,30 @@ extension Error {
 
     func resolveConflict(with resolver: (CKRecord, CKRecord) -> CKRecord?) -> CKRecord? {
         guard let effectiveError = self as? CKError else {
-            Logger.default.fault("resolveConflict called on an error that was not a CKError. The error was \(String(describing: self), privacy: .public)")
+            ckLog.fault("resolveConflict called on an error that was not a CKError. The error was \(String(describing: self), privacy: .public)")
             return nil
         }
 
         guard effectiveError.code == .serverRecordChanged else {
-            Logger.default.fault("resolveConflict called on a CKError that was not a serverRecordChanged error. The error was \(String(describing: effectiveError), privacy: .public)")
+            ckLog.fault("resolveConflict called on a CKError that was not a serverRecordChanged error. The error was \(String(describing: effectiveError), privacy: .public)")
             return nil
         }
 
         guard let clientRecord = effectiveError.userInfo[CKRecordChangedErrorClientRecordKey] as? CKRecord else {
-            Logger.default.fault("Failed to obtain client record from serverRecordChanged error. The error was \(String(describing: effectiveError), privacy: .public)")
+            ckLog.fault("Failed to obtain client record from serverRecordChanged error. The error was \(String(describing: effectiveError), privacy: .public)")
             return nil
         }
 
         guard let serverRecord = effectiveError.userInfo[CKRecordChangedErrorServerRecordKey] as? CKRecord else {
-            Logger.default.fault("Failed to obtain server record from serverRecordChanged error. The error was \(String(describing: effectiveError), privacy: .public)")
+            ckLog.fault("Failed to obtain server record from serverRecordChanged error. The error was \(String(describing: effectiveError), privacy: .public)")
             return nil
         }
 
         return resolver(clientRecord, serverRecord)
     }
 
     @discardableResult func retryCloudKitOperationIfPossible(_ log: Logger? = nil, in queue: DispatchQueue = .main, with block: @escaping () -> Void) -> Bool {
-        let effectiveLog = log ?? .default
+        let effectiveLog: Logger = log ?? ckLog
 
         guard let effectiveError = self as? CKError else { return false }
 

Packages/ConfCore/ConfCore/FavoriteSyncObject.swift

@@ -43,7 +43,7 @@ extension Favorite: SyncObjectConvertible, BelongsToSession {
 
     public var syncObject: FavoriteSyncObject? {
         guard let sessionId = session.first?.identifier else {
-            Logger.default.fault("Favorite \(self.identifier) is not associated to a session. That's illegal!")
+            ckLog.fault("Favorite \(self.identifier) is not associated to a session. That's illegal!")
 
             return nil
         }

Packages/ConfCore/ConfCore/Logger+Static.swift

@@ -0,0 +1,50 @@
+//
+//  Logging.swift
+//  
+//
+//  Created by Allen Humphreys on 6/5/23.
+//
+
+import OSLog
+
+public struct LoggingConfig {
+    public let subsystem: String
+    public let category: String
+}
+
+public protocol Logging {
+    static var log: Logger { get }
+    var log: Logger { get }
+    static func defaultLoggerConfig() -> LoggingConfig
+    static func makeLogger(config: LoggingConfig) -> Logger
+}
+
+public extension Logging {
+    static func defaultLoggerConfig() -> LoggingConfig {
+        let fullyQualifiedTypeName = String(reflecting: Self.self)
+        let fullyQualifiedTypeNameComponents = fullyQualifiedTypeName.split(separator: ".", maxSplits: 1)
+        let subsystem = fullyQualifiedTypeNameComponents[0]
+        let category = fullyQualifiedTypeNameComponents[1]
+        return LoggingConfig(subsystem: String(subsystem), category: String(category))
+    }
+    @inline(__always)
+    static func makeLogger(config: LoggingConfig = defaultLoggerConfig()) -> Logger {
+        makeLogger(subsystem: config.subsystem, category: config.category)
+    }
+    @inline(__always)
+    static func makeLogger(subsystem: String, category: String = String(describing: Self.self)) -> Logger {
+        ConfCore.makeLogger(subsystem: subsystem, category: category)
+    }
+
+    /// Convenience forwarding the static log var to the instance just to make things simpler and easier. Types conforming to Logging only
+    /// need to create the static var
+    @inline(__always)
+    var log: Logger { Self.log }
+
+}
+
+/// Mostly for identifying places that log outside of using the Logging protocol. To help with future refactors.
+@inline(__always)
+public func makeLogger(subsystem: String, category: String) -> Logger {
+    Logger(subsystem: subsystem, category: category)
+}

Packages/ConfCore/ConfCore/Logging.swift

@@ -10,7 +10,7 @@ import Foundation
 import QuartzCore
 import OSLog
 
-private let _log = Logger(subsystem: "ConfCore", category: "NSCodingExtensions")
+private let _log = makeLogger(subsystem: "ConfCore", category: "NSCodingExtensions")
 
 public extension NSKeyedArchiver {
 

Packages/ConfCore/ConfCore/NSCodingExtensions.swift

@@ -42,7 +42,8 @@ public final class SessionProgress: Object, HasCloudKitFields, SoftDeletable {
     }
 }
 
-extension Session {
+extension Session: Logging {
+    public static let log = makeLogger()
 
     private static let positionUpdateQueue = DispatchQueue(label: "PositionUpdate", qos: .background)
 
@@ -90,7 +91,7 @@ extension Session {
 
             try queueRealm.commitWrite()
         } catch {
-            Logger.default.error("Error updating session progress: \(String(describing: error), privacy: .public)")
+            log.error("Error updating session progress: \(String(describing: error), privacy: .public)")
         }
     }
 
@@ -110,7 +111,7 @@ extension Session {
 
             if mustCommit { try realm.commitWrite() }
         } catch {
-            Logger.default.error("Error updating session progress: \(String(describing: error), privacy: .public)")
+            log.error("Error updating session progress: \(String(describing: error), privacy: .public)")
         }
     }
 

Packages/ConfCore/ConfCore/SessionProgress.swift

@@ -21,7 +21,8 @@ public struct SessionProgressSyncObject: CustomCloudKitCodable, BelongsToSession
     var isDeleted: Bool
 }
 
-extension SessionProgress: SyncObjectConvertible, BelongsToSession {
+extension SessionProgress: SyncObjectConvertible, BelongsToSession, Logging {
+    public static let log = makeLogger()
 
     public static var syncThrottlingInterval: TimeInterval {
         return 20.0
@@ -49,7 +50,7 @@ extension SessionProgress: SyncObjectConvertible, BelongsToSession {
 
     public var syncObject: SessionProgressSyncObject? {
         guard let sessionId = session.first?.identifier else {
-            Logger.default.fault("SessionProgress \(self.identifier) is not associated to a session. That's illegal!")
+            log.fault("SessionProgress \(self.identifier) is not associated to a session. That's illegal!")
 
             return nil
         }