Refine APIGateway.Response APIs

Author: stevapple

Examples/CloudFunctions/Sources/APIGateway/main.swift

@@ -42,6 +42,6 @@ struct APIGatewayProxySCF: EventLoopSCFHandler {
 
     public func handle(context: SCF.Context, event: APIGateway.Request<String>) -> EventLoopFuture<APIGateway.Response> {
         context.logger.debug("hello, api gateway!")
-        return context.eventLoop.makeSucceededFuture(APIGateway.Response(statusCode: .ok, body: "Hello, world!"))
+        return context.eventLoop.makeSucceededFuture(APIGateway.Response(statusCode: .ok, body: .string("Hello, world!")))
     }
 }

Sources/TencentSCFEvents/APIGateway/Response+Init.swift

@@ -17,63 +17,59 @@ import struct Foundation.Data
 // https://cloud.tencent.com/document/product/583/12513
 
 extension APIGateway.Response {
-    public init<T: Encodable>(
+    public init(
         statusCode: HTTPResponseStatus,
         headers: HTTPHeaders = [:],
-        codableBody: T?
+        body: @autoclosure () throws -> Body = .null
     ) {
-        var headers = headers
-        headers["Content-Type"] = MIME.json.rawValue
-        self.headers = headers
+        let rawBody: Body
         do {
-            self.body = String(
-                data: try APIGateway.defaultJSONEncoder.encode(codableBody),
-                encoding: .utf8
-            ) ?? ""
-            self.statusCode = statusCode
-        } catch let err as EncodingError {
-            self.body = #"{"error":"EncodingError","message":"\#("\(err)".jsonEncoded())"}"#
-            self.statusCode = .internalServerError
+            rawBody = try body()
         } catch let err {
-            self.body = #"{"error":"UnexpectedError","message":"\#("\(err)".jsonEncoded())"}"#
+            self.headers = headers.merging(["Content-Type": "application/json"]) { (_, default) in `default` }
             self.statusCode = .internalServerError
+            self.isBase64Encoded = false
+            if let err = err as? EncodingError {
+                self.body = #"{"error":"EncodingError","message":"\#("\(err)".jsonEncoded())"}"#
+            } else {
+                self.body = #"{"error":"UnexpectedError","message":"\#("\(err)".jsonEncoded())"}"#
+            }
+            return
         }
-        self.isBase64Encoded = false
-    }
 
-    public init(
-        statusCode: HTTPResponseStatus,
-        headers: HTTPHeaders = [:],
-        type: MIME? = nil,
-        body: String? = nil
-    ) {
         self.statusCode = statusCode
-        var headers = headers
-        if let type = type?.rawValue {
-            headers["Content-Type"] = type
-        } else {
-            headers["Content-Type"] = MIME.text.rawValue
+        self.headers = headers.merging(["Content-Type": rawBody.defaultMIME]) { (custom, _) in custom }
+
+        switch rawBody {
+        case .data(let dataBody):
+            self.body = dataBody.base64EncodedString()
+            self.isBase64Encoded = true
+        case .json(let stringBody), .string(let stringBody):
+            self.body = stringBody
+            self.isBase64Encoded = false
+        case .null:
+            self.body = ""
+            self.isBase64Encoded = true
         }
-        self.headers = headers
-        self.body = body ?? ""
-        self.isBase64Encoded = false
     }
 
-    public init(
-        statusCode: HTTPResponseStatus,
-        headers: HTTPHeaders = [:],
-        type: MIME? = nil,
-        body: Data
-    ) {
-        self.statusCode = statusCode
-        var headers = headers
-        if let type = type?.rawValue {
-            headers["Content-Type"] = type
-        } else {
-            headers["Content-Type"] = MIME.octet.rawValue
+    public enum Body {
+        case json(String)
+        case data(Data)
+        case string(String)
+        case null
+
+        public static func codable<T: Encodable>(_ body: T) throws -> Self {
+            return .json(String(data: try APIGateway.defaultJSONEncoder.encode(body), encoding: .utf8) ?? "")
+        }
+
+        var defaultMIME: String {
+            switch self {
+            case .json: return "application/json"
+            case .data: return "application/octet-stream"
+            case .string: return "text/plain"
+            case .null: return "text/plain"
+            }
         }
-        self.headers = headers
-        self.body = body.base64EncodedString()
-        self.isBase64Encoded = true
     }
 }

Tests/TencentSCFEventsTests/APIGatewayTests.swift

@@ -169,8 +169,7 @@ class APIGatewayTests: XCTestCase {
 
         let resp = APIGateway.Response(
             statusCode: .ok,
-            type: .text,
-            body: "abc123"
+            body: .string("abc123")
         )
         let expectedJson = #"{"body":"abc123","headers":{"Content-Type":"text\/plain"},"isBase64Encoded":false,"statusCode":200}"#
 
@@ -192,7 +191,7 @@ class APIGatewayTests: XCTestCase {
         let body = #"{"hello":"swift"}"#
         let resp = APIGateway.Response(
             statusCode: .ok,
-            body: body.data(using: .utf8)!
+            body: .data(body.data(using: .utf8)!)
         )
         let expectedJson = #"{"body":"\#(body.data(using: .utf8)!.base64EncodedString())","headers":{"Content-Type":"application\/octet-stream"},"isBase64Encoded":true,"statusCode":200}"#
 
@@ -217,7 +216,7 @@ class APIGatewayTests: XCTestCase {
         let point = Point(x: 1.01, y: -0.01)
         let resp = APIGateway.Response(
             statusCode: .ok,
-            codableBody: point
+            body: try .codable(point)
         )
         let expectedJson = [
             #"{"body":"{\"x\":1.01,\"y\":-0.01}","headers":{"Content-Type":"application\/json"},"isBase64Encoded":false,"statusCode":200}"#,
@@ -240,7 +239,7 @@ class APIGatewayTests: XCTestCase {
         encoder.outputFormatting = .sortedKeys
 
         let resp = APIGateway.Response(statusCode: .ok)
-        let expectedJson = #"{"body":"","headers":{"Content-Type":"text\/plain"},"isBase64Encoded":false,"statusCode":200}"#
+        let expectedJson = #"{"body":"","headers":{"Content-Type":"text\/plain"},"isBase64Encoded":true,"statusCode":200}"#
 
         var data: Data?
         XCTAssertNoThrow(data = try encoder.encode(resp))
@@ -260,8 +259,8 @@ class APIGatewayTests: XCTestCase {
         let mime = "application/x-javascript"
         let resp = APIGateway.Response(
             statusCode: .ok,
-            type: .init(rawValue: mime),
-            body: "console.log(\"Hello world!\");"
+            headers: ["Content-Type": mime],
+            body: .string("console.log(\"Hello world!\");")
         )
         let expectedJson = #"{"body":"console.log(\"Hello world!\");","headers":{"Content-Type":"application\/x-javascript"},"isBase64Encoded":false,"statusCode":200}"#
 
@@ -290,7 +289,7 @@ class APIGatewayTests: XCTestCase {
 
         let resp = APIGateway.Response(
             statusCode: .ok,
-            codableBody: NotReallyEncodable()
+            body: try .codable(NotReallyEncodable())
         )
         let expectedJson = #"{"body":"{\"error\":\"EncodingError\",\"message\":\"invalidValue(\\\"NotReallyEncodable\\\", Swift.EncodingError.Context(codingPath: [], debugDescription: \\\"You\\\\'re testing something not really Encodable! Good luck.\\\"\"}","headers":{"Content-Type":"application\/json"},"isBase64Encoded":false,"statusCode":500}"#