Feat/read basic request tracker (#9)

Jaedsonn · web-flow · commit a912001d671a · 2026-02-15T14:27:31.000-03:00
* feat: jest config

* feat: integrate Redis for logging middleware and data storage

- Added Redis as a dependency in package.json.
- Implemented Redis client configuration in redis.config.ts.
- Created RedisService for handling data storage and retrieval.
- Developed logger middleware to log requests and store logs in Redis.
- Introduced redis routes for accessing stored data.
- Updated app.ts to include logger middleware and Redis routes.
- Modified AuthService to include debug logging for user registration.
- Updated environment variables to include REDIS_URL.
- Disabled SQL logging in data-source.ts for production readiness.

* lint: fix lint erros in code

* fix: redis env variable missing in ci script

* feat: add user role to private the access to the redis routes

* feat: update Redis service and tests, refactor auth service logging, and adjust test database imports

* fix: fix redis service injection
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -72,6 +72,7 @@ jobs:
       REFRESH_EXPIRE: 7d
       RESET_SECRET: secret3
       RESET_EXPIRE: 15m
+      REDIS_URL: redis://localhost:6379
 
     steps:
       - name: Checkout repository
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ dist
 *.sqlite
 *.todo
 insomnia-collection-complete.json
-TODO.md
+TODO.md
+coverage
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -13,4 +13,14 @@ services:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
     volumes:
-      - ./init-db.sql:/docker-entrypoint-initdb.d/init-db.sql
+      - ./init-db.sql:/docker-entrypoint-initdb.d/init-db.sql
+  redis:
+    image: redis:latest
+    container_name: payment_records_redis
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
diff --git a/jest.config.js b/jest.config.js
@@ -14,4 +14,12 @@ module.exports = {
   transform: {
     "^.+\\.(t|j)sx?$": ["ts-jest", { useESM: true }],
   },
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80
+    }
+  }
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
     "nodemailer": "^7.0.6",
     "pg": "^8.16.3",
     "pg-query-stream": "^4.10.3",
+    "redis": "^5.10.0",
     "reflect-metadata": "^0.2.2",
     "swagger-jsdoc": "^6.2.8",
     "swagger-ui-express": "^5.0.1",
@@ -58,4 +59,4 @@
   "overrides": {
     "validator": "13.12.0"
   }
-}
+}
diff --git a/src/app.ts b/src/app.ts
@@ -7,12 +7,15 @@ import { UserRouter } from "@modules/User/user.routes";
 import { BankRouter } from "@modules/Bank/bank.routes";
 import { AccountRouter } from "@modules/Account/account.routes";
 import { TransactionRouter } from "@modules/Transaction/transaction.routes";
+import { redisRouter } from "@modules/redis/redis.routes";
+import { loggerMiddleware } from "@middlewares/loggger.middleware";
 import cors from "cors";
 import { runSeeds } from "@shared/seeds";
 import { env } from "@shared/env";
 import swaggerUi from "swagger-ui-express"
 import docs from "docs/swagger";
 import * as dotenv from "dotenv";
+import { redisClient } from "@modules/redis/redis.config";
 
 dotenv.config();
 
