Support for HTTP API request v2.0

janaz · janaz · commit ba14a575c807 · 2020-05-02T02:14:02.000+10:00
diff --git a/src/eventToRequestOptions.ts b/src/eventToRequestOptions.ts
@@ -52,9 +52,15 @@ const eventToRequestOptions = (event: APIGatewayEvent, ctx?: LambdaContext): InP
       remoteAddress = items[items.length - 1];
     }
   }
+  let method: string | undefined= event.httpMethod;
+  let path: string | undefined = event.path;
+  if (event.requestContext && typeof event.requestContext.http === 'object') {
+    method = event.requestContext.http.method
+    path = event.requestContext.http.path
+  }
   return {
-    method: event.httpMethod,
-    path: url.format({ pathname: event.path, query: queryStringParams }),
+    method,
+    path: url.format({ pathname: path, query: queryStringParams }),
     headers: headers,
     body: Buffer.from(event.body || '', event.isBase64Encoded ? 'base64' : 'utf8'),
     ssl,
diff --git a/src/fixResponseHeaders.ts b/src/fixResponseHeaders.ts
@@ -2,17 +2,22 @@ import { OutgoingHttpHeaders } from 'http';
 import { LambdaResponseHeaders, StringMap } from './types'
 import variations from './setCookieVariations';
 
-const fixResponseHeaders = (headers: OutgoingHttpHeaders, supportMultiHeaders: boolean): LambdaResponseHeaders => {
+const fixResponseHeaders = (headers: OutgoingHttpHeaders, supportMultiHeaders: boolean, supportCookies: boolean): LambdaResponseHeaders => {
   const multiValueHeaders: StringMap<string[]> = {};
   const singleValueHeaders: StringMap<string> = {};
+  let cookies: string[] | undefined = undefined
   Object.keys(headers).forEach(k => {
     if (Array.isArray(headers[k])) {
       const values = headers[k] as string[];
       multiValueHeaders[k] = values;
       if (k === 'set-cookie') {
-        values.forEach((value, i) => {
-          singleValueHeaders[variations[i]] = value
-        });
+        if (supportCookies) {
+          cookies = values
+        } else {
+          values.forEach((value, i) => {
+            singleValueHeaders[variations[i]] = value
+          });
+        }
       } else {
         singleValueHeaders[k] = values.join(',');
       }
@@ -36,7 +41,7 @@ const fixResponseHeaders = (headers: OutgoingHttpHeaders, supportMultiHeaders: b
   if (supportMultiHeaders) {
     return { multiValueHeaders };
   } else {
-    return { headers: singleValueHeaders }
+    return { headers: singleValueHeaders, cookies }
   }
 };
 
diff --git a/src/lambda.ts b/src/lambda.ts
@@ -21,6 +21,10 @@ const eventHasMultiValueHeaders = (event: handler.APIGatewayEvent): boolean => {
   return event.multiValueHeaders !== null && typeof event.multiValueHeaders === 'object';
 }
 
+const eventSupportsCookies = (event: handler.APIGatewayEvent): boolean => {
+  return event.version === "2.0" && !eventHasMultiValueHeaders(event)
+}
+
 const handlerBuilder = (appFn: PromiseFactory<RequestListener>): handler.APIGatewayEventHandler => {
   let appHandler: Nullable<F<MockRequestOptions, Promise<MockResponse>>>;
   return async (event, ctx) => {
@@ -31,7 +35,7 @@ const handlerBuilder = (appFn: PromiseFactory<RequestListener>): handler.APIGate
     try {
       const reqOptions = eventToRequestOptions(event, ctx);
       const mockResponse = await appHandler(reqOptions);
-      return inProcessResponseToLambdaResponse(mockResponse, eventHasMultiValueHeaders(event));
+      return inProcessResponseToLambdaResponse(mockResponse, eventHasMultiValueHeaders(event), eventSupportsCookies(event));
     } catch (e) {
       console.error(e);
       return errorResponse();
diff --git a/src/response.ts b/src/response.ts
@@ -2,13 +2,13 @@ import { InProcessResponse } from 'in-process-request';
 import { LambdaResponse } from './types';
 import fixResponseHeaders from './fixResponseHeaders'
 
-export const inProcessResponseToLambdaResponse = (response: InProcessResponse, supportMultiHeaders: boolean): LambdaResponse => {
+export const inProcessResponseToLambdaResponse = (response: InProcessResponse, supportMultiHeaders: boolean, supportCookies: boolean): LambdaResponse => {
   const encoding = response.isUTF8 ? 'utf8' : 'base64';
   return {
     statusCode: response.statusCode,
     body: response.body.toString(encoding),
     isBase64Encoded: encoding === 'base64',
-    ...fixResponseHeaders(response.headers, supportMultiHeaders),
+    ...fixResponseHeaders(response.headers, supportMultiHeaders, supportCookies),
   };
 };
 
diff --git a/src/types.ts b/src/types.ts
@@ -2,31 +2,42 @@ export interface StringMap<T> {
   [k: string]: T
 }
 
+interface HttpRequestContext {
+  method: string
+  path: string
+  protocol: string
+  sourceIp: string
+  userAgent: string
+}
+
 export interface APIGatewayEvent {
-  path: string,
-  queryStringParameters?: StringMap<string> | null | undefined,
-  multiValueQueryStringParameters?: StringMap<string[]> | null | undefined,
-  body: string | null | undefined,
-  headers?: StringMap<string> | null | undefined,
-  multiValueHeaders?: StringMap<string[]> | null | undefined,
+  path?: string,
+  version?: number | string,
+  queryStringParameters?: StringMap<string> | null,
+  multiValueQueryStringParameters?: StringMap<string[]> | null,
+  body?: string | null,
+  headers?: StringMap<string> | null,
+  multiValueHeaders?: StringMap<string[]> | null,
   isBase64Encoded: boolean,
-  httpMethod: string,
+  httpMethod?: string,
   requestContext?: {
     elb?: {
       targetGroupArn: string,
     },
+    http?: HttpRequestContext,
     stage?: string,
     identity?: {
       sourceIp: string,
     },
 
-    [k: string]: any
+    // [k: string]: any
   }
 }
 
 export interface LambdaResponseHeaders {
-  headers?: StringMap<string> | undefined
-  multiValueHeaders?: StringMap<string[]> | undefined
+  headers?: StringMap<string>
+  multiValueHeaders?: StringMap<string[]>
+  cookies?: string[]
 }
 
 export interface LambdaResponse extends LambdaResponseHeaders {
diff --git a/test/app/index.ts b/test/app/index.ts
@@ -23,7 +23,7 @@ app.get('/cookies', (_, res) => {
   res.cookie('chocolate', '10');
   res.cookie('peanut_butter', '20');
   res.cookie('cinnamon', '30');
-  res.end();
+  res.send("cookies set");
 });
 
 app.get('/user/:id', (req, res) => {
diff --git a/test/fixtures/event-http-api-1.0.json b/test/fixtures/event-http-api-1.0.json
@@ -0,0 +1,106 @@
+{
+    "version": "1.0",
+    "resource": "$default",
+    "path": "/cookies",
+    "httpMethod": "GET",
+    "headers": {
+        "Content-Length": "0",
+        "Host": "myapiid.execute-api.ap-southeast-2.amazonaws.com",
+        "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
+        "X-Amzn-Trace-Id": "Root=1-5eac36bd-7a4863e4e05a7ca67c0a68ae",
+        "X-Forwarded-For": "14.201.132.129",
+        "X-Forwarded-Port": "443",
+        "X-Forwarded-Proto": "https",
+        "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
+        "accept-encoding": "gzip, deflate, br",
+        "accept-language": "en-US,en;q=0.9,pl-PL;q=0.8,pl;q=0.7,ru;q=0.6",
+        "sec-fetch-dest": "document",
+        "sec-fetch-mode": "navigate",
+        "sec-fetch-site": "none",
+        "sec-fetch-user": "?1",
+        "upgrade-insecure-requests": "1"
+    },
+    "multiValueHeaders": {
+        "Content-Length": [
+            "0"
+        ],
+        "Host": [
+            "myapiid.execute-api.ap-southeast-2.amazonaws.com"
+        ],
+        "User-Agent": [
+            "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36"
+        ],
+        "X-Amzn-Trace-Id": [
+            "Root=1-5eac36bd-7a4863e4e05a7ca67c0a68ae"
+        ],
+        "X-Forwarded-For": [
+            "14.201.132.129"
+        ],
+        "X-Forwarded-Port": [
+            "443"
+        ],
+        "X-Forwarded-Proto": [
+            "https"
+        ],
+        "accept": [
+            "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9"
+        ],
+        "accept-encoding": [
+            "gzip, deflate, br"
+        ],
+        "accept-language": [
+            "en-US,en;q=0.9,pl-PL;q=0.8,pl;q=0.7,ru;q=0.6"
+        ],
+        "sec-fetch-dest": [
+            "document"
+        ],
+        "sec-fetch-mode": [
+            "navigate"
+        ],
+        "sec-fetch-site": [
+            "none"
+        ],
+        "sec-fetch-user": [
+            "?1"
+        ],
+        "upgrade-insecure-requests": [
+            "1"
+        ]
+    },
+    "queryStringParameters": null,
+    "multiValueQueryStringParameters": null,
+    "requestContext": {
+        "accountId": "356111732087",
+        "apiId": "myapiid",
+        "domainName": "myapiid.execute-api.ap-southeast-2.amazonaws.com",
+        "domainPrefix": "myapiid",
+        "extendedRequestId": "L219niDmywMEJPQ=",
+        "httpMethod": "GET",
+        "identity": {
+            "accessKey": null,
+            "accountId": null,
+            "caller": null,
+            "cognitoAuthenticationProvider": null,
+            "cognitoAuthenticationType": null,
+            "cognitoIdentityId": null,
+            "cognitoIdentityPoolId": null,
+            "principalOrgId": null,
+            "sourceIp": "14.201.132.129",
+            "user": null,
+            "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
+            "userArn": null
+        },
+        "path": "/cookies",
+        "protocol": "HTTP/1.1",
+        "requestId": "L219niDmywMEJPQ=",
+        "requestTime": "01/May/2020:14:48:29 +0000",
+        "requestTimeEpoch": 1588344509401,
+        "resourceId": "$default",
+        "resourcePath": "$default",
+        "stage": "$default"
+    },
+    "pathParameters": null,
+    "stageVariables": null,
+    "body": null,
+    "isBase64Encoded": false
+  }
diff --git a/test/fixtures/event-http-api-2.0.json b/test/fixtures/event-http-api-2.0.json
@@ -0,0 +1,43 @@
+{
+  "version": "2.0",
+  "routeKey": "$default",
+  "rawPath": "/inspects",
+  "rawQueryString": "",
+  "headers": {
+      "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
+      "accept-encoding": "gzip, deflate, br",
+      "accept-language": "en-US,en;q=0.9,pl-PL;q=0.8,pl;q=0.7,ru;q=0.6",
+      "cache-control": "max-age=0",
+      "content-length": "0",
+      "host": "myapiid.execute-api.ap-southeast-2.amazonaws.com",
+      "sec-fetch-dest": "document",
+      "sec-fetch-mode": "navigate",
+      "sec-fetch-site": "none",
+      "sec-fetch-user": "?1",
+      "upgrade-insecure-requests": "1",
+      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
+      "x-amzn-trace-id": "Root=1-5eac37e3-8e447320ce745898566b3300",
+      "x-forwarded-for": "123.123.123.123",
+      "x-forwarded-port": "443",
+      "x-forwarded-proto": "https"
+  },
+  "requestContext": {
+      "accountId": "356111732087",
+      "apiId": "myapiid",
+      "domainName": "myapiid.execute-api.ap-southeast-2.amazonaws.com",
+      "domainPrefix": "myapiid",
+      "http": {
+          "method": "GET",
+          "path": "/cookies",
+          "protocol": "HTTP/1.1",
+          "sourceIp": "123.123.123.123",
+          "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36"
+      },
+      "requestId": "L22rohfjSwMEMHA=",
+      "routeKey": "$default",
+      "stage": "$default",
+      "time": "01/May/2020:14:53:23 +0000",
+      "timeEpoch": 1588344803984
+  },
+  "isBase64Encoded": false
+}
diff --git a/test/integration.test.ts b/test/integration.test.ts
@@ -4,6 +4,8 @@ import lambda from '../src/lambda';
 
 import event from './fixtures/event.json';
 import eventHttpApi from './fixtures/event-http-api.json';
+import eventHttpApiV1 from './fixtures/event-http-api-1.0.json';
+import eventHttpApiV2 from './fixtures/event-http-api-2.0.json';
 import eventAlb from './fixtures/alb-event.json';
 
 const handler = lambda(app);
@@ -134,7 +136,7 @@ describe('integration', () => {
     })
   })
 
-  it('handles HTTP API event', async () => {
+  it('handles HTTP API legacy event', async () => {
     const response = await handler(eventHttpApi)
     expect(response.statusCode).toEqual(200);
     expect(response.isBase64Encoded).toEqual(false);
@@ -175,6 +177,40 @@ describe('integration', () => {
     })
   })
 
+  it('handles HTTP API v1.0 event', async () => {
+    const response = await handler(eventHttpApiV1)
+    expect(response.statusCode).toEqual(200);
+    expect(response.isBase64Encoded).toEqual(false);
+    expect(response.multiValueHeaders!["content-type"][0]).toEqual('text/html; charset=utf-8');
+    expect(response.multiValueHeaders!["x-powered-by"][0]).toEqual('Express');
+    expect(response.multiValueHeaders!["set-cookie"]).toEqual([
+      'chocolate=10; Path=/',
+      'peanut_butter=20; Path=/',
+      'cinnamon=30; Path=/',
+    ])
+    expect(response.headers).toBeUndefined()
+    expect(response.cookies).toBeUndefined()
+    expect(response.body).toEqual('cookies set');
+  })
+
+  it('handles HTTP API v2.0 event', async () => {
+    const response = await handler(eventHttpApiV2)
+    expect(response.statusCode).toEqual(200);
+    expect(response.isBase64Encoded).toEqual(false);
+    expect(response.headers!["content-type"]).toEqual('text/html; charset=utf-8');
+    expect(response.headers!["x-powered-by"]).toEqual('Express');
+    expect(response.headers!["set-cookie"]).toBeUndefined()
+    expect(response.multiValueHeaders).toBeUndefined()
+    expect(response.cookies).toEqual([
+      'chocolate=10; Path=/',
+      'peanut_butter=20; Path=/',
+      'cinnamon=30; Path=/',
+      ])
+    expect(response.body).toEqual('cookies set');
+
+  })
+
+
   it('handles ALB event', async () => {
     const response = await handler(eventAlb)
     expect(response.statusCode).toEqual(200);
diff --git a/test/response.test.ts b/test/response.test.ts
