[feat] EventUserArgumentResolver 적용 및 FE 요청에 따른 추가 API 구현 (#35) #38

win-luck · 2024-08-07T07:40:36Z

#️⃣ 연관 이슈

[feat] EventUser도 Admin처럼 ArgumentResolver 적용하기 (#35) #35

📝 작업 내용

EventUser에 대한 ArgumentResolver를 적용하여 이제 Controller 단에서 유저 정보를 JWT로부터 추출할 수 있습니다.
그 외 FE로부터 여러 요구사항이 추가되어 API를 구현하고 테스트코드를 작성하였습니다.

EventUserArgumentResolver 구현 및 Postman으로 검증
인증번호 5분 유효기간 설정, 만료 시 예외처리 추가
유저의 오늘 기대평 작성 가능 여부 조회 기능 구현
유저의 선착순 이벤트 참여 상태 조회 기능 구현
선착순 이벤트에 대한 정보 조회 기능 구현

참고 이미지 및 자료

💬 리뷰 요구사항

win-luck

특이사항 및 생각은 코멘트에 정리했습니다!

win-luck · 2024-08-07T07:45:08Z

build.gradle

+	// jackson
+	implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'
+	implementation 'com.fasterxml.jackson.core:jackson-databind'


ResponseFcfsInfoDto에 존재하는 DateTime 타입 필드의 직렬화를 위해 jackson 라이브러리를 추가하였습니다.

jackson이 스프링부트에 내장되어 있어서 필요 없을 것 같아요!

말씀주신 부분 반영했습니다:)

win-luck · 2024-08-07T07:46:16Z

src/main/java/hyundai/softeer/orange/core/auth/AuthInterceptor.java

+        // 유효하지 않은 요청은 정적 리소스로 간주하여 ResourceHttpRequestHandler가 대신 처리하기에, HandlerMethod가 아닌 경우는 무시
+        if (!(handler instanceof HandlerMethod)) {
+            return true;
+        }
+


404가 발생해야 하는데 요청을 가로채는 과정에서 500이 뜨던 버그가 있어 수정했습니다.

내부 경로가 아니면 HandlerMethod가 아닌 handler이 올 수도 있다는 것을 새롭게 알게 되었네요. 기존에 swagger-ui 경로에 접근하지 못하던 문제도 이걸로 처리할 수 있었겠네요

win-luck · 2024-08-07T07:48:07Z

src/test/java/hyundai/softeer/orange/event/fcfs/load/DbFcfsServiceLoadTest.java

@@ -22,6 +23,7 @@

 @Slf4j
 @SpringBootTest
+@TestPropertySource(locations = "classpath:application-test.yml")


실 DB에 접근하는 부하 테스트의 경우 test.yml을 통해 h2를 활용하도록 수정했습니다.

win-luck · 2024-08-07T07:48:40Z

src/test/java/hyundai/softeer/orange/event/fcfs/FcfsControllerTest.java

+        when(authInterceptor.preHandle(any(), any(), any())).thenReturn(true);
+        when(eventUserArgumentResolver.supportsParameter(any())).thenReturn(true);
+        when(eventUserArgumentResolver.resolveArgument(any(), any(), any(), any()))
+                .thenReturn(mockUserInfo);


실제 테스트 코드에서도 항상 호출되는 코드이기에 mocking을 통해 테스트가 가능하도록 설정했습니다.

win-luck · 2024-08-07T07:49:28Z

src/main/java/hyundai/softeer/orange/eventuser/service/CoolSmsService.java

-        return String.format(ConstantUtil.AUTH_CODE_CREATE_REGEX, new Random().nextInt(1000000));
+        StringBuilder authCode = new StringBuilder();
+        Random random = new Random();
+        for(int i=0; i<ConstantUtil.AUTH_CODE_LENGTH; i++){
+            authCode.append(random.nextInt(10));
+        }
+        return authCode.toString();


이전 코드가 가독성이 떨어진다고 판단하여 명시적으로 특정 길이의 인증번호를 추출하는 것으로 표현했습니다.

win-luck · 2024-08-07T08:07:44Z

src/main/java/hyundai/softeer/orange/eventuser/component/EventUserArgumentResolver.java

+            Jws<Claims> claims = (Jws<Claims>) request.getAttribute(JWTConst.Token);
+            String userId = claims.getPayload().get(ConstantUtil.CLAIMS_USER_KEY).toString();
+            String role = claims.getPayload().get(ConstantUtil.CLAIMS_ROLE_KEY).toString();
+            return new EventUserInfo(userId, role);


claims에 대한 디버깅 결과 payLoad의 형태가 위와 같았습니다.
따라서, 이 중에서 userId와 role만을 별도로 추출하여 "@EventUserAnnotation" 이 붙은 객체인 EventUserInfo로 사용할 수 있게 했습니다.

win-luck · 2024-08-07T08:09:45Z

src/main/java/hyundai/softeer/orange/config/WebConfig.java

+@RequiredArgsConstructor
 @Configuration
 public class WebConfig implements WebMvcConfigurer {
-    @Autowired
-    private AuthInterceptor authInterceptor;

-    @Autowired
-    private AdminArgumentResolver adminArgumentResolver;
+    private final AuthInterceptor authInterceptor;
+    private final AdminArgumentResolver adminArgumentResolver;
+    private final EventUserArgumentResolver eventUserArgumentResolver;


필드 주입이 3개 이상이라 생성자 주입으로 바꾸었습니다.

win-luck · 2024-08-07T08:18:11Z

src/main/java/hyundai/softeer/orange/common/util/ConstantUtil.java

+    public static final String CLAIMS_USER_KEY = "userId";
+    public static final String CLAIMS_ROLE_KEY = "role";
+    public static final String CLAIMS_USER_NAME_KEY = "userName";
+    public static final String JWT_USER_KEY = "eventUser";
    public static final String CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
    public static final String LOCATION = "Location";

    public static final double LIMIT_NEGATIVE_CONFIDENCE = 99.5;
    public static final int COMMENTS_SIZE = 20;
    public static final int SCHEDULED_TIME = 1000 * 60 * 60 * 2;
    public static final int SHORT_URL_LENGTH = 10;
+    public static final int USER_ID_LENGTH = 8;
+    public static final int AUTH_CODE_LENGTH = 6;
+    public static final int JWT_LIFESPAN = 1; // 1시간
+    public static final int AUTH_CODE_EXPIRE_TIME = 5; // 5분


파편화된 Key 문자열과 매직넘버를 상수로 관리하고자 했습니다.

좋은 것 같습니다. 저도 여기에다 admin 부분을 등록해서 변경해둬야겠네요

win-luck · 2024-08-07T08:19:03Z

src/main/java/hyundai/softeer/orange/event/fcfs/service/FcfsManageService.java

+        if(nowDateTime.isBefore(eventStartTime) && nowDateTime.plusHours(3).isAfter(eventStartTime)) {
+            return new ResponseFcfsInfoDto(nowDateTime, "countdown");
+        } else if(eventStartTime.isBefore(nowDateTime) && eventStartTime.plusHours(7).isAfter(nowDateTime)) {
+            return new ResponseFcfsInfoDto(nowDateTime, "progress");
+        } else {
+            return new ResponseFcfsInfoDto(nowDateTime, "waiting");
+        }


FE에서 요구한 대로 이벤트에 대한 정보를 추출하는 메서드를 작성했습니다.

3, 7이라는 숫자는 추후에 변경될 수도 있으니 별도로 분리해두는 것도 좋을 것 같습니다.

말씀주신 부분까지 반영해서 머지하겠습니다:)

win-luck · 2024-08-07T08:28:35Z

src/main/java/hyundai/softeer/orange/event/fcfs/service/RedisLuaFcfsService.java

        stringRedisTemplate.opsForZSet().add(FcfsUtil.winnerFormatting(eventSequence.toString()), userId, System.currentTimeMillis());
+        stringRedisTemplate.opsForSet().add(FcfsUtil.participantFormatting(eventSequence.toString()), userId);
        log.info("Event Sequence: {}, User ID: {}, Timestamp: {}", eventSequence, userId, timestamp);
        return true;
    }

