@sera4/essentia 1.1.65 → 3.0.6

package/cache/index.js

@@ -1,188 +0,0 @@
-"use strict"
-
-import { promisify } from "util";
-
-const isEmpty = obj => [Object, Array].includes((obj || {}).constructor) && !Object.entries((obj || {})).length;
-
-class CacheConfigError extends Error {
-  constructor(m) {
-    super(m);
-  }
-}
-
-/* Redis cache helper
- * Example use: Place the following code in your project to setup redis use
- *
- *    import { cache } from "@sera4/essentia";
- *    const cacheHelper = cache({ password: .., database: .., host: .., port: .. }, "service:"));
- *
- */
-
-const convertRedisKeyValueToJson = (v) => {
-  return (v && v.length > 0 && v[0] !== null) ? JSON.parse(v) : null;
-}
-
-const convertRedisHashToJson = (v) => {
-  if (v) {
-    var result = {};
-    for(var k in v) {
-      if (v.hasOwnProperty(k)) {
-        result[k] = JSON.parse(v[k]);
-      }
-    }
-    return result;
-  } else {
-    return null;
-  }
-}
-
-function convertJsonToRedisValue(j) {
-  var result = {};
-  for (var key in j) {
-    if (j.hasOwnProperty(key)) {
-      result[key] = JSON.stringify(j[key]);
-    }
-  }
-  return result;
-}
-
-class Cache {
-  constructor(config, servicePrefix) {
-    if ((config == undefined) || isEmpty(config)) {
-      throw new CacheConfigError("Invalid cache configuration");
-    }
-
-    if (servicePrefix == null) {
-      throw new CacheConfigError("Invalid service prefix");
-    }
-
-    if (config.fake) {
-      // used in testing
-      this.redisClient = require("fakeredis").createClient("fake backend")
-    } else {
-      this.redisClient = require("redis").createClient(config);
-    }
-
-    this.redisClient.on("error", (err) => {
-      logger.error("Cache/Redis error: ", err);
-    });
-
-    this.servicePrefix = servicePrefix;
-  }
-
-  ping() {
-    return this.redisClient.ping();
-  }
-
-  properKey(key, path) {
-    let p = this.servicePrefix + key
-    if (path)
-      p += path
-    return p
-  }
-
-  writeHash(path, key, value) {
-    return this.redisClient.hsetAsync(properKey(key), key, value);
-  }
-
-  writeHashBlocking(path, key, value) {
-    return this.redisClient.hset(properKey(key), key, value);
-  }
-
-  // write multiple hash keys and stringify every value
-  writeMultiHash(path, j) {
-    return this.redisClient.hmsetAsync(properKey(key), convertJsonToRedisValue(j));
-  }
-
-  readHashKey(obj, key, autoConvert=true) {
-    var k = autoConvert;
-
-    return new Promise((resolve, reject) => {
-      this.redisClient.hget(properKey(key, obj), key, (e, r) => {
-        if (e) {
-          logger.error("Redis hmget error:", e);
-          reject(e);
-        } else {
-          resolve(k ? convertRedisKeyValueToJson(r) : r);
-        }
-      });
-    });
-  }
-
-  readHash(path) {
-    return new Promise((resolve, reject) => {
-      this.redisClient.hgetall(properKey(key, path), (e, r) => {
-        if (e) {
-          console.log("Redis hget error:", e);
-          reject(e);
-        } else {
-          resolve(convertRedisHashToJson(r));
-        }
-      });
-    });
-  }
-
-  deleteHashKey(hash, key) {
-    return new Promise((resolve, reject) => {
-      this.redisClient.hdel(properKey(key, hash), key, (err) => {
-        if (err) {
-          logger.error("Redis hdel error:", err);
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    });
-  }
-
-  get(key) {
-    return this.redisClient.getAsync(properKey(key));
-  }
-
-  getAsync(key) {
-    return promisify(this.redisClient.get(key)).bind(this.redisClient)
-  }
-
-
-  /* a single key write with optional expiry */
-  // returns bluebird promise
-  writeKey(key, value, expiry) {
-    key = this.servicePrefix + key;
-    if (expiry) {
-      return this.redisClient.setAsync(key, value, "EX", expiry);
-    } else {
-      return this.redisClient.setAsync(key, value);
-    }
-  }
-
-  deleteKey(key) {
-    return redisClient.delAsync(properKey(key));
-  }
-
-  expire(path, expiry) {
-    return this.redisClient.expire(path, expiry);
-  }
-
-  exists(path) {
-    return this.redisClient.exists(path);
-  }
-
-  deleteAllKeys() {
-    return new Promise((resolve, reject) => {
-      if(process.env.NODE_ENV === "production") {
-        throw new Error("Clearing system cache is not permitted in production");
-      }
-      this.redisClient.flushdb((err, res) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(res);
-        }
-      });
-    });
-  }
-}
-
-export default function(config, servicePrefix) {
-  return new Cache(config, servicePrefix)
-}

package/formatter/index.js

@@ -1,81 +0,0 @@
-"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;
-  }
-}
-
-const formatter = new S4Formatter(); 
-export default formatter;

