[release] v 1.0.1

.github/workflows/CI.yml

@@ -4,21 +4,40 @@ on:
   pull_request:
     branches: [ "develop" ]
 
+permissions:
+  checks: write
+  pull-requests: write
+
 jobs:
   build:
-    runs-on: ubuntu-22.04 
-
+    runs-on: ubuntu-22.04
 
     steps: 
     - name: checkout
       uses: actions/checkout@v3
 
+    - name: Setup MySQL
+      uses: samin/mysql-action@v1
+      with:
+        host port: 3306
+        container port: 3306
+        mysql root user: 'mile'
+        mysql root password: 'mile'
+        mysql user: 'mile'
+        mysql password: 'mile'
+
     - name: Set up JDK 17
       uses: actions/setup-java@v3
       with:
         distribution: 'corretto'
         java-version: '17'
 
+    - name : Setup Redis
+      uses: shogo82148/actions-setup-redis@v1
+      with:
+        redis-version: "7.x"
+        run: redis-cli ping
+
     - name: create application.yml
       run: |
         ## create application.yml
@@ -33,9 +52,15 @@ jobs:
         # application.yml 파일 확인
         cat ./application.yml
       shell: bash
-
-    - name: build
+
+    - name: Wait for MySQL
+      run: |
+        while ! mysqladmin ping --host=127.0.0.1 --password='mile' --silent; do
+          sleep 1
+        done
+
+    - name: Build
       run: |
           chmod +x gradlew
-          ./gradlew build -x test
-      shell: bash
+          ./gradlew clean build
+      shell: bash

README.md

@@ -1,110 +1,53 @@
 ## 📖 MILE (Make It Look Easy)
+<img width="1920" alt="마일" src="https://github.com/user-attachments/assets/4dd983b9-5018-494d-a5ea-a6d4f6533bdb">
 
 > 오직, 글모임을 위한 글쓰기 플랫폼
 
-
  <br/>
 
-
-
 ## 💗 Our Team
 |도소현|박희정|
 |:------:|:------:|
