onjs 2.5.0 → 2.5.1

package/bin/prepare-test-environment

@@ -87,3 +87,11 @@ else
   createRabbitContainer
   sleep 5
 fi
+
+function installDelayedMessageExchangePlugin() {
+  docker exec ${RABBIT_CONTAINER_NAME} sh -c "wget -q https://github.com/rabbitmq/rabbitmq-delayed-message-exchange/releases/download/v3.13.0/rabbitmq_delayed_message_exchange-3.13.0.ez -O /opt/rabbitmq/plugins/rabbitmq_delayed_message_exchange-3.13.0.ez"
+  docker exec ${RABBIT_CONTAINER_NAME} rabbitmq-plugins enable rabbitmq_delayed_message_exchange
+}
+
+echo "Ensuring the delayed-message exchange plugin is installed"
+installDelayedMessageExchangePlugin

package/bin/test

@@ -22,4 +22,5 @@ docker run --rm --name onjs_test_runner \
   --network onjs_test \
   -v ${PWD}:/app -w /app \
   -e "NODE_ENV=test" \
+  -e "ONJS_DELAYED_PLUGIN_TESTS=true" \
   rever/node:22 npm test

package/lib/on.js

@@ -338,6 +338,13 @@ class On extends EventEmitter {
     }
   }
 
+  async _initDelayedQueues(delayedQueues, options) {
+    const queueNames = delayedQueues.map((queue) => queue.eventName)
+    this._log('info', 'Listening for delayedQueueNames', queueNames)
+    const listener = await this.queueInstance.listen(queueNames, options)
+    return listener
+  }
+
   async _onTaskReceived (task, data, options = {}) {
     this._eventLog('info', task.eventName, 'Executing task callback for task')
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onjs",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "On.js is an event library based on RabbitMQ that helps you control events on a microservices arquitecture",
   "main": "index.js",
   "scripts": {

package/tests/tests/queues.js

@@ -14,6 +14,7 @@ describe('Queue', function () {
   var config = {
     mq: {
       exchange_name: 'onjs_test',
+      delayed_exchange_name: 'onjs_test_delayed',
       url: 'amqp://rabbitmq:rabbitmq@rabbitmq:5672/',
       connectMaxAttempts: 1,
       delayMS: 10,
@@ -97,6 +98,38 @@ describe('Queue', function () {
       superpower: 'Fly'
     })
   })
+
+  it("Should initialize and process a delayed queue task", async function () {
+    // The delayed round trip needs the delayed-message exchange plugin,
+    // installed by bin/prepare-test-environment. CI runs the stock image
+    // without the plugin: bin/test sets ONJS_DELAYED_PLUGIN_TESTS=true so
+    // this test runs there, and CI skips it (the routing regression test
+    // still guards the delayed path on every broker).
+    if (process.env.ONJS_DELAYED_PLUGIN_TESTS !== 'true') this.skip()
+
+    var executed = null
+
+    function execution(incomingData) {
+      executed = incomingData
+      return
+    }
+
+    on
+    .taskReceived('delayedQueueRegression', { isDelayed: true })
+    .andProcess(execution)
+
+    await on.init()
+
+    await sender.send('delayedQueueRegression', { name: 'Delayed Superman' }, 300)
+
+    var waited = 0
+    while (!executed && waited < 5000) {
+      await new Promise((resolve) => { setTimeout(resolve, 100) })
+      waited += 100
+    }
+
+    executed.should.have.property('name', 'Delayed Superman')
+  })
 })
 
 describe('Queue with manual ack', function () {
@@ -105,6 +138,7 @@ describe('Queue with manual ack', function () {
   var config = {
     mq: {
       exchange_name: 'onjs_test_manual_ack',
+      delayed_exchange_name: 'onjs_test_manual_ack_delayed',
       url: 'amqp://rabbitmq:rabbitmq@rabbitmq:5672/',
       connectMaxAttempts: 1,
       delayMS: 10,
@@ -150,6 +184,7 @@ describe('Queue with manual ack', function () {
     var listenCalls = []
     var listenManualCalls = []
     var listenManualHandlers = []
+    var listenOptions = []
 
     onInstance.mqInstance.createChannel = async function () {
       return channel
@@ -158,8 +193,9 @@ describe('Queue with manual ack', function () {
     onInstance.queueInstance = {
       setChannel: function () {},
       on: function () {},
-      listen: async function (queueNames) {
+      listen: async function (queueNames, options) {
         listenCalls.push(queueNames)
+        listenOptions.push(options)
       },
       listenManual: async function (queueNames, handler) {
         listenManualCalls.push(queueNames)
@@ -167,7 +203,7 @@ describe('Queue with manual ack', function () {
       }
     }
 
-    return { onInstance: onInstance, channel: channel, listenCalls: listenCalls, listenManualCalls: listenManualCalls, listenManualHandlers: listenManualHandlers }
+    return { onInstance: onInstance, channel: channel, listenCalls: listenCalls, listenOptions: listenOptions, listenManualCalls: listenManualCalls, listenManualHandlers: listenManualHandlers }
   }
 
   it('Should route auto ack tasks to listen and manual ack tasks to the manual consumer', async function () {
@@ -193,6 +229,23 @@ describe('Queue with manual ack', function () {
     stubs.listenManualCalls[0].should.not.deepEqual(stubs.listenCalls[0])
   })
 
+  it('Should route delayed tasks through the auto-ack listen with isDelayed', async function () {
+    var stubs = createStubbedOn()
+
+    function execution (incomingData) {
+      return
+    }
+
+    stubs.onInstance
+    .taskReceived('delayedQueue', { isDelayed: true })
+    .andProcess(execution)
+
+    await stubs.onInstance._startEventListeners()
+
+    stubs.listenCalls.should.deepEqual([['delayedQueue']])
+    stubs.listenOptions[0].should.have.property('isDelayed', true)
+  })
+
   it('Should await the actions and ack the message after processing', async function () {
     var stubs = createStubbedOn()
     var executed = []