Merge branch 'master' of https://github.com/aceew/lambda-proxy-router

Author: aceew

README.md

@@ -6,6 +6,8 @@
 
 The purpose of this package is to easily organize the mapping between your code and your API request within Lambda functions that have more than one purpose. This takes away the need for the configuration of mapping templates and handles the standard event object that Amazon sends through with Lambda functions with proxy configuration. The desired effect of the package is to make it easier to build microservices that have multiple API Gateway endpoints.
 
+As this package relates to linking API Gateway and Lambda together, the request IDs for both services are logged out to CloudWatch so when an error occurs in API Gateway, you can search the for the Gateway request ID to find the logs. More information on this can be found [here](https://aws.amazon.com/blogs/compute/techniques-and-tools-for-better-serverless-api-logging-with-amazon-api-gateway-and-aws-lambda/).
+
 ## Contents
 - [Usage](#usage)
 - [Defining Routes](#routes)

package.json

@@ -4,7 +4,7 @@
   "description": "A hapi inspired router for AWS Lambda proxy functions",
   "main": "index.js",
   "scripts": {
-    "test": "npm run-script lint && nyc ava test && nyc report --reporter=text-lcov | coveralls",
+    "test": "npm run-script lint && nyc ava test -s && nyc report --reporter=text-lcov | coveralls",
     "lint": "eslint src/*.js test/*.js",
     "build": "babel src -d build && cp package.json build/package.json && cp README.md build/README.md"
   },
@@ -33,7 +33,8 @@
     "eslint-plugin-import": "^1.16.0",
     "eslint-plugin-jsx-a11y": "^2.2.3",
     "eslint-plugin-react": "^6.4.1",
-    "nyc": "^8.3.2"
+    "nyc": "^8.3.2",
+    "sinon": "^2.3.5"
   },
   "ava": {
     "babel": "inherit",

src/index.js

@@ -15,12 +15,36 @@ export default class Alpr {
     this.event = data.event || {};
     this.context = data.context || {};
     this.callback = data.callback;
+    this.logRequestIds();
 
     if (typeof this.callback !== 'function') {
       throw new Error('A callback must be specified.');
     }
   }
 
+  /**
+   * Logs the request ids from API Gateway and Lambda to make debugging requests from API Gateway
+   * easier.
+   *
+   * @return {void}
+   */
+  logRequestIds() {
+    let apiGatewayRequestId;
+    let lambdaRequestId;
+
+    if (this.event && this.event.requestContext && this.event.requestContext.requestId) {
+      apiGatewayRequestId = this.event.requestContext.requestId;
+    }
+
+    if (this.context && this.context.awsRequestId) {
+      lambdaRequestId = this.context.awsRequestId;
+    }
+
+    if (apiGatewayRequestId && lambdaRequestId) {
+      console.log(`Lambda request ID: ${lambdaRequestId}. API Gateway request ID: ${apiGatewayRequestId}`); // eslint-disable-line
+    }
+  }
+
   /**
    * Router function. Should be called for each route you want to create.
    *

test/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+      "import/no-extraneous-dependencies": ["error", { "devDependencies": true }]
+    }
+}

test/index.js

@@ -1,11 +1,16 @@
+import test from 'ava';
+import sinon from 'sinon';
 import Alpr from './../src/index';
 import data from './aws-data-file.json';
 
 data.callback = () => {};
-// eslint-disable-next-line
-import test from 'ava';
 
 const alprGlobal = new Alpr(data);
+const sandbox = sinon.sandbox;
+
+test.afterEach(() => {
+  sandbox.restore();
+});
 
 test('Route Matching > matches path strings and resource strings', (t) => {
   const result = alprGlobal.routeMatcher({
@@ -270,3 +275,19 @@ test('String Matching > will return false when no params are provided', (t) => {
   // Just for default params
   t.is(Alpr.inArrayOrIsString(), false);
 });
+
+test('Logging request ids > Logs out the ids when they are available', (t) => {
+  const spy = sandbox.spy(console, 'log');
+
+  alprGlobal.logRequestIds();
+  const consoleLog = spy.getCall(0).args[0];
+  t.true(consoleLog.includes(data.event.requestContext.requestId));
+  t.true(consoleLog.includes(data.context.awsRequestId));
+});
+
+test('Logging request ids > Does not log out the ids when they are not available', (t) => {
+  const alprLocal = new Alpr({ callback: () => {} });
+  alprLocal.logRequestIds();
+  const spy = sandbox.spy(console, 'log');
+  t.false(spy.calledOnce);
+});