package/hal/README.md

@@ -1,54 +0,0 @@
-# HAL DECORATOR
-
-A module to add HAL decoration to JSON responses in Sequelize ORM based projects.
-
-## Usage
-
-In your model definition, set decoration on your model
-
-```
-import { halDecorator as decorator } from "@sera4/essentia"
-...
-
-module.exports = (sequelize, DataTypes) => {
-  const Post = sequelize.define('Post', {...}, {...});
-  // configure the decorator (optional)
-  const configs = {
-    links: {
-      "self" : {
-        "get": "/:id/post/"
-      },
-      "update" : {
-        "post": "/:id/post/"
-      }
-    },
-    resource: "/posts",
-    exclude : ["created_at", "updated_at"],
-    linksTag : "myLinks",
-    resourceTag: "myResource"
-  }
-  decorator.decorate(Post, configs)
-  return Post;
-};
-```
-
-The above configuration (which is optional) should produce the following JSON for each instance of Post sent out to the client:
-```
-{
-    "myLinks": {
-        "self": {
-            "get": "/posts/42801"
-        },
-        "update": {
-            "post": "/posts/42801"
-        }
-    },
-    "myResource": {
-        "id": 42801,
-        "title": "LJitZgbNPLpOlnkYdynKlSYnCjuLBYiVHYMfAPlSALeoVTuNKw",
-        "name": "cvnititqxdPnHdomgxJJVGynNInkScmDlkzAALunYFHNRjffqE",
-        "content": "LcURropLnJiudElgAVhsBSMRBRNUzHLDiTebZxxpplXdpeGEFa"
-    }
-}
-```
-The links use a similar pattern for parameters interpolation like the express route. For example `/posts/:id/by_user/:user_id` becomes `/posts/20/by_user/123`. If no matching attribute is found on the record, the variable is not replaced.

package/hal/index.js