+    public boolean isParticipated(Long eventSequence, String userId) {
+        return Boolean.TRUE.equals(stringRedisTemplate.opsForSet().isMember(FcfsUtil.participantFormatting(eventSequence.toString()), userId));
+    }


"당첨 여부"와 별개로 유저가 정답을 맞혔는지에 대한 "참여 여부"를 판정해야 한다는 요구사항을 반영하기 위해 Set을 추가했고, 중복 참여 여부를 당첨 여부로 판정했던 기존 로직을 교체했습니다.

추후에 선착순 이벤트에서 요청 시각 기반으로 "순서"를 고려해야 할 가능성이 존재하는 "당첨 여부"와 달리,
"참여 여부"는 순서를 고려할 필요가 없고 자정이 되면 휘발성으로 소멸하기 때문에 SortedSet이 아닌 단순 Set을 사용했습니다.

blaxsior

고생하셨습니다!

blaxsior · 2024-08-07T08:44:26Z

build.gradle

+	// jackson
+	implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'
+	implementation 'com.fasterxml.jackson.core:jackson-databind'


jackson이 스프링부트에 내장되어 있어서 필요 없을 것 같아요!

blaxsior · 2024-08-07T08:45:32Z

src/main/java/hyundai/softeer/orange/common/util/ConstantUtil.java

