5주차 작업 병합

.github/workflows/CI_PIPELINE.yml

@@ -59,5 +59,7 @@ jobs:
 
       - name: Test ${{ matrix.project }}
         if: env.changed == 'true'
-        run: yarn test
+        run: |
+          echo "${{ secrets.DOT_ENV_PROD }}" > ${{ github.workspace }}/backend/.env
+          yarn test
         working-directory: ${{ matrix.project }}

.gitignore

@@ -2,6 +2,9 @@
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
+**/*.csv
+**/*.log
+
 # User-specific stuff
 .idea/
 .idea/**/workspace.xml

README.md

@@ -1,8 +1,13 @@
-# **오늘의 길** 🚗
-> 나만의 지도와 코스를 만들고 친구와 공유해 보세요!
+<div align='center'>
+    <img src="https://github.com/user-attachments/assets/b30a96fe-c822-499d-942c-88e7ece72fb3" width=600 alt="오늘의 길">
+<h3> 나만의 길을 따라 일상을 공유하다. 🗺️
 
-### 팀원 소개
+</div>
+
+---
+<a href="https://forms.gle/Hkckwm6vtZxoEnxH6" target='_blank'>📝 피드백을 남겨주세요!</a>
 
+### 팀원 소개
 
 |                   [J088_도원진](https://github.com/1119wj)                    |                  [J151_안금장](https://github.com/koomchang)                  |                  [J105_박민서](https://github.com/Miensoap)                   |                  [J270 _한동효](https://github.com/hyohyo12)                   |
 |:--------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:---------------------------------------------------------------------------:|
@@ -11,15 +16,20 @@
 
 ### 프로젝트 소개
 
->**오늘의 길**은 사람들이 자신의 경험과 취향을 반영한 지도를 만들고 공유할 수 있는 플랫폼입니다.  
+> **오늘의 길**은 사람들이 자신의 경험과 취향을 반영한 지도를 만들고 공유할 수 있는 플랫폼입니다.
 >
 >맛집이나 여행지를 기록할 때 다양한 앱과 도구를 사용하는 대신,   
-이곳에서는 장소와 코스를 자유롭게 구성하고,다른 사람들과 공유하며 소통할 수 있습니다.   
+> 이곳에서는 장소와 코스를 자유롭게 구성하고,다른 사람들과 공유하며 소통할 수 있습니다.
 >
 >개인적인 기억과 감상을 담은 지도를 통해 새로운 발견을 하고,   
-좋아하는 사람들을 팔로우하며 일상의 영감을 얻는 소셜 지도 서비스입니다.
+> 좋아하는 사람들을 팔로우하며 일상의 영감을 얻는 소셜 지도 서비스입니다.
+
+### 시스템 아키텍처
 
+<img src="https://github.com/user-attachments/assets/8385c502-7e82-41fa-ae10-b5f9b9ad0d56" width=1000>
 
+</br>
+</br>
 
-|🏷️ 바로가기| [**팀 Notion**](https://elastic-bread-9ef.notion.site/12963e6f4ee98074b6f9f70cfa9ac836) | [그라운드 룰](https://github.com/boostcampwm-2024/web09-DailyRoad/wiki/%EA%B7%B8%EB%9D%BC%EC%9A%B4%EB%93%9C-%EB%A3%B0) | [컨벤션](#) | [기획/디자인](#) | [문서](#) |
-|:-:|:--------------------------------------------------------------------------------------:|:----------:|:--------:|:-----------:|:-----:|
+| 🏷️ 바로가기 | [**팀 Notion**](https://elastic-bread-9ef.notion.site/12963e6f4ee98074b6f9f70cfa9ac836) | [그라운드 룰](https://github.com/boostcampwm-2024/web09-DailyRoad/wiki/%EA%B7%B8%EB%9D%BC%EC%9A%B4%EB%93%9C-%EB%A3%B0) | [컨벤션](#) | [기획/디자인](#) | [문서](#) |
+|:--------:|:--------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------:|:--------:|:-----------:|:-------:|

backend/src/admin/banner/banner.service.ts

@@ -1,8 +1,9 @@
-import { Injectable, NotFoundException } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { AdminBannerRepository } from './banner.repository';
 import { CreateBannerRequest } from '@src/admin/banner/dto/CreateBannerRequest';
 import { UpdateBannerPeriodRequest } from '@src/admin/banner/dto/UpdateBannerPeriodRequest';
 import { UpdateBannerDetailsRequest } from '@src/admin/banner/dto/UpdateBannerDetailsRequest';
+import { BannerNotFoundException } from '@src/banner/exception/BannerNotFoundException';
 
 @Injectable()
 export class AdminBannerService {
@@ -26,7 +27,7 @@ export class AdminBannerService {
     });
 
     if (result.affected === 0) {
-      throw new NotFoundException(`Banner with id ${id} not found`);
+      throw new BannerNotFoundException(id);
     }
 
     return this.bannerRepository.findOne({ where: { id } });
@@ -42,7 +43,7 @@ export class AdminBannerService {
     });
 
     if (result.affected === 0) {
-      throw new NotFoundException(`Banner with id ${id} not found`);
+      throw new BannerNotFoundException(id);
     }
 
     return this.bannerRepository.findOne({ where: { id } });
@@ -52,9 +53,9 @@ export class AdminBannerService {
     const result = await this.bannerRepository.softDelete(id);
 
     if (result.affected === 0) {
-      throw new NotFoundException(`Banner with id ${id} not found`);
+      throw new BannerNotFoundException(id);
     }
 
-    return { message: `Banner with id ${id} successfully deleted` };
+    return { deleted: id };
   }
 }

backend/src/auth/auth.controller.ts

@@ -1,8 +1,20 @@
 import { Request, Response } from 'express';
-import { Body, Controller, Post, Get, Param, Res, Req } from '@nestjs/common';
+import {
+  Body,
+  Controller,
+  Post,
+  Get,
+  Param,
+  Res,
+  Req,
+  Delete,
+  UseGuards,
+} from '@nestjs/common';
 import { AuthService } from './auth.service';
 import { AuthenticationException } from './exception/AuthenticationException';
 import { getOAuthProviderNameByValue } from './oauthProvider/OAuthProviders';
+import { JwtAuthGuard } from '@src/auth/JwtAuthGuard';
+import { AuthUser } from '@src/auth/AuthUser.decorator';
 
 const REFRESH_TOKEN = 'refreshToken';
 
@@ -49,6 +61,18 @@ export class AuthController {
     });
   }
 
