Replace the implementation of CollectEverythingLogHandler with the one from swift-log

Author: hamzahrmalik

Tests/AsyncHTTPClientTests/HTTPClient+SOCKSTests.swift

@@ -27,7 +27,7 @@ class HTTPClientSOCKSTests: XCTestCase {
     var serverGroup: EventLoopGroup!
     var defaultHTTPBin: HTTPBin<HTTPBinHandler>!
     var defaultClient: HTTPClient!
-    var backgroundLogStore: CollectEverythingLogHandler.LogStore!
+    var backgroundLogStore: CollectEverythingLogHandler!
 
     var defaultHTTPBinURLPrefix: String {
         "http://localhost:\(self.defaultHTTPBin.port)/"
@@ -43,14 +43,8 @@ class HTTPClientSOCKSTests: XCTestCase {
         self.clientGroup = getDefaultEventLoopGroup(numberOfThreads: 1)
         self.serverGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
         self.defaultHTTPBin = HTTPBin()
-        self.backgroundLogStore = CollectEverythingLogHandler.LogStore()
-        var backgroundLogger = Logger(
-            label: "\(#function)",
-            factory: { _ in
-                CollectEverythingLogHandler(logStore: self.backgroundLogStore!)
-            }
-        )
-        backgroundLogger.logLevel = .trace
+        let (backgroundLogStore, backgroundLogger) = CollectEverythingLogHandler.makeLogger(logLevel: .trace)
+        self.backgroundLogStore = backgroundLogStore
         self.defaultClient = HTTPClient(
             eventLoopGroupProvider: .shared(self.clientGroup),
             backgroundActivityLogger: backgroundLogger

Tests/AsyncHTTPClientTests/HTTPClientBase.swift

@@ -37,7 +37,7 @@ class XCTestCaseHTTPClientTestsBaseClass: XCTestCase {
     var serverGroup: EventLoopGroup!
     var defaultHTTPBin: HTTPBin<HTTPBinHandler>!
     var defaultClient: HTTPClient!
-    var backgroundLogStore: CollectEverythingLogHandler.LogStore!
+    var backgroundLogStore: CollectEverythingLogHandler!
 
     var defaultHTTPBinURLPrefix: String {
         self.defaultHTTPBin.baseURL
@@ -53,14 +53,8 @@ class XCTestCaseHTTPClientTestsBaseClass: XCTestCase {
         self.clientGroup = getDefaultEventLoopGroup(numberOfThreads: 1)
         self.serverGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
         self.defaultHTTPBin = HTTPBin()
-        self.backgroundLogStore = CollectEverythingLogHandler.LogStore()
-        var backgroundLogger = Logger(
-            label: "\(#function)",
-            factory: { _ in
-                CollectEverythingLogHandler(logStore: self.backgroundLogStore!)
-            }
-        )
-        backgroundLogger.logLevel = .trace
+        let (backgroundLogStore, backgroundLogger) = CollectEverythingLogHandler.makeLogger(logLevel: .trace)
+        self.backgroundLogStore = backgroundLogStore
 
         self.defaultClient = HTTPClient(
             eventLoopGroupProvider: .shared(self.clientGroup),

Tests/AsyncHTTPClientTests/HTTPClientTestUtils.swift

@@ -1290,46 +1290,58 @@ extension EventLoopFuture where Value: Sendable {
     }
 }
 
+/// A copy of the InMemoryLogHandler from swift-log, but modified to use NIOLockedValueBox instead of Mutex (for better platform availability).
 struct CollectEverythingLogHandler: LogHandler {
     var metadata: Logger.Metadata = [:]
+    var metadataProvider: Logger.MetadataProvider?
     var logLevel: Logger.Level = .info
-    let logStore: LogStore
+    private let logStore: LogStore
 
-    final class LogStore: Sendable {
-        struct Entry {
-            var level: Logger.Level
-            var message: String
-            var metadata: [String: String]
-        }
-
-        private let logs = NIOLockedValueBox<[Entry]>([])
+    /// A struct representing a log entry.
+    struct Entry: Sendable, Equatable {
+        /// The level we logged at.
+        var level: Logger.Level
+        /// The message which was logged.
+        var message: Logger.Message
+        /// The metadata which was logged.
+        var metadata: Logger.Metadata
+    }
 
-        var allEntries: [Entry] {
-            get {
-                self.logs.withLockedValue { $0 }
-            }
-            set {
-                self.logs.withLockedValue { $0 = newValue }
-            }
-        }
+    private final class LogStore: Sendable {
+        private let logs: NIOLockedValueBox<[Entry]> = .init([])
 
-        func append(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata?) {
+        fileprivate func append(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata) {
             self.logs.withLockedValue {
                 $0.append(
                     Entry(
                         level: level,
-                        message: message.description,
-                        metadata: metadata?.mapValues { $0.description } ?? [:]
+                        message: message,
+                        metadata: metadata
                     )
                 )
             }
         }
+
+        fileprivate func clear() {
+            self.logs.withLockedValue {
+                $0.removeAll()
+            }
+        }
+
+        var entries: [Entry] {
+            self.logs.withLockedValue { $0 }
+        }
     }
 
-    init(logStore: LogStore) {
+    private init(logStore: LogStore) {
         self.logStore = logStore
     }
 
+    /// Create a new ``InMemoryLogHandler``.
+    init() {
+        self.init(logStore: .init())
+    }
+
     func log(
         level: Logger.Level,
         message: Logger.Message,
@@ -1339,7 +1351,14 @@ struct CollectEverythingLogHandler: LogHandler {
         function: String,
         line: UInt
     ) {
-        self.logStore.append(level: level, message: message, metadata: self.metadata.merging(metadata ?? [:]) { $1 })
+        // Start with the metadata provider..
+        var mergedMetadata: Logger.Metadata = self.metadataProvider?.get() ?? [:]
+        // ..merge in self.metadata, overwriting existing keys
+        mergedMetadata = mergedMetadata.merging(self.metadata) { $1 }
+        // ..merge in metadata from this log call, overwriting existing keys
+        mergedMetadata = mergedMetadata.merging(metadata ?? [:]) { $1 }
+
+        self.logStore.append(level: level, message: message, metadata: mergedMetadata)
     }
 
     subscript(metadataKey key: String) -> Logger.Metadata.Value? {
@@ -1350,6 +1369,34 @@ struct CollectEverythingLogHandler: LogHandler {
             self.metadata[key] = newValue
         }
     }
+
+    /// All logs that have been collected.
+    var entries: [Entry] {
+        self.logStore.entries
+    }
+
+    /// Clear all entries.
+    func clear() {
+        self.logStore.clear()
+    }
+}
+
+extension CollectEverythingLogHandler {
+    static func makeLogger(
+        logLevel: Logger.Level = .info,
+        function: String = #function
+    ) -> (CollectEverythingLogHandler, Logger) {
+        let handler = CollectEverythingLogHandler()
+
+        var logger = Logger(
+            label: "\(function)",
+            factory: { _ in
+                handler
+            }
+        )
+        logger.logLevel = logLevel
+        return (handler, logger)
+    }
 }
 
 /// A ``HTTPClientResponseDelegate`` that buffers the incoming response parts for the consumer. The consumer can