@sera4/essentia 1.1.58 → 1.1.62

package/health/index.js

@@ -2,12 +2,9 @@
 
 import pathHelper from "path";
 import logger from "./health-logger.js";
+import morgan from "morgan";
 
-class HealthCheckError extends Error {
-  constructor(m) {
-    super(m);
-  }
-}
+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
@@ -36,6 +33,7 @@ class HealthCheck {
     this.defaultPathRoute = `health_check\(.*\)?`
     this.suppressLogs = false;
     this.lastCallId = 0; // default start point/integer
+    this.pathPrefix = "";
     this.healthChecks = [];
   }
 
@@ -50,7 +48,14 @@ class HealthCheck {
     this.healthChecks.push(fcn);
   }
 
+  setPrefix(prefix) {
+    this.pathPrefix = prefix;
+  }
+
   defaultPath(prefix = "") {
+    if (prefix === "") {
+      prefix = this.pathPrefix; // maybe setup manually
+    }
     return `${prefix}/${this.defaultPathRoute}`
   }
 
@@ -67,6 +72,14 @@ class HealthCheck {
     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) }
@@ -75,7 +88,7 @@ class HealthCheck {
     this.healthChecks.push(config);
   }
 
-  /* performs health checks and returns 200 if true and 500 if not */ 
+  /* performs health checks and returns 200 if true and 500 if not */
   async checkHealth(req, res) {
     const checkFormat = pathHelper.extname(req.baseUrl);
 
@@ -83,19 +96,27 @@ class HealthCheck {
       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 {
-          await hc.healthFunction();
-          return { ...res, "result": "success" };
+          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 } 
+          return { ...res, "result": "fail", status: e.status }
         }
       }
     }));
@@ -115,7 +136,7 @@ class HealthCheck {
 
       result.some(e => {
         if (e.result.match(/fail/)) {
-          if (e.critical == false) {
+          if (e.critical === false) {
             nonCriticalFail = true;
           } else {
             criticalFail = true;
@@ -153,16 +174,15 @@ class HealthCheck {
           status_message = "fail"
         } else if ((status === 200) || nonCriticalFail) {
           status_message = "success"
-        } 
+        }
 
         res.status(status).send(status_message);
       }
     } catch(error) {
-      console.debug("error: ", error)
+      console.warn("error: ", error)
       res.status(500).send();
     }
   }
 }
 
-
-export { HealthCheck };
+export { HealthCheck };

package/index.js

@@ -14,3 +14,4 @@ export { default as serializer } from "./serializer/index.js";
 export * from "./utils/index.js";
 export * from "./safe_proxy/index.js";
 export * from "./helpers/index.js";
+export * from "./prompts/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.1.58",
+  "version": "1.1.62",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "type": "module",
@@ -20,21 +20,24 @@
   "devDependencies": {
     "chai": "^4.3.4",
     "express": "^4.17.1",
-    "mocha": "^9.2.2",
-    "mocha-junit-reporter": "^1.23.3",
-    "node-mocks-http": "^1.10.1",
+    "mocha": "^11.1.0",
+    "mocha-junit-reporter": "^2.2.1",
+    "node-mocks-http": "^1.16.2",
     "should": "^13.2.3",
     "sinon": "^5.1.1"
   },
   "dependencies": {
     "amqplib": "^0.8.0",
+    "argparse": "^2.0.1",
     "async": "^3.2.2",
-    "axios": "^1.6.2",
+    "axios": "^1.7.7",
     "deep-diff": "^1.0.2",
     "diff": "^5.0.0",
     "fast-safe-stringify": "^2.0.7",
     "git-rev": "^0.2.1",
     "lodash": "^4.17.21",
+    "morgan": "^1.10.0",
+    "prompt": "^1.3.0",
     "url-parse": "^1.5.10",
     "uuid": "^9.0.0",
     "winston": "^3.3.3",

package/prompts/index.js

@@ -0,0 +1,78 @@
+/* Essentia Common Prompt Functions */
+// This file contains common prompt functions that are used in CLI scripts
+//  that are run in the each project.  These functions are used to
+//  prompt the user for input and to wait for the user to press enter
+//  before continuing.  This is useful for scripts that are run in the
+//  command line and need to wait for the user to do something before
+//  continuing.
+
+import logger from "../logger/s4-logger.js";
+import { ArgumentParser } from 'argparse'
+import prompt from "prompt";
+
+// New common argument parser which makes parsing and setting up commandline options easier
+const setupCLIParser = (description) => {
+  logger.info(description)
+  return new ArgumentParser({ description });
+}
+
+// a common init function which waits for the command prompt to be delivered
+// a common use is for the awaiting of the queues to initialize before running
+const commonCLIInit = async(options) => {
+  //add in defaults to options if they have not been specified or object is {}
+  options = { asyncFcns: [], extraFcns: [], sleepTime: 1000, ...options };
+
+  // Sleep for 1 second to allow the prompt to be displayed
+  // at the end of bootstrap logs
+  await cliSleep(options.sleepTime);
+
+  options.extraFcns.forEach(fcn => {
+    fcn();
+  });
+
+  for (const fcn of options.asyncFcns) {
+    await fcn();
+  }
+}
+
+const promptCLIAsync = async (options) => {
+  return new Promise((resolve, reject) => {
+    prompt.start();
+    prompt.get(options, (err, res) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve(res);
+      }
+    })
+  });
+}
+
+// A predefined waitPrompt for use at the end of the scripts that use
+//  message queues.  Message Queues often take a bit to fire
+const waitCLIPrompt = {
+  "Push <enter> when done" : {
+    type: "boolean"
+  }
+};
+
+const continueCLIPrompt = {
+  "Push <enter> to continue" : {
+    type: "boolean"
+  }
+};
+
+const cliSleep = async(ms) => {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+}
+
+export {
+  commonCLIInit,
+  continueCLIPrompt,
+  promptCLIAsync,
+  setupCLIParser,
+  cliSleep,
+  waitCLIPrompt
+};