[24.12.23/ TASK-59] feature/fetching-all-posts (#8)

* refactor: 응답값 통일

* feature: 전체 포스트 조회, 커서 기반 페이지네이션 적용 전

* feature: 로그인 시 token HttpCookie에 저장

* feature: 최신순 cursor pagination

* modify: 역할 분리

* modify: error log 통일

* modify: 필요없는 주석 제거

* modify: 변수명 수정

* modify: get all post 부분 SQL 수정

* feature: sort 와 asc 값, 러프한 interface 들 추가

* hotfix: user token cookie set 부분 핫픽스

* hotfix: user token cookie set 부분 핫픽스 v2

* feature: timezone 먹은 post created-at 값도 같이 return

* hotfix: 카멜 케이스 업데이트

* modify: limit 5 개에서 15 개로

* refactor: 전체 post 조회 시 yesterday views/likes 추가

* feature: 패널 통계 전용 API

* refactor: null일 시 0으로 반환

* refactor: 전체 post 조회 api 오늘과 어제 저장한 데이터가 없다면 빈배열로 반환

* modify: 쿠키 개발 환경울 위한 세팅 분리, 포스트 릴리즈 데이터 추가

* refactor: 로그인 시 쿠키 저장 수정

* refactor: 각 api 응답값 타입화

* feature: 로그아웃 기능 추가

* modify: 로그인 쿠키 클리어 추가

* hotfix: 좌측 통계 어제값 null 에서 0으로 조회되게 변경

* feture: 유저 조회 API

* modify: 미들 웨어 auth, 줄 바꿈과 jsdocs 추가

* hotfix: 콘솔로그 제거

* hotfix: cookie maxAge 제거

* hotfix: 어제 데이터 값 정상적으로 나오게 수정

* hotfix: 전체 포스트 조회 시 어제 데이터 정상적으로 나오게 수정

* modify: conflict clear

* modify: timezone 연산 이슈 V2

* feature: 커서 기반 페이지네이션 업데이트

* modify: 컨트롤러 롤백 이슈 원복

---------

Co-authored-by: Nuung <[email protected]>

Author: HA0N1

.env.sample

@@ -1,19 +1,22 @@
 PORT=8080
-
-DATABASE_NAME=""
-POSTGRES_USER=""
-POSTGRES_PASSWORD=""
-POSTGRES_HOST=""
-POSTGRES_PORT=5432
-AES_KEY_0="13ccb93c17a8d6e49ba3c5d91e3a6f45"
-AES_KEY_1="76e2a34bf23cd45876bc91e6a87d3f22"
-AES_KEY_2="93a4d7e6b34ac8f1092fd5e87a93bc56"
-AES_KEY_3="b87f6c34d92fa17e3b2a67e58c93fa56"
-AES_KEY_4="27e3b8f67c4a12d8f93a6b17d4e58fa9"
-AES_KEY_5="6b83c9e21a7d48fa3f9b27e45c8a6f12"
-AES_KEY_6="81f92ab73c4e59d8a67f83b21d6e4c53"
-AES_KEY_7="d87b61e9f34a2c85f19a7e53c6d8f21a"
-AES_KEY_8="7c58f92ae1d3b67a4c29f8b36e17d4f9"
-AES_KEY_9="a93b4f7e2c6d81a7f5c3b2e89d47f612"
 ALLOWED_ORIGINS="http://localhost:3000,https://myapp.com"
 NODE_ENV="development"
+
+# 토큰 단방향 암호화 전용 핵심 키
+AES_KEY_0=13ccb93c17a8d6e49ba3c5d91e3a6f45
+AES_KEY_1=76e2a34bf23cd45876bc91e6a87d3f22
+AES_KEY_2=93a4d7e6b34ac8f1092fd5e87a93bc56
+AES_KEY_3=b87f6c34d92fa17e3b2a67e58c93fa56
+AES_KEY_4=27e3b8f67c4a12d8f93a6b17d4e58fa9
+AES_KEY_5=6b83c9e21a7d48fa3f9b27e45c8a6f12
+AES_KEY_6=81f92ab73c4e59d8a67f83b21d6e4c53
+AES_KEY_7=d87b61e9f34a2c85f19a7e53c6d8f21a
+AES_KEY_8=7c58f92ae1d3b67a4c29f8b36e17d4f9
+AES_KEY_9=a93b4f7e2c6d81a7f5c3b2e89d47f612
+
+# Database
+DATABASE_NAME=vd2
+POSTGRES_USER=vd2
+POSTGRES_PASSWORD=vd2
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432

README.md

@@ -10,6 +10,7 @@
 
 ```bash
 pnpm install
+NODE_ENV=development pnpm install  # devDpe 설치 위해
 
 # 만약 pnpm 이 없다면
 brew install pnpm

eslint.config.mjs

@@ -41,7 +41,7 @@ export default typescriptEslint.config(
         },
       ],
       '@typescript-eslint/naming-convention': [
-        'error',
+        'warn',
         {
           selector: 'typeLike',
           format: ['PascalCase'],

src/app.ts

@@ -17,7 +17,7 @@ app.use(
   cors({
     origin: process.env.NODE_ENV === 'production' ? process.env.ALLOWED_ORIGINS?.split(',') : 'http://localhost:3000',
     methods: ['GET', 'POST'],
-    allowedHeaders: ['Content-Type', 'Authorization', 'Cookie'],
+    allowedHeaders: ['Content-Type', 'Authorization', 'Cookie', 'access_token', 'refresh_token'],
     credentials: true,
   }),
 );

src/configs/db.config.ts

@@ -7,17 +7,16 @@ const { Pool } = pg;
 dotenv.config();
 
 const pool = new Pool({
+  database: process.env.DATABASE_NAME,
   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 {

src/constants/velog.constans.ts

@@ -0,0 +1,14 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+export const VELOG_API_URL = 'https://v3.velog.io/graphql';
+export const VELOG_QUERIES = {
+  LOGIN: `query currentUser {
+      currentUser {
+        id
+        username
+        email
+        profile {
+          thumbnail
+        }
+      }
+    }`,
+};

src/controllers/post.controller.ts

@@ -0,0 +1,64 @@
+import { NextFunction, Request, RequestHandler, Response } from 'express';
+import logger from '../configs/logger.config';
+import { PostService } from '../services/post.service';
+import { GetAllPostsQuery, PostResponse } from '../types';
+
+export class PostController {
+  constructor(private postService: PostService) {}
+
+  private validateQueryParams(query: GetAllPostsQuery): {
+    cursor: string | undefined;
+    sort: string;
+    isAsc: boolean;
+  } {
+    return {
+      cursor: query.cursor,
+      sort: query.sort || '',
+      isAsc: query.asc === 'true',
+    };
+  }
+
+  getAllPost: RequestHandler = async (
+    req: Request<object, object, object, GetAllPostsQuery>,
+    res: Response<PostResponse>,
+    next: NextFunction,
+  ) => {
+    try {
+      const { id } = req.user;
+      const { cursor, sort, isAsc } = this.validateQueryParams(req.query);
+
+      const result = await this.postService.getAllposts(id, cursor, sort, isAsc);
+
+      res.status(200).json({
+        success: true,
+        message: 'post 전체 조회에 성공하였습니다.',
+        data: {
+          nextCursor: result.nextCursor,
+          posts: result.posts,
+        },
+        error: null,
+      });
+    } catch (error) {
+      logger.error('전체 조회 실패:', error);
+      next(error);
+    }
+  };
+  getAllPostStatistics: RequestHandler = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { id } = req.user;
+
+      const result = await this.postService.getAllPostStatistics(id);
+      const totalPostCount = await this.postService.getTotalPostCounts(id);
+
+      res.status(200).json({
+        success: true,
+        message: 'post 전체 통계 조회에 성공하였습니다.',
+        data: { totalPostCount, stats: result },
+        error: null,
+      });
+    } catch (error) {
+      logger.error('전체 통계 조회 실패:', error);
+      next(error);
+    }
+  };
+}

src/controllers/tracking.controller.ts

@@ -1,30 +1,31 @@
 import { NextFunction, Request, RequestHandler, Response } from 'express';
 import logger from '../configs/logger.config';
 import { TrackingService } from '../services/tracking.service';
+import { TrackingResponse } from '../types';
 
 export class TrackingController {
   constructor(private trackingService: TrackingService) {}
 
-  event = (async (req: Request, res: Response, next: NextFunction) => {
+  event = (async (req: Request, res: Response<TrackingResponse>, 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: '이벤트 데이터 저장완료' });
+      return res.status(200).json({ success: true, message: '이벤트 데이터 저장완료', data: {}, error: null });
     } catch (error) {
       logger.error('user tracking 실패 : ', error);
       next(error);
     }
   }) as RequestHandler;
 
-  stay = (async (req: Request, res: Response, next: NextFunction) => {
+  stay = (async (req: Request, res: Response<TrackingResponse>, 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: '체류시간 데이터 완료' });
+      return res.status(200).json({ success: true, message: '체류시간 데이터 저장 완료', data: {}, error: null });
     } catch (error) {
       logger.error('user stay time 저장 실패 : ', error);
       next(error);

src/controllers/user.controller.ts

@@ -1,26 +1,66 @@
-import { NextFunction, Request, Response, RequestHandler } from 'express';
+import { NextFunction, Request, Response, RequestHandler, CookieOptions } from 'express';
 import logger from '../configs/logger.config';
-import { UserWithTokenDto } from '../types';
+import { LoginResponse, UserWithTokenDto } from '../types';
 import { UserService } from '../services/user.service';
-
 export class UserController {
   constructor(private userService: UserService) {}
 
-  login = (async (req: Request, res: Response, next: NextFunction) => {
+  private cookieOption(): CookieOptions {
+    const isProd = process.env.NODE_ENV === 'production';
+
+    const baseOptions: CookieOptions = {
+      httpOnly: isProd,
+      secure: isProd,
+      domain: process.env.COOKIE_DOMAIN || 'localhost',
+    };
+
+    if (isProd) {
+      baseOptions.sameSite = 'lax';
+    }
+
+    return baseOptions;
+  }
+
+  login: RequestHandler = async (req: Request, res: Response<LoginResponse>, next: NextFunction): Promise<void> => {
     try {
-      const { id, email, profile } = req.user;
+      const { id, email, profile, username } = req.user;
       const { accessToken, refreshToken } = req.tokens;
 
       const userWithToken: UserWithTokenDto = { id, email, accessToken, refreshToken };
       const isExistUser = await this.userService.handleUserTokensByVelogUUID(userWithToken);
-      return res.status(200).json({
+
+      res.clearCookie('access_token');
+      res.clearCookie('refresh_token');
+
+      res.cookie('access_token', accessToken, this.cookieOption());
+      res.cookie('refresh_token', refreshToken, this.cookieOption());
+
+      res.status(200).json({
         success: true,
         message: '로그인에 성공하였습니다.',
-        data: { id: isExistUser.id, email: isExistUser.email, profile },
+        data: { id: isExistUser.id, username, profile },
+        error: null,
       });
     } catch (error) {
       logger.error('로그인 실패 : ', error);
       next(error);
     }
-  }) as RequestHandler;
+  };
+
+  logout: RequestHandler = async (req: Request, res: Response) => {
+    res.clearCookie('access_token');
+    res.clearCookie('refresh_token');
+
+    res.status(200).json({ success: true, message: '로그아웃에 성공하였습니다.', data: {}, error: null });
+  };
+
+  fetchCurrentUser: RequestHandler = (req: Request, res: Response) => {
+    const { user } = req;
+    res.status(200).json({
+      success: true,
+      message: '프로필 조회에 성공하였습니다.',
+      data: { user },
+      error: null,
+    });
+  };
 }

src/exception/token.exception.ts

@@ -7,7 +7,6 @@ export class TokenError extends CustomError {
   }
 }
 
-// todo : 추후 만료 여부를 위해 token 에러 구체화 필요. 웬만한 인증관련은 unauthorized로 넘기는게 나을듯
 export class TokenExpiredError extends UnauthorizedError {
   constructor(message = '토큰이 만료되었습니다') {
     super(message, 'TOKEN_EXPIRED');