add apig v2 payload support

Author: jeremydaly

.travis.yml

@@ -8,7 +8,6 @@ const api = require('../index')({ version: 'v1.0' })
 /******************************************************************************/
 api.get('/test/hello', function(req,res) {
   let request = Object.assign(req,{app:null})
-  // console.log(JSON.stringify(request,null,2));
   res.cookie('test','value')
   res.cookie('test2','value2')
   res.status(200).json({ request })
@@ -27,9 +26,9 @@ api.get('/test/201', function(req,res) {
 
 describe('Request Tests:', function() {
 
-  describe('API Gateway Proxy Event', function() {
+  describe('API Gateway Proxy Event v1', function() {
     it('Standard event', async function() {
-      let _event = require('./sample-event-apigateway1.json')
+      let _event = require('./sample-event-apigateway-v1.json')
       let _context = require('./sample-context-apigateway1.json')
       let result = await new Promise(r => api.run(_event,_context,(e,res) => { r(res) }))
       let body = JSON.parse(result.body)
@@ -57,7 +56,7 @@ describe('Request Tests:', function() {
     })
 
     it('Missing X-Forwarded-For (sourceIp fallback)', async function() {
-      let _event = require('./sample-event-apigateway1.json')
+      let _event = require('./sample-event-apigateway-v1.json')
       let _context = require('./sample-context-apigateway1.json')
       delete _event.headers['X-Forwarded-For'] // remove the header
       delete _event.multiValueHeaders['x-forwarded-for'] // remove the header
@@ -86,6 +85,37 @@ describe('Request Tests:', function() {
     })
   })
 
+  describe('API Gateway Proxy Event v2', function() {
+    it('Standard event', async function() {
+      let _event = require('./sample-event-apigateway-v2.json')
+      let _context = require('./sample-context-apigateway1.json')
+      let result = await new Promise(r => api.run(_event,_context,(e,res) => { r(res) }))
+      let body = JSON.parse(result.body)
+      // console.log(result);
+      // console.log(body.request.multiValueHeaders);
+      expect(result.cookies).toEqual(['test=value; Path=/','test2=value2; Path=/'])
+      expect(body).toHaveProperty('request')
+      expect(body.request.id).toBeDefined()
+      expect(body.request.interface).toBe('apigateway')
+      expect(body.request.userAgent).toBe('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.82 Safari/537.36 OPR/39.0.2256.48')
+      expect(body.request).toHaveProperty('requestContext')
+      expect(body.request.ip).toBe('192.168.100.1')
+      expect(body.request.pathParameters).toEqual({ "proxy": "hello" })
+      expect(body.request.stageVariables).toEqual({ "stageVarName": "stageVarValue" })
+      expect(body.request.isBase64Encoded).toBe(false)
+      expect(body.request.clientType).toBe('desktop')
+      expect(body.request.clientCountry).toBe('US')
+      expect(body.request.route).toBe('/test/hello')
+      expect(body.request.query.qs1).toBe('foo')
+      expect(body.request.query.qs2).toBe('foo,bar')
+      expect(body.request.multiValueQuery.qs2).toEqual(['foo','bar'])
+      expect(body.request.multiValueQuery.qs3).toEqual(['bat','baz'])
+      expect(body.request.headers['test-header']).toBe('val1,val2')
+      expect(body.request.multiValueHeaders['test-header']).toEqual(['val1','val2'])
+      expect(body.request.cookies).toEqual({ cookie1: 'test', cookie2: 123 })
+    })
+  })
+
   describe('ALB Event', function() {
     it('Standard event', async function() {
       let _event = require('./sample-event-alb1.json')

__tests__/requests.unit.js

@@ -0,0 +1,85 @@
+{
+  "version": "2.0",
+  "routeKey": "$default",
+  "rawPath": "/test/hello",
+  "rawQueryString": "parameter1=value1&parameter1=value2&parameter2=value",
+  "cookies": [
+    "cookie1=test",
+    "cookie2=123"
+  ],
+  "headers": {
+    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
+    "Accept-Encoding": "gzip, deflate, lzma, sdch, br",
+    "Accept-Language": "en-US,en;q=0.8",
+    "CloudFront-Forwarded-Proto": "https",
+    "CloudFront-Is-Desktop-Viewer": "true",
+    "CloudFront-Is-Mobile-Viewer": "false",
+    "CloudFront-Is-SmartTV-Viewer": "false",
+    "CloudFront-Is-Tablet-Viewer": "false",
+    "CloudFront-Viewer-Country": "US",
+    "Host": "wt6mne2s9k.execute-api.us-west-2.amazonaws.com",
+    "Upgrade-Insecure-Requests": "1",
+    "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.82 Safari/537.36 OPR/39.0.2256.48",
+    "Via": "1.1 fb7cca60f0ecd82ce07790c9c5eef16c.cloudfront.net (CloudFront)",
+    "X-Amz-Cf-Id": "nBsWBOrSHMgnaROZJK1wGCZ9PcRcSpq_oSXZNQwQ10OTZL4cimZo3g==",
+    "X-Forwarded-For": "192.168.100.1, 192.168.1.1",
+    "X-Forwarded-Port": "443",
+    "X-Forwarded-Proto": "https",
+    "test-header": "val1,val2"
+  },
+  "queryStringParameters": {
+    "qs1": "foo",
+    "qs2": "foo,bar",
+    "qs3": "bat,baz"
+  },
+  "requestContext": {
+    "accountId": "123456789012",
+    "apiId": "api-id",
+    "authentication": {
+      "clientCert": {
+        "clientCertPem": "CERT_CONTENT",
+        "subjectDN": "www.example.com",
+        "issuerDN": "Example issuer",
+        "serialNumber": "a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1",
+        "validity": {
+          "notBefore": "May 28 12:30:02 2019 GMT",
+          "notAfter": "Aug  5 09:36:04 2021 GMT"
+        }
+      }
+    },
+    "authorizer": {
+      "jwt": {
+        "claims": {
+          "claim1": "value1",
+          "claim2": "value2"
+        },
+        "scopes": [
+          "scope1",
+          "scope2"
+        ]
+      }
+    },
+    "domainName": "id.execute-api.us-east-1.amazonaws.com",
+    "domainPrefix": "id",
+    "http": {
+      "method": "GET",
+      "path": "/test/hello",
+      "protocol": "HTTP/1.1",
+      "sourceIp": "IP",
+      "userAgent": "agent"
+    },
+    "requestId": "id",
+    "routeKey": "$default",
+    "stage": "$default",
+    "time": "12/Mar/2020:19:03:58 +0000",
+    "timeEpoch": 1583348638390
+  },
+  "body": "Hello from Lambda",
+  "pathParameters": {
+    "proxy": "hello"
+  },
+  "isBase64Encoded": false,
+  "stageVariables": {
+    "stageVarName": "stageVarValue"
+  }
+}

__tests__/sample-event-apigateway1.json renamed to __tests__/sample-event-apigateway-v1.json

@@ -3,7 +3,7 @@
 /**
  * Lightweight web framework for your serverless applications
  * @author Jeremy Daly <[email protected]>
- * @version 0.10.8
+ * @version 0.11.0
  * @license MIT
  */
 

__tests__/sample-event-apigateway-v2.json

@@ -61,14 +61,19 @@ class REQUEST {
   // Parse the request
   async parseRequest() {
 
+    // Set the payload version
+    this.payloadVersion = this.app._event.version ? this.app._event.version : null
+    
     // Detect multi-value support
     this._multiValueSupport = 'multiValueHeaders' in this.app._event
 
     // Set the method
-    this.method = this.app._event.httpMethod ? this.app._event.httpMethod.toUpperCase() : 'GET'
+    this.method = this.app._event.httpMethod ? this.app._event.httpMethod.toUpperCase() 
+      : this.app._event.requestContext && this.app._event.requestContext.http ? this.app._event.requestContext.http.method.toUpperCase()
+      : 'GET'
 
     // Set the path
-    this.path = this.app._event.path
+    this.path = this.payloadVersion === '2.0' ? this.app._event.rawPath : this.app._event.path
 
     // Set the query parameters (backfill for ALB)
     this.query = Object.assign({}, this.app._event.queryStringParameters,
@@ -82,7 +87,7 @@ class REQUEST {
     // Set the multi-value query parameters (simulate if no multi-value support)
     this.multiValueQuery = Object.assign({},
       this._multiValueSupport ? {} : Object.keys(this.query)
-        .reduce((qs,key) => Object.assign(qs, { [key]: [this.query[key]] }), {}),
+        .reduce((qs,key) => Object.assign(qs, { [key]: this.query[key].split(',') }), {}),
       this.app._event.multiValueQueryStringParameters)
 
     // Set the raw headers (normalize multi-values)
@@ -98,21 +103,21 @@ class REQUEST {
 
     this.multiValueHeaders = this._multiValueSupport ? this.app._event.multiValueHeaders
       : Object.keys(this.headers).reduce((headers,key) =>
-        Object.assign(headers,{ [key.toLowerCase()]: [this.headers[key]] }),{})
+        Object.assign(headers,{ [key.toLowerCase()]: this.headers[key].split(',') }),{})
 
     // Extract user agent
     this.userAgent = this.headers['user-agent']
 
+    // Get cookies from event
+    let cookies = this.app._event.cookies ? this.app._event.cookies
+      : this.headers.cookie ? this.headers.cookie.split(';')
+      : []
+    
     // Set and parse cookies
-    this.cookies = this.headers.cookie ?
-      this.headers.cookie.split(';')
-        .reduce(
-          (acc,cookie) => {
-            cookie = cookie.trim().split('=')
-            return Object.assign(acc,{ [cookie[0]] : UTILS.parseBody(decodeURIComponent(cookie[1])) })
-          },
-          {}
-        ) : {}
+    this.cookies = cookies.reduce((acc,cookie) => {
+      cookie = cookie.trim().split('=')
+      return Object.assign(acc,{ [cookie[0]] : UTILS.parseBody(decodeURIComponent(cookie[1])) })
+    },{})
 
     // Attempt to parse the auth
     this.auth = UTILS.parseAuth(this.headers.authorization)

index.js

@@ -457,10 +457,26 @@ class RESPONSE {
       body = ''
     }
 
+    let headers = {}
+    let cookies = {}
+
+    if (this._request.payloadVersion === '2.0') {
+      if (this._headers['set-cookie']) {
+        cookies = { cookies: this._headers['set-cookie'] }
+        delete this._headers['set-cookie']
+      }
+    }
+    
+    if (this._request._multiValueSupport) {
+      headers = { multiValueHeaders: this._headers }
+    } else {
+      headers = { headers: UTILS.stringifyHeaders(this._headers) }
+    }
+
     // Create the response
     this._response = Object.assign({},
-      this._request._multiValueSupport ? { multiValueHeaders: this._headers }
-      : { headers: UTILS.stringifyHeaders(this._headers) },
+      headers,
+      cookies,
       {
         statusCode: this._statusCode,
         body: this._request.method === 'HEAD' ? '' : UTILS.encodeBody(body,this._serializer),

lib/request.js

@@ -1,6 +1,6 @@
 {
   "name": "lambda-api",
-  "version": "0.10.8",
+  "version": "0.11.0",
   "description": "Lightweight web framework for your serverless applications",
   "main": "index.js",
   "types": "index.d.ts",