API versioning support.

Author: Sachin Maheshwari

Dockerfile

@@ -2,12 +2,12 @@
 # and runs it against the specified Topcoder backend (development or
 # production) when container is executed.
 
-FROM node:8.2.1
-LABEL app="tc email" version="1.0"
+FROM node:6.10
+LABEL app="tc email" version="1.1"
 
 WORKDIR /opt/app
 COPY . .
 RUN npm install
-RUN npm install dotenv --save
+#RUN npm install dotenv --save
 RUN npm run lint
 CMD ["npm", "start"]

config/default.js

@@ -40,4 +40,8 @@ module.exports = {
 
   //in every 2 minutes will retry for failed status
   EMAIL_RETRY_SCHEDULE: process.env.EMAIL_RETRY_SCHEDULE || '0 */2 * * * *',
+
+  API_CONTEXT_PATH: process.env.API_CONTEXT_PATH || 'email',
+  API_VERSION: process.env.API_VERSION || 'v5',
+
 };

src/app.js

@@ -79,27 +79,27 @@ function configureKafkaConsumer(handlers) {
         // emailTries[topicName] += 1; //temporary disabling this feature 
         emailModel.status = 'FAILED';
         return emailModel.save().then(() => {
-	 /* 
-	  * temporary disabling this feature as there is chance of losing message during
-	  * unsubscribe/pausing due to simple kafka consumer
-         */ 	
-	  /*	
-          const currentTries = emailTries[topicName];
-          if (currentTries > maxErrors) {
-            logger.debug(`Failed to send email. Will sleep for ${pauseTime}s`);
-            emailTries[topicName] = 0;
-
-            schedule.scheduleJob(new Date(now.getTime() + pauseTime * 1000), () => {
-              consumer.subscribe(topic, dataHandler);
-            });
-
-            return consumer.unsubscribe(topic, partition).then(() => {
-              throw result.error
-            });
-          } else {
-            logger.debug(`Failed to send email (retries left ${maxErrors - currentTries})`);
-            throw result.error;
-          }*/ 
+          /* 
+           * temporary disabling this feature as there is chance of losing message during
+           * unsubscribe/pausing due to simple kafka consumer
+                */
+          /*	
+                const currentTries = emailTries[topicName];
+                if (currentTries > maxErrors) {
+                  logger.debug(`Failed to send email. Will sleep for ${pauseTime}s`);
+                  emailTries[topicName] = 0;
+      
+                  schedule.scheduleJob(new Date(now.getTime() + pauseTime * 1000), () => {
+                    consumer.subscribe(topic, dataHandler);
+                  });
+      
+                  return consumer.unsubscribe(topic, partition).then(() => {
+                    throw result.error
+                  });
+                } else {
+                  logger.debug(`Failed to send email (retries left ${maxErrors - currentTries})`);
+                  throw result.error;
+                }*/
         });
       }
     }).then(() => consumer.commitOffset({ topic, partition, offset: m.offset })) // commit offset
@@ -124,9 +124,9 @@ function startKafkaConsumer(consumer, handlers, dataHandler) {
   return consumer
     .init()
     .then(() => Promise.each(_.keys(handlers), (topicName) => { // add back the ignored topic prefix to use full topic name
-        emailTries[topicName] = 0;
-        return consumer.subscribe(`${config.KAFKA_TOPIC_IGNORE_PREFIX || ''}${topicName}`, dataHandler);
-      })
+      emailTries[topicName] = 0;
+      return consumer.subscribe(`${config.KAFKA_TOPIC_IGNORE_PREFIX || ''}${topicName}`, dataHandler);
+    })
     );
 }
 
@@ -189,7 +189,8 @@ function start(handlers) {
         req.signature = `${def.controller}#${def.method}`;
         next();
       });
-      if (url !== '/email/health') {
+      if ((url !== '/email/health')
+        && (url !== `/${config.API_VERSION}/${config.API_CONTEXT_PATH}/health`)) {
         actions.push(jwtAuth());
         actions.push((req, res, next) => {
           if (!req.authUser) {

src/routes.js

@@ -1,16 +1,40 @@
 'use strict';
 
-module.exports = {
-  '/email/templates/eventType/:name': {
-    get: {
-      controller: 'TemplateController',
-      method: 'eventTypes',
-    },
-  },
-  '/email/health': {
-    get: {
-      controller: 'HealthController',
-      method: 'health',
-    },
-  },
+const config = require('config');
+
+var routes = {};
+
+let oldkeyEventType = '/email/templates/eventType/:name';
+routes[oldkeyEventType] = {
+  get: {
+    controller: 'TemplateController',
+    method: 'eventTypes',
+  }
+};
+
+let oldkeyHealthCheck = '/email/health';
+routes[oldkeyHealthCheck] = {
+  get: {
+    controller: 'HealthController',
+    method: 'health',
+  }
+};
+
+let keyEventType = `/${config.API_VERSION}/${config.API_CONTEXT_PATH}/templates/eventType/:name`;
+routes[keyEventType] = {
+  get: {
+    controller: 'TemplateController',
+    method: 'eventTypes',
+  }
+};
+
+let keyHealthCheck = `/${config.API_VERSION}/${config.API_CONTEXT_PATH}/health`;
+routes[keyHealthCheck] = {
+  get: {
+    controller: 'HealthController',
+    method: 'health',
+  }
 };
+
+
+module.exports = routes;