All files / redis-smq-api/tests common.ts

92.85% Statements 247/266
74.07% Branches 40/54
88.13% Functions 52/59
93.15% Lines 245/263

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 53857x 57x 57x 57x                   57x           57x 57x 57x 57x 57x   57x 57x 57x 57x 57x 57x 57x             57x 57x   57x                                   57x 57x   57x       57x 57x 57x 57x 57x 57x 57x   57x 57x 57x 57x 57x 57x   57x 57x 57x 57x 57x 57x     57x 114x 114x 53x         53x   52x 52x           57x 57x   57x 57x 57x 57x 57x 57x 57x   57x       57x 37x 37x 37x         57x 97x 97x 97x         57x     57x     57x                         57x 24x 24x 24x 24x 24x     57x 29x 29x 29x 29x     57x                       57x 37x 37x   37x 37x 37x 37x 37x               57x 33x 33x 33x       57x 57x 33x 33x       57x 2x 2x 2x               2x       57x 57x 57x 2x 2x 2x   55x       57x                               57x 57x 57x         57x       57x 2x 2x 2x               2x       57x 57x 57x 2x 2x 2x   55x       57x 8x 8x 8x               8x       57x 57x 57x 8x 8x 8x   49x       57x 2x 2x 2x               2x       57x 57x 57x 2x 2x 2x   55x       57x 3x 2x 2x               2x       57x 57x 57x 2x 2x 2x   55x       57x         130x           57x 97x 97x 97x 97x     57x       16x     16x 16x         57x       8x       8x         57x       8x     57x     8x 8x     10x       8x 8x 8x   8x 8x 8x     57x     8x 8x     26x       8x 8x 8x   8x 8x 8x     57x 7x 7x 7x 7x 7x     57x     3x 3x 3x 3x 3x     57x 1x 1x 1x 1x 1x     57x           13x 13x 13x 13x 13x 130x 130x   13x 284x 13x 13x 271x   13x     57x 8x 8x 8x 8x   8x 8x 8x 8x 8x       8x           57x       36x 36x    
import { delay, promisifyAll } from 'bluebird';
import { events } from 'redis-smq/dist/src/common/events';
import { RedisClient } from 'redis-smq/dist/src/common/redis-client/redis-client';
import {
  Producer,
  Message,
  Consumer,
  setLogger,
  QueueManager,
  MessageManager,
  registerConsumerPlugin,
  registerProducerPlugin,
} from 'redis-smq';
import { config as testConfig, monitorConfig } from './config';
import {
  IConfig,
  TConsumerMessageHandler,
  TQueueParams,
} from 'redis-smq/dist/types';
import { WebsocketMainStreamWorker } from '../src/workers/websocket-main-stream.worker';
import * as supertest from 'supertest';
import { WebsocketRateStreamWorker } from '../src/workers/websocket-rate-stream.worker';
import { WebsocketHeartbeatStreamWorker } from '../src/workers/websocket-heartbeat-stream.worker';
import { WebsocketOnlineStreamWorker } from '../src/workers/websocket-online-stream.worker';
import { TimeSeriesResponseBodyDTO } from '../src/controllers/common/dto/time-series/time-series-response.DTO';
import * as configuration from 'redis-smq/dist/src/common/configuration/configuration';
import ScheduleWorker from 'redis-smq/dist/src/workers/schedule.worker';
import { merge } from 'lodash';
import { reset } from 'redis-smq/dist/src/common/logger';
import Store from 'redis-smq/dist/src/common/configuration/messages/store';
import TimeSeriesCleanUpWorker from '../src/workers/time-series.clean-up.worker';
import {
  MonitorServer,
  ConsumerMessageRatePlugin,
  ProducerMessageRatePlugin,
} from '../index';
import { TTimeSeriesRange } from '../types';
 
registerProducerPlugin(ProducerMessageRatePlugin);
registerConsumerPlugin(ConsumerMessageRatePlugin);
 
export const config = configuration.setConfiguration(testConfig);
 
type TGetConsumerArgs = {
  queue?: string | TQueueParams;
  messageHandler?: TConsumerMessageHandler;
};
 
export interface ISuperTestResponse<TData> extends supertest.Response {
  body: {
    data?: TData;
    error?: {
      code: string;
      message: string;
      details: Record<string, any>;
    };
  };
}
 
const QueueManagerAsync = promisifyAll(QueueManager);
const MessageManagerAsync = promisifyAll(MessageManager);
 
