[24.12.15 / TASK-43] feature: user event tracking (#7)

* feature: database connection 추가

* refactor: db.comfig.ts -> db.config.ts 오타 수정

* feature: pre-commit 기능추가, 변경된 파일만 해당

* feature: add cors

* modify: Type folder changed from camelCase to snake_case

* refactor: changed TypeScript runtime executor from ts-node to tsx

* feature: 간단한 토큰 검증 후 Velog API 호출

* modify: 오타 및 상대 경로 -> 절대 경로

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* modify: user.controller.ts 절대 경로 -> 상대 경로

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* refactor: Token 추출 로직 개선

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* refactor: cors 설정 및 개발 환경변수 추가

* refactor: cors 설정 오탈자 수정

* refactor: src/app.ts 미들웨어 순서 조정

* featrue: 유저 저장 및 업데이트

* modify: .env.sample 수정

* modify: 에러 핸들링 next제거 express.d.ts 수정

* modify src/app.ts

에러핸들링 위치 변경

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* modify: 에러 핸들링 미들웨어

* modify: 에러 핸들링 미들웨어

* feature: login 요쳥 시 token 인증 및 사용자 저장, 업데이트

* modify: query문 수정

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* refactor: user controller 응답값 통일화 및 에러 미들웨어 수정

* modify: key.util 문서 오타 수정

* refactor: User Repo 에러 핸들링

* modify: repositories 오타 수정

* refactor: user service 에러 헨들링

* modify: 전체 파일 절대경로 -> 상대경로

* refactor: user service 리펙토링

* refactor: dto 검증 미들웨어 try문으로 변경 및 수정

* modify: 로그인 반환값 수정

* refactor: custom error

* modify: db error status code

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* modify: import 순서 수정

* feature: log저장

* refactor: User Service encryptTokens Error

* refactor: import model path

* refactor: error handling

* fix: 오탈자 수정 및 경로 수정

* modify: 파일 네이밍 컨벤션 통일화 및 User Tracking Interface 추가

* modify: 기본적인 tracking setting

* refactor: validate middleware 유동적으로 검증할 수 있게 수정

* feature: user tracking 저장

* modify: api docs 기반 end point 수정

* refactor: tracking controller 디테일 수정

* refactor: index.ts를 통해 깔끔하게 import

* modify: back-office 와 맞게 에러 message 수정

* refactor: supabase에 맞게 수정

* feature: 체류시간 저장

* fix: database value 수정 및 docker-conpose 삭제

* refactor: 유효성 검증 추가

* refactor: router index 추가

* modify: 오타 수정

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: HA0N1

.env.sample

@@ -1,9 +1,10 @@
 PORT=8080
-DB_USER="postgres"
-DB_PASSWORD="your_password"
-DB_HOST="localhost"
-DB_PORT=5432
-DB_NAME="your_db_name"
+
+DATABASE_NAME=""
+POSTGRES_USER=""
+POSTGRES_PASSWORD=""
+POSTGRES_HOST=""
+POSTGRES_PORT=5432
 AES_KEY_0="13ccb93c17a8d6e49ba3c5d91e3a6f45"
 AES_KEY_1="76e2a34bf23cd45876bc91e6a87d3f22"
 AES_KEY_2="93a4d7e6b34ac8f1092fd5e87a93bc56"

src/app.ts

@@ -3,8 +3,8 @@ import express, { Application } from 'express';
 import dotenv from 'dotenv';
 import cors from 'cors';
 import cookieParser from 'cookie-parser';
-import router from './routes/user.router';
-import { errorHandlingMiddleware } from './middlewares/error-handling.middleware';
+import router from './routes';
+import { errorHandlingMiddleware } from './middlewares/errorHandling.middleware';
 
 dotenv.config();
 
@@ -21,7 +21,7 @@ app.use(
     credentials: true,
   }),
 );
-app.use('/', router);
+app.use('/api', router);
 app.get('/', (req, res) => {
   res.send('Hello, V.D.!');
 });

src/configs/db.config.ts

@@ -1,16 +1,32 @@
 import dotenv from 'dotenv';
 import pg from 'pg';
+import logger from './logger.config';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const { Pool } = pg;
 
 dotenv.config();
 
 const pool = new Pool({
-  user: process.env.DB_USER,
-  host: process.env.DB_HOST,
-  database: process.env.DB_NAME,
-  password: process.env.DB_PASSWORD,
-  port: Number(process.env.DB_PORT),
+  user: process.env.POSTGRES_USER,
+  host: process.env.POSTGRES_HOST,
+  database: process.env.DATABASE_NAME,
+  password: process.env.POSTGRES_PASSWORD,
+  port: Number(process.env.POSTGRES_PORT),
+  ssl: {
+    rejectUnauthorized: false,
+  },
 });
 
