cleanup $ refactoring

Author: cgohlke

index.js

@@ -1,9 +1,9 @@
 "use strict";
 
 function handler(routeConfig) {
-    const processorMapping = extractProcessorMapping(routeConfig);
+    const eventProcessorMapping = extractEventProcessorMapping(routeConfig);
     return (event, context, callback) => {
-        for (const processorName of processorMapping.keys()) {
+        for (const eventProcessorName of eventProcessorMapping.keys()) {
 
             try {
                 // the contract of 'processors' is as follows:
@@ -13,7 +13,7 @@ function handler(routeConfig) {
                 //   - throws Error: the 'error.toString()' is taken as the error message of processing the event
                 //   - returns object: this is taken as the result of processing the event
                 //   - returns promise: when the promise is resolved, this is taken as the result of processing the event
-                const result = processorMapping.get(processorName)(routeConfig[processorName], event);
+                const result = eventProcessorMapping.get(eventProcessorName)(routeConfig[eventProcessorName], event);
                 if (result) {
                     // be resilient against a processor returning a value instead of a promise:
                     return Promise.resolve(result)
@@ -31,17 +31,17 @@ function handler(routeConfig) {
                 return;
             }
         }
-        callback('No processor found to handle this kind of event!');
+        callback('No event processor found to handle this kind of event!');
     }
 }
 
-function extractProcessorMapping(routeConfig) {
+function extractEventProcessorMapping(routeConfig) {
     const processorMap = new Map();
     for (let key of Object.keys(routeConfig)) {
         try {
             processorMap.set(key, require(`./lib/${key}`));
         } catch (error) {
-            throw new Error(`The processor '${key}', that is mentioned in the routerConfig, cannot be instantiated (${error.toString()})`);
+            throw new Error(`The event processor '${key}', that is mentioned in the routerConfig, cannot be instantiated (${error.toString()})`);
         }
     }
     return processorMap;

lib/proxyIntegration.js

@@ -7,9 +7,14 @@ const NO_MATCHING_ACTION = request => {
     }
 };
 
-function route(proxyIntegrationConfig, event) {
+function process(proxyIntegrationConfig, event) {
+    //validate config
+    if (!Array.isArray(proxyIntegrationConfig.routes) || proxyIntegrationConfig.routes.length < 1) {
+        throw new Error('proxyIntegration.routes must not be empty');
+    }
+
     // detect if it's an http-call at all:
-    if (!event.httpMethod) {
+    if (!event.httpMethod || !event.path) {
         return null;
     }
     const headers = Object.assign({
@@ -18,19 +23,12 @@ function route(proxyIntegrationConfig, event) {
     if (proxyIntegrationConfig.cors) {
         headers["Access-Control-Allow-Origin"] = "*";
     }
+
     // assure necessary values have sane defaults:
-    event.path = event.path || '';
     const errorMapping = proxyIntegrationConfig.errorMapping || {};
     errorMapping['NO_MATCHING_ACTION'] = 404;
-    proxyIntegrationConfig.routes = proxyIntegrationConfig.routes || [];
-    // ugly hack: if host is from 'Custom Domain Name Mapping', then event.path has the value '/basepath/resource-path/';
-    // if host is from amazonaws.com, then event.path is just '/resource-path':
-    const apiId = event.requestContext ? event.requestContext.apiId : null; // the apiId that is the first part of the amazonaws.com-host
-    if ((apiId && event.headers && event.headers.Host && event.headers.Host.substring(0, apiId.length) != apiId)) {
-        // remove first path element:
-        const groups = /\/[^\/]+(.*)/.exec(event.path) || [null, null];
-        event.path = groups[1] || '/';
-    }
+
+    event.path = normalizeRequestPath(event);
 
     try {
         const actionConfig = findMatchingActionConfig(event.httpMethod, event.path, proxyIntegrationConfig) || {action: NO_MATCHING_ACTION};
@@ -49,6 +47,18 @@ function route(proxyIntegrationConfig, event) {
     }
 }
 
+function normalizeRequestPath(event) {
+    // ugly hack: if host is from API-Gateway 'Custom Domain Name Mapping', then event.path has the value '/basepath/resource-path/';
+    // if host is from amazonaws.com, then event.path is just '/resource-path':
+    const apiId = event.requestContext ? event.requestContext.apiId : null; // the apiId that is the first part of the amazonaws.com-host
+    if ((apiId && event.headers && event.headers.Host && event.headers.Host.substring(0, apiId.length) != apiId)) {
+        // remove first path element:
+        const groups = /\/[^\/]+(.*)/.exec(event.path) || [null, null];
+        return groups[1] || '/';
+    }
+
+    return event.path;
+}
 
 function convertError(error, errorMapping, headers) {
     if (typeof error.reason === 'string' && typeof error.message === 'string' && errorMapping && errorMapping[error.reason]) {
@@ -95,4 +105,4 @@ function extractPathNames(pathExpression) {
     return pathNames && pathNames.length > 0 ? pathNames.slice(1) : null;
 }
 
-module.exports = route;
+module.exports = process;

lib/sns.js

@@ -1,14 +1,16 @@
 "use strict";
 
-function route(snsConfig, event) {
+function process(snsConfig, event) {
     // detect if it's an sns-event at all:
     if(snsConfig.debug){
         console.log('sns:Event', JSON.stringify(event));
     }
+
     if (!Array.isArray(event.Records) || event.Records.length<1 || !event.Records[0].Sns) {
         console.log('Event does not look like SNS');
         return null;
     }
+
     const sns = event.Records[0].Sns;
     for(let routeConfig of snsConfig.routes){
         if(routeConfig.subject instanceof RegExp){
@@ -20,13 +22,15 @@ function route(snsConfig, event) {
             console.log(`SNS-Route with subject-regex '${routeConfig.subject}' is not a Regex; it is ignored!`);
         }
     }
+
     if (snsConfig.debug) {
         console.log(`No subject-match for ${sns.Subject}`);
     }
+
     return null;
 }
 
-module.exports = route;
+module.exports = process;
 
 /*
 const cfgExample = {

test/index.spec.js

@@ -36,7 +36,7 @@ describe('processor.configuration', () => {
             lib1: {},
             lib2: {}
         })({}, {}, cb);
-        expect(cb).toHaveBeenCalledWith(jasmine.stringMatching(/^No processor found/));
+        expect(cb).toHaveBeenCalledWith(jasmine.stringMatching(/^No event processor found/));
     });
 
 });

test/proxyIntegration.spec.js

@@ -183,8 +183,8 @@ describe('proxyIntegration.routeHandler', () => {
             paths: {}
         });
     });
-    it('should return error for no route found', (done) => {
-        proxyIntegration({routes: []}, {httpMethod: 'GET'}).then(result => {
+    it('should return error for no process found', (done) => {
+        proxyIntegration({routes: [{}]}, {httpMethod: 'GET', path: '/'}).then(result => {
             expect(result).toEqual({
                 statusCode: 404,
                 body: jasmine.stringMatching(/Could not find/),
@@ -194,7 +194,7 @@ describe('proxyIntegration.routeHandler', () => {
         });
     });
     it('should return null if it is not an http request', () => {
-        const result = proxyIntegration({routes: []}, {});
+        const result = proxyIntegration({routes: [{}]}, {});
         expect(result).toBe(null);
     });
     forEach([