update tests to match new testRequest logic

Author: manwaring

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [4.4.2]  (2020-11-25)
+
+### Fixed
+
+- Update calculation of `testRequest` prop on api signature based on headers
+
 ## [4.4.1]  (2020-11-25)
 
 ### Changed
@@ -342,6 +348,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/),
 - Update older libraries
 - Now publish from Git tags instead of master pushes
 
+[4.4.2]: https://github.com/manwaring/lambda-wrapper/compare/v4.4.1...v4.4.2
 [4.4.1]: https://github.com/manwaring/lambda-wrapper/compare/v4.4.0...v4.4.1
 [4.4.0]: https://github.com/manwaring/lambda-wrapper/compare/v4.3.0...v4.4.0
 [4.3.0]: https://github.com/manwaring/lambda-wrapper/compare/v4.2.0...v4.3.0

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@manwaring/lambda-wrapper",
   "description": "A lambda handler wrapper to abstract common functionality and provide useful defaults",
-  "version": "4.4.1",
+  "version": "4.4.2",
   "scripts": {
     "publish-please-dry-run": "publish-please --dry-run",
     "publish-please": "publish-please",
@@ -23,7 +23,7 @@
     "@types/aws-lambda": "^8.10.64",
     "@types/cfn-response": "^1.0.4",
     "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.9",
+    "@types/node": "^14.14.10",
     "@typescript-eslint/eslint-plugin": "^4.8.2",
     "@typescript-eslint/parser": "^4.8.2",
     "aws-lambda": "^1.0.6",

package.json

@@ -1,72 +1,72 @@
-import { stringify } from 'querystring';
-import { apiGatewayEvent } from 'serverless-plugin-test-helper';
-import { Request, Body } from './parser';
+import { stringify } from "querystring";
+import { apiGatewayEvent } from "serverless-plugin-test-helper";
+import { Request, Body } from "./parser";
 
-describe('Body parsing', () => {
-  it('Parses json body', () => {
-    const json = { hello: 'world' };
-    const headers = { 'content-type': 'application/json' };
+describe("Body parsing", () => {
+  it("Parses json body", () => {
+    const json = { hello: "world" };
+    const headers = { "content-type": "application/json" };
     const body = new Body(JSON.stringify(json), headers).getParsedBody();
     expect(body).toEqual(json);
   });
 
-  it('Parses json body when charset is also defined in the content-type', () => {
-    const json = { hello: 'world' };
-    const headers = { 'content-type': 'application/json;charset=UTF-8' };
+  it("Parses json body when charset is also defined in the content-type", () => {
+    const json = { hello: "world" };
+    const headers = { "content-type": "application/json;charset=UTF-8" };
     const body = new Body(JSON.stringify(json), headers).getParsedBody();
     expect(body).toEqual(json);
   });
 
-  it('Parses form url encoded body', () => {
-    const form = { hello: 'world' };
-    const headers = { 'content-type': 'application/x-www-form-urlencoded' };
+  it("Parses form url encoded body", () => {
+    const form = { hello: "world" };
+    const headers = { "content-type": "application/x-www-form-urlencoded" };
     const body = new Body(stringify(form), headers).getParsedBody();
     expect(body).toEqual(form);
   });
 
-  it('Parses form url encoded body when charset is also defined in the content-type', () => {
-    const form = { hello: 'world' };
-    const headers = { 'content-type': 'application/x-www-form-urlencoded;charset=UTF-8' };
+  it("Parses form url encoded body when charset is also defined in the content-type", () => {
+    const form = { hello: "world" };
+    const headers = { "content-type": "application/x-www-form-urlencoded;charset=UTF-8" };
     const body = new Body(stringify(form), headers).getParsedBody();
     expect(body).toEqual(form);
   });
 
   it("Tries to parse body as JSON when content type isn't specified", () => {
-    const json = { hello: 'world' };
+    const json = { hello: "world" };
     const headers = undefined;
     const body = new Body(JSON.stringify(json), headers).getParsedBody();
     expect(body).toEqual(json);
   });
 
   it("Errors when encoding and content-type don't match", () => {
     const invalid = '2["test" : 123]4}{';
-    const headers = { 'content-type': 'application/json' };
+    const headers = { "content-type": "application/json" };
     const body = new Body(invalid, headers).getParsedBody();
     expect(body).toEqual(invalid);
   });
 
-  it('Returns empty body when none given', () => {
+  it("Returns empty body when none given", () => {
     let empty;
-    const headers = { 'content-type': 'application/x-www-form-urlencoded' };
+    const headers = { "content-type": "application/x-www-form-urlencoded" };
     const body = new Body(empty, headers).getParsedBody();
     expect(body).toEqual(empty);
   });
 });
 
-describe('Request parsing', () => {
-  it('Gets all fields with optional parameters', () => {
+describe("Request parsing", () => {
+  it("Gets all fields with optional parameters", () => {
     const event = apiGatewayEvent({
-      body: JSON.stringify({ hello: 'world' }),
-      pathParameters: { proxy: 'not today' },
-      queryStringParameters: { name: 'a test' },
-      headers: { 'content-type': 'application/json', 'Test-Request': 'true' },
+      body: JSON.stringify({ hello: "world" }),
+      pathParameters: { proxy: "not today" },
+      queryStringParameters: { name: "a test" },
+      headers: { "content-type": "application/json", "test-request": "true" },
     });
     const { body, path, query, auth, headers, testRequest } = new Request(event).getProperties();
 
-    expect(body).toEqual({ hello: 'world' });
-    expect(path).toEqual({ proxy: 'not today' });
-    expect(query).toEqual({ name: 'a test' });
-    expect(headers['content-type']).toEqual('application/json');
+    expect(body).toEqual({ hello: "world" });
+    expect(path).toEqual({ proxy: "not today" });
+    expect(query).toEqual({ name: "a test" });
+    expect(headers["content-type"]).toEqual("application/json");
     expect(testRequest).toEqual(true);
     expect(auth).toBeTruthy();
   });
@@ -87,7 +87,7 @@ describe('Request parsing', () => {
     expect(testRequest).toBeFalsy();
   });
 
-  it('Supports default values in method signature', () => {
+  it("Supports default values in method signature", () => {
     const event = apiGatewayEvent();
     delete event.body;
     delete event.headers;

src/api/v1/parser.test.ts

@@ -1,8 +1,8 @@
-import { APIGatewayEvent } from 'aws-lambda';
-import { parse } from 'querystring';
-import { Metrics, logger } from '../../common';
+import { APIGatewayEvent } from "aws-lambda";
+import { parse } from "querystring";
+import { Metrics, logger } from "../../common";
 
-const metrics = new Metrics('API Gateway');
+const metrics = new Metrics("API Gateway");
 
 export class Request {
   constructor(private event: APIGatewayEvent) {}
@@ -15,7 +15,7 @@ export class Request {
     const auth = this.getAuth();
     const headers = event.headers ? event.headers : undefined;
     const body = new Body(event.body, headers).getParsedBody();
-    const TEST_REQUEST_HEADER = process.env.TEST_REQUEST_HEADER || 'Test-Request';
+    const TEST_REQUEST_HEADER = process.env.TEST_REQUEST_HEADER || "test-request";
     const testRequest = headers && headers[TEST_REQUEST_HEADER] ? JSON.parse(headers[TEST_REQUEST_HEADER]) : false;
     const parsed = { body, websocket, path, query, auth, headers, testRequest };
     metrics.common(parsed, event);
@@ -24,6 +24,7 @@ export class Request {
 
   private getAuth() {
     const authorizer = this.event?.requestContext?.authorizer;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     const httpApiAuth = this.event.auth;
     return authorizer ? authorizer : httpApiAuth;
@@ -43,11 +44,11 @@ export class Body {
         } else if (this.isJSON(contentType)) {
           parsedBody = JSON.parse(this.body);
         } else {
-          logger.error('Content-Type header not found, attempting to parse as JSON');
+          logger.error("Content-Type header not found, attempting to parse as JSON");
           parsedBody = JSON.parse(this.body);
         }
       } catch (err) {
-        logger.error('Error parsing body, returning as-is', err, this.body);
+        logger.error("Error parsing body, returning as-is", err, this.body);
         parsedBody = this.body;
       }
     }
@@ -56,15 +57,15 @@ export class Body {
 
   private getContentType(): string {
     return (
-      this.headers && (this.headers['Content-Type'] || this.headers['CONTENT-TYPE'] || this.headers['content-type'])
+      this.headers && (this.headers["Content-Type"] || this.headers["CONTENT-TYPE"] || this.headers["content-type"])
     );
   }
 
   private isFormUrlEncoded(contentType?: string): boolean {
-    return contentType?.toUpperCase().includes('APPLICATION/X-WWW-FORM-URLENCODED');
+    return contentType?.toUpperCase().includes("APPLICATION/X-WWW-FORM-URLENCODED");
   }
 
   private isJSON(contentType: string): boolean {
-    return contentType?.toUpperCase().includes('APPLICATION/JSON');
+    return contentType?.toUpperCase().includes("APPLICATION/JSON");
   }
 }

src/api/v1/parser.ts

@@ -1,34 +1,34 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
-import { apiGatewayEvent } from 'serverless-plugin-test-helper';
-import { api, ApiSignature } from './wrapper';
+import { apiGatewayEvent } from "serverless-plugin-test-helper";
+import { api, ApiSignature } from "./wrapper";
 
-describe('API wrapper', () => {
+describe("API wrapper", () => {
   const requestEvent = apiGatewayEvent({
-    body: JSON.stringify({ hello: 'world' }),
-    pathParameters: { proxy: 'not today' },
-    queryStringParameters: { name: 'a test' },
-    headers: { 'content-type': 'application/json', 'Test-Request': 'true' },
+    body: JSON.stringify({ hello: "world" }),
+    pathParameters: { proxy: "not today" },
+    queryStringParameters: { name: "a test" },
+    headers: { "content-type": "application/json", "test-request": "true" },
     requestContext: {
-      connectionId: 'abc-123',
+      connectionId: "abc-123",
     },
   });
   const context = {
     callbackWaitsForEmptyEventLoop: false,
-    functionName: 'function-name',
-    functionVersion: '$LATEST',
-    invokedFunctionArn: 'arn:',
-    memoryLimitInMB: '128',
-    awsRequestId: 'request',
-    logGroupName: 'group',
-    logStreamName: 'stream',
+    functionName: "function-name",
+    functionVersion: "$LATEST",
+    invokedFunctionArn: "arn:",
+    memoryLimitInMB: "128",
+    awsRequestId: "request",
+    logGroupName: "group",
+    logStreamName: "stream",
     getRemainingTimeInMillis: () => 2,
     done: () => {},
     fail: () => {},
     succeed: () => {},
   };
   const callback = jest.fn((err, result) => (err ? new Error(err) : result));
 
-  it('Has expected properties and response functions', () => {
+  it("Has expected properties and response functions", () => {
     function customHandler({
       event,
       websocket,
@@ -47,11 +47,11 @@ describe('API wrapper', () => {
       custom,
     }: ApiSignature) {
       expect(event).toEqual(requestEvent);
-      expect(websocket.connectionId).toEqual('abc-123');
-      expect(body).toEqual({ hello: 'world' });
-      expect(path).toEqual({ proxy: 'not today' });
-      expect(query).toEqual({ name: 'a test' });
-      expect(headers['content-type']).toEqual('application/json');
+      expect(websocket.connectionId).toEqual("abc-123");
+      expect(body).toEqual({ hello: "world" });
+      expect(path).toEqual({ proxy: "not today" });
+      expect(query).toEqual({ name: "a test" });
+      expect(headers["content-type"]).toEqual("application/json");
       expect(testRequest).toEqual(true);
       expect(auth).toBeTruthy();
       expect(success).toBeInstanceOf(Function);
@@ -61,12 +61,12 @@ describe('API wrapper', () => {
       expect(redirect).toBeInstanceOf(Function);
       expect(error).toBeInstanceOf(Function);
       expect(custom).toBeInstanceOf(Function);
-      success({ body: 'success' });
+      success({ body: "success" });
     }
     api(customHandler)(requestEvent, context, callback);
   });
 
-  it('Has expected properties and response functions with optional generic type', () => {
+  it("Has expected properties and response functions with optional generic type", () => {
     interface CustomType {
       Message: string;
       Id: number;
@@ -89,11 +89,11 @@ describe('API wrapper', () => {
       custom,
     }: ApiSignature<CustomType>) {
       expect(event).toEqual(requestEvent);
-      expect(websocket.connectionId).toEqual('abc-123');
-      expect(body).toEqual({ hello: 'world' });
-      expect(path).toEqual({ proxy: 'not today' });
-      expect(query).toEqual({ name: 'a test' });
-      expect(headers['content-type']).toEqual('application/json');
+      expect(websocket.connectionId).toEqual("abc-123");
+      expect(body).toEqual({ hello: "world" });
+      expect(path).toEqual({ proxy: "not today" });
+      expect(query).toEqual({ name: "a test" });
+      expect(headers["content-type"]).toEqual("application/json");
       expect(testRequest).toEqual(true);
       expect(auth).toBeTruthy();
       expect(success).toBeInstanceOf(Function);
@@ -103,7 +103,7 @@ describe('API wrapper', () => {
       expect(redirect).toBeInstanceOf(Function);
       expect(error).toBeInstanceOf(Function);
       expect(custom).toBeInstanceOf(Function);
-      success({ body: 'success' });
+      success({ body: "success" });
     }
     api(customHandler)(requestEvent, context, callback);
   });