feat: 기존 학교 이메일 인증 API 기능(동작 방식) 재구성 #381

seulgi99 · 2024-06-12T16:55:09Z

🌱 관련 이슈

close ✨ 기존 학교 이메일 인증 API 기능(동작 방식) 변경 #376

🤔 작업 배경 및 사유

기존 학교 이메일로 인증번호를 전송하고 그 값을 redis에 저장 후 ttl전에 인증요청을 할 시 인증되도록 구현되어 있습니다.

이 방식을 사용 할 시 아래와 같은 문제점이 나오게 되었습니다.

메일로 인증번호 받고 그 번호를 다시 해당 페이지에서 인증하는 경우 depth가 최소 2번이상 발생
번호 인증 완료 전에 인증페이지를 이탈할 경우 다시 인증메일을 받아야하는 불편함 존재

따라서 해당 문제점을 해결하기 위해 인증 링크를 통해 인증번호 입력 페이지 없이 인증가능하도록 기능 변경을 하게되었습니다.

📌 작업 내용 및 특이사항

메일로 인증번호를 보내는 것이 아닌 인증완료 url을 보내도록 변경(링크 : 프론트 인증 catch page + query string으로 토큰 전달)
해당 페이지 클릭시 프론트에서 백엔드로 해당 토큰으로 인증요청 -> 완료하도록 인증 api 수정
기존 redis에 인증번호, memberId를 저장하던 방식을 아예 제거하고, jwt방식으로 인증하도록 변경하였습니다. (redis를 사용하지않아 redis부하 감소)
검증로직또한 redis에서 ttl로 만료시간을 보는게 아닌 jwt 만료시간을 보도록 변경
해당 생성로직을 전부 jwtUtil에 만드려 했으나 해당 jwtUtil엔 계정토큰(access, refresh용 코드이기에 따로 EmailVerificationTokenUtil에서 생성하도록 하였습니다)
-이메일 인증하기 api GET -> PATCH로 수정

마지막으로, 조금 우려되는 사항이 해당방식으로 했을 시, jwt로만 검증하다보니 여러 인증메일을 요청한다면, 그중 어떤 링크를 선택하든 인증이 된다는 점이 우려됩니다. 사실 이건 어떤 방식이든 제가 재인증 검증을 넣어둬서 상관없지만 기획이 아래처럼 어떠냐에 따라 변경해야 할 수도 있을것 같습니다.

가장 최근에 보낸 인증메일의 링크로만 인증가능하도록 해야한다. -> redis에 멤버 id별로 토큰을 저장해둬서 해당 링크에 삽입된 토큰인지 검증하도록 한다
모든 메일의 인증링크로 인증가능하다. -> 변경사항 없을 것

이렇게되므로 기획적으로 한번 논의해봐야할것 같습니다.

☑️ToDo

프론트에게 이메일인증 링크 catch해서 인증하는 페이지 변경 및 로직 체크해주기
이메일 인증 변경점 프론트 담당자와 로직 동기화하기

📝 참고사항

📚 기타

코드는 기존 작업자 코드 스타일대로 최대한 짯는데 여러분들 입맛에 맞을지는 모르겠네요 ㅠ

github-actions · 2024-06-12T16:56:03Z

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
gdsc	check	8.5	✅

Sangwook02

확인했습니다~

src/main/java/com/gdschongik/gdsc/domain/member/domain/Member.java

Sangwook02 · 2024-06-13T05:14:07Z

src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java

