@sera4/essentia 1.0.9 → 1.0.11

package/README.md

@@ -5,4 +5,5 @@ A collection of small modules providing essential utilities for TWS services:
 * [Sequelize Paginator](paginator/README.md)
 * [Sequelize HAL Decorator](hal/README.md)
 * A logging tool
-* A small utility to dump the last commit of the project
+* An HTTP response tool for consistenty formatting error responses
+* A small utility to dump the last commit of the project

package/formatter/index.js

@@ -0,0 +1,80 @@
+"use strict"
+
+class FormatError extends Error {
+  constructor(m) {
+    super(m);
+  }
+}
+
+// helps to clean up response formats for services responding to rest requests
+class S4Formatter {
+  constructor() { 
+    this.defaults = {
+      status: 422,
+      errors: {}
+    };
+  }
+
+  _isArray (value) {
+    return value && typeof value === 'object' && value.constructor === Array;
+  }
+
+  _fromHash(error) {
+    let response = Object.assign({}, this.defaults);
+
+    if (error.status) {
+      let errorStatus = parseInt(error.status);
+
+      if ((errorStatus >= 200) && (errorStatus < 522)) {
+        response.status = errorStatus
+      }
+    }
+
+    if (error.error && (typeof(error.error) === "string")) {
+      response.errors["generic"] = { msg: error.error }
+    } else if (error.errors) {
+      if (this._isArray(error.errors)) {
+        // many legacy responses which are errors: ["error_name"]
+        error.errors.forEach(function(el, index) {
+          response.errors[`generic_${index}`] = { msg: el }
+        })
+      } else if (typeof(error.errors) === "object") {
+        response.errors = error.errors
+      }
+    } 
+
+    return response;
+  }
+  
+  /**
+  * Desired Response format 
+  *{
+  *    "error": {
+  *        "status": 422,
+  *        "errors": {
+  *            "password": {
+  *                "location": "body",
+  *                "param": "password",
+  *                "value": "mypassword",
+  *                "msg": "weak"
+  *            }
+  *        }
+  *    },
+  *    "error_id": "a2ddf895-2aaf-4189-88a2-8e11f6843f91"
+  *}
+  */
+  formatError(error) {
+    let response;
+    if (error === null) {
+      response = this.defaults;
+    } else if (typeof(error) === "object")  {
+      response = this._fromHash(error);
+    } else { 
+      return new FormatError("invalid_error_format");
+    }
+
+    return response;
+  }
+}
+
+module.exports = new S4Formatter();

package/health/index.js

@@ -0,0 +1,111 @@
+"use strict"
+
+const pathHelper = require("path");
+const logger = require("../logger/s4-logger");
+
+class HealthCheckError extends Error {
+  constructor(m) {
+    super(m);
+  }
+}
+
+/* Health Checking router + controller for use in all of our modules
+ * Example use: Place the following code in your routes file 
+ *
+ *    const hc = require("@sera4/essentia").healthCheck;
+ *    const router = require('express').Router();
+ *
+ *      ....
+ *    app.use(hc.defaultPath(serverConfigs.api_prefix), hc.routes(router));
+ *
+ */
+
+class HealthCheck {
+  constructor() { 
+    this.defaultResponse = {
+      status: 200,
+      errors: {}
+    };
+
+    this.defaultPathRoute = `health_check\(.*\)?` 
+
+    this.healthChecks = [];
+  }
+
+  /* call this with an async function, must support wait capability 
+   * 
+   *   const dbCheck = async () => {
+   *     return { name: "db", "result": "success", critical: false };
+   *   }
+   */ 
+  addCheck(fcn) {
+    this.healthChecks.push(fcn);
+  }
+
+  defaultPath(prefix = "") {
+    return `${prefix}/${this.defaultPathRoute}`
+  }
+
+  routes(router) {
+    if (!router) {
+      throw new HealthCheckError("missing_express_router");
+    }
+
+    /* definition of all routes, rooted at defaultPath */
+    router.get('/', (req, res) => {
+      this.checkHealth(req, res)
+    });
+
+    return router
+  }
+
+  /* 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();
+      }));
+
+      //let result = (result.reduce((e) => e.success, 200))
+      let status = this.defaultResponse.status;
+
+      result.some(e => {
+        if (e.result.match(/fail/)) {
+          status = 500;
+          return true; // break
+        }
+      })
+
+      if (checkFormat === ".json") {
+        if (status === 200) {
+          res.status(status).json({
+            "healthy":true,
+
+            "message":"success"
+          });
+        } else {
+          res.status(status).json({
+            "healthy": false,
+            "message": "fail",
+            "services": [result]
+          });
+        }
+      } else {
+        let status_message;
+        if (status === 200) {
+          status_message = "success"
+        } else {
+          status_message = "fail"
+        }
+
+        res.status(status).send(status_message);
+      }
+    } catch(error) {
+      res.status(500).send();
+    }  
+  }
+}
+
+module.exports = HealthCheck;

package/index.js

@@ -1,7 +1,12 @@
+'use strict';
+
 module.exports = {
   paginator : require("./paginator/s4-pagination"),
   sqlPaginator : require("./paginator/sql-pagination"),
   logger : require("./logger/s4-logger"),
   lastCommit : require("./last_commit"),
-  halDecorator : require("./hal")
-}
+  halDecorator : require("./hal"),
+  formatter : require("./formatter"),
+  healthCheck: require("./health")
+}
+//console.log(module.exports.formatter.formatError({ status: 200, error: ["error1"] }));

package/logger/s4-logger.js

@@ -11,7 +11,7 @@ logger.add(winston.transports.Console, {
 
 class S4Logger {
   setLevel(level) {
-    if (level && ["debug", "info", "error"].indexOf(level.toLowerCase())) {
+    if (level && ["debug", "info", "error", "warn"].indexOf(level.toLowerCase())) {
       logger.transports[loggerName].level = level;  
     }
   }
@@ -24,6 +24,9 @@ class S4Logger {
   debug(str, args) {
     logger.log("debug", str, args);
   }
+  warn(str, args) {
+    logger.log("warn", str, args);
+  }
   info(str, args) {
     logger.log("info", str, args);
   }
@@ -32,4 +35,4 @@ class S4Logger {
   }
 }
 
-module.exports = new S4Logger();
+module.exports = new S4Logger();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "scripts": {
@@ -16,6 +16,7 @@
   "license": "UNLICENSED",
   "devDependencies": {
     "chai": "^4.1.2",
+    "express": "^4.16.4",
     "mocha": "^5.1.1",
     "mocha-junit-reporter": "^1.17.0",
     "node-mocks-http": "^1.5.8",