@sera4/essentia 1.1.35 → 1.1.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.1.35",
+  "version": "1.1.37",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "type": "module",

package/queue/index.js

@@ -148,14 +148,15 @@ class S4Queue {
    * Registers a new direct 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.
+   * @param {Object} options connection options
    */
-  async registerDirectPublisher(exchange) {
+  async registerDirectPublisher(exchange, options) {
     const name = exchange;
     if (Object.keys(this.pubs).includes(name)) {
       throw new Error(`Publisher ${name} already registered`);
     }
 
-    const p = new Publisher(exchange, 'direct', true, name);
+    const p = new Publisher(exchange, 'direct', name, options);
     await p.init(this.connection);
     this.pubs[name] = p;
   }
@@ -164,14 +165,15 @@ class S4Queue {
    * 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.
+   * @param {Object} options connection options
    */
-  async registerTopicPublisher(exchange) {
+  async registerTopicPublisher(exchange, options) {
     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);
+    const p = new Publisher(exchange, 'topic', name, options);
     await p.init(this.connection);
     this.pubs[name] = p;
   }
@@ -180,18 +182,44 @@ class S4Queue {
    * Registers a new fanout 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.
+   * @param {Object} options connection options
    */
-  async registerFanoutPublisher(exchange) {
+  async registerFanoutPublisher(exchange, options) {
     const name = exchange;
     if (Object.keys(this.pubs).includes(name)) {
       throw new Error(`Publisher ${name} already registered`);
     }
 
-    const p = new Publisher(exchange, 'fanout', true, name);
+    const p = new Publisher(exchange, 'fanout', name, options);
     await p.init(this.connection);
     this.pubs[name] = p;
   }
 
+  /**
+   * Checks whether or not a publisher with given parameters
+   * has been registered already
+   * @param {String} exchange the name of the exchange.
+   * @returns true if registered already, false otherwise
+   */
+  hasPublisher(exchange) {
+    return Object.keys(this.pubs).includes(exchange);
+  }
+
+  /**
+   * Removes a previously registered publisher
+   * @param {String} exchange
+   */
+   async unregisterPublisher(exchange) {
+    const name = exchange;
+    if (!Object.keys(this.pubs).includes(name)) {
+      throw new Error(`Publisher ${name} not registered`);
+    }
+    const p = this.pubs[name];
+    await p.closeChannel();
+    delete this.pubs[name];
+    logger.debug("Unregistered publisher", name);
+  }
+
   /**
    * Registers a new direct subscriber on a given exchange and queue.
    * If exchange and queue don't exists, they'll be created
@@ -199,14 +227,15 @@ class S4Queue {
    * @param {String} exchange the name of the exchange.
    * @param {String} queue the name of the queue.
    * @param {String} key the name of the routing key.
+   * @param {Object} options connection options
    */
-  async registerDirectSubscriber(exchange, queue, key) {
+  async registerDirectSubscriber(exchange, queue, key, options) {
     const name = `${exchange}-${queue}-${key}`;
     if (Object.keys(this.subs).includes(name)) {
       throw new Error(`Subscriber ${name} already registered`);
     }
 
-    const s = new Subscriber(exchange, queue, 'direct', true, key, name);
+    const s = new Subscriber(exchange, queue, 'direct', key, name, options);
     await s.init(this.connection);
     this.subs[name] = s;
   }
@@ -218,18 +247,49 @@ class S4Queue {
    * @param {String} exchange the name of the exchange.
    * @param {String} queue the name of the queue.
    * @param {String} key the name of the routing key.
+   * @param {Object} options connection options
    */
-  async registerTopicSubscriber(exchange, queue, key) {
+  async registerTopicSubscriber(exchange, queue, key, options) {
     const name = `${exchange}-${queue}-${key}`;
     if (Object.keys(this.subs).includes(name)) {
       throw new Error(`Subscriber ${name} already registered`);
     }
 
-    const s = new Subscriber(exchange, queue, 'topic', true, key, name);
+    const s = new Subscriber(exchange, queue, 'topic', key, name, options);
     await s.init(this.connection);
     this.subs[name] = s;
   }
 
+  /**
+   * Checks whether or not a subscriber with given parameters
+   * has been registered already
+   * @param {String} exchange the name of the exchange.
+   * @param {String} queue the name of the queue.
+   * @param {String} key the name of the routing key.
+   * @returns true if registered already, false otherwise
+   */
+  hasSubscriber(exchange, queue, key) {
+    const name = `${exchange}-${queue}-${key}`;
+    return Object.keys(this.subs).includes(name);
+  }
+
+  /**
+   * Removes a previously registered subscriber
+   * @param {String} exchange
+   * @param {String} queue the name of the queue.
+   * @param {String} key the name of the routing key.
+   */
+   async unregisterSubscriber(exchange, queue, key) {
+    const name = `${exchange}-${queue}-${key}`;
+    if (!Object.keys(this.subs).includes(name)) {
+      throw new Error(`Subscriber ${name} not registered`);
+    }
+    const s = this.subs[name];
+    await s.closeChannel();
+    delete this.subs[name];
+    logger.debug("Unregistered subscriber", name);
+  }
+
   /**
    * Publishes a message on a given exchange with routing key.
    * @param {String} exchange the name of the exchange.

package/queue/publisher.js

@@ -8,13 +8,14 @@ export class Publisher {
   /**
    * @param {String} exchange AMQP exchange name.
    * @param {String} type direct|fanout| etc (supported types by RabbitMQ).
-   * @param {boolean} durable true if the messages should persist service restarts.
    * @param {String} name a name to identify this publisher in the logs.
+   * @param {Object} options connection options
+
    */
-  constructor(exchange, type, durable, name) {
+  constructor(exchange, type, name, options = {}) {
     this.exchange = exchange;
     this.type = type;
-    this.durable = durable;
+    this.options = {durable: true, ...options};
     this.name = name;
     this.channel = null;
   }
@@ -38,7 +39,7 @@ export class Publisher {
     }
 
     logger.debug(`Initialized PUB channel for ${this.name}`);
-    await this.channel.assertExchange(this.exchange, this.type, {durable: this.durable});
+    await this.channel.assertExchange(this.exchange, this.type, this.options);
 
     this.channel.on("error", (err) => {
       logger.debug(`Connection error for ${this.name}`, err);
@@ -80,6 +81,19 @@ export class Publisher {
     return parcel.tracking_id;
   }
 
+  /**
+   * Closes the channel
+   * @returns promise
+   */
+  async closeChannel() {
+    if (this.channel) {
+      logger.debug("Closing publishing channel", this.name);
+      return this.channel.close();
+    } else {
+      logger.error("Can't close a null publishing channel");
+    }
+  }
+
   async bindQueue(queue, pattern, args) {
     await this.channel.bindQueue(queue, this.exchange, pattern, args)
   }

package/queue/subscriber.js

@@ -10,15 +10,15 @@ export class Subscriber {
    * @param {String} exchange name of the AMQP exchange.
    * @param {String} queue name of the AMQP service.
    * @param {String} type direct|fanout or other supported connection types.
-   * @param {boolean} durable durable connection or not.
    * @param {String} key routing key. This will be used to bind the queue to the exchange.
    * @param {String} name a usefull name to be printed in the logs.
+   * @param {Object} options connection options
    */
-  constructor(exchange, queue, type, durable, key, name) {
+  constructor(exchange, queue, type, key, name, options = {}) {
     this.exchange = exchange;
     this.queue = queue;
     this.type = type;
-    this.durable = durable;
+    this.options = {durable: true, ...options};
     this.key = key;
     this.name = name;
     this.channel = null;
@@ -55,8 +55,8 @@ export class Subscriber {
     });
 
     logger.debug(`Initialized SUB channel for ${this.name}`);
-    await this.channel.assertExchange(this.exchange, this.type, {durable: this.durable});
-    await this.channel.assertQueue(this.queue, { durable: this.durable });
+    await this.channel.assertExchange(this.exchange, this.type, this.options);
+    await this.channel.assertQueue(this.queue, this.options);
 
     logger.debug(`Binding queue ${this.queue} on ${this.exchange} exchange for ${this.key} key`);
     await this.channel.bindQueue(this.queue, this.exchange, this.key);
@@ -82,6 +82,19 @@ export class Subscriber {
     }, { noAck: false });
   }
 
+  /**
+   * Closes the channel
+   * @returns promise
+   */
+   async closeChannel() {
+    if (this.channel) {
+      logger.debug("Closing subscriber channel", this.name);
+      return this.channel.close();
+    } else {
+      logger.error("Can't close a null subscriber channel");
+    }
+  }
+
   /**
    * Register a new callback to recive message through this
    * subscriber object