@@ -1,75 +0,0 @@
-"use strict"
-
-function lastElement(arr) {
-  if (arr && arr.length) {
-    return arr[arr.length - 1];
-  } else {
-    return null;
-  }
-}
-
-class HalDecorator {
-
-  decorate(Model, options) {
-    const model = Model.instance || Model;
-    const resource = (options && options.resource) ? options.resource : "";
-    const exclude = (options && options.exclude) ? options.exclude : [];
-    const links = (options && options.links) ? options.links : {};
-    const linksTag = (options && options.linksTag) ? options.linksTag : "_links";
-    const resourceTag = (options && options.resourceTag) ? options.resourceTag : "_resource";
-
-    const link = (name, method, l) => {
-      if (name && method && l) {
-        var aLink = {};
-        alink[method] = l;
-        links[name] = aLink;
-      }
-      return model;
-    }
-
-    const getLinkData = (values) => {
-      var linkData = {};
-      if (links) {
-        for (const key in links) {
-          if (links.hasOwnProperty(key)) {
-            const link = links[key];
-            const method = lastElement(Object.keys(link));
-            var url = link[method];
-            const paramPattern = /\:([a-zA-z_0-9]*)/;
-            const arr = paramPattern.exec(url);
-            if (arr) {
-              // Replace parameters
-              url = `/${resource}/${url.split(arr[0]).join(values[arr[1]])}`;
-              // Remove extra slashes that may have been added
-              url = url.replace(/\/\/*/g, "/");
-              linkData[key] = {}
-              linkData[key][method] = url;
-            }
-          }
-        }
-      }
-      return Object.keys(linkData).length > 0 ? linkData : null;
-    }
-
-    model.link = link;
-    Model.prototype.toJSON = function() {
-      var values = Object.assign({}, this.get());
-      if (exclude) {
-        exclude.forEach(element => {
-          delete values[element];
-        });
-      }
-      const links = getLinkData(values);
-      const result = {}
-      if (links) {
-        result[linksTag] = links;
-      }
-      result[resourceTag] = values;
-      return result;
-    };
-  }
-}
-
-
-const halDecorator = new HalDecorator();
-export default halDecorator;

package/health/health-logger.js

@@ -1,40 +0,0 @@
-import logger from "../logger/s4-logger.js";
-let enabled = false;
-
-const helpers = {
-  debug(...args) {
-    if (enabled) {
-      logger.debug(":: HealthCheck ::", args);
-    }
-  },
-
-  log(...args) {
-    if (enabled) {
-      logger.debug(":: HealthCheck ::", args);
-    }
-  },
-
-  warn(...args) {
-    if (enabled) {
-      logger.warn(":: HealthCheck ::", args);
-    }
-  },
-
-  info(...args) {
-    if (enabled) {
-      logger.info(":: HealthCheck ::", args);
-    }
-  },
-
-  error(...args) {
-    if (enabled) {
-      logger.error(":: HealthCheck ::", args);
-    }
-  },
-
-  setEnabled(e) {
-    enabled = e;
-  }
-}
-
-export default helpers;

package/health/index.js

@@ -1,188 +0,0 @@
-"use strict"
-
-import pathHelper from "path";
-import logger from "./health-logger.js";
-import morgan from "morgan";
-
-class HealthCheckError extends Error {}
-
-/* Health Checking router + controller for use in all of our modules
- * Example use: Place the following code in your routes file
- *
- *    import { healthCheck } from "@sera4/essentia";
- *    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 = {}, enableLogging = true) {
-    logger.setEnabled(enableLogging);
-
-    this.defaultResponse = {
-      ...
-      appendData,
-      status: 200,
-      errors: {}
-    };
-
-    this.defaultPathRoute = `health_check\(.*\)?`
-    this.suppressLogs = false;
-    this.lastCallId = 0; // default start point/integer
-    this.pathPrefix = "";
-    this.healthChecks = [];
-  }
-
-  /* Deprecated and replaced by setupCheck
-   *   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);
-  }
-
-  setPrefix(prefix) {
-    this.pathPrefix = prefix;
-  }
-
-  defaultPath(prefix = "") {
-    if (prefix === "") {
-      prefix = this.pathPrefix; // maybe setup manually
-    }
-    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
-  }
-
-  suppressHealthCheckLog(app) {
-    // Custom morgan skip function to ignore health check logging
-    console.log("skip: ", this.defaultPath())
-    app.use(morgan('combined', {
-      skip: (req) => req.path === defaultPath()
-    }));
-  }
-
-  // v2 version of health check, replaced addCheck
-  // example:
-  //  const checkRedisFcn = async () => { await cache.ping().then(() => true) }
-  //  setupCheck({ name: "redis", checkResult: false, critical: false, healthFunction: checkRedisFcn });
-  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);
-
-    const result = await Promise.all(this.healthChecks.map(async hc => {
-      if (typeof(hc) === "function") {
-        try {
-          return await hc();
-        } catch(e) {
-          return  { name: "unknown", result: 'fail', status: e.status }
-        }
-      } else {
-        let res = { name: hc.name, critical: hc.critical }
-        try {
-          const result = await hc.healthFunction();
-          if (typeof(result) === "boolean") {
-            if (result === false) {
-              res = {"result": "fail", ...res }
-            } else {
-              res = {"result": "success", ...res }
-            }
-          } else {
-            res = {"result": "success", ...res }
-          }
-          return res;
-        } catch(e) {
-          const appendStatus = e.status ? ` (${e.status})` : ""
-          logger.warn(`${hc.name} service failed${appendStatus}` )
-          return { ...res, "result": "fail", status: e.status }
-        }
-      }
-    }));
-
-    try {
-      let callId = ++this.lastCallId;
-
-      // start the counter over
-      if ((callId % (1 << 30)) === 0) {
-        callId = this.lastCallId = 1;
-      }
-
-      let status = this.defaultResponse.status;
-
-      let nonCriticalFail = false;
-      let criticalFail = false;
-
-      result.some(e => {
-        if (e.result.match(/fail/)) {
-          if (e.critical === false) {
-            nonCriticalFail = true;
-          } else {
-            criticalFail = true;
-            status = 500;
-            return true; // break
-          }
-        }
-      })
-
-      // set this in the header no matter what
-      res.setHeader('check', callId)
-
-      if (checkFormat === ".json") {
-        const payload = { "check": callId, healthy: "true", message: "success" }
-
-        if (criticalFail) {
-          res.status(status).json({
-            ... payload,
-            "healthy": false,
-            "message": "fail",
-            "services": result
-          });
-        } else if (nonCriticalFail) {
-          res.status(status).json({
-            ... payload,
-            "message": "fail",
-            "services": result
-          });
-        } else if (status === 200) {
-          res.status(status).json(payload);
-        }
-      } else {
-        let status_message;
-        if (criticalFail) {
-          status_message = "fail"
-        } else if ((status === 200) || nonCriticalFail) {
-          status_message = "success"
-        }
-
-        res.status(status).send(status_message);
-      }
-    } catch(error) {
-      console.warn("error: ", error)
-      res.status(500).send();
-    }
-  }
-}
-
-export { HealthCheck };

package/helpers/index.js

@@ -1 +0,0 @@
-export * from "./test-server-wrapper.js";