Merge pull request #483 from boostcampwm-2024/refactor/auth-req-type

♻️ refactor: 인증 payload 사용 방법 변경

Author: asn6878

server/src/comment/controller/comment.controller.ts

@@ -8,21 +8,21 @@ import {
   Param,
   Patch,
   Post,
-  Req,
   UseGuards,
 } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import { CommentService } from '../service/comment.service';
 import { ApiCreateComment } from '../api-docs/createComment.api-docs';
 import { ApiDeleteComment } from '../api-docs/deleteComment.api-docs';
 import { ApiUpdateComment } from '../api-docs/updateComment.api-docs';
-import { JwtGuard } from '../../common/guard/jwt.guard';
+import { JwtGuard, Payload } from '../../common/guard/jwt.guard';
 import { ApiResponse } from '../../common/response/common.response';
 import { CreateCommentRequestDto } from '../dto/request/createComment.dto';
 import { DeleteCommentRequestDto } from '../dto/request/deleteComment.dto';
 import { UpdateCommentRequestDto } from '../dto/request/updateComment.dto';
 import { GetCommentRequestDto } from '../dto/request/getComment.dto';
 import { ApiGetComment } from '../api-docs/getComment.api-docs';
+import { CurrentUser } from '../../common/decorator';
 
 @ApiTags('Comment')
 @Controller('comment')
