feat: add wire logging middleware (#264)

Author: kneekey23

Packages/ClientRuntime/Sources/Config/Configuration.swift

@@ -14,19 +14,24 @@ 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/ClientLogMode.swift

@@ -0,0 +1,15 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+        
+public enum ClientLogMode {
+    case request
+    case requestWithBody
+    case response
+    case responseWithBody
+    case requestAndResponse
+    case requestAndResponseWithBody
+}

Packages/ClientRuntime/Sources/Logging/LogAgent.swift

@@ -5,7 +5,7 @@
 
 import AwsCommonRuntimeKit
 
-protocol LogAgent {
+public protocol LogAgent {
     /// name of the struct or class where the logger was instantiated from
     var name: String {get}
 
@@ -31,7 +31,7 @@ protocol LogAgent {
              line: UInt)
 }
 
-extension LogAgent {
+public extension LogAgent {
 
     internal static func currentModule(filePath: String = #file) -> String {
         let utf8All = filePath.utf8

Packages/ClientRuntime/Sources/Logging/SwiftLog+LogAgent.swift

@@ -6,11 +6,11 @@
 import Logging
 import enum AwsCommonRuntimeKit.LogLevel
 
-typealias SwiftLogger = Logger
+public typealias SwiftLogger = Logger
 
 extension SwiftLogger: LogAgent {
 
-    var level: LogLevel {
+    public var level: LogLevel {
         get {
             return LogLevel.fromString(string: logLevel.rawValue)
         }
@@ -19,11 +19,11 @@ extension SwiftLogger: LogAgent {
         }
     }
 
-    var name: String {
+    public var name: String {
             return label
     }
 
-    func log(level: LogLevel,
+    public func log(level: LogLevel,
              message: String,
              metadata: [String: String]?,
              source: String,

Packages/ClientRuntime/Sources/Networking/Http/DefaultMiddlewares/LoggerMiddleware.swift

@@ -0,0 +1,59 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+	
+public struct LoggerMiddleware<Output: HttpResponseBinding,
+                               OutputError: HttpResponseBinding>: Middleware {
+
+    public let id: String = "Logger"
+
+    let clientLogMode: ClientLogMode
+
+    public init(clientLogMode: ClientLogMode) {
+        self.clientLogMode = clientLogMode
+    }
+
+    public func handle<H>(context: Context,
+                          input: SdkHttpRequest,
+                          next: H) -> Result<OperationOutput<Output>, SdkError<OutputError>>
+    where H: Handler,
+          Self.MInput == H.Input,
+          Self.MOutput == H.Output,
+          Self.Context == H.Context,
+          Self.MError == H.MiddlewareError {
+        
+        guard let logger = context.getLogger() else {
+            return next.handle(context: context, input: input)
+        }
+        
+        if clientLogMode == .request || clientLogMode == .requestAndResponse {
+            logger.debug("Request: \(input.debugDescription)")
+        }else if clientLogMode == .requestAndResponseWithBody || clientLogMode == .requestWithBody {
+            logger.debug("Request: \(input.debugDescriptionWithBody)")
+        }
+        
+        let response = next.handle(context: context, input: input)
+        
+        do {
+            let output = try response.get()
+            if clientLogMode == .response || clientLogMode == .requestAndResponse {
+                logger.debug("Response: \(output.httpResponse.debugDescription)")
+            } else if clientLogMode == .requestAndResponseWithBody || clientLogMode == .responseWithBody {
+                logger.debug("Response: \(output.httpResponse.debugDescriptionWithBody)")
+            }
+            
+        } catch {
+            return response
+        }
+        
+        return response
+    }
+
+    public typealias MInput = SdkHttpRequest
+    public typealias MOutput = OperationOutput<Output>
+    public typealias Context = HttpContext
+    public typealias MError = SdkError<OutputError>
+}

Packages/ClientRuntime/Sources/Networking/Http/Headers.swift

@@ -134,3 +134,9 @@ extension Headers {
         }
     }
 }
+
+extension Headers: CustomDebugStringConvertible {
+    public var debugDescription: String {
+        return dictionary.map {"\($0.key): \($0.value.joined(separator: ", "))"}.joined(separator: ", \n")
+    }
+}

Packages/ClientRuntime/Sources/Networking/Http/HttpBody.swift

@@ -29,8 +29,26 @@ extension HttpBody: Equatable {
 }
 
 public extension HttpBody {
-
     static var empty: HttpBody {
         .data(nil)
     }
 }
+
+extension HttpBody: CustomDebugStringConvertible {
+    public var debugDescription: String {
+        var bodyAsString: String?
+        switch self {
+        case .data(let data):
+            if let data = data {
+                bodyAsString = String(data: data, encoding: .utf8)
+            }
+        case .streamSource(let stream):
+            let byteBuffer = ByteBuffer(size: 1024)
+            stream.unwrap().sendData(writeTo: byteBuffer)
+            bodyAsString = String(data: byteBuffer.toData(), encoding: .utf8)
+        default:
+            bodyAsString = nil
+        }
+        return bodyAsString ?? ""
+    }
+}

Packages/ClientRuntime/Sources/Networking/Http/HttpContext.swift

@@ -41,6 +41,10 @@ public struct HttpContext: MiddlewareContext {
     public func getHostPrefix() -> String? {
         return attributes.get(key: AttributeKey<String>(name: "HostPrefix"))
     }
+    
+    public func getLogger() -> LogAgent? {
+        return attributes.get(key: AttributeKey<LogAgent>(name: "Logger"))
+    }
 }
 
 public class HttpContextBuilder {
@@ -58,6 +62,7 @@ public class HttpContextBuilder {
     let decoder = AttributeKey<ResponseDecoder>(name: "Decoder")
     let idempotencyTokenGenerator = AttributeKey<IdempotencyTokenGenerator>(name: "IdempotencyTokenGenerator")
     let hostPrefix = AttributeKey<String>(name: "HostPrefix")
+    let logger = AttributeKey<LogAgent>(name: "Logger")
 
     // We follow the convention of returning the builder object
     // itself from any configuration methods, and by adding the
@@ -130,6 +135,12 @@ public class HttpContextBuilder {
         return self
     }
 
+    @discardableResult
+    public func withLogger(value: LogAgent) -> HttpContextBuilder {
+        self.attributes.set(key: logger, value: value)
+        return self
+    }
+    
     public func build() -> HttpContext {
         return HttpContext(attributes: attributes)
     }

Packages/ClientRuntime/Sources/Networking/Http/HttpResponse.swift

@@ -24,3 +24,12 @@ public class HttpResponse: HttpUrlResponse {
         self.headers = headers
     }
 }
+
+extension HttpResponse: CustomDebugStringConvertible {
+    public var debugDescriptionWithBody: String {
+        return debugDescription + "\n \(body)"
+    }
+    public var debugDescription: String {
+        return "\(statusCode) \n \(headers)"
+    }
+}

Packages/ClientRuntime/Sources/Networking/Http/SdkHttpRequest.swift

@@ -9,7 +9,7 @@ import AwsCommonRuntimeKit
 
 // we need to maintain a reference to this same request while we add headers
 // in the CRT engine so that is why it's a class
-public class SdkHttpRequest: CustomStringConvertible {
+public class SdkHttpRequest {
     public var body: HttpBody
     public var headers: Headers
     public let queryItems: [URLQueryItem]?
@@ -27,10 +27,6 @@ public class SdkHttpRequest: CustomStringConvertible {
         self.body = body
         self.queryItems = queryItems
     }
-    
-    public var description: String {
-        return "SdkHttpRequest(body: \(body), headers: \(headers), queryItems: \(String(describing: queryItems)), endpoint: \(endpoint), method: \(method))"
-    }
 }
 
 extension SdkHttpRequest {
@@ -62,6 +58,21 @@ extension SdkHttpRequest {
     }
 }
 
+extension SdkHttpRequest: CustomDebugStringConvertible, CustomStringConvertible {
+    
+    public var debugDescriptionWithBody: String {
+        return debugDescription + "\n \(body)"
+    }
+    
+    public var debugDescription: String {
+        return "\(method.rawValue.uppercased()) \(endpoint.protocolType ?? ProtocolType.https):\(endpoint.port) \n Path: \(endpoint.path), \n \(headers) \n \(String(describing: queryItems))"
+    }
+    
+    public var description: String {
+        return "\(method.rawValue.uppercased()) \(endpoint.protocolType ?? ProtocolType.https):\(endpoint.port) \n Path: \(endpoint.path) \n \(headers) \n \(String(describing: queryItems))"
+    }
+}
+
 extension SdkHttpRequestBuilder {
     public func update(from crtRequest: HttpRequest, originalRequest: SdkHttpRequest) -> SdkHttpRequestBuilder {
         headers = convertSignedHeadersToHeaders(crtRequest: crtRequest)