feat: create SDKLoggingSystem to expose logging interface for devs (#287)

Author: wooj2

Packages/ClientRuntime/Sources/Config/Configuration.swift

@@ -14,25 +14,20 @@ open class Configuration {
     public let httpClientConfiguration: HttpClientConfiguration
     public let idempotencyTokenGenerator: IdempotencyTokenGenerator
     public let retrier: Retrier
-    public var clientLogMode: ClientLogMode
-    public let logger: LogAgent
 
     public init(encoder: RequestEncoder? = nil,
                 decoder: ResponseDecoder? = nil,
                 httpClientEngine: HttpClientEngine? = nil,
                 httpClientConfiguration: HttpClientConfiguration = HttpClientConfiguration(),
                 retrier: Retrier? = nil,
-                clientLogMode: ClientLogMode = .request,
-                logger: LogAgent? = nil,
                 idempotencyTokenGenerator: IdempotencyTokenGenerator = DefaultIdempotencyTokenGenerator()) throws {
         self.encoder = encoder
         self.decoder = decoder
         let engine = try httpClientEngine ?? CRTClientEngine()
         self.httpClientEngine = engine
         self.retrier = try retrier ?? SDKRetrier(clientEngine: engine)
-        self.clientLogMode = clientLogMode
-        self.logger = logger ?? SwiftLogger(label: "Swift SDK Logger")
         self.httpClientConfiguration = httpClientConfiguration
         self.idempotencyTokenGenerator = idempotencyTokenGenerator
     }
+
 }

Packages/ClientRuntime/Sources/Logging/SDKLogHandlerFactory.swift

@@ -0,0 +1,13 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+	
+import Logging
+
+public protocol SDKLogHandlerFactory {
+    var label: String { get }
+    func construct(label: String) -> LogHandler
+}

Packages/ClientRuntime/Sources/Logging/SDKLogLevel.swift

@@ -0,0 +1,37 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+	
+import Logging
+
+public enum SDKLogLevel: String, Codable, CaseIterable {
+    case trace
+    case debug
+    case info
+    case notice
+    case warning
+    case error
+    case critical
+
+    public func toLoggerType() -> Logger.Level {
+        switch self {
+        case .trace:
+            return .trace
+        case .debug:
+            return .debug
+        case .info:
+            return .info
+        case .notice:
+            return .notice
+        case .warning:
+            return .warning
+        case .error:
+            return .error
+        case .critical:
+            return .critical
+        }
+    }
+}

Packages/ClientRuntime/Sources/Logging/SDKLoggingSystem.swift

@@ -0,0 +1,36 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+	
+import Logging
+
+public class SDKLoggingSystem {
+    private static var factories: [String: SDKLogHandlerFactory] = [:]
+
+    public class func add(logHandlerFactory: SDKLogHandlerFactory) {
+        let label = logHandlerFactory.label
+        factories[label] = logHandlerFactory
+    }
+
+    public class func initialize() {
+        LoggingSystem.bootstrap { label in
+            if let factory = factories[label] {
+                return factory.construct(label: label)
+            }
+            var handler = StreamLogHandler.standardOutput(label: label)
+            handler.logLevel = .info
+            return handler
+        }
+    }
+
+    public class func initialize(logLevel: SDKLogLevel) {
+        LoggingSystem.bootstrap { label in
+            var handler = StreamLogHandler.standardOutput(label: label)
+            handler.logLevel = logLevel.toLoggerType()
+            return handler
+        }
+    }
+}

Packages/ClientRuntime/Sources/Networking/Http/CRT/CRTClientEngineLogHandlerFactory.swift

@@ -0,0 +1,23 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+	
+import Logging
+
+public struct CRTClientEngineLogHandlerFactory: SDKLogHandlerFactory {
+    public var label = "CRTClientEngine"
+    let logLevel: SDKLogLevel
+
+    public func construct(label: String) -> LogHandler {
+        var handler = StreamLogHandler.standardOutput(label: label)
+        handler.logLevel = logLevel.toLoggerType()
+        return handler
+    }
+    
+    public init(logLevel: SDKLogLevel) {
+        self.logLevel = logLevel
+    }
+}

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/SwiftDependency.kt

@@ -18,6 +18,7 @@ enum class SwiftDependency(
     var packageName: String
 ) : SymbolDependencyContainer {
     BIG("ComplexModule", null, "0.0.5", "https://github.com/apple/swift-numerics", "", "swift-numerics"),
+    SWIFT_LOG("Logging", null, "", "", "", ""),
     CLIENT_RUNTIME(
         "ClientRuntime",
         "master",

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolClientGenerator.kt

@@ -46,6 +46,7 @@ open class HttpProtocolClientGenerator(
     fun render() {
         val serviceSymbol = symbolProvider.toSymbol(serviceShape)
         writer.addImport(SwiftDependency.CLIENT_RUNTIME.target)
+        writer.addImport(SwiftDependency.SWIFT_LOG.target)
         writer.addFoundationImport()
         httpProtocolCustomizable.renderInternals(ctx)
         httpProtocolServiceClient.render(serviceSymbol)

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolServiceClient.kt

@@ -39,9 +39,28 @@ open class HttpProtocolServiceClient(
                 writer.write("client.close()")
             }
             writer.write("")
-            // FIXME: possible move generation of the config to a separate file or above the service client
             renderConfig(serviceSymbol)
         }
+        writer.write("")
+        renderLogHandlerFactory(serviceSymbol)
+        writer.write("")
+    }
+
+    private fun renderLogHandlerFactory(serviceSymbol: Symbol) {
+        writer.openBlock("public struct ${serviceSymbol.name}LogHandlerFactory: SDKLogHandlerFactory {", "}") {
+            writer.write("public var label = \"${serviceSymbol.name}\"")
+            writer.write("let logLevel: SDKLogLevel")
+
+            writer.openBlock("public func construct(label: String) -> LogHandler {", "}") {
+                writer.write("var handler = StreamLogHandler.standardOutput(label: label)")
+                writer.write("handler.logLevel = logLevel.toLoggerType()")
+                writer.write("return handler")
+            }
+
+            writer.openBlock("public init(logLevel: SDKLogLevel) {", "}") {
+                writer.write("self.logLevel = logLevel")
+            }
+        }
     }
 
     private fun renderConfig(serviceSymbol: Symbol) {
@@ -54,31 +73,35 @@ open class HttpProtocolServiceClient(
                 writer.write("public var ${it.name}: ${it.type}")
             }
             writer.write("")
-            renderConfigInit(configFields)
+            writer.write("public let clientLogMode: ClientLogMode")
+            writer.write("public let logger: LogAgent")
+            writer.write("")
+            renderConfigInit(configFields, serviceSymbol)
             writer.write("")
             serviceConfig.renderConvenienceInits(serviceSymbol)
             writer.write("")
             serviceConfig.renderStaticDefaultImplementation(serviceSymbol)
         }
     }
 
-    private fun renderConfigInit(configFields: List<ConfigField>) {
-        if (configFields.isNotEmpty()) {
-            val configFieldsSortedByName = configFields.sortedBy { it.name }
-            writer.openBlock("public init (", ") throws") {
-                for ((index, member) in configFieldsSortedByName.withIndex()) {
-                    val memberName = member.name
-                    val memberSymbol = member.type
-                    if (memberName == null) continue
-                    val terminator = if (index == configFieldsSortedByName.size - 1) "" else ","
-                    writer.write("\$L: \$L$terminator", memberName, memberSymbol)
-                }
+    private fun renderConfigInit(configFields: List<ConfigField>, serviceSymbol: Symbol) {
+        val configFieldsSortedByName = configFields.sortedBy { it.name }
+        writer.openBlock("public init (", ") throws") {
+            for (member in configFieldsSortedByName) {
+                val memberName = member.name
+                val memberSymbol = member.type
+                if (memberName == null) continue
+                writer.write("\$L: \$L,", memberName, memberSymbol)
             }
-            writer.openBlock("{", "}") {
-                configFieldsSortedByName.forEach {
-                    writer.write("self.\$1L = \$1L", it.name)
-                }
+            writer.write("clientLogMode: ClientLogMode = .request,")
+            writer.write("logger: LogAgent? = nil")
+        }
+        writer.openBlock("{", "}") {
+            configFieldsSortedByName.forEach {
+                writer.write("self.\$1L = \$1L", it.name)
             }
+            writer.write("self.clientLogMode = clientLogMode")
+            writer.write("self.logger = logger ?? SwiftLogger(label: \"${serviceSymbol.name}\")")
         }
     }
 }

smithy-swift-codegen/src/test/kotlin/HttpProtocolClientGeneratorTests.kt

@@ -53,18 +53,43 @@ class HttpProtocolClientGeneratorTests {
                         self.decoder = config.decoder
                         self.config = config
                     }
-
+                
                     deinit {
                         client.close()
                     }
-
+                
                     public class ExampleClientConfiguration: ClientRuntime.Configuration {
                 
+                        public let clientLogMode: ClientLogMode
+                        public let logger: LogAgent
+                
+                        public init (
+                            clientLogMode: ClientLogMode = .request,
+                            logger: LogAgent? = nil
+                        ) throws
+                        {
+                            self.clientLogMode = clientLogMode
+                            self.logger = logger ?? SwiftLogger(label: "ExampleClient")
+                        }
+                
                         public static func `default`() throws -> ExampleClientConfiguration {
                             return try ExampleClientConfiguration()
                         }
                     }
                 }
+
+                public struct ExampleClientLogHandlerFactory: SDKLogHandlerFactory {
+                    public var label = "ExampleClient"
+                    let logLevel: SDKLogLevel
+                    public func construct(label: String) -> LogHandler {
+                        var handler = StreamLogHandler.standardOutput(label: label)
+                        handler.logLevel = logLevel.toLoggerType()
+                        return handler
+                    }
+                    public init(logLevel: SDKLogLevel) {
+                        self.logLevel = logLevel
+                    }
+                }
             """.trimIndent()
         )
     }