@@ -31,12 +34,14 @@ app.use(
 
 app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
+app.use(loggerMiddleware);
 app.use("/auth", AuthRouter);
 app.use("/user", UserRouter);
 app.use("/bank", BankRouter);
 app.use("/account", AccountRouter);
 app.use("/transaction", TransactionRouter);
 app.use("/api", swaggerUi.serve, swaggerUi.setup(docs));
+app.use("/redis", redisRouter);
 app.use(ErrorHandler.handle.bind(ErrorHandler));
 
 app.get("/health", (_req, res) => {
@@ -46,9 +51,11 @@ app.get("/health", (_req, res) => {
 
 AppDataSource.initialize()
   .then(() => {
-    app.listen(port, async () => {
-      await runSeeds();
-    });
+    redisClient.connect().then(() => {
+      app.listen(port, async () => {
+        await runSeeds();
+      });
+    })
   })
   .catch((err) => {
     console.error("Error during Data Source initialization", err);
diff --git a/src/core/interfaces/logger.ts b/src/core/interfaces/logger.ts
@@ -0,0 +1,4 @@
+export interface Logger{
+    store(key: string, value: object): void;
+    get(key: string): object | null;
+}
diff --git a/src/lib/enums.ts b/src/lib/enums.ts
@@ -53,3 +53,8 @@ export const ErrorEnum = {
 	ACCOUNT_BLOCKED: { message: "Account Blocked", status: 403 },
 	MISSING_PROPERTIES: { message: "Missing Required Properties", status: 400 },
 } as const;
+
+export enum Role{
+	USER,
+	ADMIN
+}
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -1,4 +1,5 @@
 import nodemailer from "nodemailer"
+import { Role } from "./enums";
 
 /**
  * @swagger
@@ -34,6 +35,7 @@ export type MailOptions = nodemailer.SendMailOptions;
 export type AccessPayload = {
   email: string
   id: string
+  role: Role
 }
 
 /**
diff --git a/src/middlewares/jwt.ts b/src/middlewares/jwt.ts
@@ -44,3 +44,4 @@ export function validateToken(req: Request, res: Response, next: NextFunction) {
     });
   }
 }
+
diff --git a/src/middlewares/loggger.middleware.ts b/src/middlewares/loggger.middleware.ts
@@ -0,0 +1,23 @@
+import { RedisService } from "@modules/redis/redis.service";
+import { Request, Response, NextFunction } from "express";
+import { redisClient } from "@modules/redis/redis.config";
+
+export const redisService = new RedisService(redisClient);
+
+export function loggerMiddleware(req: Request, res: Response, next: NextFunction){
+    const timestamp = new Date().toISOString();
+    const {method, url, params, query, host, hostname, httpVersion,ip} = req;
+    console.log(`[${timestamp}] ${method} ${url} - ${ip}`);
+    redisService.store(timestamp, {
+        method,
+        url,
+        params,
+        query,
+        host,
+        hostname,
+        httpVersion,
+        ip
+    })
+
+    next();
+};
diff --git a/src/modules/Auth/auth.service.ts b/src/modules/Auth/auth.service.ts
@@ -18,9 +18,12 @@ export class AuthService {
 
   async register(createUserDTO: CreateUserDto): Promise<User> {
     const isAlreadyRegistered = await this.authRepository.findOne({ where: { email: createUserDTO.email } });
+    
     if (isAlreadyRegistered) {
+      console.error("Usuário já existe:", isAlreadyRegistered);
       throw new Error(ErrorEnum.USER_ALREADY_EXISTS.message);
     }
+    
     const password_digest = await hashPassword(createUserDTO.password);
     const user = await this.authRepository.save({...createUserDTO, password: password_digest });
     this.emailService.send({
@@ -29,7 +32,6 @@ export class AuthService {
       from: process.env.EMAIL_USER,
       html: welcomeTemplate(user.name)
     })
-    console.debug("Mensagem enviada");
     return user;
   }
 
@@ -47,12 +49,13 @@ export class AuthService {
     const access_token = jwt.sign(
       {
         email: user.email,
-        id: user.id
+        sub: user.id,
+        role: user.role
       }, env.ACCESS_SECRET,
       { expiresIn: env.ACCESS_EXPIRE as number })
 
     const refresh_token = jwt.sign({
-      id: user.id
+      sub: user.id
     }, env.REFRESH_SECRET,
       {
         expiresIn: env.REFRESH_EXPIRE as number
diff --git a/src/modules/User/entity/user.entity.ts b/src/modules/User/entity/user.entity.ts
@@ -1,5 +1,6 @@
 import { Column, Entity, OneToMany, PrimaryGeneratedColumn } from "typeorm";
 import { Account } from "@modules/Account/entity/account.entity";
+import { Role as RoleEnum } from "@lib/enums";
 
 @Entity("users")
 export class User {
@@ -18,6 +19,9 @@ export class User {
   @Column("int", { nullable: false })
   age: number;
 
+  @Column("enum", {enum: RoleEnum, default: RoleEnum.USER})
+  role: RoleEnum;
+
   @OneToMany(() => Account, (account) => account.user)
   accounts: Account[];
 }
diff --git a/src/modules/redis/redis.config.ts b/src/modules/redis/redis.config.ts
@@ -0,0 +1,6 @@
+import {createClient} from 'redis'
+import { env } from '@shared/env'
+
+export const redisClient = createClient({
+    url: env.REDIS_URL
+})
diff --git a/src/modules/redis/redis.factory.ts b/src/modules/redis/redis.factory.ts
@@ -0,0 +1,8 @@
+import { RedisService } from "./redis.service";
+import { redisClient } from "./redis.config";
+
+export class RedisFactory {
+    public static createController(){
+        return new RedisService(redisClient);       
+    }
+}
diff --git a/src/modules/redis/redis.routes.ts b/src/modules/redis/redis.routes.ts
@@ -0,0 +1,28 @@
+import { Router } from "express";
+import { RedisFactory } from "./redis.factory";
+import { Request, Response } from "express";
+import { validateToken } from "@middlewares/jwt";
+import { Role as RoleEnum } from "@lib/enums";
+
+export const redisRouter = Router();
+
+// Here i don't want to expose the store method
+// The store is a internal method that should be used by other services, not by external clients
+
+redisRouter.get("/", validateToken, async (req: Request, res: Response) => {
+    const role = req.data?.role;
+    if(role !== RoleEnum.ADMIN) return res.status(403).json({message: "Forbidden - Admins only"});
+
+   const data = await RedisFactory.createController().getAll();
+   return res.status(200).json({data});
+})
+
+redisRouter.get("/:key", validateToken, async (req: Request, res: Response) => {
+    const {key} = req.params;
+    const role = req.data?.role;
+    if(role !== RoleEnum.ADMIN) return res.status(403).json({message: "Forbidden - Admins only"});
+
+    const data = await RedisFactory.createController().get(key);
+    if(!data) return res.status(404).json({message: "Key not found"});
+    return res.status(200).json({data});
+})
diff --git a/src/modules/redis/redis.service.ts b/src/modules/redis/redis.service.ts
@@ -0,0 +1,30 @@
+import { redisClient as CreateClient } from "./redis.config";
+import { Logger } from "@core/interfaces/logger";
+export class RedisService implements Logger{
+    constructor(private readonly client:typeof CreateClient){}
+
+    store(key: string, value: object){
+        return this.client.set(key, JSON.stringify(value))
+    }
+
+    async get(key: string){
+        const data = await this.client.get(key);
+
+        if(!data) return null;
+
+        return JSON.parse(data);
+    }
+
+    async getAll(){
+        const keys = await this.client.keys("*");
+        const allData = {};
+
+        for(const key of keys){
+            const data = await this.client.get(key);
+            if(!data) continue;
+            allData[key] = JSON.parse(data);
+        }
+
+        return allData
+    }
+}
diff --git a/src/shared/db/data-source.ts b/src/shared/db/data-source.ts
@@ -16,7 +16,7 @@ export const AppDataSource = new typeorm.DataSource({
   username: env.DB_USERNAME,
   password: env.DB_PASSWORD,
   synchronize: true,
-  logging: true,
+  logging: false,
   entities: [User, Bank, Transaction, Account],
   subscribers: [],
   migrations: [],
diff --git a/src/shared/env.ts b/src/shared/env.ts
@@ -23,6 +23,8 @@ const envSchema = z.object(
     RESET_SECRET: z.string(),
     RESET_EXPIRE: z.string().or(z.number()),
     FRONTEND_URL: z.url(),
+
+    REDIS_URL: z.string()
   },
   { error: "Missing variables in env file" }
 );
diff --git a/src/tests/integration/account.service.spec.ts b/src/tests/integration/account.service.spec.ts
@@ -3,7 +3,7 @@ import { Account } from '@modules/Account/entity/account.entity';
 import { User } from '@modules/User/entity/user.entity';
 import { Bank } from '@modules/Bank/entity/bank.entity';
 import { Repository } from 'typeorm';
-import { TestAppDataSource as dataSource } from './db';
+import { TestAppDataSource as dataSource } from './postgres-db';
 import { BankService } from '@modules/Bank/bank.service';
 import { generateRandomUser, generateRandomBank, generateRandomAccount, getRandomFromArray } from '../../lib/utils';
 import { AuthService } from '@modules/Auth/auth.service';
diff --git a/src/tests/integration/auth.service.spec.ts b/src/tests/integration/auth.service.spec.ts
@@ -1,7 +1,7 @@
 import { Email } from "@core/abstractions/email";
 import { AuthService } from "@modules/Auth/auth.service";
 import { User } from "@modules/User/entity/user.entity";
-import { TestAppDataSource as dataSource } from "./db";
+import { TestAppDataSource as dataSource } from "./postgres-db";
 import { MailOptions } from "@lib/types";
 import { CreateUserDto } from "@modules/Auth/dto/create-user.dto";
 
diff --git a/src/tests/integration/bank.service.spec.ts b/src/tests/integration/bank.service.spec.ts
@@ -2,7 +2,7 @@ import { BankService } from '@modules/Bank/bank.service';
 import { Bank } from '@modules/Bank/entity/bank.entity';
 import { Repository } from 'typeorm';
 import { ErrorEnum } from '@lib/enums';
-import { TestAppDataSource as dataSource } from './db';
+import { TestAppDataSource as dataSource } from './postgres-db';
 
 describe('BankService', () => {
     let bankService: BankService;
diff --git a/src/tests/integration/postgres-db.ts b/src/tests/integration/postgres-db.ts
diff --git a/src/tests/integration/redis.service.spec.ts b/src/tests/integration/redis.service.spec.ts
@@ -0,0 +1,47 @@
+import { RedisService } from "@modules/redis/redis.service";
+import { Request } from "express";
+import { createClient } from "redis";
+import { redisClient as Client } from "@modules/redis/redis.config";
+
+describe("RedisService Integration Tests", () => {
+    let redisService: RedisService;
+    let client: typeof Client;
+
+    beforeAll(async () => {
+        client = createClient({
+            url: "redis://localhost:6379"
+        });
+
+        client.on("error", (err) => console.error("Redis Client Error", err));
+
+        await client.connect();
+
+        redisService = new RedisService(client);
+    })
+
+    afterAll(async () => {
+        await client.quit();
+    })
+
+    test("Store and Retrieve Data", async () => {
+        const timestamp = new Date();
+
+        const mockRequest: Partial<Request> = {
+            method: "GET",
+            url: "/test",
+            params: {},
+            query: {},
+            host: "localhost",
+            hostname: "localhost",
+            httpVersion: "1.1",
+            ip: "127.0.0.1"
+        } 
+
+        
+        await redisService.store(timestamp.toISOString(), mockRequest);
+
+        const retrieveData = await redisService.get(timestamp.toISOString());
+        
+        expect(retrieveData).toEqual(mockRequest);
+    })
+})
diff --git a/src/tests/integration/user.service.spec.ts b/src/tests/integration/user.service.spec.ts
