rascal 15.0.0 → 16.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 16.0.0
+
+- Automatically set replyTo message property when a publication references a replyTo queue
+- Stop prefixing binding keys with replyTo uuid
+- Drop support for Node 12
+
+## 15.0.1
+
+- Fix MaxListenersExceeded warning when there are more than 10 vhosts - See https://github.com/guidesmiths/rascal/issues/206
+
 ## 15.0.0
 
 - Drop support for Node 10

package/README.md

@@ -30,6 +30,7 @@ Rascal seeks to either solve these problems, make them easier to deal with or br
 - Transparent encryption / decryption
 - Automatic reconnection and resubscription
 - Advanced error handling including delayed, limited retries
+- RPC Support
 - Redelivery protection
 - Channel pooling
 - Flow control
@@ -679,6 +680,25 @@ Enable to purge the queue during initialisation. Useful when running automated t
 }
 ```
 
+##### replyTo
+
+Sometimes you want to publish a message, and have the consumer of the message send a reply to the same application instance that published the original message. This can be difficult if you application is deployed using multiple instances which share a common configuration. Quite often the solution is to make your application stateless so it doesn't matter which instance receives the reply. An altnernative is to mark the queue as a reply queue using the replyTo.
+
+```json
+{
+  "queues": {
+    "q1": {
+      "replyTo": true
+    }
+  },
+  "publications": {
+    "replyTo": "q1"
+  }
+}
+```
+
+When true, Rascal will append a uuid to the queue name so that it is unique for each instance of the application. Use this conjunction with the publication replyTo property, to automaticlaly set the replyTo property on outbound messages to the unique queue name. You may also want to make make the queue non durable and exclusive too (see below).
+
 ##### options
 
 Define any further configuration in an options block

package/lib/amqp/Publication.js

@@ -37,6 +37,7 @@ function Publication(vhost, borrowChannelFn, returnChannelFn, destroyChannelFn,
     const content = getContent(payload);
     publishConfig.options.contentType = publishConfig.options.contentType || content.type;
     publishConfig.options.messageId = publishConfig.options.messageId || uuid();
+    publishConfig.options.replyTo = publishConfig.options.replyTo || publishConfig.replyTo;
 
     publishConfig.encryption ? _publishEncrypted(content.buffer, publishConfig, next) : _publish(content.buffer, publishConfig, next);
   };

package/lib/amqp/tasks/initVhosts.js

@@ -6,6 +6,8 @@ const Vhost = require('../Vhost');
 
 module.exports = _.curry((config, ctx, next) => {
   ctx.vhosts = {};
+  const maxListeners = Math.max(ctx.broker.getMaxListeners(), Object.keys(config.vhosts).length);
+  ctx.broker.setMaxListeners(maxListeners);
   async.eachSeries(
     _.values(config.vhosts),
     (vhostConfig, callback) => {

package/lib/config/configure.js

@@ -133,11 +133,11 @@ module.exports = _.curry((rascalConfig, next) => {
       },
       {}
     );
-
     _.each(_.defaults({}, publications, defaultPublications), configurePublication);
   }
 
   function configurePublication(publicationConfig, name) {
+    if (publicationConfig.destination) return;
     debug('Configuring publication: %s', name);
     if (rascalConfig.publications[name] && rascalConfig.publications[name].vhost !== publicationConfig.vhost) throw new Error(format('Duplicate publication: %s', name));
     rascalConfig.publications[name] = _.defaultsDeep(publicationConfig, { name }, rascalConfig.defaults.publications);
@@ -145,6 +145,13 @@ module.exports = _.curry((rascalConfig, next) => {
     const destination = Object.prototype.hasOwnProperty.call(publicationConfig, 'exchange') ? rascalConfig.vhosts[publicationConfig.vhost].exchanges[publicationConfig.exchange] : rascalConfig.vhosts[publicationConfig.vhost].queues[publicationConfig.queue];
     rascalConfig.publications[name].destination = destination.fullyQualifiedName;
 
+    if (publicationConfig.replyTo) {
+      const replyToQueue = rascalConfig.vhosts[publicationConfig.vhost].queues[publicationConfig.replyTo];
+
+      if (!replyToQueue) throw new Error(`Publication: ${name} refers to an unknown reply queue: ${publicationConfig.replyTo}`);
+      publicationConfig.replyTo = replyToQueue.fullyQualifiedName;
+    }
+
     if (publicationConfig.encryption && _.isString(publicationConfig.encryption)) {
       rascalConfig.publications[name].encryption = _.defaultsDeep({ name: publicationConfig.encryption }, rascalConfig.encryption[publicationConfig.encryption]);
     }
@@ -260,10 +267,6 @@ module.exports = _.curry((rascalConfig, next) => {
       if (bindingConfig.qualifyBindingKeys) {
         config.bindings[name].bindingKey = fqn.qualify(bindingConfig.bindingKey, config.namespace);
       }
-      if (bindingConfig.destinationType === 'queue') {
-        const queue = config.queues[bindingConfig.destination];
-        config.bindings[name].bindingKey = fqn.prefix(queue && queue.replyTo, bindingConfig.bindingKey, '.');
-      }
     });
   }
 

package/lib/config/validate.js

@@ -101,7 +101,7 @@ module.exports = _.curry((config, next) => {
   }
 
   function validatePublication(publication, publicationName) {
-    validateAttributes('Publication', publication, publicationName, ['name', 'vhost', 'exchange', 'queue', 'routingKey', 'confirm', 'options', 'destination', 'autoCreated', 'deprecated', 'encryption', 'timeout']);
+    validateAttributes('Publication', publication, publicationName, ['name', 'vhost', 'exchange', 'queue', 'routingKey', 'confirm', 'options', 'destination', 'autoCreated', 'deprecated', 'encryption', 'replyTo', 'timeout']);
     if (!publication.vhost) throw new Error(format('Publication: %s is missing a vhost', publicationName));
     if (!(Object.prototype.hasOwnProperty.call(publication, 'exchange') || publication.queue)) throw new Error(format('Publication: %s is missing an exchange or a queue', publicationName));
     if (Object.prototype.hasOwnProperty.call(publication, 'exchange') && publication.queue) throw new Error(format('Publication: %s has an exchange and a queue', publicationName));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rascal",
-  "version": "15.0.0",
+  "version": "16.0.0",
   "description": "A config driven wrapper for amqplib supporting multi-host connections, automatic error recovery, redelivery flood protection, transparent encryption / decryption,  channel pooling and publication timeouts",
   "main": "index.js",
   "dependencies": {
@@ -30,13 +30,13 @@
     "prettier": "^2.4.1",
     "random-readable": "^1.0.1",
     "superagent-defaults": "^0.1.14",
-    "zunit": "^3.2.1"
+    "zunit": "^4.0.0"
   },
   "peerDependencies": {
     "amqplib": ">=0.5.5"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14"
   },
   "scripts": {
     "test": "zUnit",