export const defaultQueue: TQueueParams = {
  name: 'test_queue',
  ns: config.namespace,
};
const redisClients: RedisClient[] = [];
const consumersList: Consumer[] = [];
const producersList: Producer[] = [];
const getConfigurationOrig = configuration.getConfiguration;
let monitorServer: MonitorServer | null = null;
let websocketMainStreamWorker: WebsocketMainStreamWorker | null = null;
let websocketRateStreamWorker: WebsocketRateStreamWorker | null = null;
let websocketHeartbeatStreamWorker: WebsocketHeartbeatStreamWorker | null =
  null;
let websocketOnlineStreamWorker: WebsocketOnlineStreamWorker | null = null;
let scheduleWorker: ScheduleWorker | null = null;
let timeSeriesCleanUpWorker: TimeSeriesCleanUpWorker | null = null;
let messageManager: MessageManager | null = null;
let queueManager: QueueManager | null = null;
 
export async function startUp(): Promise<void> {
  const redisClient = await getRedisInstance();
  await redisClient.flushallAsync();
  restoreConfiguration();
  reset();
  setLogger(console);
}
 
export async function shutdown(): Promise<void> {
  const p = async (list: (Consumer | Producer)[]) => {
    for (const i of list) {
      Iif (i.isGoingUp()) {
        await new Promise((resolve) => {
          i.once(events.UP, resolve);
        });
      }
      if (i.isRunning()) {
        // eslint-disable-next-line no-await-in-loop
        await new Promise((resolve) => {
          i.shutdown(resolve);
        });
      }
    }
  };
 
  await p(consumersList);
  await p(producersList);
 
  await stopMonitorServer();
  await stopWebsocketMainStreamWorker();
  await stopWebsocketRateStreamWorker();
  await stopWebsocketHeartbeatStreamWorker();
  await stopWebsocketOnlineStreamWorker();
  await stopScheduleWorker();
  await stopTimeSeriesWorker();
 
  Iif (messageManager) {
    await promisifyAll(messageManager).quitAsync();
    messageManager = null;
  }
  if (queueManager) {
    const q = promisifyAll(queueManager);
    await q.quitAsync();
    queueManager = null;
  }
 
  // Redis clients should be stopped in the last step, to avoid random errors from different
  // dependant components.
  while (redisClients.length) {
    const redisClient = redisClients.pop();
    if (redisClient) {
      await promisifyAll(redisClient).haltAsync();
    }
  }
}
 
export function restoreConfiguration(): void {
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-ignore
  configuration.getConfiguration = getConfigurationOrig;
}
 
export function mockConfiguration(config: IConfig): void {
  const store = config.messages?.store !== undefined ? Store(config) : {};
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-ignore
  configuration.getConfiguration = () => {
    return merge({}, getConfigurationOrig(), config, {
      messages: {
        store,
      },
    });
  };
}
 
export function getConsumer(args: TGetConsumerArgs = {}) {
  const { queue = defaultQueue, messageHandler = (msg, cb) => cb() } = args;
  const consumer = promisifyAll(new Consumer());
  consumer.consume(queue, messageHandler, () => void 0);
  consumersList.push(consumer);
  return consumer;
}
 
export function getProducer() {
  const producer = new Producer();
  const p = promisifyAll(producer);
  producersList.push(p);
  return p;
}
 
export async function getMessageManager() {
  Iif (!messageManager) {
    messageManager = await MessageManagerAsync.getSingletonInstanceAsync();
  }
  return {
    deadLetteredMessages: promisifyAll(messageManager.deadLetteredMessages),
    acknowledgedMessages: promisifyAll(messageManager.acknowledgedMessages),
    pendingMessages: promisifyAll(messageManager.pendingMessages),
    scheduledMessages: promisifyAll(messageManager.scheduledMessages),
  };
}
 
export async function getQueueManager() {
  if (!queueManager) {
    queueManager = await QueueManagerAsync.getSingletonInstanceAsync();
  }
  const queue = promisifyAll(queueManager.queue);
  const namespace = promisifyAll(queueManager.namespace);
  const queueRateLimit = promisifyAll(queueManager.queueRateLimit);
  const queueMetrics = promisifyAll(queueManager.queueMetrics);
  return {
    queue,
    namespace,
    queueRateLimit,
    queueMetrics,
  };
}
 
export async function startMonitorServer(): Promise<void> {
  if (!monitorServer) {
    monitorServer = new MonitorServer(monitorConfig);
    await monitorServer.listen();
  }
}
 
export async function stopMonitorServer(): Promise<void> {
  if (monitorServer) {
    await monitorServer.quit();
    monitorServer = null;
  }
}
 
