@sera4/essentia 1.0.37 → 1.0.38

package/health/index.js

@@ -15,10 +15,12 @@ class HealthCheckError extends Error {
  *    const router = require('express').Router();
  *
  *      ....
+ *
+ *    const checkRedis = async () => { await cache.ping(); }
+ *    hc.setupCheck({ name: "redis", checkResult: false, critical: true, healthFunction: checkRedis });
  *    app.use(hc.defaultPath(serverConfigs.api_prefix), hc.routes(router));
  *
  */
-
 class HealthCheck {
   constructor(appendData = {}) {
     this.defaultResponse = {
@@ -60,15 +62,35 @@ class HealthCheck {
     return router
   }
 
+  // v2 version of health check
+  setupCheck(config) {
+    this.healthChecks.push(config);
+  }
+
   /* performs health checks and returns 200 if true and 500 if not */
   async checkHealth(req, res) {
     const checkFormat = pathHelper.extname(req.baseUrl);
 
-    try {
-      const result = await Promise.all(this.healthChecks.map(async healthCallback => {
-        return await healthCallback();
-      }));
+    const result = await Promise.all(this.healthChecks.map(async hc => {
+      if (typeof(hc) === "function") {
+        try {
+          return await hc();
+          return { "result": "success", critical: false };
+        } catch(e) {
+          return  { name: "unknown", result: 'fail', status: e.status }
+        }
+      } else {
+        let res = { name: hc.name, critical: hc.critical }
+        try {
+          return await hc.healthFunction();
+          return { ...res, "result": "success" };
+        } catch(e) {
+          return { ...res, "result": "fail", status: e.status } 
+        }
+      }
+    }));
 
+    try {
       let callId = ++this.lastCallId;
 
       // start the counter over
@@ -78,10 +100,18 @@ class HealthCheck {
 
       let status = this.defaultResponse.status;
 
+      let nonCriticalFail = false;
+      let criticalFail = false;
+
       result.some(e => {
         if (e.result.match(/fail/)) {
-          status = 500;
-          return true; // break
+          if (e.critical == false) {
+            nonCriticalFail = true;
+          } else {
+            criticalFail = true;
+            status = 500;
+            return true; // break
+          }
         }
       })
 
@@ -89,29 +119,31 @@ class HealthCheck {
       res.setHeader('check', callId)
 
       if (checkFormat === ".json") {
-        const payload = { "check": callId }
+        const payload = { "check": callId, healthy: "true", message: "success" }
 
-        if (status === 200) {
+        if (criticalFail) {
           res.status(status).json({
             ... payload,
-            "healthy":true,
-            "message":"success"
+            "healthy": false,
+            "message": "fail",
+            "services": [result]
           });
-        } else {
+        } else if (status === 200) {
+          res.status(status).json(payload);
+        } else if (nonCriticalFailure) {
           res.status(status).json({
             ... payload,
-            "healthy": false,
             "message": "fail",
             "services": [result]
           });
         }
       } else {
         let status_message;
-        if (status === 200) {
-          status_message = "success"
-        } else {
+        if (criticalFail) {
           status_message = "fail"
-        }
+        } else if ((status === 200) || nonCriticalFail) {
+          status_message = "success"
+        } 
 
         res.status(status).send(status_message);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.0.37",
+  "version": "1.0.38",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "scripts": {