@@ -43,26 +43,35 @@ export class CommentController {
   @Post()
   @UseGuards(JwtGuard)
   @HttpCode(HttpStatus.CREATED)
-  async createComment(@Req() req, @Body() commentDto: CreateCommentRequestDto) {
-    await this.commentService.create(req.user, commentDto);
+  async createComment(
+    @CurrentUser() user: Payload,
+    @Body() commentDto: CreateCommentRequestDto,
+  ) {
+    await this.commentService.create(user, commentDto);
     return ApiResponse.responseWithNoContent('댓글 등록을 성공했습니다.');
   }
 
   @ApiDeleteComment()
   @Delete()
   @UseGuards(JwtGuard)
   @HttpCode(HttpStatus.OK)
-  async deleteComment(@Req() req, @Body() commentDto: DeleteCommentRequestDto) {
-    await this.commentService.delete(req.user, commentDto);
+  async deleteComment(
+    @CurrentUser() user: Payload,
+    @Body() commentDto: DeleteCommentRequestDto,
+  ) {
+    await this.commentService.delete(user, commentDto);
     return ApiResponse.responseWithNoContent('댓글 삭제를 성공했습니다.');
   }
 
   @ApiUpdateComment()
   @Patch()
   @UseGuards(JwtGuard)
   @HttpCode(HttpStatus.OK)
-  async updateComment(@Req() req, @Body() commentDto: UpdateCommentRequestDto) {
-    await this.commentService.update(req.user, commentDto);
+  async updateComment(
+    @CurrentUser() user: Payload,
+    @Body() commentDto: UpdateCommentRequestDto,
+  ) {
+    await this.commentService.update(user, commentDto);
     return ApiResponse.responseWithNoContent('댓글 수정을 성공했습니다.');
   }
 }

server/src/common/decorator/current-user.decorator.ts

@@ -0,0 +1,9 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { Payload } from '../guard/jwt.guard';
+
+export const CurrentUser = createParamDecorator(
+  (data: unknown, ctx: ExecutionContext): Payload | null => {
+    const request = ctx.switchToHttp().getRequest();
+    return request.user;
+  },
+);

server/src/common/decorator/index.ts

@@ -0,0 +1 @@
+export * from './current-user.decorator';

server/src/file/controller/file.controller.ts

@@ -4,7 +4,6 @@ import {
   Delete,
   UseInterceptors,
   UploadedFile,
-  Req,
   Param,
   UseGuards,
   BadRequestException,
@@ -15,13 +14,14 @@ import {
 import { FileInterceptor } from '@nestjs/platform-express';
 import { FileService } from '../service/file.service';
 import { ApiTags } from '@nestjs/swagger';
-import { JwtGuard } from '../../common/guard/jwt.guard';
+import { JwtGuard, Payload } from '../../common/guard/jwt.guard';
 import { createDynamicStorage } from '../../common/disk/diskStorage';
 import { ApiResponse } from '../../common/response/common.response';
 import { ApiUploadProfileFile } from '../api-docs/uploadProfileFile.api-docs';
 import { ApiDeleteFile } from '../api-docs/deleteFile.api-docs';
 import { DeleteFileRequestDto } from '../dto/request/deleteFile.dto';
 import { UploadFileQueryDto } from '../dto/request/uploadFile.dto';
+import { CurrentUser } from '../../common/decorator';
 
 @ApiTags('File')
 @Controller('file')
@@ -36,15 +36,15 @@ export class FileController {
   async upload(
     @UploadedFile() file: any,
     @Query() query: UploadFileQueryDto,
-    @Req() req,
+    @CurrentUser() user: Payload,
   ) {
     if (!file) {
       throw new BadRequestException('파일이 선택되지 않았습니다.');
     }
 
     return ApiResponse.responseWithData(
       '파일 업로드에 성공했습니다.',
-      await this.fileService.create(file, Number.parseInt(req.user.id)),
+      await this.fileService.create(file, user.id),
     );
   }
 

server/src/like/controller/like.controller.ts

@@ -7,11 +7,10 @@ import {
   HttpStatus,
   Param,
   Post,
-  Req,
   UseGuards,
   UseInterceptors,
 } from '@nestjs/common';
-import { JwtGuard } from '../../common/guard/jwt.guard';
+import { JwtGuard, Payload } from '../../common/guard/jwt.guard';
 import { ApiResponse } from '../../common/response/common.response';
 import { LikeService } from '../service/like.service';
 import { ApiTags } from '@nestjs/swagger';
@@ -20,6 +19,7 @@ import { ApiDeleteLike } from '../api-docs/deleteLike.api-docs';
 import { ManageLikeRequestDto } from '../dto/request/manageLike.dto';
 import { ApiGetLike } from '../api-docs/getLike.api-docs';
 import { InjectUserInterceptor } from '../../common/auth/jwt.interceptor';
+import { CurrentUser } from '../../common/decorator';
 
 @ApiTags('Like')
 @Controller('like')
@@ -30,28 +30,37 @@ export class LikeController {
   @Get('/:feedId')
   @HttpCode(HttpStatus.OK)
   @UseInterceptors(InjectUserInterceptor)
-  async getLike(@Req() req, @Param() feedLikeDto: ManageLikeRequestDto) {
+  async getLike(
+    @CurrentUser() user: Payload | null,
+    @Param() feedLikeDto: ManageLikeRequestDto,
+  ) {
     return ApiResponse.responseWithData(
       '좋아요 조회를 성공했습니다.',
-      await this.likeService.get(req.user, feedLikeDto),
+      await this.likeService.get(user, feedLikeDto),
     );
   }
 
   @ApiCreateLike()
   @Post()
   @UseGuards(JwtGuard)
   @HttpCode(HttpStatus.CREATED)
-  async createLike(@Req() req, @Body() feedLikeDto: ManageLikeRequestDto) {
-    await this.likeService.create(req.user, feedLikeDto);
+  async createLike(
+    @CurrentUser() user: Payload,
+    @Body() feedLikeDto: ManageLikeRequestDto,
+  ) {
+    await this.likeService.create(user, feedLikeDto);
     return ApiResponse.responseWithNoContent('좋아요 등록을 성공했습니다.');
   }
 
   @ApiDeleteLike()
   @Delete('/:feedId')
   @UseGuards(JwtGuard)
   @HttpCode(HttpStatus.OK)
-  async deleteLike(@Req() req, @Param() feedLikeDto: ManageLikeRequestDto) {
-    await this.likeService.delete(req.user, feedLikeDto);
+  async deleteLike(
+    @CurrentUser() user: Payload,
+    @Param() feedLikeDto: ManageLikeRequestDto,
+  ) {
+    await this.likeService.delete(user, feedLikeDto);
     return ApiResponse.responseWithNoContent('좋아요 삭제를 성공했습니다.');
   }
 }

server/src/like/service/like.service.ts

@@ -19,7 +19,10 @@ export class LikeService {
     private readonly dataSource: DataSource,
   ) {}
 
-  async get(userInformation: Payload, feedLikeGetDto: ManageLikeRequestDto) {
+  async get(
+    userInformation: Payload | null,
+    feedLikeGetDto: ManageLikeRequestDto,
+  ) {
     await this.feedService.getFeed(feedLikeGetDto.feedId);
     let isLike = false;
 

server/src/user/controller/user.controller.ts

@@ -8,7 +8,6 @@ import {
   Patch,
   Post,
   Query,
-  Req,
   Res,
   UseGuards,
 } from '@nestjs/common';
@@ -23,7 +22,7 @@ import { CheckEmailDuplicationRequestDto } from '../dto/request/checkEmailDuplic
 import { LoginUserRequestDto } from '../dto/request/loginUser.dto';
 import { Response } from 'express';
 import { ApiLoginUser } from '../api-docs/loginUser.api-docs';
-import { JwtGuard, RefreshJwtGuard } from '../../common/guard/jwt.guard';
+import { JwtGuard, Payload, RefreshJwtGuard } from '../../common/guard/jwt.guard';
 import { ApiRefreshToken } from '../api-docs/refreshToken.api-docs';
 import { ApiLogoutUser } from '../api-docs/logoutUser.api-docs';
 import { UpdateUserRequestDto } from '../dto/request/updateUser.dto';
@@ -35,6 +34,7 @@ import { ResetPasswordRequestDto } from '../dto/request/resetPassword.dto';
 import { ForgotPasswordRequestDto } from '../dto/request/forgotPassword.dto';
 import { ApiForgotPassword } from '../api-docs/forgotPassword.api-docs';
 import { ApiResetPassword } from '../api-docs/resetPassword.api-docs';
+import { CurrentUser } from '../../common/decorator';
 
 @ApiTags('User')
 @Controller('user')
@@ -93,11 +93,10 @@ export class UserController {
   @Post('/refresh-token')
   @HttpCode(HttpStatus.OK)
   @UseGuards(RefreshJwtGuard)
-  async refreshAccessToken(@Req() req) {
-    const userInformation = req.user;
+  async refreshAccessToken(@CurrentUser() user: Payload) {
     return ApiResponse.responseWithData(
       '엑세스 토큰을 재발급했습니다.',
-      this.userService.refreshAccessToken(userInformation),
+      this.userService.refreshAccessToken(user),
     );
   }
 
@@ -114,8 +113,11 @@ export class UserController {
   @Patch('/profile')
   @HttpCode(HttpStatus.OK)
   @UseGuards(JwtGuard)
-  async updateUser(@Body() updateUserDto: UpdateUserRequestDto, @Req() req) {
-    await this.userService.updateUser(req.user.id, updateUserDto);
+  async updateUser(
+    @Body() updateUserDto: UpdateUserRequestDto,
+    @CurrentUser() user: Payload,
+  ) {
+    await this.userService.updateUser(user.id, updateUserDto);
     return ApiResponse.responseWithNoContent(
       '사용자 프로필 정보가 성공적으로 수정되었습니다.',
     );