Merge branch 'main' into disable-log-level-traits

Author: kukushechkin

.github/workflows/main.yml

@@ -49,8 +49,8 @@ jobs:
     name: Cxx interop
     uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
 
-  static-sdk:
-    name: Static SDK
+  static-linux:
+    name: Static Linux Swift SDK
     # Workaround https://github.com/nektos/act/issues/1875
     uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
 
@@ -62,6 +62,15 @@ jobs:
       build_scheme: swift-log-Package
       swift_test_enabled: true
 
+  wasm:
+    name: Wasm Swift SDK
+    uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
+
+  android:
+    name: Android Swift SDK
+    # Workaround https://github.com/nektos/act/issues/1875
+    uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
+
   release-builds:
     name: Release builds
     uses: apple/swift-nio/.github/workflows/release_builds.yml@main

.github/workflows/pull_request.yml

@@ -55,8 +55,8 @@ jobs:
     name: Cxx interop
     uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
 
-  static-sdk:
-    name: Static SDK
+  static-linux:
+    name: Static Linux Swift SDK
     # Workaround https://github.com/nektos/act/issues/1875
     uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
 
@@ -68,6 +68,10 @@ jobs:
       build_scheme: swift-log-Package
       swift_test_enabled: true
 
+  android:
+    name: Android Swift SDK
+    # Workaround https://github.com/nektos/act/issues/1875
+    uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
 
   release-builds:
     name: Release builds
@@ -78,3 +82,7 @@ jobs:
       windows_6_2_enabled: true
       windows_nightly_next_enabled: true
       windows_nightly_main_enabled: true
+
+  wasm:
+    name: Wasm Swift SDK
+    uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main

Sources/InMemoryLogging/InMemoryLogHandler.swift

@@ -13,7 +13,6 @@
 //===----------------------------------------------------------------------===//
 
 import Logging
-import Synchronization
 
 /// A custom log handler which just collects logs into memory.
 /// You can then retrieve an array of those log entries.
@@ -35,7 +34,6 @@ import Synchronization
 /// let logEntries = logger.entries
 /// ```
 ///
-@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, *)
 public struct InMemoryLogHandler: LogHandler {
     public var metadata: Logger.Metadata = [:]
     public var metadataProvider: Logger.MetadataProvider?
@@ -58,12 +56,13 @@ public struct InMemoryLogHandler: LogHandler {
         }
     }
 
