@sera4/essentia 1.0.25 → 1.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.0.25",
+  "version": "1.0.27",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "scripts": {
@@ -29,6 +29,7 @@
     "async": "^2.6.1",
     "fast-safe-stringify": "^2.0.6",
     "git-rev": "^0.2.1",
+    "url-parse": "^1.4.7",
     "uuid": "^3.3.3",
     "winston": "^3.2.1",
     "winston-logstash": "^0.4.0"

package/queue/index.js

@@ -1,6 +1,7 @@
 "use strict";
 const amqp = require("amqplib/callback_api");
 const logger = require("./queue-logger");
+const urlParse = require("url-parse");
 const { Publisher } = require("./publisher");
 const { Subscriber } = require("./subscriber");
 
@@ -15,6 +16,38 @@ class S4Queue {
     this.subs = {};
   }
 
+  /**
+   * 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.
+   */
+  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};
+
+      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)
+          }
+        })
+      });
+    });
+  }
+
   /**
    * Opens a connection to AMQP server.
    * @param {Object} options Connection parameters. At the very least options.connectionUrl must be present.
@@ -37,7 +70,14 @@ class S4Queue {
     // when a callback isn't provided, therefore run
     // in a new Promise
     return new Promise((resolve, reject) => {
-      amqp.connect(options.connectionUrl, (err, conn) => {
+      // 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};
+
+      amqp.connect(options.connectionUrl, socketOptions, (err, conn) => {
 
         if (err) {
           return reject(err);
@@ -123,6 +163,22 @@ class S4Queue {
     this.pubs[name] = p;
   }
 
+  /**
+   * Registers a new topic publisher on the given exchange.
+   * If exchange doesn't exist, one will be created.
+   * @param {String} exchange the name of the exchange on AMQP service.
+   */
+  async registerTopicPublisher(exchange) {
+    const name = exchange;
+    if (Object.keys(this.pubs).includes(name)) {
+      throw new Error(`Publisher ${name} already registered`);
+    }
+
+    const p = new Publisher(exchange, 'topic', true, name);
+    await p.init(this.connection);
+    this.pubs[name] = p;
+  }
+
   /**
    * Registers a new direct subscriber on a given exchange and queue.
    * If exchange and queue don't exists, they'll be created
@@ -152,15 +208,15 @@ class S4Queue {
     const p = this.pubs[exchange];
 
     if (!key) {
-      reject(new Error(`Direct message require a key`));
+      throw(new Error(`Direct message require a key`));
     }
 
     if (!p) {
-      reject(new Error(`No PUB for ${exchange} found`));
+      throw(new Error(`No PUB for ${exchange} found`));
     }
 
     if (p.type !== 'direct') {
-      reject(new Error(`PUB ${exchange} is not direct`));
+      throw(new Error(`PUB ${exchange} is not direct`));
     }
 
     let content = msg;
@@ -174,6 +230,38 @@ class S4Queue {
     return await p.publish({key, content});
   }
 
+  /**
+   * Publishes a message on a given exchange with a topic.
+   * @param {String} exchange the name of the exchange.
+   * @param {String} topic the name of the topic.
+   * @param {Object} msg a JSON object as the message.
+   */
+  async publishTopicMessage(exchange, topic, msg) {
+    const p = this.pubs[exchange];
+
+    if (!topic) {
+      throw(new Error(`Topic message require a topic`));
+    }
+
+    if (!p) {
+      throw(new Error(`No PUB for ${exchange} found`));
+    }
+
+    if (p.type !== 'topic') {
+      throw(new Error(`PUB ${exchange} is not topic`));
+    }
+
+    let content = msg;
+    if (content.constructor !== ({}).constructor) {
+      // if not in JSON format, let's make it so
+      content = {
+        msg: msg
+      }
+    }
+
+    return await p.publish({key: topic, content});
+  }
+
   /**
    * Adds a listener for a specific key.
    * If a subscriber that was regitered was found

package/queue/publisher.js

@@ -27,7 +27,7 @@ class Publisher {
    * @param {Object} conn amqp connection object
    */
   async init (conn) {
-    logger.debug(`Initializing PUB channel for ${this.name}`);
+    logger.debug(`Initializing PUB channel for ${this.name}. Type: ${this.type}`);
 
     if(this.channel) {
       logger.warn(`PUB channel for ${this.name} already initialized`);
@@ -67,7 +67,9 @@ class Publisher {
       tracking_id: uuidv4(),
       data: msg.content
     }
-    logger.debug("Publishing message", parcel);
+    logger.debug("Publishing message");
+    logger.debug("Key", msg.key);
+    logger.debug("Data", parcel);
 
     const content = Buffer.from(JSON.stringify(parcel));
     const res = await this.channel.publish(this.exchange, msg.key, content, {persistent: true});