convert static class into module

Author: janishar

.env.example

@@ -36,8 +36,9 @@ DB_ADMIN=admin
 DB_ADMIN_PWD=changeit
 
 # Redis 
-REDIS_CACHE_PORT=6379
-REDIS_CACHE_PASSWORD=changeit
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_PASSWORD=changeit
 
 # Log
 # Example '/home/node/logs'

.templates/database/repository/SampleRepo.ts

@@ -1,21 +1,25 @@
 import Sample, { SampleModel } from '../model/Sample';
 import { Types } from 'mongoose';
 
-export default class SampleRepo {
-  public static findById(id: Types.ObjectId): Promise<Sample | null> {
-    return SampleModel.findOne({ _id: id, status: true }).lean().exec();
-  }
+async function findById(id: Types.ObjectId): Promise<Sample | null> {
+  return SampleModel.findOne({ _id: id, status: true }).lean().exec();
+}
 
-  public static async create(sample: Sample): Promise<Sample> {
-    const now = new Date();
-    sample.createdAt = now;
-    sample.updatedAt = now;
-    const created = await SampleModel.create(sample);
-    return created.toObject();
-  }
+async function create(sample: Sample): Promise<Sample> {
+  const now = new Date();
+  sample.createdAt = now;
+  sample.updatedAt = now;
+  const created = await SampleModel.create(sample);
+  return created.toObject();
+}
 
-  public static update(sample: Sample): Promise<Sample | null> {
-    sample.updatedAt = new Date();
-    return SampleModel.findByIdAndUpdate(sample._id, sample, { new: true }).lean().exec();
-  }
+async function update(sample: Sample): Promise<Sample | null> {
+  sample.updatedAt = new Date();
+  return SampleModel.findByIdAndUpdate(sample._id, sample, { new: true }).lean().exec();
 }
+
+export default {
+  findById,
+  create,
+  update,
+};

docker-compose.yml

@@ -55,8 +55,8 @@ services:
     restart: unless-stopped
     env_file: .env
     ports:
-      - '$REDIS_CACHE_PORT:6379'
-    command: redis-server --save 20 1 --loglevel warning --requirepass $REDIS_CACHE_PASSWORD
+      - '$REDIS_PORT:6379'
+    command: redis-server --save 20 1 --loglevel warning --requirepass $REDIS_PASSWORD
     volumes:
       - cache:/data/cache
 

package-lock.json

@@ -36,6 +36,7 @@
     "multer": "^1.4.5-lts.1",
     "newrelic": "^9.7.2",
     "qs": "^6.11.0",
+    "redis": "^4.5.1",
     "winston": "^3.8.2",
     "winston-daily-rotate-file": "^4.7.1"
   },

package.json

@@ -3,6 +3,7 @@ import Logger from './core/Logger';
 import cors from 'cors';
 import { corsUrl, environment } from './config';
 import './database'; // initialize database
+import './cache'; // initialize cache
 import { NotFoundError, ApiError, InternalError, ErrorType } from './core/ApiError';
 import routesV1 from './routes/v1';
 

src/app.ts

@@ -0,0 +1,24 @@
+import { redis } from '../config';
+import { createClient } from 'redis';
+import Logger from '../core/Logger';
+
+const redisURL = `redis://${redis.password}@${redis.host}:${redis.port}`;
+
+const client = createClient({ url: redisURL });
+
+client.on('connect', () => Logger.info('Cache is connecting'));
+client.on('ready', () => Logger.info('Cache is ready'));
+client.on('end', () => Logger.info('Cache disconnected'));
+client.on('reconnecting', () => Logger.info('Cache is reconnecting'));
+client.on('error', (e) => Logger.error(e));
+
+(async () => {
+  await client.connect();
+})();
+
+// If the Node process ends, close the Cache connection
+process.on('SIGINT', async () => {
+  await client.disconnect();
+});
+
+export default client;

src/cache/index.ts

@@ -0,0 +1,15 @@
+export enum Key {
+  BLOGS_LATEST = 'BLOGS_LATEST',
+}
+
+export enum DynamicKey {
+  BLOGS_TAG = 'BLOGS_TAG',
+  BLOG = 'BLOG',
+}
+
+export type DynamicKeyType = `${DynamicKey}_${string}`;
+
+export function getDynamicKey(key: DynamicKey, suffix: string) {
+  const dynamic: DynamicKeyType = `${key}_${suffix}`;
+  return dynamic;
+}