rascal 20.0.0 → 20.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 20.1.1
+- npm search algorithm has changed. Updating metadata accordingly.
+
+## 20.1.0
+- Ignore and remove immediateNack header based on the xDeath header. See https://github.com/onebeyond/rascal/issues/237
+
 ## 20.0.0
 - Replaced superagent with native node http client as per https://github.com/onebeyond/rascal/issues/234
 

package/README.md

@@ -1,6 +1,6 @@
-# Rascal
+# Rascal - A RabbitMQ / AMQP Client
 
-Rascal is a rich pub/sub wrapper around [amqplib](https://www.npmjs.com/package/amqplib).
+Rascal is an advanced RabbitMQ / AMQP client built on [amqplib](https://www.npmjs.com/package/amqplib).
 
 [![NPM version](https://img.shields.io/npm/v/rascal.svg?style=flat-square)](https://www.npmjs.com/package/rascal)
 [![NPM downloads](https://img.shields.io/npm/dm/rascal.svg?style=flat-square)](https://www.npmjs.com/package/rascal)
@@ -12,7 +12,7 @@ Rascal is a rich pub/sub wrapper around [amqplib](https://www.npmjs.com/package/
 
 ## About
 
-Rascal is a rich pub/sub wrapper for the excellent [amqplib](https://www.npmjs.com/package/amqplib). One of the best things about amqplib is that it doesn't make assumptions about how you use it. Another is that it doesn't attempt to abstract away [AMQP Concepts](https://www.rabbitmq.com/tutorials/amqp-concepts.html). As a result the library offers a great deal of control and flexibility, but the onus is on you adopt appropriate patterns and configuration. You need to be aware that:
+Rascal is an advanced RabbitMQ / AMQP client built on [amqplib](https://www.npmjs.com/package/amqplib). One of the best things about amqplib is that it doesn't make assumptions about how you use it. Another is that it doesn't attempt to abstract away [AMQP Concepts](https://www.rabbitmq.com/tutorials/amqp-concepts.html). As a result the library offers a great deal of control and flexibility, but the onus is on you adopt appropriate patterns and configuration. You need to be aware that:
 
 - Messages are not persistent by default and will be lost if your broker restarts
 - Messages that crash your app will be infinitely retried
@@ -601,7 +601,7 @@ Running automated tests against shared queues and exchanges is problematic. Mess
 }
 ```
 
-If you specify `"namespace" :true` Rascal will prefix the queues and exchanges it creates with a uuid. Alternatively you can specify your own namespace, `"namespace": "foo"`. Namespaces are also if you want to use a single vhost locally but multiple vhosts in other environments.
+If you specify `"namespace" :true` Rascal will prefix the queues and exchanges it creates with a uuid. Alternatively you can specify your own namespace, `"namespace": "foo"`. Namespaces may also be helpful if you want to use a single vhost locally but multiple vhosts in other environments.
 
 #### Exchanges
 
@@ -1534,7 +1534,7 @@ As mentioned previously, dead lettering invalid messages is a good strategy with
 ackOrNack(err, { strategy: 'republish', immediateNack: true });
 ```
 
-If you ever want to resend the message to the same queue you will have to remove the `properties.headers.rascal.<queue>.immediateNack` header first.
+Prior to Rascal v20.1.0, if you wanted to resend the message to the original queue you had to remove the `properties.headers.rascal.<queue>.immediateNack` header first. From v20.1.0, Rascal will ignore and remove the immediateNack header if the message's xDeath header indicates that the message was dead lettered after it was republished with immediateNack.
 
 ##### Forward
 

package/lib/amqp/SubscriberError.js

@@ -3,10 +3,11 @@ const format = require('util').format;
 const _ = require('lodash');
 const async = require('async');
 const setTimeoutUnref = require('../utils/setTimeoutUnref');
+const { EMPTY_X_DEATH } = require('./XDeath');
 
 module.exports = function SubscriptionRecovery(broker, vhost) {
   this.handle = function (session, message, err, recoveryOptions, next) {
-    debug('Handling subscriber error for message: %s', message.properties.messageId);
+    debug('Handling subscriber error for message: %s with error: %s', message.properties.messageId, err.message);
 
     async.eachSeries(
       [].concat(recoveryOptions || []).concat({ strategy: 'fallback-nack' }),
@@ -84,7 +85,11 @@ module.exports = function SubscriptionRecovery(broker, vhost) {
           _.set(publishOptions, 'headers.rascal.error.code', err.code);
           _.set(publishOptions, 'headers.rascal.restoreRoutingHeaders', _.has(strategyConfig, 'restoreRoutingHeaders') ? strategyConfig.restoreRoutingHeaders : true);
 
-          if (strategyConfig.immediateNack) _.set(publishOptions, ['headers', 'rascal', 'recovery', originalQueue, 'immediateNack'], true);
+          if (strategyConfig.immediateNack) {
+            const xDeathRecords = message.properties.headers['x-death'] || [];
+            const xDeath = xDeathRecords.find(({ queue, reason }) => queue === originalQueue && reason === 'rejected') || EMPTY_X_DEATH;
+            _.set(publishOptions, ['headers', 'rascal', 'recovery', originalQueue], { immediateNack: true, xDeath });
+          }
 
           const ackMessage = () => {
             session._ack(message, (err) => {

package/lib/amqp/Subscription.js

@@ -8,6 +8,7 @@ const SubscriberSession = require('./SubscriberSession');
 const SubscriberError = require('./SubscriberError');
 const backoff = require('../backoff');
 const setTimeoutUnref = require('../utils/setTimeoutUnref');
+const { EMPTY_X_DEATH } = require('./XDeath');
 
 module.exports = {
   create(broker, vhost, counter, config, next) {
@@ -95,7 +96,11 @@ function Subscription(broker, vhost, subscriptionConfig, counter) {
     session._incrementUnacknowledgeMessageCount(message.fields.consumerTag);
 
     decorateWithRoutingHeaders(message);
-    if (immediateNack(message)) return ackOrNack(session, message, true);
+    if (immediateNack(message)) {
+      debug('Immediately nacking message: %s from queue: %s', message.properties.messageId, config.queue);
+      ackOrNack(session, message, new Error('Immediate nack'));
+      return;
+    }
 
     decorateWithRedeliveries(message, (err) => {
       if (err) return handleRedeliveriesError(err, session, message);
@@ -208,8 +213,24 @@ function Subscription(broker, vhost, subscriptionConfig, counter) {
   }
 
   function immediateNack(message) {
-    if (_.get(message, ['properties', 'headers', 'rascal', 'recovery', message.properties.headers.rascal.originalQueue, 'immediateNack'])) return true;
-    return false;
+    const originalQueue = message.properties.headers.rascal.originalQueue;
+    const xDeathRecords = message.properties.headers['x-death'] || [];
+    const currentXDeath = xDeathRecords.find(({ queue, reason }) => queue === originalQueue && reason === 'rejected') || EMPTY_X_DEATH;
+    const previousXDeath = _.get(message, ['properties', 'headers', 'rascal', 'recovery', originalQueue, 'xDeath'], EMPTY_X_DEATH);
+    const hasImmediateNackHeader = _.has(message, ['properties', 'headers', 'rascal', 'recovery', originalQueue, 'immediateNack']);
+    if (!hasImmediateNackHeader) return false;
+    debug('Message %s has been marked for immediate nack. Previous xDeath is %o. Current xDeath is %o.', message.properties.messageId, previousXDeath, currentXDeath);
+    // See https://github.com/rabbitmq/rabbitmq-server/issues/11331
+    // RabbitMQ v3.13 stopped updating the xDeath record's count property.
+    // RabbitMQ v3.12 does not update the xDeath record's time property.
+    // Therefore having test them both
+    if (currentXDeath.count > previousXDeath.count || currentXDeath.time.value > previousXDeath.time.value) {
+      debug('Message %s has been replayed after being dead lettered. Removing immediate nack.', message.properties.messageId);
+      _.unset(message, ['properties', 'headers', 'rascal', 'recovery', originalQueue, 'immediateNack']);
+      _.unset(message, ['properties', 'headers', 'rascal', 'recovery', originalQueue, 'xDeath']);
+      return false;
+    }
+    return true;
   }
 
   function getAckOrNack(session, message) {

package/lib/amqp/XDeath.js

@@ -0,0 +1,5 @@
+const EMPTY_X_DEATH = { count: 0, time: { value: 0 } };
+
+module.exports = {
+  EMPTY_X_DEATH,
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rascal",
-  "version": "20.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",
+  "version": "20.1.1",
+  "description": "An advanced RabbitMQ / AMQP client built on amqplib",
   "main": "index.js",
   "dependencies": {
     "async": "^3.2.4",
@@ -40,20 +40,17 @@
     "lint:fix": "eslint --fix .",
     "lint-staged": "lint-staged",
     "coverage": "nyc --report html --reporter lcov --reporter text-summary zUnit",
-    "docker": "docker run -d --name rascal-rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:3-management",
+    "docker": "docker run -d --name rascal-rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:3.12.9-management-alpine",
     "prepare": "husky install"
   },
   "lint-staged": {
     "**/*.js": "eslint --fix"
   },
   "keywords": [
-    "amqplib",
-    "amqp",
     "rabbitmq",
-    "callback",
-    "promise",
-    "await",
-    "async"
+    "rabbit",
+    "amqplib",
+    "amqp"
   ],
   "repository": {
     "type": "git",