Adapt API Gateway event data

Author: stevapple

Examples/CloudFunctions/scripts/serverless/APIGateway/serverless.yml

@@ -26,3 +26,5 @@ inputs:
           endpoints:
             - path: /api
               method: GET
+              function:
+                isIntegratedResponse: TRUE

README.md

@@ -21,6 +21,8 @@ There are several areas which need additional attention, including but not limit
 * Additional documentation and best practices
 * Additional examples
 
+By August 2020, SCF Custom Runtime is also at an early stage. You may encounter some problems triggered by the SCF Runtime Engine itself, or the API changes and deprecations. You are welcome to open issues actively on those problems.
+
 ## Getting started
 
 If you have used [Swift AWS Lambda Runtime](https://github.com/swift-server/swift-aws-lambda-runtime), you may find most of the APIs familiar. If you have never used Tencent SCF, AWS Lambda or Docker before, check out this [getting started guide](https://fabianfett.de/getting-started-with-swift-aws-lambda-runtime) which helps you with every step from zero to a running cloud function.

Sources/TencentSCFEvents/APIGateway.swift

@@ -22,7 +22,6 @@ public enum APIGateway {
         public struct Context: Codable {
             public let identity: [String: String]
             public let serviceId: String
-            public let requestId: String
             public let path: String
             public let sourceIp: String
             public let stage: Stage
@@ -37,10 +36,9 @@ public enum APIGateway {
         public let pathParameters: [String: String]
         public let queryStringParameters: [String: String]
         public let headerParameters: [String: String]
-        public let stageVariables: [String: String]
 
         public let context: Context
-        public let body: String
+        public let body: String?
 
         enum CodingKeys: String, CodingKey {
             case context = "requestContext"
@@ -53,42 +51,42 @@ public enum APIGateway {
             case pathParameters
             case queryStringParameters
             case headerParameters
-            case stageVariables
         }
     }
 
     public enum Stage: String, Codable {
         case test
+        case debug
         case prepub
         case release
     }
 
     public struct Response: Codable {
         public let statusCode: HTTPResponseStatus
-        public let headers: HTTPHeaders?
-        public let body: String?
+        public let headers: HTTPHeaders
+        public let body: String
         public let isBase64Encoded: Bool
 
         public init(
             statusCode: HTTPResponseStatus,
-            headers: HTTPHeaders? = nil,
+            headers: HTTPHeaders = [:],
             body: String? = nil,
             isBase64Encoded: Bool = false
         ) {
             self.statusCode = statusCode
             self.headers = headers
-            self.body = body
+            self.body = body ?? ""
             self.isBase64Encoded = isBase64Encoded
         }
 
         public init(
             statusCode: HTTPResponseStatus,
-            headers: HTTPHeaders? = nil,
-            body: Data? = nil
+            headers: HTTPHeaders = [:],
+            body: Data
         ) {
             self.statusCode = statusCode
             self.headers = headers
-            self.body = body?.base64EncodedString()
+            self.body = body.base64EncodedString()
             self.isBase64Encoded = true
         }
     }

Tests/TencentSCFEventsTests/APIGatewayTests.swift

@@ -35,18 +35,21 @@ class APIGatewayTests: XCTestCase {
         "serviceId": "service-f94sy04v",
         "path": "/test/{path}",
         "httpMethod": "POST",
-        "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
         "identity": {
           "secretId": "abdcdxxxxxxxsdfs"
         },
         "sourceIp": "10.0.2.14",
-        "stage": "release"
+        "stage": "debug"
       },
       "headers": {
-        "Accept-Language": "en-US,en,cn",
-        "Accept": "text/html,application/xml,application/json",
-        "Host": "service-3ei3tii4-251000691.ap-guangzhou.apigateway.myqloud.com",
-        "User-Agent": "User Agent String"
+        "accept-language": "en-US,en,cn",
+        "accept": "text/html,application/xml,application/json",
+        "host": "service-3ei3tii4-251000691.ap-guangzhou.apigateway.myqloud.com",
+        "user-agent": "User Agent String",
+        "x-anonymous-consumer":  "true",
+        "x-api-requestid": "24281851d905b02add27dad71656f29b",
+        "x-b3-traceid": "24281851d905b02add27dad71656f29b",
+        "x-qualifier": "$DEFAULT"
       },
       "body": "{\"test\":\"body\"}",
       "pathParameters": {
@@ -58,9 +61,6 @@ class APIGatewayTests: XCTestCase {
       "headerParameters":{
         "Refer": "10.0.2.14"
       },
-      "stageVariables": {
-        "stage": "release"
-      },
       "path": "/test/value",
       "queryString": {
         "foo": "bar",
@@ -77,29 +77,31 @@ class APIGatewayTests: XCTestCase {
 
         XCTAssertEqual(req?.path, "/test/value")
         XCTAssertEqual(req?.body, #"{"test":"body"}"#)
-        XCTAssertEqual(req?.headers, ["Accept-Language": "en-US,en,cn",
-                                      "Accept": "text/html,application/xml,application/json",
-                                      "Host": "service-3ei3tii4-251000691.ap-guangzhou.apigateway.myqloud.com",
-                                      "User-Agent": "User Agent String"])
+        XCTAssertEqual(req?.headers, ["accept-language": "en-US,en,cn",
+                                      "accept": "text/html,application/xml,application/json",
+                                      "host": "service-3ei3tii4-251000691.ap-guangzhou.apigateway.myqloud.com",
+                                      "user-agent": "User Agent String",
+                                      "x-anonymous-consumer":  "true",
+                                      "x-api-requestid": "24281851d905b02add27dad71656f29b",
+                                      "x-b3-traceid": "24281851d905b02add27dad71656f29b",
+                                      "x-qualifier": "$DEFAULT"])
         XCTAssertEqual(req?.query, ["foo": "bar",
                                     "bob": "alice"])
         XCTAssertEqual(req?.httpMethod, .POST)
 
         XCTAssertEqual(req?.pathParameters, ["path": "value"])
         XCTAssertEqual(req?.queryStringParameters, ["foo": "bar"])
         XCTAssertEqual(req?.headerParameters, ["Refer": "10.0.2.14"])
-        XCTAssertEqual(req?.stageVariables, ["stage": "release"])
 
         XCTAssertEqual(req?.context.sourceIp, "10.0.2.14")
-        XCTAssertEqual(req?.context.requestId, "c6af9ac6-7b61-11e6-9a41-93e8deadbeef")
         XCTAssertEqual(req?.context.serviceId, "service-f94sy04v")
         XCTAssertEqual(req?.context.path, "/test/{path}")
         XCTAssertEqual(req?.context.httpMethod, .POST)
-        XCTAssertEqual(req?.context.stage, .release)
+        XCTAssertEqual(req?.context.stage, .debug)
         XCTAssertEqual(req?.context.identity, ["secretId": "abdcdxxxxxxxsdfs"])
     }
 
-    func testResponseEncodingWithString() {
+    func testResponseEncodingWithText() {
         let resp = APIGateway.Response(
             statusCode: .ok,
             headers: ["Content-Type": "text/plain"],
@@ -113,16 +115,16 @@ class APIGatewayTests: XCTestCase {
 
         XCTAssertEqual(json?.statusCode, resp.statusCode)
         XCTAssertEqual(json?.body, resp.body)
-        XCTAssertEqual(json?.isBase64Encoded, resp.isBase64Encoded)
-        XCTAssertEqual(json?.headers?["Content-Type"], "text/plain")
+        XCTAssertEqual(json?.isBase64Encoded, false)
+        XCTAssertEqual(json?.headers["Content-Type"], "text/plain")
     }
 
     func testResponseEncodingWithData() {
         let body = #"{"hello":"swift"}"#
         let resp = APIGateway.Response(
             statusCode: .ok,
             headers: ["Content-Type": "application/json"],
-            body: body.data(using: .utf8)
+            body: body.data(using: .utf8)!
         )
 
         var data: Data?
@@ -137,7 +139,7 @@ class APIGatewayTests: XCTestCase {
 
         XCTAssertEqual(newResp.statusCode, resp.statusCode)
         XCTAssertEqual(newResp.isBase64Encoded, true)
-        XCTAssertEqual(newResp.headers?["Content-Type"], "application/json")
-        XCTAssertEqual(Data(base64Encoded: newResp.body!), body.data(using: .utf8))
+        XCTAssertEqual(newResp.headers["Content-Type"], "application/json")
+        XCTAssertEqual(Data(base64Encoded: newResp.body), body.data(using: .utf8))
     }
 }