+// timescaleDB 확장. 최초 1회 이므로 즉시실행 함수로
+(async () => {
+  const client = await pool.connect();
+  try {
+    await client.query('CREATE EXTENSION IF NOT EXISTS timescaledb;');
+    logger.info('TimescaleDB 확장 성공');
+  } catch (error) {
+    logger.error('TimescaleDB 초기화 실패 : ', error);
+  } finally {
+    client.release();
+  }
+})();
 export default pool;

src/controllers/tracking.controller.ts

@@ -0,0 +1,33 @@
+import { NextFunction, Request, RequestHandler, Response } from 'express';
+import logger from '../configs/logger.config';
+import { TrackingService } from '../services/tracking.service';
+
+export class TrackingController {
+  constructor(private trackingService: TrackingService) {}
+
+  event = (async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { type } = req.body;
+      const { id } = req.user;
+
+      await this.trackingService.tracking(type, id);
+      return res.status(200).json({ success: true, message: '이벤트 데이터 저장완료' });
+    } catch (error) {
+      logger.error('user tracking 실패 : ', error);
+      next(error);
+    }
+  }) as RequestHandler;
+
+  stay = (async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { loadDate, unloadDate } = req.body;
+      const { id } = req.user;
+
+      await this.trackingService.stay({ loadDate, unloadDate }, id);
+      return res.status(200).json({ success: true, message: '체류시간 데이터 완료' });
+    } catch (error) {
+      logger.error('user stay time 저장 실패 : ', error);
+      next(error);
+    }
+  }) as RequestHandler;
+}

src/controllers/user.controller.ts

@@ -1,6 +1,6 @@
 import { NextFunction, Request, Response, RequestHandler } from 'express';
 import logger from '../configs/logger.config';
-import { UserWithTokenDto } from '../types/dto/user-with-token.dto';
+import { UserWithTokenDto } from '../types';
 import { UserService } from '../services/user.service';
 
 export class UserController {
@@ -19,7 +19,7 @@ export class UserController {
         data: { id: isExistUser.id, email: isExistUser.email, profile },
       });
     } catch (error) {
-      logger.error('로그인 실패', error);
+      logger.error('로그인 실패 : ', error);
       next(error);
     }
   }) as RequestHandler;

src/exception/badRequest.exception.ts

@@ -0,0 +1,7 @@
+import { CustomError } from './custom.exception';
+
+export class BadRequestError extends CustomError {
+  constructor(message: string, code: string = 'INVALID_SYNTAX') {
+    super(message, code, 400);
+  }
+}

src/exception/custom.exception.ts

@@ -1,7 +1,7 @@
 export class CustomError extends Error {
-  code: string;
-  statusCode?: number;
-  constructor(message: string, code: string, statusCode?: number) {
+  readonly code: string;
+  readonly statusCode: number;
+  constructor(message: string, code: string, statusCode: number) {
     super(message);
     this.name = this.constructor.name;
     this.code = code;

src/exception/index.ts

@@ -0,0 +1,5 @@
+export { CustomError } from './custom.exception';
+export { DBError } from './db.exception';
+export { TokenError, TokenExpiredError, InvalidTokenError } from './token.exception';
+export { UnauthorizedError } from './unauthorized.exception';
+export { BadRequestError } from './badRequest.exception';

src/exception/token.exception.ts

@@ -1,6 +1,21 @@
 import { CustomError } from './custom.exception';
+import { UnauthorizedError } from './unauthorized.exception';
+
 export class TokenError extends CustomError {
   constructor(message: string) {
     super(message, 'TOKEN_ERROR', 401);
   }
 }
+
+// todo : 추후 만료 여부를 위해 token 에러 구체화 필요. 웬만한 인증관련은 unauthorized로 넘기는게 나을듯
+export class TokenExpiredError extends UnauthorizedError {
+  constructor(message = '토큰이 만료되었습니다') {
+    super(message, 'TOKEN_EXPIRED');
+  }
+}
+
+export class InvalidTokenError extends UnauthorizedError {
+  constructor(message = '유효하지 않은 토큰입니다') {
+    super(message, 'INVALID_TOKEN');
+  }
+}

src/exception/unauthorized.exception.ts

@@ -0,0 +1,7 @@
+import { CustomError } from './custom.exception';
+
+export class UnauthorizedError extends CustomError {
+  constructor(message: string, code: string = 'UNAUTHORIZED') {
+    super(message, code, 401);
+  }
+}