onjs 2.3.5 → 2.4.1

package/README.md

@@ -28,7 +28,7 @@ Processing means that the task will be added to the queue and processed as soon
 
 Dispatching means that the task will be added to the queue but instead of being processed, it will be sent to MQ with another name.
 
-```
+```javascript
 on
 	.eventReceived(eventName: string)
 	.withProperties(properties: array)
@@ -38,7 +38,7 @@ on
 
 Broadcasting means that the task will immediately be executed by ALL the listeners without using redis, the tasks will be "duplicated" across all listeners.
 
-```
+```javascript
 on
 	.broadcastReceived(eventName: string)
 	.do(callback: function)
@@ -48,7 +48,7 @@ on
 
 #### Processing
 
-```
+```javascript
 on
 	.eventReceived(eventName: string)
 	.withProperties(properties: array)
@@ -59,7 +59,7 @@ Any event received with the name registered on ```eventReceived``` will be added
 
 #### Dispatching
 
-```
+```javascript
 on
 	.eventReceived(eventName: string)
 	.withProperties(properties: array)
@@ -74,7 +74,7 @@ The pattern of listening to work queues is described at https://www.rabbitmq.com
 
 This are tasks that will be executed by a queue
 
-```
+```javascript
 on
 	.taskReceived(eventName: string)
 	.withProperties(properties: array)
@@ -87,7 +87,7 @@ This type of queues require the rabbitmq-delayed-message-exchange plugin
 
 The task will arrive at the queue with a set delay
 
-```
+```javascript
 on
 	.taskReceived(eventName: string, options: { isDelayed: boolean})
 	.withProperties(properties: array)
@@ -99,7 +99,7 @@ The pattern of listening to RPC requests described at https://www.rabbitmq.com/t
 
 On.js will order MQ to start listening for events registered and the callback registered will be executed by MQ and the results sent to the client who requested the data.
 
-```
+```javascript
 on
 	.eventReceived(eventName: string)
 	.withProperties(properties: array)
@@ -113,7 +113,7 @@ The response will be a JSON string so you will have to parse it. The type of res
 
 To initialize initialize a new instance and then call .init()
 
