Add mergeMetadata() convenience function for adding multiple metadata…

… k/v pairs to a Logger
apple · Sep 19, 2024 · 6bb92fb · 6bb92fb
1 parent 2cb03fa
commit 6bb92fb
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 0 deletions.
diff --git a/Sources/Logging/Logging.swift b/Sources/Logging/Logging.swift
@@ -166,6 +166,20 @@ extension Logger {
         }
     }
 
+    /// Convenience function for merging multiple metadata items into a Logger's existing metadata.
+    ///
+    /// - parameters:
+    ///    - metadata: The metadata to merge into a Logger's existing metadata.
+    ///
+    /// - note: Logging metadata behaves as a value that means a change to the logging metadata will only affect the
+    ///         very `Logger` it was changed on.
+    @inlinable
+    public mutating func mergeMetadata(_ metadata: Logger.Metadata) {
+        metadata.forEach { (key, value) in
+            self.handler[metadataKey: key] = value
+        }
+    }
+
     /// Get or set the log level configured for this `Logger`.
     ///
     /// - note: `Logger`s treat `logLevel` as a value. This means that a change in `logLevel` will only affect this

diff --git a/Tests/LoggingTests/LoggingTest.swift b/Tests/LoggingTests/LoggingTest.swift
@@ -357,6 +357,59 @@ class LoggingTest: XCTestCase {
                                                    "nested-list": ["l1str", ["l2str1", "l2str2"]]])
     }
 
+    func testMergeMetadataExistingMetadata() {
+        let testLogging = TestLogging()
+        LoggingSystem.bootstrapInternal { testLogging.make(label: $0) }
+
+        var logger = Logger(label: "\(#function)")
+        let metadata: Logger.Metadata = [
+            "foo": ["bar", "buz"],
+            "empty-list": [],
+            "nested-list": ["l1str", ["l2str1", "l2str2"]],
+        ]
+        logger.mergeMetadata(metadata)
+        logger.info("first log")
+        testLogging.history.assertExist(level: .info,
+                                        message: "first log",
+                                        metadata: ["foo": ["bar", "buz"],
+                                                   "empty-list": [],
+                                                   "nested-list": ["l1str", ["l2str1", "l2str2"]]])
+
+        // Non-overlapping metadata key-value pairs should be added without affecting existing metadata,
+        // while overlapping metadata key-value pairs should update the existing key's value.
+        logger.mergeMetadata([
+            "foo": ["bar"], // drops "buz" for existing key value
+            "newkey": "newvalue1" // adds new key-value pair
+        ])
+        logger.info("second log")
+        testLogging.history.assertExist(level: .info,
+                                        message: "second log",
+                                        metadata: ["foo": ["bar"],
+                                                   "empty-list": [],
+                                                   "nested-list": ["l1str", ["l2str1", "l2str2"]],
+                                                   "newkey": "newvalue1"])
+
+        // Finally, if new metadata with overlapping keys is added more than once, the
+        // latest value should be the one set in the Logger metadata.
+        logger.mergeMetadata([
+            "foo": [],
+            "newkey": "newvalue2"
+        ])
+        logger.mergeMetadata([
+            "foo": "a new type for this value",
+            "newkey": "newvalue3"
+        ])
+        logger.info("third log")
+        testLogging.history.assertExist(level: .info,
+                                        message: "third log",
+                                        metadata: ["foo": "a new type for this value",
+                                                   "empty-list": [],
+                                                   "nested-list": ["l1str", ["l2str1", "l2str2"]],
+                                                   "newkey": "newvalue3"])
+
+
+    }
+
     // Example of custom "box" which may be used to implement "render at most once" semantics
     // Not thread-safe, thus should not be shared across threads.
     internal final class LazyMetadataBox: CustomStringConvertible {