export async function startWebsocketMainStreamWorker(): Promise<void> {
  if (!websocketMainStreamWorker) {
    const redisClient = await getRedisInstance();
    websocketMainStreamWorker = new WebsocketMainStreamWorker(
      redisClient,
      {
        timeout: 1000,
        config: monitorConfig,
      },
      false,
    );
    websocketMainStreamWorker.run();
  }
}
 
export async function stopWebsocketMainStreamWorker(): Promise<void> {
  return new Promise<void>((resolve) => {
    if (websocketMainStreamWorker) {
      websocketMainStreamWorker.quit(() => {
        websocketMainStreamWorker = null;
        resolve();
      });
    } else resolve();
  });
}
 
export async function startScheduleWorker(): Promise<void> {
  Iif (!scheduleWorker) {
    const redisClient = await getRedisInstance();
    scheduleWorker = new ScheduleWorker(
      redisClient,
      {
        timeout: 1000,
        config,
        consumerId: 'abc',
      },
      false,
    );
    scheduleWorker.run();
  }
}
 
export async function stopScheduleWorker(): Promise<void> {
  return new Promise<void>((resolve) => {
    Iif (scheduleWorker) {
      scheduleWorker.quit(() => {
        scheduleWorker = null;
        resolve();
      });
    } else resolve();
  });
}
 
export async function startTimeSeriesWorker(): Promise<void> {
  if (!timeSeriesCleanUpWorker) {
    const redisClient = await getRedisInstance();
    timeSeriesCleanUpWorker = new TimeSeriesCleanUpWorker(
      redisClient,
      {
        timeout: 1000,
        config: monitorConfig,
      },
      false,
    );
    timeSeriesCleanUpWorker.run();
  }
}
 
export async function stopTimeSeriesWorker(): Promise<void> {
  return new Promise<void>((resolve) => {
    if (timeSeriesCleanUpWorker) {
      timeSeriesCleanUpWorker.quit(() => {
        timeSeriesCleanUpWorker = null;
        resolve();
      });
    } else resolve();
  });
}
 
export async function startWebsocketRateStreamWorker(): Promise<void> {
  if (!websocketRateStreamWorker) {
    const redisClient = await getRedisInstance();
    websocketRateStreamWorker = new WebsocketRateStreamWorker(
      redisClient,
      {
        timeout: 1000,
        config: monitorConfig,
      },
      false,
    );
    websocketRateStreamWorker.run();
  }
}
 
export async function stopWebsocketRateStreamWorker(): Promise<void> {
  return new Promise<void>((resolve) => {
    if (websocketRateStreamWorker) {
      websocketRateStreamWorker.quit(() => {
        websocketRateStreamWorker = null;
        resolve();
      });
    } else resolve();
  });
}
 
export async function startWebsocketHeartbeatStreamWorker(): Promise<void> {
  if (!websocketHeartbeatStreamWorker) {
    const redisClient = await getRedisInstance();
    websocketHeartbeatStreamWorker = new WebsocketHeartbeatStreamWorker(
      redisClient,
      {
        timeout: 1000,
        config: monitorConfig,
      },
      false,
    );
    websocketHeartbeatStreamWorker.run();
  }
}
 
export async function stopWebsocketHeartbeatStreamWorker(): Promise<void> {
  return new Promise<void>((resolve) => {
    if (websocketHeartbeatStreamWorker) {
      websocketHeartbeatStreamWorker.quit(() => {
        websocketHeartbeatStreamWorker = null;
        resolve();
      });
    } else resolve();
  });
}
 
export async function startWebsocketOnlineStreamWorker(): Promise<void> {
  if (!websocketOnlineStreamWorker) {
    const redisClient = await getRedisInstance();
    websocketOnlineStreamWorker = new WebsocketOnlineStreamWorker(
      redisClient,
      {
        timeout: 1000,
        config: monitorConfig,
      },
      false,
    );
    websocketOnlineStreamWorker.run();
  }
}
 
export async function stopWebsocketOnlineStreamWorker(): Promise<void> {
  return new Promise<void>((resolve) => {
    if (websocketOnlineStreamWorker) {
      websocketOnlineStreamWorker.quit(() => {
        websocketOnlineStreamWorker = null;
        resolve();
      });
    } else resolve();
  });
}
 
export function validateTime(
  actualTime: number,
  expectedTime: number,
  driftTolerance = 3000,
): boolean {
  return (
    actualTime >= expectedTime - driftTolerance &&
    actualTime <= expectedTime + driftTolerance
  );
}
 
