@sera4/essentia 1.0.30 → 1.0.32

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.30",
+  "version": "1.0.32",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "scripts": {

package/queue/index.js

@@ -17,35 +17,27 @@ class S4Queue {
   }
 
   /**
-   * Opens a connection and immediately closes it.
-   * To be used for health checks.
-   * @param {Object} options Connection parameters. At the very least options.connectionUrl must be present.
+   * Tests the connection to the service.
+   * Internally, the same connection is used for test
+   * and production code, but a separate channel is opened.
+   * Once the channel is obtained, there is an assert on the
+   * existence of a topic exchange called '--health-check--'.
+   * The following must be satisfied for the test to pass
+   * 1. must be connected
+   * 2. must have a test channel
+   * 3. must assert the exchange
    */
-  async testConnection(options) {
-    return new Promise((resolve, reject) => {
-      // We may run into issues with SNI TLS if
-      // we host with 3rd parties using our own certs.
-      // To avoid any issues, let's parse the url
-      // and provide the server name in the socket options
-      const urlParts = urlParse(options.connectionUrl);
-      const socketOptions = {servername: urlParts.hostname};
+  async testConnection() {
+    if (!this.isConnected()) {
+      throw("queue service not connected")
+    }
 
-      amqp.connect(options.connectionUrl, socketOptions, (err, conn) => {
-        if (err) {
-          return reject(err);
-        }
-        if (!conn) {
-          return reject("Failed to obtain connection");
-        }
-        conn.close(e => {
-          if (e) {
-            reject(e)
-          } else {
-            resolve(true)
-          }
-        })
-      });
-    });
+    this.connectionTestChannel = this.connectionTestChannel || await this.connection.createChannel();
+    if (!this.connectionTestChannel) {
+      throw("queue service failed to obtain a channel")
+    }
+
+    await this.connectionTestChannel.assertExchange("--health-check--", "topic", {durable: false});
   }
 
   /**