+    public static final String CLAIMS_USER_KEY = "userId";
+    public static final String CLAIMS_ROLE_KEY = "role";
+    public static final String CLAIMS_USER_NAME_KEY = "userName";
+    public static final String JWT_USER_KEY = "eventUser";
    public static final String CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
    public static final String LOCATION = "Location";

    public static final double LIMIT_NEGATIVE_CONFIDENCE = 99.5;
    public static final int COMMENTS_SIZE = 20;
    public static final int SCHEDULED_TIME = 1000 * 60 * 60 * 2;
    public static final int SHORT_URL_LENGTH = 10;
+    public static final int USER_ID_LENGTH = 8;
+    public static final int AUTH_CODE_LENGTH = 6;
+    public static final int JWT_LIFESPAN = 1; // 1시간
+    public static final int AUTH_CODE_EXPIRE_TIME = 5; // 5분


좋은 것 같습니다. 저도 여기에다 admin 부분을 등록해서 변경해둬야겠네요

blaxsior · 2024-08-07T08:47:22Z

src/main/java/hyundai/softeer/orange/core/auth/AuthInterceptor.java

+        // 유효하지 않은 요청은 정적 리소스로 간주하여 ResourceHttpRequestHandler가 대신 처리하기에, HandlerMethod가 아닌 경우는 무시
+        if (!(handler instanceof HandlerMethod)) {
+            return true;
+        }
+


내부 경로가 아니면 HandlerMethod가 아닌 handler이 올 수도 있다는 것을 새롭게 알게 되었네요. 기존에 swagger-ui 경로에 접근하지 못하던 문제도 이걸로 처리할 수 있었겠네요

blaxsior · 2024-08-07T08:48:48Z

src/main/java/hyundai/softeer/orange/event/fcfs/service/FcfsManageService.java

+        if(nowDateTime.isBefore(eventStartTime) && nowDateTime.plusHours(3).isAfter(eventStartTime)) {
+            return new ResponseFcfsInfoDto(nowDateTime, "countdown");
+        } else if(eventStartTime.isBefore(nowDateTime) && eventStartTime.plusHours(7).isAfter(nowDateTime)) {
+            return new ResponseFcfsInfoDto(nowDateTime, "progress");
+        } else {
+            return new ResponseFcfsInfoDto(nowDateTime, "waiting");
+        }


3, 7이라는 숫자는 추후에 변경될 수도 있으니 별도로 분리해두는 것도 좋을 것 같습니다.

win-luck added 20 commits August 7, 2024 11:29

