test: use typed events, remove legacy events

weyoss · Nov 26, 2023 · 5d85cb0 · 5d85cb0
1 parent 5f5a34f
commit 5d85cb0
Show file tree

Hide file tree

Showing 25 changed files with 60 additions and 103 deletions.
diff --git a/tests/common/base-instance.ts b/tests/common/base-instance.ts
@@ -7,19 +7,18 @@
  * in the root directory of this source tree.
  */
 
-import { events } from '../../src/common/events/events';
 import { Base } from '../../src/lib/base';
 
 export async function shutDownBaseInstance(i: Base): Promise<void> {
   if (i.isGoingUp()) {
-    await new Promise((resolve) => {
-      i.once(events.UP, resolve);
+    await new Promise<void>((resolve) => {
+      i.once('up', resolve);
     });
   }
   if (i.isRunning()) {
     // eslint-disable-next-line no-await-in-loop
-    await new Promise((resolve) => {
-      i.shutdown(resolve);
+    await new Promise<void>((resolve) => {
+      i.shutdown(() => resolve());
     });
   }
 }
diff --git a/tests/common/events.ts b/tests/common/events.ts
@@ -8,12 +8,12 @@
  */
 
 import { Consumer } from '../../src/lib/consumer/consumer';
-import { events } from '../../src/common/events/events';
+import { TRedisSMQEvent } from '../../types';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function consumerOnEvent<T extends Array<any>>(
   consumer: Consumer,
-  event: string,
+  event: keyof TRedisSMQEvent,
 ) {
   return new Promise<T>((resolve) => {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -28,10 +28,7 @@ export async function untilMessageAcknowledged(
   consumer: Consumer,
   messageId?: string,
 ): Promise<void> {
-  const [id] = await consumerOnEvent<[string]>(
-    consumer,
-    events.MESSAGE_ACKNOWLEDGED,
-  );
+  const [id] = await consumerOnEvent<[string]>(consumer, 'messageAcknowledged');
   if (messageId && messageId !== id) {
     await untilMessageAcknowledged(consumer, messageId);
   }
@@ -43,7 +40,7 @@ export async function untilMessageDeadLettered(
 ): Promise<void> {
   const [, id] = await consumerOnEvent<[string, string]>(
     consumer,
-    events.MESSAGE_DEAD_LETTERED,
+    'messageDeadLettered',
   );
   if (messageId && messageId !== id) {
     await untilMessageDeadLettered(consumer, messageId);
@@ -52,7 +49,7 @@ export async function untilMessageDeadLettered(
 
 export async function untilConsumerEvent(
   consumer: Consumer,
-  event: string,
+  event: keyof TRedisSMQEvent,
 ): Promise<unknown[]> {
   return consumerOnEvent(consumer, event);
 }
diff --git a/tests/common/message-producing-consuming.ts b/tests/common/message-producing-consuming.ts
@@ -9,7 +9,6 @@
 
 import { EQueueType, IQueueParams } from '../../types';
 import { Message } from '../../src/lib/message/message';
-import { events } from '../../src/common/events/events';
 import { untilConsumerEvent, untilMessageAcknowledged } from './events';
 import { getConsumer } from './consumer';
 import { getProducer } from './producer';
@@ -63,7 +62,7 @@ export async function produceAndDeadLetterMessage(
   const { messages } = await producer.produceAsync(message);
 
   consumer.run();
-  await untilConsumerEvent(consumer, events.MESSAGE_DEAD_LETTERED);
+  await untilConsumerEvent(consumer, 'messageDeadLettered');
   return { producer, consumer, messageId: messages[0], queue };
 }
 

diff --git a/tests/tests/consuming-messages/test00004.test.ts b/tests/tests/consuming-messages/test00004.test.ts
@@ -9,7 +9,6 @@
 
 import { delay } from 'bluebird';
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { untilConsumerEvent } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -29,7 +28,7 @@ test('A message is dead-lettered and not delivered when messageTTL is exceeded',
   const consume = jest.spyOn(consumer, 'consume');
 
   let unacknowledged = 0;
-  consumer.on(events.MESSAGE_UNACKNOWLEDGED, () => {
+  consumer.on('messageUnacknowledged', () => {
     unacknowledged += 1;
   });
 
@@ -40,7 +39,7 @@ test('A message is dead-lettered and not delivered when messageTTL is exceeded',
   await delay(5000);
   consumer.run();
 
-  await untilConsumerEvent(consumer, events.MESSAGE_DEAD_LETTERED);
+  await untilConsumerEvent(consumer, 'messageDeadLettered');
   expect(consume).toHaveBeenCalledTimes(0);
   expect(unacknowledged).toBe(1);
   const deadLetteredMessages = await getQueueDeadLetteredMessages();

diff --git a/tests/tests/consuming-messages/test00005.test.ts b/tests/tests/consuming-messages/test00005.test.ts
@@ -9,7 +9,6 @@
 
 import { delay } from 'bluebird';
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { untilConsumerEvent } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -29,7 +28,7 @@ test('Setting default message TTL from configuration', async () => {
   const consume = jest.spyOn(consumer, 'consume');
 
   let unacks = 0;
-  consumer.on(events.MESSAGE_UNACKNOWLEDGED, () => {
+  consumer.on('messageUnacknowledged', () => {
     unacks += 1;
   });
   const msg = new Message();
@@ -39,7 +38,7 @@ test('Setting default message TTL from configuration', async () => {
   await delay(5000);
   consumer.run();
 
-  await untilConsumerEvent(consumer, events.MESSAGE_DEAD_LETTERED);
+  await untilConsumerEvent(consumer, 'messageDeadLettered');
 
   expect(consume).toHaveBeenCalledTimes(0);
   expect(unacks).toBe(1);

diff --git a/tests/tests/consuming-messages/test00006.test.ts b/tests/tests/consuming-messages/test00006.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { ICallback } from 'redis-smq-common';
 import { untilConsumerEvent } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
@@ -43,6 +42,6 @@ test('A message is unacknowledged when messageConsumeTimeout is exceeded', async
 
   await producer.produceAsync(msg);
   consumer.run();
-  await untilConsumerEvent(consumer, events.MESSAGE_UNACKNOWLEDGED);
-  await untilConsumerEvent(consumer, events.MESSAGE_ACKNOWLEDGED);
+  await untilConsumerEvent(consumer, 'messageUnacknowledged');
+  await untilConsumerEvent(consumer, 'messageAcknowledged');
 });
diff --git a/tests/tests/consuming-messages/test00007.test.ts b/tests/tests/consuming-messages/test00007.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { ICallback } from 'redis-smq-common';
 import { untilMessageAcknowledged } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
@@ -35,12 +34,12 @@ test('Unacknowledged message are re-queued when messageRetryThreshold is not exc
   });
 
   let unacknowledged = 0;
-  consumer.on(events.MESSAGE_UNACKNOWLEDGED, () => {
+  consumer.on('messageUnacknowledged', () => {
     unacknowledged += 1;
   });
 
   let acknowledged = 0;
-  consumer.on(events.MESSAGE_ACKNOWLEDGED, () => {
+  consumer.on('messageAcknowledged', () => {
     acknowledged += 1;
   });
 

diff --git a/tests/tests/consuming-messages/test00008.test.ts b/tests/tests/consuming-messages/test00008.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { delay } from 'bluebird';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -37,12 +36,12 @@ test('Async exceptions are caught when consuming a message', async () => {
   });
 
   let unacknowledged = 0;
-  consumer.on(events.MESSAGE_UNACKNOWLEDGED, () => {
+  consumer.on('messageUnacknowledged', () => {
     unacknowledged += 1;
   });
 
   let acknowledged = 0;
-  consumer.on(events.MESSAGE_ACKNOWLEDGED, () => {
+  consumer.on('messageAcknowledged', () => {
     acknowledged += 1;
   });
 

diff --git a/tests/tests/consuming-messages/test00009.test.ts b/tests/tests/consuming-messages/test00009.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { delay } from 'bluebird';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -30,7 +29,7 @@ test('A message is dead-lettered when messageRetryThreshold is exceeded', async
   });
 
   let unacknowledged = 0;
-  consumer.on(events.MESSAGE_UNACKNOWLEDGED, () => {
+  consumer.on('messageUnacknowledged', () => {
     unacknowledged += 1;
   });
 

diff --git a/tests/tests/consuming-messages/test00011.test.ts b/tests/tests/consuming-messages/test00011.test.ts
@@ -9,7 +9,6 @@
 
 import { delay } from 'bluebird';
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
 import {
@@ -28,10 +27,10 @@ test('Given many consumers, a message is delivered only to one consumer', async
   let unacks1 = 0;
   let acks1 = 0;
   consumer1
-    .on(events.MESSAGE_UNACKNOWLEDGED, () => {
+    .on('messageUnacknowledged', () => {
       unacks1 += 1;
     })
-    .on(events.MESSAGE_ACKNOWLEDGED, () => {
+    .on('messageAcknowledged', () => {
       acks1 += 1;
     });
 
@@ -46,10 +45,10 @@ test('Given many consumers, a message is delivered only to one consumer', async
   let unacks2 = 0;
   let acks2 = 0;
   consumer2
-    .on(events.MESSAGE_UNACKNOWLEDGED, () => {
+    .on('messageUnacknowledged', () => {
       unacks2 += 1;
     })
-    .on(events.MESSAGE_ACKNOWLEDGED, () => {
+    .on('messageAcknowledged', () => {
       acks2 += 1;
     });
 

diff --git a/tests/tests/consuming-messages/test00012.test.ts b/tests/tests/consuming-messages/test00012.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { untilMessageAcknowledged } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -36,12 +35,12 @@ test('An unacknowledged message is delayed given messageRetryDelay > 0 and messa
   });
 
   let unacks = 0;
-  consumer.on(events.MESSAGE_UNACKNOWLEDGED, () => {
+  consumer.on('messageUnacknowledged', () => {
     unacks += 1;
   });
 
   let acks = 0;
-  consumer.on(events.MESSAGE_ACKNOWLEDGED, () => {
+  consumer.on('messageAcknowledged', () => {
     acks += 1;
   });
 

diff --git a/tests/tests/consuming-messages/test00013.test.ts b/tests/tests/consuming-messages/test00013.test.ts
@@ -9,7 +9,6 @@
 
 import { Message } from '../../../src/lib/message/message';
 import { delay } from 'bluebird';
-import { events } from '../../../src/common/events/events';
 import { ICallback } from 'redis-smq-common';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -44,7 +43,7 @@ test('Given many queues, a message is recovered from a consumer crash and re-que
       cb();
     },
   });
-  queueAConsumer.on(events.MESSAGE_ACKNOWLEDGED, () => {
+  queueAConsumer.on('messageAcknowledged', () => {
     defaultQueueMetrics.acks += 1;
   });
   await queueAConsumer.runAsync();
@@ -56,7 +55,7 @@ test('Given many queues, a message is recovered from a consumer crash and re-que
       cb();
     },
   });
-  queueBConsumer.on(events.MESSAGE_ACKNOWLEDGED, () => {
+  queueBConsumer.on('messageAcknowledged', () => {
     queueBMetrics.acks += 1;
   });
   await queueBConsumer.runAsync();

diff --git a/tests/tests/consuming-messages/test00014.test.ts b/tests/tests/consuming-messages/test00014.test.ts
@@ -42,8 +42,8 @@ test('Consume message from different queues and published by a single producer i
     const consumer = getConsumer({
       queue: `queUE_${i}`,
       messageHandler: (msg, cb) => {
-        // message handlers start consuming message once started and before the consumer is fully started (when events.UP is emitted)
-        // untilMessageAcknowledged() may miss acknowledged events
+        // message handlers start consuming message once started and before the consumer is fully started (when event.UP is emitted)
+        // untilMessageAcknowledged() may miss acknowledged event
         // As a workaround, adding a delay before acknowledging a message
         setTimeout(cb, 10000);
       },

diff --git a/tests/tests/consuming-messages/test00019.test.ts b/tests/tests/consuming-messages/test00019.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../index';
-import { events } from '../../../src/common/events/events';
 import { untilConsumerEvent } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -38,7 +37,7 @@ test('An unacknowledged message is dead-lettered and not delivered again, given
   await producer.produceAsync(msg);
 
   consumer.run();
-  await untilConsumerEvent(consumer, events.MESSAGE_DEAD_LETTERED);
+  await untilConsumerEvent(consumer, 'messageDeadLettered');
   const deadLetteredMessages = await getQueueDeadLetteredMessages();
   const r = await deadLetteredMessages.getMessagesAsync(defaultQueue, 0, 100);
   expect(r.items.length).toBe(1);

diff --git a/tests/tests/consuming-messages/test00022.test.ts b/tests/tests/consuming-messages/test00022.test.ts
@@ -8,7 +8,6 @@
  */
 
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { untilConsumerEvent } from '../../common/events';
 import { getConsumer } from '../../common/consumer';
 import { getProducer } from '../../common/producer';
@@ -36,7 +35,7 @@ test('Shutdown a consumer when consuming a message with retryThreshold = 0: expe
   await producer.produceAsync(msg);
 
   consumer.run();
-  await untilConsumerEvent(consumer, events.DOWN);
+  await untilConsumerEvent(consumer, 'down');
   const deadLetteredMessages = await getQueueDeadLetteredMessages();
   const res = await deadLetteredMessages.getMessagesAsync(defaultQueue, 0, 100);
   expect(res.totalItems).toBe(1);

diff --git a/tests/tests/consuming-messages/test00023.test.ts b/tests/tests/consuming-messages/test00023.test.ts
@@ -16,7 +16,6 @@ import {
 } from '../../common/message-producing-consuming';
 import { getQueueDeadLetteredMessages } from '../../common/queue-dead-lettered-messages';
 import { untilConsumerEvent } from '../../common/events';
-import { events } from '../../../src/common/events/events';
 
 test('Messages produced from scheduled message are processed like normal message upon consume failures (retry, delay, requeue, etc)', async () => {
   await createQueue(defaultQueue, false);
@@ -39,7 +38,7 @@ test('Messages produced from scheduled message are processed like normal message
   await producer.produceAsync(msg);
 
   consumer.run();
-  await untilConsumerEvent(consumer, events.MESSAGE_DEAD_LETTERED);
+  await untilConsumerEvent(consumer, 'messageDeadLettered');
   const deadLetteredMessages = await getQueueDeadLetteredMessages();
   const res = await deadLetteredMessages.getMessagesAsync(defaultQueue, 0, 100);
   expect(res.totalItems).toBe(1);

diff --git a/tests/tests/consuming-messages/test00035.test.ts b/tests/tests/consuming-messages/test00035.test.ts
@@ -10,7 +10,6 @@
 import { delay, promisifyAll } from 'bluebird';
 import { Consumer } from '../../../src/lib/consumer/consumer';
 import { Message } from '../../../src/lib/message/message';
-import { events } from '../../../src/common/events/events';
 import { getProducer } from '../../common/producer';
 import { shutDownBaseInstance } from '../../common/base-instance';
 import { EQueueType } from '../../../types';
@@ -28,7 +27,7 @@ test('Consume message from different queues using a single consumer instance: ca
   await queue.saveAsync('test0', EQueueType.LIFO_QUEUE);
   await consumer.consumeAsync('test0', () => void 0);
 
-  consumer.once(events.MESSAGE_RECEIVED, () => {
+  consumer.once('messageReceived', () => {
     setTimeout(() => {
       // cancelling a queue when a message handler is active
       consumer.cancelAsync('test0').catch((e: unknown) => {