July 2019 release challenge

Author: jmgasper

.gitignore

@@ -31,3 +31,5 @@ npm-debug.log
 
 /config/local.js
 .DS_Store
+
+package-lock.json

app.js

@@ -12,6 +12,18 @@ const express = require('express');
 const logger = require('morgan');
 const cookieParser = require('cookie-parser');
 const bodyParser = require('body-parser');
+const healthcheck = require('topcoder-healthcheck-dropin');
+
+/**
+ * Method to check the service status
+ * @returns {Object} The returned status
+ */
+function check() {
+  // No checks to run. The output of this itself is an indication that the app is actively running
+  return {
+    checksRun: 1
+  };
+}
 
 const webhooks = require('./routes/webhooks');
 
@@ -26,6 +38,8 @@ app.use(bodyParser.json({
 app.use(bodyParser.urlencoded({extended: false}));
 app.use(cookieParser());
 
+app.use(healthcheck.middleware([check]));
+
 app.use('/webhooks', webhooks);
 
 // catch 404 and forward to error handler

build.sh

@@ -25,7 +25,7 @@ AWS_REPOSITORY=$(eval "echo \$${ENV}_AWS_REPOSITORY")
 #App variables
 KAFKA_CLIENT_CERT=$(eval "echo \$${ENV}_KAFKA_CLIENT_CERT")
 KAFKA_CLIENT_CERT_KEY=$(eval "echo \$${ENV}_KAFKA_CLIENT_CERT_KEY")
-KAFKA_HOST=$(eval "echo \$${ENV}_KAFKA_URL")
+KAFKA_URL=$(eval "echo \$${ENV}_KAFKA_URL")
 ZOO_KEEPER=$(eval "echo \$${ENV}_ZOO_KEEPER")
 TOPIC=$(eval "echo \$${ENV}_TOPIC")
 MONGODB_URI=$(eval "echo \$${ENV}_MONGODB_URI")

config/default.js

@@ -18,16 +18,16 @@ module.exports = {
   LOG_LEVEL: process.env.LOG_LEVEL || 'info',
   TOPIC: process.env.TOPIC || 'tc-x-events',
   KAFKA_OPTIONS: {
-    connectionString: process.env.KAFKA_HOST || 'localhost:9092',
+    connectionString: process.env.KAFKA_URL || 'localhost:9092',
     ssl: {
       cert: process.env.KAFKA_CLIENT_CERT || fs.readFileSync('./kafka_client.cer'), // eslint-disable-line no-sync
       key: process.env.KAFKA_CLIENT_CERT_KEY || fs.readFileSync('./kafka_client.key') // eslint-disable-line no-sync
     }
   },
   DYNAMODB: {
-    AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID || '',
-    AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY || '',
-    AWS_REGION: process.env.AWS_REGION || '',
-    IS_LOCAL: process.env.IS_LOCAL || ''
+    AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID,
+    AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY,
+    AWS_REGION: process.env.AWS_REGION,
+    IS_LOCAL: process.env.IS_LOCAL
   }
 };

configuration.md

@@ -8,7 +8,7 @@ The following config parameters are supported, they are defined in `config/defau
 | LOG_LEVEL                              | The log level                              |  info                            |
 |TOPIC  | The Kafka topic where events are published.  This must be the same as the configured value for topcoder-x-processor| |
 |KAFKA_OPTIONS | Kafka connection options| |
-|KAFKA_HOST | The Kafka host to connect to| localhost:9092 |
+|KAFKA_URL | The Kafka host to connect to| localhost:9092 |
 |KAFKA_CLIENT_CERT | The Kafka SSL certificate to use when connecting| Read from kafka_client.cer file, but this can be set as a string like it is on Heroku |
 |KAFKA_CLIENT_CERT_KEY | The Kafka SSL certificate key to use when connecting| Read from kafka_client.key file, but this can be set as a string like it is on Heroku|
 |AWS_ACCESS_KEY_ID | The Amazon certificate key to use when connecting. Use local dynamodb you can set fake value|FAKE_ACCESS_KEY_ID |

package.json

@@ -19,6 +19,7 @@
     "joi": "^11.4.0",
     "morgan": "~1.8.1",
     "no-kafka": "^3.2.10",
+    "topcoder-healthcheck-dropin": "^1.0.3",
     "winston": "^2.4.2"
   },
   "devDependencies": {

utils/logger.js

@@ -9,8 +9,8 @@
  * @version 1.0
  */
 'use strict';
-const winston = require('winston');
 const config = require('config');
+const winston = require('winston');
 
 const logger = new winston.Logger({
   transports: [