add redis-mock library and fix tests

Author: pavelzotikov

package.json

@@ -28,6 +28,7 @@
     "jest": "^26.2.2",
     "mongodb-memory-server": "^6.6.1",
     "nodemon": "^2.0.2",
+    "redis-mock": "^0.58.0",
     "ts-jest": "^26.1.4",
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"

test/integration/jestEnv.js

@@ -1,6 +1,7 @@
 const NodeEnvironment = require('jest-environment-node');
 const amqp = require('amqplib');
 const mongodb = require('mongodb');
+const { installRedisMock, uninstallRedisMock } = require('./redisMock');
 
 /**
  * Custom test environment for defining global connections
@@ -19,6 +20,12 @@ class CustomEnvironment extends NodeEnvironment {
     await mongoClient.db('hawk').dropDatabase();
     // await mongoClient.db('codex_accounting').dropDatabase();
 
+    /**
+     * Use redis-mock instead of a real Redis connection.
+     * This avoids spinning up Redis during integration tests while keeping the API surface.
+     */
+    this.global.redisClient = installRedisMock();
+
     this.rabbitMqConnection = await amqp.connect('amqp://guest:guest@rabbitmq:5672/');
     this.global.rabbitChannel = await this.rabbitMqConnection.createChannel();
     await this.global.rabbitChannel.purgeQueue('cron-tasks/limiter');
@@ -41,6 +48,8 @@ class CustomEnvironment extends NodeEnvironment {
       if (this.rabbitMqConnection) {
         await this.rabbitMqConnection.close();
       }
+
+      uninstallRedisMock();
     } catch (error) {
       console.error('Error during teardown:', error);
     }

test/integration/redisMock.js

@@ -0,0 +1,72 @@
+const path = require('path');
+const redisMock = require('redis-mock');
+
+let originalRedisModule = null;
+let redisModulePath = null;
+
+/**
+ * Create Redis mock client compatible with node-redis v4 API portions we use.
+ *
+ * @returns {object} mocked redis client
+ */
+function createMockClient() {
+  const client = redisMock.createClient();
+
+  client.isOpen = true;
+  client.connect = async () => client;
+  client.quit = async () => undefined;
+  client.sendCommand = async () => [];
+  client.on = () => client;
+
+  return client;
+}
+
+/**
+ * Install redis-mock into Node's module cache so that `require('redis')`
+ * returns the mocked client factory.
+ *
+ * @returns {object} mock client instance to be reused in tests
+ */
+function installRedisMock() {
+  redisModulePath = require.resolve('redis');
+  originalRedisModule = require.cache[redisModulePath] || null;
+
+  const mockExports = {
+    createClient: () => createMockClient(),
+  };
+
+  require.cache[redisModulePath] = {
+    id: redisModulePath,
+    filename: redisModulePath,
+    loaded: true,
+    exports: mockExports,
+    path: path.dirname(redisModulePath),
+    children: [],
+  };
+
+  return mockExports.createClient();
+}
+
+/**
+ * Restore original `redis` module if it existed.
+ */
+function uninstallRedisMock() {
+  if (!redisModulePath) {
+    return;
+  }
+
+  if (originalRedisModule) {
+    require.cache[redisModulePath] = originalRedisModule;
+  } else {
+    delete require.cache[redisModulePath];
+  }
+
+  originalRedisModule = null;
+  redisModulePath = null;
+}
+
+module.exports = {
+  installRedisMock,
+  uninstallRedisMock,
+};
+

yarn.lock

@@ -5762,6 +5762,11 @@ readdirp@~3.6.0:
   dependencies:
     picomatch "^2.2.1"
 
+redis-mock@^0.58.0:
+  version "0.56.3"
+  resolved "https://registry.yarnpkg.com/redis-mock/-/redis-mock-0.56.3.tgz#e96471bcc774ddc514c2fc49cdd03cab2baecd89"
+  integrity sha512-ynaJhqk0Qf3Qajnwvy4aOjS4Mdf9IBkELWtjd+NYhpiqu4QCNq6Vf3Q7c++XRPGiKiwRj9HWr0crcwy7EiPjYQ==
+
 redis@^4.7.0:
   version "4.7.1"
   resolved "https://registry.yarnpkg.com/redis/-/redis-4.7.1.tgz#08588a30936be0e7ad9c0f3e1ac6a85ccaf73e94"