-    private final class LogStore: Sendable {
-        private let logs: Mutex<[Entry]> = .init([])
+    private final class LogStore: @unchecked Sendable {
+        private var _entries: [Entry] = []
+        private let lock = Lock()
 
         fileprivate func append(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata) {
-            self.logs.withLock {
-                $0.append(
+            self.lock.withLockVoid {
+                self._entries.append(
                     Entry(
                         level: level,
                         message: message,
@@ -74,13 +73,13 @@ public struct InMemoryLogHandler: LogHandler {
         }
 
         fileprivate func clear() {
-            self.logs.withLock {
-                $0.removeAll()
+            self.lock.withLockVoid {
+                _entries.removeAll()
             }
         }
 
         var entries: [Entry] {
-            self.logs.withLock { $0 }
+            self.lock.withLock { self._entries }
         }
     }
 

proposals/0001-metadata-providers.md …Proposals/SLG-0001-metadata-providers.mdproposals/0001-metadata-providers.md renamed to Sources/Logging/Docs.docc/Proposals/SLG-0001-metadata-providers.md proposals/0001-metadata-providers.md renamed to Sources/Logging/Docs.docc/Proposals/SLG-0001-metadata-providers.md

@@ -1,10 +1,10 @@
 # Metadata Providers
 
-Authors: [Moritz Lang](https://github.com/slashmo), [Konrad 'ktoso' Malawski](https://github.com/ktoso)
+While global metadata attributes may be manually set on a `LogHandler` level, there's currently no way of reliably providing contextual, automatically propagated, metadata when logging with swift-log.
 
-## Introduction
+## Authors
 
-While global metadata attributes may be manually set on a `LogHandler` level, there's currently no way of reliably providing contextual, automatically propagated, metadata when logging with swift-log.
+[Moritz Lang](https://github.com/slashmo), [Konrad 'ktoso' Malawski](https://github.com/ktoso)
 
 ## Motivation
 

Sources/Logging/Locks.swift

@@ -48,7 +48,7 @@ import Musl
 /// of lock is safe to use with `libpthread`-based threading models, such as the
 /// one used by NIO. On Windows, the lock is based on the substantially similar
 /// `SRWLOCK` type.
-internal final class Lock: @unchecked Sendable {
+package final class Lock: @unchecked Sendable {
     #if canImport(WASILibc)
     // WASILibc is single threaded, provides no locks
     #elseif os(Windows)
@@ -60,7 +60,7 @@ internal final class Lock: @unchecked Sendable {
     #endif
 
     /// Create a new lock.
-    public init() {
+    package init() {
         #if canImport(WASILibc)
         // WASILibc is single threaded, provides no locks
         #elseif os(Windows)
@@ -92,7 +92,7 @@ internal final class Lock: @unchecked Sendable {
     ///
     /// Whenever possible, consider using `withLock` instead of this method and
     /// `unlock`, to simplify lock handling.
-    public func lock() {
+    package func lock() {
         #if canImport(WASILibc)
         // WASILibc is single threaded, provides no locks
         #elseif os(Windows)
@@ -107,7 +107,7 @@ internal final class Lock: @unchecked Sendable {
     ///
     /// Whenever possible, consider using `withLock` instead of this method and
     /// `lock`, to simplify lock handling.
-    public func unlock() {
+    package func unlock() {
         #if canImport(WASILibc)
         // WASILibc is single threaded, provides no locks
         #elseif os(Windows)
@@ -129,7 +129,7 @@ extension Lock {
     /// - Parameter body: The block to execute while holding the lock.
     /// - Returns: The value returned by the block.
     @inlinable
-    internal func withLock<T>(_ body: () throws -> T) rethrows -> T {
+    package func withLock<T>(_ body: () throws -> T) rethrows -> T {
         self.lock()
         defer {
             self.unlock()
@@ -139,7 +139,7 @@ extension Lock {
 
     // specialise Void return (for performance)
     @inlinable
-    internal func withLockVoid(_ body: () throws -> Void) rethrows {
+    package func withLockVoid(_ body: () throws -> Void) rethrows {
         try self.withLock(body)
     }
 }

Sources/Logging/Logging.swift

@@ -19,7 +19,7 @@ import CRT
 #elseif canImport(Glibc)
 @preconcurrency import Glibc
 #elseif canImport(Android)
-import Android
+@preconcurrency import Android
 #elseif canImport(Musl)
 import Musl
 #elseif canImport(WASILibc)
@@ -1102,6 +1102,19 @@ extension Logger.Level: Comparable {
     }
 }
 
+extension Logger.Level: CustomStringConvertible, LosslessStringConvertible {
+    /// A textual representation of the log level.
+    public var description: String {
+        self.rawValue
+    }
+
+    /// Creates a log level from its textual representation.
+    /// - Parameter description: A textual representation of the log level, case insensitive.
+    public init?(_ description: String) {
+        self.init(rawValue: description.lowercased())
+    }
+}
+
 // Extension has to be done on explicit type rather than Logger.Metadata.Value as workaround for
 // https://bugs.swift.org/browse/SR-9687
 // Then we could write it as follows and it would work under Swift 5 and not only 4 as it does currently:

Tests/InMemoryLoggingTests/InMemoryLogHandlerTests.swift

@@ -18,7 +18,6 @@ import Testing
 
 struct InMemoryLogHandlerTests {
     @Test
-    @available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, *)
     func collectsLogs() {
         let (logHandler, logger) = self.makeTestLogger()
         logger.info("hello", metadata: ["key1": "value1", "key2": ["a", "b", "c"]])
@@ -35,7 +34,6 @@ struct InMemoryLogHandlerTests {
     }
 
     @Test
-    @available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, *)
     func metadataFromLoggerEndsUpInEntry() {
         var (logHandler, logger) = self.makeTestLogger()
         logger[metadataKey: "test"] = "value"
@@ -55,7 +53,6 @@ struct InMemoryLogHandlerTests {
     }
 
     @Test
-    @available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, *)
     func moreSpecificMetadataOverridesGlobal() {
         let testProvider = Logger.MetadataProvider {
             ["a": "1", "b": "1", "c": "1"]
@@ -73,7 +70,6 @@ struct InMemoryLogHandlerTests {
     }
 
     @Test
-    @available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, *)
     func clear() {
         let (logHandler, logger) = self.makeTestLogger()
         logger.info("hello", metadata: ["key1": "value1", "key2": ["a", "b", "c"]])
@@ -88,7 +84,6 @@ struct InMemoryLogHandlerTests {
         )
     }
 
-    @available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, *)
     private func makeTestLogger(metadataProvider: Logger.MetadataProvider? = nil) -> (InMemoryLogHandler, Logger) {
         var logHandler = InMemoryLogHandler()
         logHandler.metadataProvider = metadataProvider

Tests/LoggingTests/LoggingTest.swift

@@ -957,6 +957,11 @@ struct LoggingTest {
         #expect(Logger.Level.error < Logger.Level.critical)
     }
 
+    @Test(arguments: Logger.Level.allCases) func logLevelDescription(level: Logger.Level) {
+        #expect(level.description == level.rawValue)
+        #expect(Logger.Level(level.rawValue.uppercased()) == level)
+    }
+
     final class InterceptStream: TextOutputStream {
         var interceptedText: String?
         var strings = [String]()