-```
+```javascript
 var options = {
 	redis: {
 		host: REDIS_HOST,
@@ -132,9 +132,30 @@ var on = new On(options)
 on.init()
 ```
 
-## Usage Example
+### reconnecting
 
+By default onjs will try to reconnect to rabbitmq if the connection is closed, including when using the MQ library to close a connection directly, if you need to tear down use onjs.tearDown() function, or you can disable this behavior by setting the config option `reconnectOnClose` to false
+
+```javascript
+const options = {
+	redis: {
+		host: REDIS_HOST,
+		port: REDIS_PORT
+	},
+	mq: {
+		url: RABBITMQ_URL,
+  	exchange_name: EXCHANGE_NAME
+	},
+	reconnectOnClose: false,
+}
+
+const on = new On(options)
+on.init()
 ```
+
+## Usage Example
+
+```javascript
 var RabbitMQ = require('rabbitmq-lib')
 var On = require('./lib/on/on.js')
 
@@ -203,13 +224,13 @@ on.init()
 # Debugging and Logging
 Running 
 
-```
+```javascript
 on.debug()
 ```
 
 will enable all logging. If you only want to enable one particular event to have logging, you can do it as well by calling the .log method on a particular event:
 
-```
+```javascript
 on
 	.requestReceived('someRequest')
 	.withProperties(['userId'])
@@ -222,7 +243,7 @@ on
 # MQ Dependency
 The module has a dependency on a MQ class that handles the communication with MQ. In theory any kind of service with MQ should work as long as the communication with MQ is abstracted. The methods needed in the constructor are:
 
-```
+```javascript
 connect()
 disconnect()
 publish(eventName, data)

package/bin/prepare-test-environment

@@ -9,7 +9,7 @@ REDIS_CONTAINER_PORT=19379
 
 function createRabbitContainer() {
 	id=$(docker run -d --name ${RABBIT_CONTAINER_NAME} \
-  -p 5672 \
+  -p 5672:5272 \
   -e RABBITMQ_ERLANG_COOKIE=SWQOKODSQALRPCLNMEQG \
   -e RABBITMQ_DEFAULT_USER=rabbitmq \
   -e RABBITMQ_DEFAULT_PASS=rabbitmq \

package/lib/on.js

@@ -27,6 +27,7 @@ class On extends EventEmitter {
     this.currentEventTypeToRegister = null
     this.debugEnabled = false
     this.delayedExchangeNameIsEmpty = !options.mq.delayed_exchange_name && options.mq.delayed_exchange_name !== ''
+    this.reconnectOnClose = options.reconnectOnClose ?? true
 
     return this
   }
@@ -66,6 +67,10 @@ class On extends EventEmitter {
         this._log('info', 'Connected to MQ, initializing topics')
       })
 
+      this.mqInstance.on('connectionAttempt', async (attempt) => {
+        this._log('info', `MQ Connection attempt number ${attempt}`)
+      })
+
       this.mqInstance.on('reconnected', async (connection) => {
         this.setConnection(connection)
         this._log('info', 'ReConnected to MQ, initializing topics')
@@ -77,6 +82,13 @@ class On extends EventEmitter {
         throw err
       })
 
+      this.mqInstance.on('close', async (err) => {
+        if (this.reconnectOnClose) {
+          this._log('error', 'MQ Connection closed attempting to reconnect', err)
+          await this.mqInstance.reconnect()
+        }
+      })
+
       this._log('info', 'Connecting to RabbitMQ')
       var connection = await this.mqInstance.connect()
       this.setConnection(connection)
@@ -145,6 +157,7 @@ class On extends EventEmitter {
   async tearDown () {
     try {
       this._log('info', 'Tearing down on.js. Closing connection and stopped listening events')
+      this.reconnectOnClose = false
       this.removeAllListeners()
       var connection = this.getConnection()
       return await connection.close()
@@ -270,13 +283,13 @@ class On extends EventEmitter {
 
   async _initRPCRequests (requests) {
     try {
-      this._log('info', 'Listening for rpc requests', requests)
+      this._log('info', 'Listening for rpc requests')
 
       for (let request of requests) {
         let rpcInstance = new RPC()
         let channel = await this.mqInstance.createChannel()
         rpcInstance.setChannel(channel)
-        this._log('info', `Listening rpc request ${request.eventName}`, channel)
+        this._log('info', `Listening rpc request ${request.eventName}`)
         await rpcInstance.listen(request.eventName, request.actions[0])
       }
 
@@ -561,9 +574,9 @@ class On extends EventEmitter {
     }
   }
 
-  _log (type, message) {
+  _log (type, message, metadata) {
     if (this.debugEnabled) {
-      return this.logger[type](message)
+      return this.logger[type](message, metadata)
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onjs",
-  "version": "2.3.5",
+  "version": "2.4.1",
   "description": "On.js is an event library based on RabbitMQ that helps you control events on a microservices arquitecture",
   "main": "index.js",
   "scripts": {
@@ -28,8 +28,8 @@
     "mocha": "^5.2.0"
   },
   "dependencies": {
-    "rabbitmq-lib": "^2.2.0",
-    "amqplib": "^0.10.3",
+    "rabbitmq-lib": "^2.3.2",
+    "amqplib": "^0.10.5",
     "bull": "^3.29.3"
   }
 }

package/tests/tests/queues.js

@@ -15,11 +15,13 @@ describe('Queue', function () {
     mq: {
       exchange_name: 'onjs_test',
       url: 'amqp://rabbitmq:rabbitmq@rabbitmq:5672/',
+      connectMaxAttempts: 1,
+      delayMS: 10,
     },
     redis: {
       port: REDIS_PORT,
       host: 'redis'
-    }
+    },
   }
 
   var mq1 = new MQ(config.mq)

package/tests/tests/rpcs.js

@@ -14,11 +14,14 @@ describe('RPC', function () {
     mq: {
       exchange_name: 'onjs_test',
       url: 'amqp://rabbitmq:rabbitmq@rabbitmq:5672/',
+      connectMaxAttempts: 1,
+      delayMS: 10,
     },
     redis: {
       port: REDIS_PORT,
       host: 'redis'
-    }
+    },
+    reconnectOnClose: false,
   }
 
   var mq = new MQ(config.mq)

package/tests/tests/test.js

@@ -18,11 +18,14 @@ describe('On.js', function () {
     mq: {
       exchange_name: 'onjs_test',
       url: 'amqp://rabbitmq:rabbitmq@rabbitmq:5672/',
+      connectMaxAttempts: 1,
+      delayMS: 10,
     },
     redis: {
       port: REDIS_PORT,
       host: 'redis'
-    }
+    },
+    reconnectOnClose: false,
   }
 
   describe('Topics registration', function () {

package/tests/tests/topics.js

@@ -13,11 +13,14 @@ describe('Topics', function () {
     mq: {
       exchange_name: 'onjs_test',
       url: 'amqp://rabbitmq:rabbitmq@rabbitmq:5672/',
+      connectMaxAttempts: 1,
+      delayMS: 10,
     },
     redis: {
       port: REDIS_PORT,
       host: 'redis'
-    }
+    },
+    reconnectOnClose: false,
   }
 
   var mq1 = new MQ(config.mq)