feat: Handling multi value query params and headers

Author: muratcorlu

README.md

@@ -89,9 +89,9 @@ Properties:
 | [protocol](https://expressjs.com/en/4x/api.html#req.protocol) | - |
 | [secure](https://expressjs.com/en/4x/api.html#req.secure) | - |
 | [method](https://expressjs.com/en/4x/api.html#req.method) | - |
-| [query](https://expressjs.com/en/4x/api.html#req.query) | Doesn't include repeated query parameters. |
+| [query](https://expressjs.com/en/4x/api.html#req.query) | - |
 | [params](https://expressjs.com/en/4x/api.html#req.params) | - |
-| [headers](https://expressjs.com/en/4x/api.html#req.headers) | Doesn't include repeated headers values |
+| [headers](https://expressjs.com/en/4x/api.html#req.headers) | - |
 
 Methods:
 

src/lambda-wrapper.spec.js

@@ -67,7 +67,10 @@ describe('Lambda Wrapper', () => {
         'Content-Type': 'application/json',
         'Content-Length': requestObject.length
       },
-      multiValueHeaders: {},
+      multiValueHeaders: {
+        'Content-Type': [ 'application/json' ],
+        'Content-Length': [ requestObject.length ]
+      },
       httpMethod: 'POST',
       isBase64Encoded: false,
       path: '/path',

src/request.js

@@ -9,14 +9,20 @@ class Request extends ReadableStream {
   constructor(event) {
     super();
 
-    this.headers = Object.keys(event.headers).reduce((headers, key) => {
-      headers[key.toLowerCase()] = event.headers[key];
+    this.headers = Object.keys(event.multiValueHeaders).reduce((headers, key) => {
+      const value = event.multiValueHeaders[key];
+      headers[key.toLowerCase()] = value.length > 1 ? value : value[0];
       return headers;
     }, {});
 
     this.hostname = this.headers.host
     this.method = event.httpMethod;
-    this.query = event.queryStringParameters;
+    this.query = Object.keys(event.multiValueQueryStringParameters).reduce((queryParams, key) => {
+      const value = event.multiValueQueryStringParameters[key];
+      queryParams[key] = value.length > 1 ? value : value[0];
+      return queryParams;
+    }, {});
+
     this.path = event.path;
     this.params = event.pathParameters;
 

src/request.spec.js

@@ -6,27 +6,57 @@ describe('Request object', () => {
     body: JSON.stringify(requestObject),
     headers: {
       'Content-Type': 'application/json',
-      'Content-Length': JSON.stringify(requestObject).length
+      'Content-Length': JSON.stringify(requestObject).length,
+      'X-Header': 'value2'
+    },
+    multiValueHeaders: {
+      'Content-Type': [ 'application/json' ],
+      'Content-Length': [ JSON.stringify(requestObject).length ],
+      'X-Header': [ 'value1', 'value2' ]
     },
-    multiValueHeaders: {},
     httpMethod: 'POST',
     isBase64Encoded: false,
     path: '/path',
     pathParameters: { },
-    queryStringParameters: { },
-    multiValueQueryStringParameters: { },
+    queryStringParameters: {
+      a: '1',
+      b: '2'
+    },
+    multiValueQueryStringParameters: {
+      a: [ '1' ],
+      b: [ '1', '2']
+    },
     stageVariables: { },
     requestContext: {},
     resource: ''
   };
 
+  it('should read query parameter', () => {
+    const request = new Request(event);
+
+    expect(request.query.a).toBe('1');
+  });
+
+
+  it('should read query parameter with multiple values', () => {
+    const request = new Request(event);
+
+    expect(request.query.b).toEqual(['1', '2']);
+  });
+
   it('should read header', () => {
     const request = new Request(event);
 
     expect(request.get('Content-Type')).toBe('application/json');
     expect(request.get('content-type')).toBe('application/json');
   });
 
+  it('should read header with multiple values', () => {
+    const request = new Request(event);
+
+    expect(request.get('X-Header')).toEqual(['value1', 'value2']);
+  });
+
   it('should handle weird header asks', () => {
     const request = new Request(event);
 
@@ -37,6 +67,7 @@ describe('Request object', () => {
   it('should read referer/referrer header', () => {
     const referer = 'muratcorlu.com';
     event.headers['Referer'] = referer;
+    event.multiValueHeaders['Referer'] = [ referer ];
 
     const request = new Request(event);
     expect(request.get('referer')).toBe(referer);
@@ -52,6 +83,7 @@ describe('Request object', () => {
 
   it('should check accept header', () => {
     event.headers['Accept'] = 'application/json';
+    event.multiValueHeaders['Accept'] = [ 'application/json' ];
 
     const request = new Request(event);
     expect(request.accepts('xml')).toBe(false);
@@ -63,6 +95,7 @@ describe('Request object', () => {
 
   it('should check acceptEncodings', () => {
     event.headers['accept-encoding'] = 'gzip, compress;q=0.2';
+    event.multiValueHeaders['accept-encoding'] = [ 'gzip, compress;q=0.2' ];
 
     const request = new Request(event);
     expect(request.acceptsEncodings('gzip', 'compress')).toBe('gzip');
@@ -71,6 +104,7 @@ describe('Request object', () => {
 
   it('should check acceptsCharsets', () => {
     event.headers['accept-charset'] = 'utf-8, iso-8859-1;q=0.2, utf-7;q=0.5';
+    event.multiValueHeaders['accept-charset'] = [ 'utf-8, iso-8859-1;q=0.2, utf-7;q=0.5' ];
 
     const request = new Request(event);
     expect(request.acceptsCharsets('utf-7', 'utf-8')).toBe('utf-8');
@@ -79,6 +113,7 @@ describe('Request object', () => {
 
   it('should check acceptsLanguages', () => {
     event.headers['accept-charset'] = 'en;q=0.8, es, tr';
+    event.multiValueHeaders['accept-charset'] = [ 'en;q=0.8, es, tr' ];
 
     const request = new Request(event);
     expect(request.acceptsLanguages('tr', 'en')).toBe('tr');

src/response.spec.js

@@ -94,7 +94,10 @@ describe('Response object', () => {
           'Accept': 'text/xml',
           'Content-Length': 0
         },
-        multiValueHeaders: {},
+        multiValueHeaders: {
+          'Accept': [ 'text/xml' ],
+          'Content-Length': [ 0 ]
+        },
         httpMethod: 'POST',
         isBase64Encoded: false,
         path: '/path',
@@ -136,7 +139,10 @@ describe('Response object', () => {
           'Accept': 'text/html',
           'Content-Length': 0
         },
-        multiValueHeaders: {},
+        multiValueHeaders: {
+          'Accept': [ 'text/html' ],
+          'Content-Length': [ 0 ]
+        },
         httpMethod: 'POST',
         isBase64Encoded: false,
         path: '/path',
@@ -182,7 +188,10 @@ describe('Response object', () => {
           'Accept': 'image/jpeg',
           'Content-Length': 0
         },
-        multiValueHeaders: {},
+        multiValueHeaders: {
+          'Accept': [ 'image/jpeg' ],
+          'Content-Length': [ 0 ]
+        },
         httpMethod: 'POST',
         isBase64Encoded: false,
         path: '/path',

src/test-event.json

@@ -0,0 +1,123 @@
+{
+  "body": "eyJ0ZXN0IjoiYm9keSJ9",
+  "resource": "/{proxy+}",
+  "path": "/path/to/resource",
+  "httpMethod": "POST",
+  "isBase64Encoded": true,
+  "queryStringParameters": {
+    "foo": "bar"
+  },
+  "multiValueQueryStringParameters": {
+    "foo": [
+      "bar"
+    ]
+  },
+  "pathParameters": {
+    "proxy": "/path/to/resource"
+  },
+  "stageVariables": {
+    "baz": "qux"
+  },
+  "headers": {
+    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
+    "Accept-Encoding": "gzip, deflate, sdch",
+    "Accept-Language": "en-US,en;q=0.8",
+    "Cache-Control": "max-age=0",
+    "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": "1234567890.execute-api.eu-central-1.amazonaws.com",
+    "Upgrade-Insecure-Requests": "1",
+    "User-Agent": "Custom User Agent String",
+    "Via": "1.1 08f323deadbeefa7af34d5feb414ce27.cloudfront.net (CloudFront)",
+    "X-Amz-Cf-Id": "cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA==",
+    "X-Forwarded-For": "127.0.0.1, 127.0.0.2",
+    "X-Forwarded-Port": "443",
+    "X-Forwarded-Proto": "https"
+  },
+  "multiValueHeaders": {
+    "Accept": [
+      "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8"
+    ],
+    "Accept-Encoding": [
+      "gzip, deflate, sdch"
+    ],
+    "Accept-Language": [
+      "en-US,en;q=0.8"
+    ],
+    "Cache-Control": [
+      "max-age=0"
+    ],
+    "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": [
+      "0123456789.execute-api.eu-central-1.amazonaws.com"
+    ],
+    "Upgrade-Insecure-Requests": [
+      "1"
+    ],
+    "User-Agent": [
+      "Custom User Agent String"
+    ],
+    "Via": [
+      "1.1 08f323deadbeefa7af34d5feb414ce27.cloudfront.net (CloudFront)"
+    ],
+    "X-Amz-Cf-Id": [
+      "cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA=="
+    ],
+    "X-Forwarded-For": [
+      "127.0.0.1, 127.0.0.2"
+    ],
+    "X-Forwarded-Port": [
+      "443"
+    ],
+    "X-Forwarded-Proto": [
+      "https"
+    ]
+  },
+  "requestContext": {
+    "accountId": "123456789012",
+    "resourceId": "123456",
+    "stage": "prod",
+    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
+    "requestTime": "09/Apr/2015:12:34:56 +0000",
+    "requestTimeEpoch": 1428582896000,
+    "identity": {
+      "cognitoIdentityPoolId": null,
+      "accountId": null,
+      "cognitoIdentityId": null,
+      "caller": null,
+      "accessKey": null,
+      "sourceIp": "127.0.0.1",
+      "cognitoAuthenticationType": null,
+      "cognitoAuthenticationProvider": null,
+      "userArn": null,
+      "userAgent": "Custom User Agent String",
+      "user": null
+    },
+    "path": "/prod/path/to/resource",
+    "resourcePath": "/{proxy+}",
+    "httpMethod": "POST",
+    "apiId": "1234567890",
+    "protocol": "HTTP/1.1"
+  }
+}