@@ -43,6 +43,7 @@ public enum ErrorCode {
    UNIV_NOT_VERIFIED(HttpStatus.CONFLICT, "재학생 인증이 완료되지 않았습니다."),
    DISCORD_NOT_VERIFIED(HttpStatus.CONFLICT, "디스코드 인증이 완료되지 않았습니다."),
    BEVY_NOT_VERIFIED(HttpStatus.CONFLICT, "GDSC Bevy 가입이 완료되지 않았습니다."),
+    EMAIL_ALREADY_VERIFIED(HttpStatus.CONFLICT, "이미 이메일 인증된 회원입니다."),


line 50과 중복되는 것 같습니다~

아 이건 line50과 좀 다른게 line50의 경우엔
이메일 중복검증 이고 이건 인증을 이미 한 회원이 재인증한경우 에러뱉도록 하는거에요!

src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java

src/main/java/com/gdschongik/gdsc/global/util/email/EmailVerificationTokenUtil.java

.../java/com/gdschongik/gdsc/domain/email/application/UnivEmailVerificationLinkSendService.java

src/main/java/com/gdschongik/gdsc/domain/email/application/UnivEmailVerificationService.java

...ain/java/com/gdschongik/gdsc/domain/email/dto/request/UnivEmailTokenVerificationRequest.java

Sangwook02 · 2024-06-13T05:30:55Z

src/main/java/com/gdschongik/gdsc/domain/email/api/OnboardingUnivEmailController.java

    public ResponseEntity<Void> sendUnivEmailVerificationLink(
-            @RequestParam(VERIFY_EMAIL_REQUEST_PARAMETER_KEY) String verificationCode) {
-        univEmailVerificationService.verifyMemberUnivEmail(verificationCode);
+            @RequestBody @Valid UnivEmailTokenVerificationRequest verificationToken) {


dto는 request라는 이름으로 받고 있습니다~

Suggested change

@RequestBody @Valid UnivEmailTokenVerificationRequest verificationToken) {

@RequestBody @Valid UnivEmailTokenVerificationRequest request) {

메일로 보내는 링크는 /onboarding/verify-email?%token={token value}의 형태던데,
그걸 클릭하면 인증되는 방식 아닌가요?
만약 맞다면 파라미터가 아닌 body로 토큰을 받는 이유가 궁금합니다!

메일로 보내는 링크는 /onboarding/verify-email?%token={token value}의 형태던데, 그걸 클릭하면 인증되는 방식 아닌가요? 만약 맞다면 파라미터가 아닌 body로 토큰을 받는 이유가 궁금합니다!

이거 하나만 설명 부탁드립니다!

src/main/java/com/gdschongik/gdsc/domain/email/application/UnivEmailVerificationService.java

Co-authored-by: Cho Sangwook <[email protected]>

github-actions · 2024-06-13T07:11:08Z

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
gdsc	check	8.5	❌

github-actions · 2024-06-13T07:16:36Z

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
gdsc	check	8.5	✅

uwoobeat

lgtm

AlmondBreez3

lgtm

단순한 궁금증인데 이건 테스트코드로 못짜나용?

Sangwook02

백엔드 팀 온보딩 가이드를 보시면 커밋 메시지 컨벤션이 정리되어있습니다.
대체로 잘 지켜주셨는데, 콜론 앞에는 공백이 없어야 합니다!
해당 내용 한번 더 확인해보시고 pr 제목만 컨벤션에 맞게 수정 부탁드립니다!

uwoobeat · 2024-06-15T11:57:15Z

lgtm

단순한 궁금증인데 이건 테스트코드로 못짜나용?

외부 의존성 경계를 기준으로 모킹해서 테스트할 수 있어요
저희는 util 기준으로 외부 의존성 분리하고 있어서 (memberUtil, jda는 제외) util을 모킹하는 식으로 가능합니다

Sangwook02

lgtm

…into feature/376-univ-email-verify

github-actions · 2024-06-17T06:27:03Z

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
gdsc	check	8.5	❌

github-actions · 2024-06-17T06:28:30Z

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
gdsc	check	8.5	✅

ImNM · 2024-06-17T13:15:53Z

슬기화이팅

seulgi99 added 4 commits June 12, 2024 22:39

refactor : 학교 이메일 인증 코드 삭제 후 이메일 토큰 생성 및 파싱 로직 추가

2ac5096

feat : 학교 인증 메일 발송 요청 api redis로 인증정보 저장하던 로직 삭제 후 토큰을 포함한 정보 전송하도록 변경

3b2b523

feat : 학교 인증 메일 인증하기 api에 redis로 인증정보 검색 제거 및 토큰 검증하여 인증정보 update 하도록 변경

5f19b5e

refactor : 이메일 인증하기 api Patch로 변경 및 이미 인증되었으면 에러뱉도록 검증 추가

304c157

seulgi99 added the ⚓ Domain: Membership 멤버십 관련 작업 label Jun 12, 2024

seulgi99 self-assigned this Jun 12, 2024

seulgi99 requested a review from a team as a code owner June 12, 2024 16:55

seulgi99 requested review from Sangwook02, uwoobeat and AlmondBreez3 June 12, 2024 16:55

Sangwook02 requested changes Jun 13, 2024

View reviewed changes

refactor : ERRORCODE IMPORT 적용 후 static 변수 사용하도록 수정

b275354

Co-authored-by: Cho Sangwook <[email protected]>

seulgi99 added 4 commits June 13, 2024 16:11

refactor : 사용하지 않는 redis로직 제거

5fbce28

refactor : 인증코드 만료시간 -> 인증토큰 만료시간으로 명명 변경

397716d

refactor : 이메일 인증 Request 클래스 이름 변경

94a7e71

refactor : spotless 적용

ae131ed

uwoobeat approved these changes Jun 13, 2024

View reviewed changes

AlmondBreez3 approved these changes Jun 13, 2024

View reviewed changes

Sangwook02 requested changes Jun 14, 2024

View reviewed changes

seulgi99 changed the title ~~feat : 기존 학교 이메일 인증 API 기능(동작 방식) 재구성~~ feat: 기존 학교 이메일 인증 API 기능(동작 방식) 재구성 Jun 16, 2024

Sangwook02 approved these changes Jun 16, 2024

View reviewed changes

Merge branch 'develop' of https://github.com/GDSC-Hongik/gdsc-server …

4eb1fdf

…into feature/376-univ-email-verify

refactor : spotless 적용

9d5ccf3

seulgi99 merged commit 8ead2cb into develop Jun 17, 2024
1 check passed

seulgi99 deleted the feature/376-univ-email-verify branch June 17, 2024 06:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 기존 학교 이메일 인증 API 기능(동작 방식) 재구성 #381

feat: 기존 학교 이메일 인증 API 기능(동작 방식) 재구성 #381

seulgi99 commented Jun 12, 2024 •

edited

Loading

github-actions bot commented Jun 12, 2024

Check Style and Test to Develop :: build-test

Sangwook02 left a comment

Sangwook02 Jun 13, 2024

seulgi99 Jun 13, 2024

Sangwook02 Jun 13, 2024

Sangwook02 Jun 13, 2024

Sangwook02 Jun 14, 2024

github-actions bot commented Jun 13, 2024

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 13, 2024

Check Style and Test to Develop :: build-test

uwoobeat left a comment

AlmondBreez3 left a comment

Sangwook02 left a comment

uwoobeat commented Jun 15, 2024

Sangwook02 left a comment

github-actions bot commented Jun 17, 2024

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 17, 2024

Check Style and Test to Develop :: build-test

ImNM commented Jun 17, 2024

	@RequestBody @Valid UnivEmailTokenVerificationRequest verificationToken) {
	@RequestBody @Valid UnivEmailTokenVerificationRequest request) {

feat: 기존 학교 이메일 인증 API 기능(동작 방식) 재구성 #381

feat: 기존 학교 이메일 인증 API 기능(동작 방식) 재구성 #381

Conversation

seulgi99 commented Jun 12, 2024 • edited Loading

🌱 관련 이슈

🤔 작업 배경 및 사유

📌 작업 내용 및 특이사항

☑️ToDo

📝 참고사항

📚 기타

github-actions bot commented Jun 12, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Sangwook02 left a comment

Choose a reason for hiding this comment

Sangwook02 Jun 13, 2024

Choose a reason for hiding this comment

seulgi99 Jun 13, 2024

Choose a reason for hiding this comment

Sangwook02 Jun 13, 2024

Choose a reason for hiding this comment

Sangwook02 Jun 13, 2024

Choose a reason for hiding this comment

Sangwook02 Jun 14, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 13, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 13, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

uwoobeat left a comment

Choose a reason for hiding this comment

AlmondBreez3 left a comment

Choose a reason for hiding this comment

Sangwook02 left a comment

Choose a reason for hiding this comment

uwoobeat commented Jun 15, 2024

Sangwook02 left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 17, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 17, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

ImNM commented Jun 17, 2024

seulgi99 commented Jun 12, 2024 •

edited

Loading