-|<img src="https://github.com/Mile-Writings/Mile-Server/assets/79795051/5cfa86cb-c618-4903-a89d-87eca2f26c77" width="300" height="450" />|<img src="https://github.com/Mile-Writings/Mile-Server/assets/79795051/c1a5e201-cf6a-4aab-83d1-2afb1dbeeb33" width="300" height="450" />|
 |[@sohyundoh](https://github.com/sohyundoh)|[@parkheeddong](https://github.com/parkheeddong)|
 
 
 <br/>
 
-## 🌳 Branch Convention
-<details>
-	<summary> GIT - FLOW 전략 </summary>
-  	<div markdown="1">
-      <img src="https://github.com/Mile-Writings/Mile-Server/assets/116873401/5c3f34cb-5ab1-4a16-ad44-712a39108985" width = "600"/>
-  	</div>
-</details>
-
-- `main` : 프로덕션용 브랜치 (배포 시 사용될 버전만 존재)
-- `develop` : 개발 전용 브랜치
-- `이슈 기반 브랜치`
-    - 생성된 이슈 번호로 브랜치를 생성한다
-    - feat/#{이슈번호}
-    - ex. feat/#1,
-    - ex. hotfix/#3
-- PR이 Merge되면 해당 브랜치는 삭제한다.
-
-
-
-<br />
-
-
-## 📌 Commit Convention
-**이슈번호 [tag] 커밋 내용 요약**
-
-ex. #123 [feat] 로그인 구현
-
-| tag | description |
-| --- | --- |
-| feat | 새로운 기능 추가 |
-| fix | 자잘한 수정 |
-| bugfix | 버그 수정 |
-| refactor | 코드 리팩토링 시에만 사용 |
-| chore | config 및 라이브러리, 빌드 관련 파일 수정 (프로덕션 코드 수정 x) |
-| rename | 파일명, 변수명 수정 |
-| docs | 문서 수정 |
-| comment | 주석 추가 및 수정 |
-| remove | 기능 삭제 및 파일 삭제 |
-| test | 테스트 코드 작성 |
-| hotfix | hotfix |
-
-<br />
-
-
 ## 📍 Architecture
 ![image](https://github.com/Mile-Writings/Mile-Server/assets/79795051/3fadfcd5-ae4b-420a-bc5b-313aca7b5b11)
 
 ## 🤍 ERD
 <img width="718" alt="image" src="https://github.com/Mile-Writings/Mile-Server/assets/79795051/ce6b8805-0547-46f0-a571-563165ddd372">
 
-## 👨🏻‍💻 Stack
-| Stack | Version | Content |
-| --- | --- | --- |
-| Spring Boot | 3.2.1 | - |
-| JDK | 17 | - |
-| MySql | 8.0.33 | - |
-| Openfeign - Spring Cloud | 2022.0.4 | 소셜 로그인 연동 |
-| Redis | 2.3.1 | 리프레시 토큰 저장 |
-| QueryDsl | 5.0.0 | 동적 쿼리 생성 |
-
-<br />
-
 ## 🗂️ Directory
 ```jsx
 ├── build.gradle
-├── 🗂️ module-api
+├── 🗂️ module-api # 프레젠테이션
 │   ├── build.gradle
-│   └── 📂 src/main/java/com/mile
-│       ├── 📂 common
-│       ├── 📂 config
-│       └── 📂 post # 도메인 별로 controller 분리
+│   └── 📂 src
+│       ├──main/java/com/mile
+│     	   ├── 📂 common
+│          ├── 📂 config
+│          └── 📂 controller
+│       └── test/java/com/mile
 ├── 🗂️ module-auth
 │   ├── build.gradle
 │   └── 📂 src/main/java/com/mile
-│       └── 📂 external
-│           └── 📂 client
+│           ├── 📂 client
+│           ├── 📂 jwt # 레디스 리프레시 토큰 저장용
+│           └── 📂 strategy # 로그인 전략패턴
 ├── 🗂️ module-common
 │   ├── build.gradle
 │   └── 📂 src/main/java/com/mile
-│        └── 📂 exception
-│            ├── 📂 message
-│            └── 📂 model
-│        └── 📂 util
+│        ├── 📂 exception
+│        ├── 📂 dto
+│        ├── 📂 handler
+│        ├── 📂 log
+│        └── 📂 swagger
 ├── 🗂️ module-domain
 │   ├── build.gradle
 │   └── 📂 src/main/java/com/mile
-│          └── 📂 post #도메인 별로 분리
-│              ├── 📂 domain
-│              ├── 📂 repository
-│              └── 📂 service
-└── settings.gradle
+│          └── 📂 post # 도메인 별로 분리
+└── 🗂️ module-external # AWS S3
 ```
+

module-api/src/main/java/com/mile/common/auth/JwtTokenProvider.java

@@ -24,7 +24,7 @@
 public class JwtTokenProvider {
 
     private static final String MEMBER_ID = "memberId";
-    private static final Long ACCESS_TOKEN_EXPIRATION_TIME = 24 * 60 * 60 * 1000L * 14;
+    private static final Long ACCESS_TOKEN_EXPIRATION_TIME = 4 * 60 * 60 * 1000L;
     private static final Long REFRESH_TOKEN_EXPIRATION_TIME = 60 * 60 * 24 * 1000L * 14;
 
     @Value("${jwt.secret}")
@@ -37,7 +37,7 @@ protected void init() {
     }
 
     private String getTokenFromHeader(final String token) {
-        if (!StringUtils.hasText(token)) {
+        if (!StringUtils.hasText(token) || token.equals("Bearer null") || token.equals("Bearer ")) {
             throw new UnauthorizedException(ErrorMessage.UN_LOGIN_EXCEPTION);
         } else if (StringUtils.hasText(token) && !token.startsWith("Bearer ")) {
             throw new BadRequestException(ErrorMessage.BEARER_LOST_ERROR);

module-api/src/main/java/com/mile/common/utils/ContextHolderUtil.java

@@ -1,6 +1,9 @@
 package com.mile.common.utils;
 
 import com.mile.common.auth.JwtTokenProvider;
+import com.mile.common.auth.JwtValidationType;
+import com.mile.exception.message.ErrorMessage;
+import com.mile.exception.model.UnauthorizedException;
 import jakarta.servlet.http.HttpServletRequest;
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
@@ -19,11 +22,17 @@ public class ContextHolderUtil {
 
     public String getUserIdFromContextHolder() {
         HttpServletRequest servletRequest = ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest();
-
         if (HttpMethod.OPTIONS.matches(servletRequest.getMethod())) {
             return null;
         }
-        return jwtTokenProvider.getUserFromJwt(servletRequest.getHeader("Authorization")).toString();
+
+        final String token = servletRequest.getHeader("Authorization");
+
+        if(!jwtTokenProvider.validateToken(token).equals(JwtValidationType.VALID_JWT)) {
+            throw new UnauthorizedException(ErrorMessage.TOKEN_VALIDATION_ERROR);
+        }
+
+        return jwtTokenProvider.getUserFromJwt(token).toString();
     }
 
 }

module-api/src/main/java/com/mile/config/WebConfig.java

@@ -9,6 +9,7 @@
 import com.mile.common.resolver.topic.TopicVariableResolver;
 import com.mile.common.resolver.user.UserIdHeaderResolver;
 import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 import org.springframework.web.servlet.config.annotation.CorsRegistry;
@@ -28,11 +29,30 @@ public class WebConfig implements WebMvcConfigurer {
     private final DuplicatedInterceptor duplicatedInterceptor;
     private final UserIdHeaderResolver userIdHeaderResolver;
 
+    @Value("${client.local}")
+    private String clientLocal;
+
+    @Value("${client.deploy}")
+    private String clientDeploy;
+
+    @Value("${backend.local-set1}")
+    private String serverLocalSet1;
+
+    @Value("${backend.local-set2}")
+    private String serverLocalSet2;
+
+    @Value("${backend.develop}")
+    private String serverDevelop;
+
+    @Value("${backend.deploy}")
+    private String serverDeploy;
+
     @Override
     public void addCorsMappings(CorsRegistry registry) {
         registry.addMapping("/**")
-                .allowedOrigins("*")
+                .allowedOrigins(clientLocal, clientDeploy, serverLocalSet1, serverLocalSet2, serverDevelop, serverDeploy)
                 .allowedMethods("GET", "POST", "DELETE", "PUT", "PATCH", "OPTIONS")
+                .allowCredentials(true)
                 .maxAge(3000);
     }
 

module-api/src/main/java/com/mile/controller/comment/CommentController.java

@@ -8,8 +8,8 @@
 import com.mile.common.resolver.user.UserId;
 import com.mile.dto.SuccessResponse;
 import com.mile.exception.message.SuccessMessage;
+import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.DeleteMapping;
@@ -20,7 +20,6 @@
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
-@Slf4j
 @RequestMapping("/api/comment")
 @RequiredArgsConstructor
 public class CommentController implements CommentControllerSwagger {
@@ -41,13 +40,14 @@ public ResponseEntity<SuccessResponse> deleteComment(
     public ResponseEntity<SuccessResponse> createCommentReply(
             @CommentIdPathVariable final Long commentId,
             @UserId final Long userId,
-            @RequestBody final ReplyCreateRequest createRequest,
+            @Valid @RequestBody final ReplyCreateRequest createRequest,
             @PathVariable("commentId") final String commentUrl
     ) {
         return ResponseEntity.status(HttpStatus.CREATED).header("Location",
                 commentService.createCommentReply(
                         userId,
-                        commentId, createRequest
+                        commentId,
+                        createRequest
                 )).body(SuccessResponse.of(SuccessMessage.REPLY_CREATE_SUCCESS));
     }
 

module-api/src/main/java/com/mile/controller/comment/CommentControllerSwagger.java

@@ -11,13 +11,11 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PathVariable;
 
 @Tag(name = "Comment", description = "댓글 관련 API")
-@SecurityRequirement(name = "JWT Auth")
 public interface CommentControllerSwagger {
 
     @Operation(description = "댓글 삭제 API")

module-api/src/main/java/com/mile/controller/post/PostController.java

@@ -8,6 +8,7 @@
 import com.mile.post.service.dto.CommentCreateRequest;
 import com.mile.post.service.dto.CommentListResponse;
 import com.mile.post.service.dto.ModifyPostGetResponse;
+import com.mile.post.service.dto.PostAuthenticateResponse;
 import com.mile.post.service.dto.PostCreateRequest;
 import com.mile.post.service.dto.PostCuriousResponse;
 import com.mile.post.service.dto.PostGetResponse;
@@ -96,7 +97,7 @@ public SuccessResponse<PostCuriousResponse> deleteCurious(
 
     @GetMapping("/{postId}/authenticate")
     @Override
-    public ResponseEntity<SuccessResponse> getAuthenticateWrite(
+    public ResponseEntity<SuccessResponse<PostAuthenticateResponse>> getAuthenticateWrite(
             @PostIdPathVariable final Long postId,
             @UserId final Long userId,
             @PathVariable("postId") final String postUrl

module-api/src/main/java/com/mile/controller/post/PostControllerSwagger.java

@@ -7,6 +7,7 @@
 import com.mile.post.service.dto.CommentCreateRequest;
 import com.mile.post.service.dto.CommentListResponse;
 import com.mile.post.service.dto.ModifyPostGetResponse;
+import com.mile.post.service.dto.PostAuthenticateResponse;
 import com.mile.post.service.dto.PostCreateRequest;
 import com.mile.post.service.dto.PostCuriousResponse;
 import com.mile.post.service.dto.PostGetResponse;
@@ -121,7 +122,7 @@ SuccessResponse<PostCuriousResponse> deleteCurious(
     );
 
 
-    @Operation(summary = "게시글 삭제/수정 권한 확인")
+    @Operation(summary = "게시글 권한 확인")
     @ApiResponses(
             value = {
                     @ApiResponse(responseCode = "200", description = "게시글 권한이 확인되었습니다."),
@@ -134,7 +135,7 @@ SuccessResponse<PostCuriousResponse> deleteCurious(
 
             }
     )
-    ResponseEntity<SuccessResponse> getAuthenticateWrite(
+    ResponseEntity<SuccessResponse<PostAuthenticateResponse>> getAuthenticateWrite(
             @Parameter(schema = @Schema(implementation = String.class), in = ParameterIn.PATH) final Long postId,
             @Parameter(schema = @Schema(implementation = String.class), in = ParameterIn.PATH) @UserId final Long userId,
             @PathVariable("postId") final String postUrl

module-api/src/main/java/com/mile/controller/topic/TopicController.java

@@ -31,8 +31,8 @@ public class TopicController implements TopicControllerSwagger {
     @GetMapping("/{topicId}")
     public SuccessResponse<PostListInTopicResponse> getPostListByTopic(
             @TopicIdPathVariable Long topicId,
-            @PathVariable("topicId") final String topicUrl,
-            @RequestParam(required = false) final String lastPostId
+            @RequestParam(required = false) final String lastPostId,
+            @PathVariable("topicId") final String topicUrl
     ) {
         return SuccessResponse.of(SuccessMessage.MOIM_POST_GET_SUCCESS, topicService.getPostListByTopic(topicId, lastPostId));
     }

module-api/src/main/java/com/mile/controller/topic/TopicControllerSwagger.java

@@ -36,8 +36,8 @@ public interface TopicControllerSwagger {
     )
     SuccessResponse<PostListInTopicResponse> getPostListByTopic(
             @Parameter(schema = @Schema(implementation = String.class), in = ParameterIn.PATH) final Long topicId,
-            @PathVariable("topicId") final String topicUrl,
-            @RequestParam(required = false) final String lastPostId
+            @RequestParam(required = false) final String lastPostId,
+            @PathVariable("topicId") final String topicUrl
     );
 
     @Operation(summary = "관리자 페이지 - 글감 상세 정보")