Add Authentication to Redis

.env.sample

@@ -99,6 +99,10 @@
 # The default port of where the Redis instance is running
 # (default=6379)
 # REDIS_PORT=
+# The username of the redis server
+# REDIS_USER=
+# The password of the redis server
+# REDIS_PASS=
 
 
 # Cache Expiration Times

src/__tests__/redis-client.factory.ts

@@ -2,9 +2,19 @@ import type { RedisClientType } from 'redis';
 import { createClient } from 'redis';
 
 export async function redisClientFactory(): Promise<RedisClientType> {
-  const { REDIS_HOST = 'localhost', REDIS_PORT = 6379 } = process.env;
+  const {
+    REDIS_USER,
+    REDIS_PASS,
+    REDIS_HOST = 'localhost',
+    REDIS_PORT = 6379,
+  } = process.env;
   const client: RedisClientType = createClient({
-    url: `redis://${REDIS_HOST}:${REDIS_PORT}`,
+    socket: {
+      host: REDIS_HOST,
+      port: Number(REDIS_PORT),
+    },
+    username: REDIS_USER,
+    password: REDIS_PASS,
   });
   await client.connect();
   return client;

src/config/entities/__tests__/configuration.ts

@@ -204,6 +204,8 @@ export default (): ReturnType<typeof configuration> => ({
     },
   },
   redis: {
+    user: process.env.REDIS_USER,
+    pass: process.env.REDIS_PASS,
     host: process.env.REDIS_HOST || 'localhost',
     port: process.env.REDIS_PORT || '6379',
   },

src/config/entities/configuration.ts

@@ -307,6 +307,8 @@ export default () => ({
     },
   },
   redis: {
+    user: process.env.REDIS_USER,
+    pass: process.env.REDIS_PASS,
     host: process.env.REDIS_HOST || 'localhost',
     port: process.env.REDIS_PORT || '6379',
   },

src/datasources/cache/cache.module.ts

@@ -13,10 +13,17 @@ async function redisClientFactory(
   configurationService: IConfigurationService,
   loggingService: ILoggingService,
 ): Promise<RedisClientType> {
+  const redisUser = configurationService.get<string>('redis.user');
+  const redisPass = configurationService.get<string>('redis.pass');
   const redisHost = configurationService.getOrThrow<string>('redis.host');
   const redisPort = configurationService.getOrThrow<string>('redis.port');
   const client: RedisClientType = createClient({
-    url: `redis://${redisHost}:${redisPort}`,
+    socket: {
+      host: redisHost,
+      port: Number(redisPort),
+    },
+    username: redisUser,
+    password: redisPass,
   });
   client.on('error', (err) =>
     loggingService.error(`Redis client error: ${err}`),