export async function getRedisInstance() {
  const RedisClientAsync = promisifyAll(RedisClient);
  const c = promisifyAll(await RedisClientAsync.getNewInstanceAsync());
  redisClients.push(c);
  return c;
}
 
export async function consumerOnEvent<T extends Array<any>>(
  consumer: Consumer,
  event: string,
) {
  return new Promise<T>((resolve) => {
    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
    // @ts-ignore
    consumer.once(event, (...args: T) => {
      resolve(args);
    });
  });
}
 
export async function untilMessageAcknowledged(
  consumer: Consumer,
  msg?: Message,
): Promise<void> {
  const [message] = await consumerOnEvent<[Message]>(
    consumer,
    events.MESSAGE_ACKNOWLEDGED,
  );
  Iif (msg && msg.getRequiredId() !== message.getRequiredId()) {
    await untilMessageAcknowledged(consumer, msg);
  }
}
 
export async function untilConsumerEvent(
  consumer: Consumer,
  event: string,
): Promise<unknown[]> {
  return consumerOnEvent(consumer, event);
}
 
export async function produceAndAcknowledgeMessage(
  queue: TQueueParams = defaultQueue,
) {
  const producer = getProducer();
  const consumer = getConsumer({
    queue,
    messageHandler: jest.fn((msg, cb) => {
      cb();
    }),
  });
 
  const message = new Message();
  message.setBody({ hello: 'world' }).setQueue(queue);
  await producer.produceAsync(message);
 
  consumer.run();
  await untilMessageAcknowledged(consumer);
  return { producer, consumer, queue, message };
}
 
export async function produceAndDeadLetterMessage(
  queue: TQueueParams = defaultQueue,
) {
  const producer = getProducer();
  const consumer = getConsumer({
    queue,
    messageHandler: jest.fn(() => {
      throw new Error('Explicit error');
    }),
  });
 
  const message = new Message();
  message.setBody({ hello: 'world' }).setQueue(queue);
  await producer.produceAsync(message);
 
  consumer.run();
  await untilConsumerEvent(consumer, events.MESSAGE_DEAD_LETTERED);
  return { producer, consumer, message, queue };
}
 
export async function produceMessage(queue: TQueueParams = defaultQueue) {
  const producer = getProducer();
  const message = new Message();
  message.setBody({ hello: 'world' }).setQueue(queue);
  await producer.produceAsync(message);
  return { producer, message, queue };
}
 
export async function produceMessageWithPriority(
  queue: TQueueParams = defaultQueue,
) {
  const producer = promisifyAll(getProducer());
  const message = new Message();
  message.setPriority(Message.MessagePriority.LOW).setQueue(queue);
  await producer.produceAsync(message);
  return { message, producer, queue };
}
 
export async function scheduleMessage(queue: TQueueParams = defaultQueue) {
  const producer = promisifyAll(getProducer());
  const message = new Message();
  message.setScheduledDelay(10000).setQueue(queue);
  await producer.produceAsync(message);
  return { message, producer, queue };
}
 
export async function listenForWebsocketStreamEvents<
  TPayload = TTimeSeriesRange,
>(
  streamName: string,
  startFn: () => Promise<void> = startWebsocketRateStreamWorker,
) {
  await startFn();
  const subscribeClient = await getRedisInstance();
  subscribeClient.subscribe(streamName);
  const data: { ts: number; payload: TPayload }[] = [];
  subscribeClient.on('message', (channel, message) => {
    const payload: TPayload = JSON.parse(message);
    data.push({ ts: Date.now(), payload });
  });
  for (; true; ) {
    if (data.length === 10) {
      subscribeClient.unsubscribe(streamName);
      break;
    } else await delay(500);
  }
  return data;
}
 
export async function validateTimeSeriesFrom(url: string) {
  await startMonitorServer();
  const request = supertest('http://127.0.0.1:3000');
  const timestamp = Math.ceil(Date.now() / 1000);
  const from = timestamp - 60;
  const response1: ISuperTestResponse<TimeSeriesResponseBodyDTO['data']> =
    await request.get(`${url}?from=${from}&to=${timestamp}`);
  expect(response1.statusCode).toBe(200);
  const data = response1.body.data ?? [];
  expect(data.length).toEqual(60);
  expect(data[0]).toEqual({
    timestamp: from,
    value: 0,
  });
  expect(data[59]).toEqual({
    timestamp: timestamp - 1,
    value: 0,
  });
}
 
export async function createQueue(
  queue: string | TQueueParams,
  priorityQueuing: boolean,
) {
  const qm = await getQueueManager();
  await qm.queue.createAsync(queue, priorityQueuing);
}