@sera4/essentia 1.0.31 → 1.0.33

package/index.js

@@ -9,5 +9,6 @@ module.exports = {
   formatter : require("./formatter"),
   healthCheck : require("./health"),
   queue : require("./queue"),
-  utils : require("./utils")
+  utils : require("./utils"),
+  safePRoxy : require("./safe_proxy")
 }

package/logger/s4-logger.js

@@ -5,6 +5,22 @@ const colorizer = winston.format.colorize();
 
 require('winston-logstash');
 
+// IETF RFC5424:
+// Severity of all levels is assumed to be numerically ascending from most important to least important.
+const levels = {
+  error: 0,
+  warn: 1,
+  info: 2,
+  debug: 3,
+  trace: 4,
+}
+
+// These colors are not used, however if colors are not defined for custom levels
+// then winston will throw an exception.
+winston.addColors({
+  trace: 'white'
+})
+
 const devFormat = {
   transform(info) {
     const { message } = info;
@@ -17,10 +33,12 @@ const devFormat = {
 };
 
 const defaultTransport = new winston.transports.Console({
-  format: devFormat
+  format: devFormat,
+  level: 'trace'
 });
 
 const logger = winston.createLogger({
+  levels: levels,
   level: 'debug',
   defaultMeta: { },
   transports: [defaultTransport]
@@ -32,9 +50,7 @@ class S4Logger {
       return;
     }
 
-    if (options.level && ["debug", "info", "error", "warn"].indexOf(options.level.toLowerCase())) {
-      logger.level = options.level;
-    }
+    this.setLevel(options.level)
 
     logger.defaultMeta.service = options.service;
     switch(options.format.toLowerCase()) {
@@ -51,7 +67,7 @@ class S4Logger {
   }
 
   setLevel(level) {
-    if (level && ["debug", "info", "error", "warn"].indexOf(level.toLowerCase())) {
+    if (level && ["trace", "debug", "info", "error", "warn"].indexOf(level.toLowerCase())) {
       logger.level = level;
     }
   }
@@ -68,6 +84,10 @@ class S4Logger {
     });
   }
 
+  trace(...args) {
+    logger.trace(util.format(...args));
+  }
+
   debug(...args) {
     logger.debug(util.format(...args));
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.0.31",
+  "version": "1.0.33",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "scripts": {
@@ -27,11 +27,13 @@
     "sinon": "^5.0.1"
   },
   "dependencies": {
-    "amqplib": "^0.5.5",
+    "amqplib": "^0.8.0",
     "async": "^2.6.1",
+    "axios": "^0.21.1",
     "fast-safe-stringify": "^2.0.6",
     "git-rev": "^0.2.1",
-    "url-parse": "^1.4.7",
+    "lodash": "^4.17.21",
+    "url-parse": "^1.5.1",
     "uuid": "^3.3.3",
     "winston": "^3.2.1",
     "winston-logstash": "^0.4.0"

package/safe_proxy/index.js

@@ -0,0 +1,59 @@
+"use strict";
+
+const axios = require("axios"); // required only until migration is complete
+const { omitBy, isNil } = require("lodash");
+
+/* A class which safely wraps an axios connection in order to pass the current user through to
+ * the next service.  Useful when one of our microservices requires auth as either an admin (sera4tal)
+ * or as the end user (example: DELETE /auth/sessions/:id
+ *
+ * each method requires a res.locals from a pre-authd session
+ */
+class SafeProxy {
+  constructor() {
+  }
+
+  // a safe post request
+  // locals = res.locals - your authentication details
+  post(locals, url, options = { headers: {}, data: {}}) {
+    let { account, tenant, membership } = locals;
+    return this._proxyRequest({ account, tenant, membership }, url, "post", options);
+  }
+  delete(locals, url, options = { headers: {}, data: {}}) {
+    let { account, tenant, membership } = locals;
+    return this._proxyRequest({ account, tenant, membership }, url, "delete", options);
+  }
+
+  /* private methods */
+  // supports get, delete, post
+  // options includes { headers, data } for post / delete payloads
+  async _proxyRequest(locals, url, method = "get", options) {
+    let request;
+    let membership = locals.membership ? JSON.stringify(locals.membership) : null;
+    let headers = omitBy({ ...options.headers,
+      "tws-account-id": locals.account?.id,
+      "tws-tenant-id": locals.tenant?.id,
+      "tws-membership-id": locals.membership?.id,
+      "tws-membership": membership
+    }, isNil);
+
+    switch(method) {
+      case "post":
+        request = axios.post(url, { ...options.data }, { headers })
+        break;
+      case "delete":
+        request = axios.delete(url, { ...options.data, headers } )
+        break;
+      case "get":
+        request = axios.get(url, { headers, data } )
+        break;
+      default:
+        throw new Error("uknown type called in proxyRequest");
+    }
+
+    return request;
+  }
+
+}
+
+module.exports = new SafeProxy();