[chore] ConstantUtil에 상수 문자열 추가 (#35)

59eaf16

[feat] EventUserArgumentResolver 구현 (#35)

e0fe948

[chore] WebConfig resolver 반영 및 생성자 주입으로 변경 (#35)

b1fc018

[fix] JWT 필터링 및 추출 과정 에러 수정 (#35)

17c0ad2

[refactor] 기대평 생성 기능 ArgumentResolver 기반 리팩토링 (#35)

fd263e3

[test] 기대평 작성 관련 테스트코드 재작성 (#35)

4a095b9

[chore] 인증번호 관련 로직 일부 표현 수정 (#35)

96903b0

[refactor] FcfsController ArgumentResolver 적용 (#35)

7c50d87

[test] ArgumentResolver 관련 단위테스트 표현 수정 (#35)

732743c

[chore] 여러 매직넘버 상수로 관리 (#35)

b4f81dc

[feat] 인증번호 5분 유효기간 설정 및 예외처리 추가 (#35)

5348547

[chore] JWT 토큰 payLoad에 userName 추가 (#35)

9c856c1

[feat] 선착순 이벤트 정보 조회 구현 (#35)

d52bd05

[fix] AuthInterceptor 예외처리 추가 (#35)

2063d85

[feat] 기대평 참여 상태 조회 기능 구현 (#35)

5864bea

[chore] 참여자 여부 판정을 위한 Redis Key Format 도입 (#35)

7fba82c

[feat] 유저의 선착순 이벤트 참여 상태 조회 기능 구현 (#35)

191b4ff

[feat] 타 선착순 이벤트 구현방안에도 참여 여부 조회 기능 적용 (#35)

2f7cf59

[build] jackson 의존성 추가 (#35)

7fa66a1

[test] 신규 기능 추가에 따른 테스트코드 재작성 (#35)

81b36a2

win-luck added the feat 기능 구현 label Aug 7, 2024

win-luck requested a review from blaxsior August 7, 2024 07:40

win-luck self-assigned this Aug 7, 2024

win-luck linked an issue Aug 7, 2024 that may be closed by this pull request

[feat] EventUser도 Admin처럼 ArgumentResolver 적용하기 (#35) #35

Closed

4 tasks

win-luck added 3 commits August 7, 2024 17:06

[fix] 불필요하거나 잘못된 일부 표현 수정 (#35)

149dead

[test] CommentControllerTest 보강 및 swagger 예외처리 추가 (#35)

bf64b81

[chore] Fcfs 신규 기능 관련 잘못된 표현 수정 (#35)

3348767

win-luck commented Aug 7, 2024

View reviewed changes

[build] 불필요한 것으로 판정된 jackson 라이브러리 삭제 및 관련 코드 제거 (#35)

70bd40b

blaxsior reviewed Aug 7, 2024

View reviewed changes

win-luck added 2 commits August 7, 2024 17:55

[test] 테스트코드 일부 업데이트 (#35)

c6296c0

[chore] 누락된 매직넘버 상수화 (#35)

544357d

win-luck merged commit fe1105d into dev Aug 7, 2024
1 check passed

win-luck deleted the feature/35-feat-argumentresolver branch August 13, 2024 03:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] EventUserArgumentResolver 적용 및 FE 요청에 따른 추가 API 구현 (#35) #38

[feat] EventUserArgumentResolver 적용 및 FE 요청에 따른 추가 API 구현 (#35) #38

win-luck commented Aug 7, 2024 •

edited

Loading

win-luck left a comment

win-luck Aug 7, 2024

blaxsior Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

blaxsior Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

blaxsior Aug 7, 2024

win-luck Aug 7, 2024

blaxsior Aug 7, 2024

win-luck Aug 7, 2024

win-luck Aug 7, 2024

blaxsior left a comment

blaxsior Aug 7, 2024

blaxsior Aug 7, 2024

blaxsior Aug 7, 2024

blaxsior Aug 7, 2024

[feat] EventUserArgumentResolver 적용 및 FE 요청에 따른 추가 API 구현 (#35) #38

[feat] EventUserArgumentResolver 적용 및 FE 요청에 따른 추가 API 구현 (#35) #38

Conversation

win-luck commented Aug 7, 2024 • edited Loading

#️⃣ 연관 이슈

📝 작업 내용

참고 이미지 및 자료

💬 리뷰 요구사항

win-luck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blaxsior left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

win-luck commented Aug 7, 2024 •

edited

Loading