feat: added redis integration for the application

Author: odavibatista

.env.example

@@ -18,4 +18,8 @@ API_URL=
 FRONTEND_URL=
 
 # Application Environment
-NODE_ENV=
+NODE_ENV=
+
+# Redis Variables
+REDIS_HOST=
+REDIS_PORT=

package-lock.json

@@ -38,6 +38,7 @@
     "@nestjs/typeorm": "^10.0.2",
     "bcryptjs": "^2.4.3",
     "cache-manager": "^5.7.6",
+    "cache-manager-redis-store": "^3.0.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "cors": "^2.8.5",

package.json

@@ -7,13 +7,13 @@ import { UserActivitiesAnsweredModule } from '../modules/user-activities-answere
 import { UserCoursesConcludedModule } from '../modules/user-courses-concluded/infra/modules/user-courses-concluded.module';
 import { ActivityModule } from '../modules/activity/infra/modules/activity.module';
 import { CacheModule } from '@nestjs/cache-manager';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { RedisOptions } from '../shared/config/redis.config';
 
 @Module({
   imports: [
-    CacheModule.register({
-      isGlobal: true,
-      ttl: 60 * 10000,
-    }),
+    ConfigModule.forRoot({ isGlobal: true }),
+    CacheModule.registerAsync(RedisOptions),
     DatabaseModule,
     UserModule,
     UserScoreModule,

src/app/app.module.ts

@@ -24,6 +24,9 @@ const appConfigurationsSchema = z.object({
     .enum(['development', 'production', 'test', 'local'])
     .default('development'),
   SSL: z.boolean().default(false),
+
+  REDIS_HOST: z.string().min(1),
+  REDIS_PORT: z.number(),
 });
 
 let appConfigurations: z.infer<typeof appConfigurationsSchema> = {};
@@ -53,6 +56,8 @@ try {
     JWT_KEY: process.env.JWT_KEY,
     API_PORT: parseInt(process.env.API_PORT),
     SSL: process.env.NODE_ENV === 'production' ? true : false,
+    REDIS_HOST: process.env.REDIS_HOST,
+    REDIS_PORT: parseInt(process.env.REDIS_PORT),
   });
 } catch (error) {
   if (error instanceof ZodError) {

src/shared/config/app.config.ts

@@ -0,0 +1,22 @@
+import { CacheModuleAsyncOptions } from "@nestjs/cache-manager";
+import { ConfigModule } from "@nestjs/config";
+import { redisStore } from "cache-manager-redis-store";
+import { appConfigurations } from "./app.config";
+
+export const RedisOptions: CacheModuleAsyncOptions = {
+    isGlobal: true,
+    imports: [ConfigModule],
+    useFactory: async () => {
+      const store = await redisStore({
+        ttl: 60 * 10000,
+        socket: {
+          host: appConfigurations.REDIS_HOST,
+          port: appConfigurations.REDIS_PORT,
+        },
+      });
+      return {
+        store: () => store,
+      };
+    },
+    inject: [],
+  };