update all method signatures

Author: manwaring

CHANGELOG.md

@@ -4,7 +4,13 @@ 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)
 
-## [1.0.7]  (2019-09-04)
+## [1.0.8]  (2019-09-07)
+
+### Changed
+
+- Update the remaining wrapper signature with Lambda inputs (event, context, callback) for easier testing in applications
+
+## [1.0.7]  (2019-09-07)
 
 ### Changed
 
@@ -38,6 +44,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
 
+[1.0.8]: https://github.com/manwaring/lambda-wrapper/compare/v1.0.7...v1.0.8
 [1.0.7]: https://github.com/manwaring/lambda-wrapper/compare/v1.0.1...v1.0.7
 [1.0.1]: https://github.com/manwaring/lambda-wrapper/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/manwaring/lambda-wrapper/compare/v0.3.8...v1.0.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": "1.0.7",
+  "version": "1.0.8",
   "scripts": {
     "publish-please-dry-run": "publish-please --dry-run",
     "publish-please": "publish-please",

package.json

@@ -31,7 +31,7 @@ describe('API responses', () => {
   it('Handles error response', () => {
     const error = errorWrapper(metrics, callback);
     error('error');
-    expect(callback).toHaveBeenCalledWith(new Error('error'));
+    expect(callback).toHaveBeenCalledWith('error');
   });
 
   it('Handles invalid response', () => {

src/api/responses.test.ts

@@ -31,7 +31,7 @@ export function invalidWrapper(metrics: Metrics, callback: Callback) {
 export function errorWrapper(metrics: Metrics, callback: Callback) {
   return function error(error?: any) {
     metrics.error(error);
-    callback(new Error(error));
+    callback(error);
   };
 }
 

src/api/responses.ts

@@ -26,7 +26,7 @@ describe('API wrapper', () => {
   const callback = jest.fn((err, result) => (err ? new Error(err) : result));
 
   it('Has expected properties and response functions', () => {
-    function mockHandler({
+    function custom({
       event,
       body,
       path,
@@ -52,6 +52,6 @@ describe('API wrapper', () => {
       expect(error).toBeInstanceOf(Function);
       success('success');
     }
-    api(mockHandler)(requestEvent, context, callback);
+    api(custom)(requestEvent, context, callback);
   });
 });

src/api/wrapper.test.ts

@@ -11,7 +11,7 @@ export function api(
   return function handler(event: APIGatewayEvent, context: Context, callback: Callback) {
     const { body, path, query, auth, headers, testRequest } = new Request(event).getProperties();
 
-    const signature = {
+    return custom({
       event,
       body,
       path,
@@ -23,8 +23,7 @@ export function api(
       invalid: invalidWrapper(metrics, callback),
       error: errorWrapper(metrics, callback),
       redirect: redirectWrapper(metrics, callback)
-    };
-    return custom(signature);
+    });
   };
 }
 

src/api/wrapper.ts

@@ -1,13 +1,24 @@
-import { valid, invalid, error } from './responses';
+import { validWrapper, invalidWrapper, errorWrapper } from './responses';
+import { Metrics } from '../common';
 
 describe('Lambda Authorizer responses', () => {
+  const metrics = new Metrics('Lambda Authorizer');
+  const callback = jest.fn((err, result) => (err ? new Error(err) : result));
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
   it('Handles valid response with jwt sub', () => {
+    const valid = validWrapper(metrics, callback);
     const jwt = {
       sub: '1234567890',
       name: 'John Doe',
       admin: true
     };
-    expect(valid(jwt)).toEqual({
+
+    valid(jwt);
+    expect(callback).toHaveBeenCalledWith(null, {
       principalId: '1234567890',
       policyDocument: {
         Version: '2012-10-17',
@@ -23,12 +34,15 @@ describe('Lambda Authorizer responses', () => {
   });
 
   it('Handles valid response with jwt claims', () => {
+    const valid = validWrapper(metrics, callback);
     const jwt = {
       claims: 'abcdefghij',
       name: 'John Doe',
       admin: true
     };
-    expect(valid(jwt)).toEqual({
+
+    valid(jwt);
+    expect(callback).toHaveBeenCalledWith(null, {
       principalId: 'abcdefghij',
       policyDocument: {
         Version: '2012-10-17',
@@ -44,11 +58,14 @@ describe('Lambda Authorizer responses', () => {
   });
 
   it('Handles valid response without jwt subs or claims', () => {
+    const valid = validWrapper(metrics, callback);
     const jwt = {
       name: 'John Doe',
       admin: true
     };
-    expect(valid(jwt)).toEqual({
+
+    valid(jwt);
+    expect(callback).toHaveBeenCalledWith(null, {
       principalId: '',
       policyDocument: {
         Version: '2012-10-17',
@@ -64,10 +81,14 @@ describe('Lambda Authorizer responses', () => {
   });
 
   it('Handles invalid response', () => {
-    expect(() => invalid()).toThrow('Unauthorized');
+    const invalid = invalidWrapper(metrics, callback);
+    invalid();
+    expect(callback).toHaveBeenCalledWith('Unauthorized');
   });
 
   it('Handles error response', () => {
-    expect(() => error('error')).toThrow('error');
+    const error = errorWrapper(metrics, callback);
+    error('error');
+    expect(callback).toHaveBeenCalledWith('error');
   });
 });

src/authorizer/responses.test.ts

@@ -1,21 +1,26 @@
+import { Callback } from 'aws-lambda';
 import { Metrics } from '../common';
 
-const metrics = new Metrics('Lambda Authorizer');
-
-export function valid(jwt: any) {
-  const policy = generatePolicy(jwt);
-  metrics.valid(policy);
-  return policy;
+export function validWrapper(metrics: Metrics, callback: Callback) {
+  return function valid(jwt: any) {
+    const policy = generatePolicy(jwt);
+    metrics.valid(policy);
+    callback(null, policy);
+  };
 }
 
-export function invalid(message?: any): void {
-  metrics.invalid(message);
-  throw new Error('Unauthorized');
+export function invalidWrapper(metrics: Metrics, callback: Callback) {
+  return function invalid(message?: any): void {
+    metrics.invalid(message);
+    callback('Unauthorized');
+  };
 }
 
-export function error(error?: any) {
-  metrics.error(error);
-  throw new Error(error);
+export function errorWrapper(metrics: Metrics, callback: Callback) {
+  return function error(error?: any) {
+    metrics.error(error);
+    callback(error);
+  };
 }
 
 function generatePolicy(jwt: any): any {

src/authorizer/responses.ts

@@ -1,5 +1,21 @@
 import { authorizer, AuthorizerSignature } from './wrapper';
 
+const context = {
+  callbackWaitsForEmptyEventLoop: false,
+  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));
+
 describe('Stream wrapper', () => {
   const requestEvent = {
     type: 'type',
@@ -8,14 +24,14 @@ describe('Stream wrapper', () => {
   };
 
   it('Has expected properties and response funtions', () => {
-    function mockHandler({ event, token, valid, invalid, error }: AuthorizerSignature) {
+    function custom({ event, token, valid, invalid, error }: AuthorizerSignature) {
       expect(event).toEqual(requestEvent);
       expect(token).toEqual('token');
       expect(valid).toBeInstanceOf(Function);
       expect(invalid).toBeInstanceOf(Function);
       expect(error).toBeInstanceOf(Function);
+      error('error');
     }
-    // @ts-ignore
-    authorizer(mockHandler)(requestEvent);
+    authorizer(custom)(requestEvent, context, callback);
   });
 });