Added health checks

Author: callmekatootie

README.md

@@ -24,6 +24,8 @@ Configuration for the application is at `config/default.js` and `config/producti
 - API_VERSION: the API version
 - AUTH_SECRET: TC Authentication secret
 - VALID_ISSUERS: valid issuers for TC authentication
+- AMAZON.AWS_ACCESS_KEY_ID: The AWS access key
+- AMAZON.AWS_SECRET_ACCESS_KEY: The AWS secret key
 - AMAZON.AWS_REGION: The Amazon region to use when connecting. For local dynamodb you can set fake value.
 - AMAZON.IS_LOCAL_DB: Use local or AWS Amazon DynamoDB
 - AMAZON.DYNAMODB_URL: The local url, if using local Amazon DynamoDB

config/default.js

@@ -6,6 +6,7 @@ module.exports = {
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
   PORT: process.env.PORT || 3001,
   API_VERSION: process.env.API_VERSION || '/v1',
+
   AUTH_SECRET: process.env.AUTH_SECRET || 'mysecret',
   VALID_ISSUERS: process.env.VALID_ISSUERS ? process.env.VALID_ISSUERS.replace(/\\"/g, '')
     : '["https://topcoder-dev.auth0.com/", "https://api.topcoder.com"]',
@@ -15,26 +16,31 @@ module.exports = {
   TOKEN_CACHE_TIME: process.env.TOKEN_CACHE_TIME,
   AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID,
   AUTH0_CLIENT_SECRET: process.env.AUTH0_CLIENT_SECRET,
+
   BUSAPI_URL: process.env.BUSAPI_URL || 'https://api.topcoder-dev.com/v5',
+
   KAFKA_ERROR_TOPIC: process.env.KAFKA_ERROR_TOPIC || 'common.error.reporting',
+  KAFKA_MESSAGE_ORIGINATOR: process.env.KAFKA_MESSAGE_ORIGINATOR || 'ubahn-search-ui-api',
+  UPLOAD_CREATE_TOPIC: process.env.UPLOAD_CREATE_TOPIC || 'ubahn.action.create',
 
   AMAZON: {
+    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 || 'us-east-1',
+
+    DYNAMODB_TEMPLATE_TABLE: process.env.DYNAMODB_TEMPLATE_TABLE || 'templates',
+    DYNAMODB_UPLOAD_TABLE: process.env.DYNAMODB_UPLOAD_TABLE || 'uploads',
+
     IS_LOCAL_DB: process.env.IS_LOCAL_DB ? process.env.IS_LOCAL_DB === 'true' : false,
     // Below three configuration is required if IS_LOCAL_DB is true
     DYNAMODB_URL: process.env.DYNAMODB_URL || 'http://localhost:8000',
     DYNAMODB_READ_CAPACITY_UNITS: process.env.DYNAMODB_READ_CAPACITY_UNITS || 10,
     DYNAMODB_WRITE_CAPACITY_UNITS: process.env.DYNAMODB_WRITE_CAPACITY_UNITS || 5,
-    // table name is model name
-    DYNAMODB_TEMPLATE_TABLE: process.env.DYNAMODB_TEMPLATE_TABLE || 'template',
-    DYNAMODB_UPLOAD_TABLE: process.env.DYNAMODB_UPLOAD_TABLE || 'upload'
   },
 
   TEMPLATE_FILE_MAX_SIZE: process.env.TEMPLATE_FILE_MAX_SIZE || 2 * 1024 * 1024,
   TEMPLATE_FILE_MIMETYPE: process.env.TEMPLATE_FILE_MIMETYPE || 'application/vnd.ms-excel,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
   TEMPLATE_S3_BUCKET: process.env.TEMPLATE_S3_BUCKET || 'ubahn',
   UPLOAD_S3_BUCKET: process.env.UPLOAD_S3_BUCKET || 'ubahn',
-  S3_OBJECT_URL_EXPIRY_TIME: process.env.S3_OBJECT_URL_EXPIRY_TIME || 60 * 60,
-  KAFKA_MESSAGE_ORIGINATOR: process.env.KAFKA_MESSAGE_ORIGINATOR || 'ubahn-search-ui-api',
-  UPLOAD_CREATE_TOPIC: process.env.UPLOAD_CREATE_TOPIC || 'ubahn.action.create'
+  S3_OBJECT_URL_EXPIRY_TIME: process.env.S3_OBJECT_URL_EXPIRY_TIME || 60 * 60
 }

src/common/helper.js

@@ -15,8 +15,8 @@ const busApiClient = busApi(_.pick(config, ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKE
 let dbInstance
 
 AWS.config.update({
-  // accessKeyId: config.AMAZON.AWS_ACCESS_KEY_ID,
-  // secretAccessKey: config.AMAZON.AWS_SECRET_ACCESS_KEY,
+  accessKeyId: config.AMAZON.AWS_ACCESS_KEY_ID,
+  secretAccessKey: config.AMAZON.AWS_SECRET_ACCESS_KEY,
   region: config.AMAZON.AWS_REGION
 })
 

src/controllers/HealthCheckController.js

@@ -0,0 +1,18 @@
+/**
+ * Controller for health check endpoint
+ */
+const service = require('../services/HealthCheckService')
+
+/**
+ * Do health check
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function check (req, res) {
+  const result = await service.check()
+  res.send(result)
+}
+
+module.exports = {
+  check
+}

src/routes.js

@@ -65,5 +65,11 @@ module.exports = {
       access: constants.AllAuthenticatedUsers,
       scopes: [constants.Scopes.GetTemplate, constants.Scopes.AllTemplate]
     }
+  },
+  '/health': {
+    get: {
+      controller: 'HealthCheckController',
+      method: 'check'
+    }
   }
 }

src/services/HealthCheckService.js

@@ -0,0 +1,29 @@
+/**
+ * This service provides a method to check health.
+ */
+const config = require('config')
+const helper = require('../common/helper')
+const logger = require('../common/logger')
+const errors = require('../common/errors')
+
+/**
+ * Check health.
+ * @returns {Object} the health check result
+ */
+async function check () {
+  // check DB connection by a simple query
+  try {
+    await helper.scan(config.AMAZON.DYNAMODB_TEMPLATE_TABLE)
+  } catch (e) {
+    throw new errors.ServiceUnavailableError(`DynamoDB is unavailable, ${e.message}`)
+  }
+
+  // ok
+  return { checksRun: 1 }
+}
+
+module.exports = {
+  check
+}
+
+logger.buildService(module.exports)