refactor: deserialize custom event object

Author: roggervalf

src/classes/queue-events.ts

@@ -8,6 +8,7 @@ import {
   array2obj,
   clientCommandMessageReg,
   isRedisInstance,
+  parseObjectValues,
   QUEUE_EVENT_SUFFIX,
 } from '../utils';
 import { QueueBase } from './queue-base';
@@ -298,20 +299,40 @@ export class QueueEvents extends QueueBase {
           id = events[i][0];
           const args = array2obj(events[i][1]);
 
+          let { event, ...restArgs } = args;
+
           //
           // TODO: we may need to have a separate xtream for progress data
           // to avoid this hack.
-          switch (args.event) {
+          switch (event) {
+            case 'active':
+            case 'added':
+            case 'cleaned':
+            case 'debounced': // TODO: to be removed in next breaking change
+            case 'deduplicated':
+            case 'delayed':
+            case 'duplicated':
+            case 'error':
+            case 'failed':
+            case 'paused':
+            case 'removed':
+            case 'resumed':
+            case 'retries-exhausted':
+            case 'stalled':
+            case 'waiting':
+            case 'waiting-children':
+              break;
             case 'progress':
-              args.data = JSON.parse(args.data);
+              restArgs.data = JSON.parse(restArgs.data);
               break;
             case 'completed':
-              args.returnvalue = JSON.parse(args.returnvalue);
+              restArgs.returnvalue = JSON.parse(restArgs.returnvalue);
+              break;
+            default:
+              restArgs = parseObjectValues(restArgs);
               break;
           }
 
-          const { event, ...restArgs } = args;
-
           if (event === 'drained') {
             this.emit(event, id);
           } else {

tests/test_events.ts

@@ -1269,7 +1269,7 @@ describe('events', function () {
   });
 
   describe('when publishing custom events', function () {
-    it('emits waiting when a job has been added', async () => {
+    it('emits custom event', async () => {
       const queueName2 = `test-${v4()}`;
       const queueEventsProducer = new QueueEventsProducer(queueName2, {
         connection,
@@ -1311,5 +1311,50 @@ describe('events', function () {
       await queueEvents2.close();
       await removeAllQueueData(new IORedis(redisHost), queueName2);
     });
+
+    describe('when published event is an object', function () {
+      it('deserialize event', async () => {
+        const queueName2 = `test-${v4()}`;
+        const queueEventsProducer = new QueueEventsProducer(queueName2, {
+          connection,
+          prefix,
+        });
+        const queueEvents2 = new QueueEvents(queueName2, {
+          autorun: false,
+          connection,
+          prefix,
+          lastEventId: '0-0',
+        });
+        await queueEvents2.waitUntilReady();
+
+        interface CustomListener extends QueueEventsListener {
+          example: (args: { custom: { foo: string } }, id: string) => void;
+        }
+        const customEvent = new Promise<void>(resolve => {
+          queueEvents2.on<CustomListener>('example', async ({ custom }) => {
+            await delay(250);
+            await expect(custom.foo).to.be.equal('value');
+            resolve();
+          });
+        });
+
+        interface CustomEventPayload {
+          eventName: string;
+          custom: { foo: string };
+        }
+
+        await queueEventsProducer.publishEvent<CustomEventPayload>({
+          eventName: 'example',
+          custom: { foo: 'value' },
+        });
+
+        queueEvents2.run();
+        await customEvent;
+
+        await queueEventsProducer.close();
+        await queueEvents2.close();
+        await removeAllQueueData(new IORedis(redisHost), queueName2);
+      });
+    });
   });
 });