+  @Delete('signOut')
+  @UseGuards(JwtAuthGuard)
+  async signOut(@Res() response: Response, @AuthUser() user: AuthUser) {
+    await this.authService.signOut(user.userId);
+    response.clearCookie(REFRESH_TOKEN, {
+      httpOnly: true,
+      secure: true,
+      sameSite: 'none',
+    });
+    response.status(204).send();
+  }
+
   @Post('refresh')
   async refreshAccessToken(@Req() request: Request) {
     const refreshToken = request.cookies[REFRESH_TOKEN];

backend/src/auth/auth.service.ts

@@ -1,16 +1,18 @@
 import { Injectable } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
-import { JWTHelper } from './JWTHelper';
-import { CreateUserRequest } from '../user/dto/CreateUserRequest';
-import { UserService } from '../user/user.service';
-import { RefreshTokenRepository } from './refresh-token.repository';
-import { OAuthProvider } from './oauthProvider/OAuthProvider';
-import { AuthenticationException } from './exception/AuthenticationException';
-import { UserRole } from '../user/user.role';
+import { JWTHelper } from '@src/auth/JWTHelper';
+import { CreateUserRequest } from '@src/user/dto/CreateUserRequest';
+import { UserService } from '@src/user/user.service';
+import { RefreshTokenRepository } from '@src/auth/refresh-token.repository';
+import { OAuthProvider } from '@src/auth/oauthProvider/OAuthProvider';
+import { AuthenticationException } from '@src/auth/exception/AuthenticationException';
+import { InvalidTokenException } from '@src/auth/exception/InvalidTokenException';
+import { UserRole } from '@src/user/user.role';
 import {
-  OAuthProviderName,
   getOAuthProviders,
-} from './oauthProvider/OAuthProviders';
+  OAuthProviderName,
+} from '@src/auth/oauthProvider/OAuthProviders';
+import { ExpiredTokenException } from '@src/auth/exception/ExpiredTokenException';
 
 @Injectable()
 export class AuthService {
@@ -65,12 +67,12 @@ export class AuthService {
     });
 
     if (!tokenEntity) {
-      throw new AuthenticationException('유효하지 않은 리프레시 토큰입니다.');
+      throw new InvalidTokenException('유효하지 않은 리프레시 토큰입니다.');
     }
 
     const isTokenValid = this.jwtHelper.verifyToken(refreshToken);
     if (!isTokenValid) {
-      throw new AuthenticationException('리프레시 토큰이 만료되었습니다.');
+      throw new ExpiredTokenException('리프레시 토큰이 만료되었습니다.');
     }
 
     return this.jwtHelper.generateToken(this.accessTokenExpiration, {
@@ -110,4 +112,8 @@ export class AuthService {
 
     return { accessToken, refreshToken };
   }
+
+  async signOut(userId: number) {
+    await this.refreshTokenRepository.deleteByUserId(userId);
+  }
 }

backend/src/auth/exception/AuthenticationException.ts

@@ -4,7 +4,7 @@ import { HttpStatus } from '@nestjs/common';
 export class AuthenticationException extends BaseException {
   constructor(message: string = '인증에 실패했습니다.') {
     super({
-      code: 601,
+      code: 500,
       message: message,
       status: HttpStatus.UNAUTHORIZED,
     });

backend/src/auth/exception/AuthorizationException.ts

@@ -4,7 +4,7 @@ import { HttpStatus } from '@nestjs/common';
 export class AuthorizationException extends BaseException {
   constructor(message: string = '해당 작업에 대한 권한이 없습니다.') {
     super({
-      code: 602,
+      code: 510,
       message: message,
       status: HttpStatus.FORBIDDEN,
     });

backend/src/auth/exception/ExpiredTokenException.ts

@@ -0,0 +1,12 @@
+import { BaseException } from '@src/common/exception/BaseException';
+import { HttpStatus } from '@nestjs/common';
+
+export class ExpiredTokenException extends BaseException {
+  constructor(message: string = '만료된 토큰입니다.') {
+    super({
+      code: 502,
+      message: message,
+      status: HttpStatus.UNAUTHORIZED,
+    });
+  }
+}

backend/src/auth/exception/InvalidTokenException.ts

@@ -0,0 +1,12 @@
+import { BaseException } from '@src/common/exception/BaseException';
+import { HttpStatus } from '@nestjs/common';
+
+export class InvalidTokenException extends BaseException {
+  constructor(message: string = '유효하지 않은 토큰입니다.') {
+    super({
+      code: 501,
+      message: message,
+      status: HttpStatus.UNAUTHORIZED,
+    });
+  }
+}

backend/src/banner/exception/BannerNotFoundException.ts

@@ -0,0 +1,11 @@
+import { BaseException } from '@src/common/exception/BaseException';
+
+export class BannerNotFoundException extends BaseException {
+  constructor(id: number) {
+    super({
+      code: 661,
+      message: `[${id}] 배너가 존재하지 않습니다.`,
+      status: 404,
+    });
+  }
+}

backend/src/common/consts.ts

@@ -0,0 +1,3 @@
+// Todo. 오브젝트 스토리지에 실제 이미지 저장 후 수정
+export const DEFAULT_THUMBNAIL_URL =
+  'https://avatars.githubusercontent.com/u/87180146?v=4';

backend/src/common/decorator/ReplaceEmptyWith.ts

@@ -0,0 +1,9 @@
+import { Transform } from 'class-transformer';
+
+/**
+ * 빈 문자열을 기본값으로 변환합니다.
+ * @param defaultValue
+ */
+export function ReplaceEmptyWith(defaultValue: string): PropertyDecorator {
+  return Transform(({ value }) => (value === '' ? defaultValue : value));
+}

backend/src/common/decorator/UnavaliableIn.ts

@@ -0,0 +1,23 @@
+import { ServiceUnavailableException } from '@nestjs/common';
+
+export function UnavailableIn(env: string): MethodDecorator {
+  return (
+    target: object,
+    propertyKey: string | symbol,
+    descriptor: PropertyDescriptor,
+  ) => {
+    const originalMethod = descriptor.value;
+    descriptor.value = function (...args: any[]) {
+      console.log(process.env.NODE_ENV);
+      if (process.env.NODE_ENV === env) {
+        throw new ServiceUnavailableException(
+          `현재는 지원하지 않는 서비스입니다. [${env} 환경]`,
+        );
+      }
+
+      return originalMethod.apply(this, args);
+    };
+
+    return descriptor;
+  };
+}

backend/src/common/exception/BaseException.ts

@@ -4,13 +4,16 @@ import { ExceptionType } from './ExceptionType';
 export class BaseException extends HttpException {
   readonly code: number;
 
-  constructor(exceptionType: ExceptionType) {
+  constructor(
+    readonly exceptionType: ExceptionType,
+    readonly error?: Error,
+  ) {
     super(exceptionType.message, exceptionType.status);
     this.code = exceptionType.code;
   }
 
-  getCode(): number {
-    return this.code;
+  getCode(): string {
+    return `E${this.code}`;
   }
 
   getMessage(): string {

backend/src/common/exception/EmptyRequestException.ts

@@ -0,0 +1,12 @@
+import { BaseException } from '@src/common/exception/BaseException';
+import { HttpStatus } from '@nestjs/common';
+
+export class EmptyRequestException extends BaseException {
+  constructor(action: string = '작업') {
+    super({
+      code: 601,
+      message: `${action}에 필요한 정보가 없습니다.`,
+      status: HttpStatus.BAD_REQUEST,
+    });
+  }
+}