Health check

src/common/errors.js

@@ -22,5 +22,6 @@ module.exports = {
   newAuthError: msg => new AppError(401, msg || 'Auth failed.'),
   newPermissionError: msg => new AppError(403, msg || 'The entity does not exist.'),
   newConflictError: msg => new AppError(409, msg || 'The entity does not exist.'),
+  serviceUnavailableError: msg => new AppError(503, msg || 'One or more services are not available'),
   elasticSearchEnrichError: msg => new AppError(500, msg || 'Elasticsearch enrich failed')
 }

src/modules/health/controller.js

@@ -0,0 +1,11 @@
+/**
+ * the role controller
+ */
+
+const service = require('./service')
+const helper = require('../../common/helper')
+const methods = helper.getControllerMethods(service)
+
+module.exports = {
+  ...methods
+}

src/modules/health/route.js

@@ -0,0 +1,12 @@
+/**
+ * the health routes
+ */
+
+const Controller = require('./controller')
+module.exports = {
+  '/health': {
+    get: {
+      method: Controller.get
+    }
+  }
+}

src/modules/health/service.js

@@ -0,0 +1,17 @@
+const errors = require('../../common/errors')
+const models = require('../../models')
+
+async function get () {
+  // Check QLDB Connection by retrieving a session
+  try {
+    const session = await models.DBHelper.getSession()
+
+    session.close()
+  } catch (e) {
+    throw errors.serviceUnavailableError(`QLDB is unavailable, ${e.message}`)
+  }
+
+  return { checksRun: 1 }
+}
+
+module.exports = { get }