Address PR comments (and format)

Author: natanrolnik

Sources/AWSLambdaEvents/Codable Helpers/APIGatewayV2+Encode.swift

@@ -1,20 +1,46 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) 2017-2022 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import HTTPTypes
+
 #if canImport(FoundationEssentials)
 import FoundationEssentials
 #else
 import Foundation
 #endif
 
-import HTTPTypes
+public protocol DecodableRequest {
+    var body: String? { get }
+    var isBase64Encoded: Bool { get }
+
+    func decodeBody() throws -> Data?
+    func decodeBody<T>(
+        _ type: T.Type,
+        using decoder: JSONDecoder
+    ) throws -> T where T: Decodable
+}
 
-public extension APIGatewayV2Request {
+extension DecodableRequest {
     /// Decodes the body of the request into a `Data` object.
     ///
     /// - Returns: The decoded body as `Data` or `nil` if the body is empty.
-    func decodeBody() throws -> Data? {
+    public func decodeBody() throws -> Data? {
         guard let body else { return nil }
 
         if isBase64Encoded,
-           let base64Decoded = Data(base64Encoded: body) {
+            let base64Decoded = Data(base64Encoded: body)
+        {
             return base64Decoded
         }
 
@@ -30,7 +56,7 @@ public extension APIGatewayV2Request {
     ///
     /// - Returns: The decoded body as `T`.
     /// - Throws: An error if the body cannot be decoded.
-    func decodeBody<T>(
+    public func decodeBody<T>(
         _ type: T.Type,
         using decoder: JSONDecoder = JSONDecoder()
     ) throws -> T where T: Decodable {
@@ -39,10 +65,14 @@ public extension APIGatewayV2Request {
         var requestData = bodyData
 
         if isBase64Encoded,
-           let base64Decoded = Data(base64Encoded: requestData) {
+            let base64Decoded = Data(base64Encoded: requestData)
+        {
             requestData = base64Decoded
         }
 
         return try decoder.decode(T.self, from: requestData)
     }
 }
+
+extension APIGatewayV2Request: DecodableRequest {}
+extension FunctionURLRequest: DecodableRequest {}

Sources/AWSLambdaEvents/Codable Helpers/APIGatewayV2+Decode.swift renamed to Sources/AWSLambdaEvents/Codable Helpers/DecodableRequest.swift

@@ -0,0 +1,107 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) 2017-2022 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import HTTPTypes
+
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+public protocol EncodableResponse {
+    static func encoding<T>(
+        _ encodable: T,
+        status: HTTPResponse.Status,
+        using encoder: JSONEncoder,
+        headers: HTTPHeaders?,
+        cookies: [String]?,
+        onError: ((Error) -> Self)
+    ) -> Self where T: Encodable
+
+    init(
+        statusCode: HTTPResponse.Status,
+        headers: HTTPHeaders?,
+        body: String?,
+        cookies: [String]?,
+        isBase64Encoded: Bool?
+    )
+}
+
+extension EncodableResponse {
+    /// Encodes a given encodable object into a response object.
+    ///
+    /// - Parameters:
+    ///   - encodable: The object to encode.
+    ///   - status: The status code to use. Defaults to `ok`.
+    ///   - encoder: The encoder to use. Defaults to a new `JSONEncoder`.
+    ///   - onError: A closure to handle errors, and transform them into a `APIGatewayV2Response`.
+    /// Defaults to converting the error into a 500 (Internal Server Error) response with the error message as
+    /// the body.
+    ///
+    /// - Returns: a response object whose body is the encoded `encodable` type and with the
+    /// other response parameters
+    public static func encoding<T>(
+        _ encodable: T,
+        status: HTTPResponse.Status = .ok,
+        using encoder: JSONEncoder = JSONEncoder(),
+        headers: HTTPHeaders? = nil,
+        cookies: [String]? = nil,
+        onError: ((Error) -> Self) = Self.defaultErrorHandler
+    ) -> Self where T: Encodable {
+        do {
+            let encodedResponse = try encoder.encode(encodable)
+            return Self(
+                statusCode: status,
+                headers: headers,
+                body: String(data: encodedResponse, encoding: .utf8),
+                cookies: cookies,
+                isBase64Encoded: nil
+            )
+        } catch {
+            return onError(error)
+        }
+    }
+
+    public static var defaultErrorHandler: ((Error) -> Self) {
+        { error in
+            Self(
+                statusCode: .internalServerError,
+                headers: nil,
+                body: "Internal Server Error: \(String(describing: error))",
+                cookies: nil,
+                isBase64Encoded: nil
+            )
+        }
+    }
+}
+
+extension APIGatewayV2Response: EncodableResponse {
+    public init(
+        statusCode: HTTPResponse.Status,
+        headers: HTTPHeaders?,
+        body: String?,
+        cookies: [String]?,
+        isBase64Encoded: Bool?
+    ) {
+        self.init(
+            statusCode: statusCode,
+            headers: headers,
+            body: body,
+            isBase64Encoded: isBase64Encoded,
+            cookies: cookies
+        )
+    }
+}
+extension FunctionURLResponse: EncodableResponse {}

Sources/AWSLambdaEvents/Codable Helpers/EncodableResponse.swift

@@ -1,10 +1,24 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) 2017-2022 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
 #if canImport(FoundationEssentials)
 import FoundationEssentials
 #else
 import Foundation
 #endif
 
-public extension SQSEvent {
+extension SQSEvent {
     /// Decodes the records included in the event into an array of decodable objects.
     ///
     /// - Parameters:
@@ -13,7 +27,7 @@ public extension SQSEvent {
     ///
     /// - Returns: The decoded records as `[T]`.
     /// - Throws: An error if any of the records cannot be decoded.
-    func decodeBody<T>(
+    public func decodeBody<T>(
         _ type: T.Type,
         using decoder: JSONDecoder = JSONDecoder()
     ) throws -> [T] where T: Decodable {
@@ -23,7 +37,7 @@ public extension SQSEvent {
     }
 }
 
-public extension SQSEvent.Message {
+extension SQSEvent.Message {
     /// Decodes the body of the message into a decodable object.
     ///
     /// - Parameters:
@@ -32,10 +46,10 @@ public extension SQSEvent.Message {
     ///
     /// - Returns: The decoded body as `T`.
     /// - Throws: An error if the body cannot be decoded.
-    func decodeBody<T>(
+    public func decodeBody<T>(
         _ type: T.Type,
         using decoder: JSONDecoder = JSONDecoder()
     ) throws -> T where T: Decodable {
         try decoder.decode(T.self, from: body.data(using: .utf8) ?? Data())
     }
-}
+}