🔗 :: (#430) 비밀번호 찾기 이메일 인증 버그

[parkuiery]

개요

비밀번호 찾기에서 이메일 인증 예외처리 메세지를 변경하였습니다

작업 내용

할 말

없음

Summary by CodeRabbit

• 새로운 기능
  • 이메일 인증 과정에서 학생을 찾을 수 없을 때 표시되는 메시지가 업데이트되었습니다.
• 버그 수정
  • 이메일 인증 클릭 시 발생하는 오류 처리 로직이 개선되어, 이메일 설명의 유형이 명확하게 구분됩니다.
• 문서화
  • 문자열 리소스에서 이메일 확인 메시지가 변경되었습니다.

[coderabbitai]

Walkthrough

이 변경 사항은 VerifyEmailScreen.kt와 VerifyEmailViewModel.kt 파일에서 이메일 확인 프로세스와 관련된 사용자 피드백을 수정합니다. VerifyEmail 컴포저블 함수에서 NotFoundStudent 사이드 이펙트가 발생할 때 표시되는 메시지를 변경하고, VerifyEmailViewModel의 onAuthenticationClick 함수에서 ConflictException 처리 방식을 개선하여 이메일 설명 유형을 명확히 구분합니다. 또한, strings.xml 파일에서 이메일이 등록되지 않았음을 알리는 새로운 문자열 리소스를 추가했습니다.

Changes

파일 경로	변경 요약
feature/verify-email/src/main/java/team/retum/jobis/verify/email/ui/VerifyEmailScreen.kt	NotFoundStudent 사이드 이펙트 발생 시 표시되는 메시지를 R.string.toast_check_email에서 R.string.toast_not_found_email로 변경.
feature/verify-email/src/main/java/team/retum/jobis/verify/email/viewmodel/VerifyEmailViewModel.kt	onAuthenticationClick 함수에서 ConflictException 처리 방식을 수정하여 emailDescriptionType을 DescriptionType.Error로 설정.
feature/verify-email/src/main/res/values/strings.xml	toast_check_email 문자열을 제거하고 toast_not_found_email 문자열로 대체.

Possibly related PRs

• 🔗 :: (#369) 인증코드 전송 버그 #376: VerifyEmailScreen.kt와 VerifyEmailViewModel.kt 파일을 수정하여 새로운 사이드 이펙트 NotFoundStudent를 도입하고 이메일 참조 처리 방식을 업데이트함.
• 🔗 :: (#396) 이메일 주소 중복 버그 #397: VerifyEmailViewModel.kt에서 이메일 생성 및 처리 방식을 수정하여 이메일 확인 피드백과 관련된 내용을 다룸.
• 🔗 :: (#399) 인증하기 텍스트 필드 높이 수정 #401: VerifyEmailScreen.kt에서 인증 코드 전송을 위한 상호작용 모델을 개선하여 사용자 피드백 변경과 밀접한 관련이 있음.
• 🚀 :: (#418) 전체 예외 처리 #423: 새로운 예외 처리를 도입하여 이메일 확인 과정에서 사용자 피드백 관리에 간접적으로 영향을 줄 수 있음.

Suggested labels

리팩토링

Suggested reviewers

• Tmdhoon2

🐰 변화의 기쁨을 노래해요,
이메일 확인, 이제는 더 명확해요.
오류 메시지, 새로 태어나,
사용자에게 더 나은 길을 열어줘요!
🥕✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

feature/verify-email/src/main/java/team/retum/jobis/verify/email/viewmodel/VerifyEmailViewModel.kt (1)

96-101: 에러 처리 로직 개선을 위한 제안사항

현재 구현은 잘 작동하지만, 다음과 같은 개선사항을 고려해보시면 좋을 것 같습니다:

1. 각 예외 상황에 대한 구체적인 에러 메시지를 추가하여 사용자에게 더 명확한 정보를 제공
2. 에러 처리 로직을 별도의 확장 함수로 분리하여 코드 재사용성 향상
3. 각 예외 처리 케이스에 대한 주석 추가

예시 리팩토링:

+ private fun handleEmailError(exception: Exception) {
+     when (exception) {
+         is ConflictException -> setState {
+             state.value.copy(
+                 emailDescriptionType = DescriptionType.Error,
+                 showEmailDescription = true,
+                 // 구체적인 에러 메시지 추가
+                 errorMessage = "이미 등록된 이메일입니다"
+             )
+         }
+         // 다른 예외 처리...
+     }
+ }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 65ffe2a and 10816ad.

📒 Files selected for processing (3)

• feature/verify-email/src/main/java/team/retum/jobis/verify/email/ui/VerifyEmailScreen.kt (1 hunks)
• feature/verify-email/src/main/java/team/retum/jobis/verify/email/viewmodel/VerifyEmailViewModel.kt (1 hunks)
• feature/verify-email/src/main/res/values/strings.xml (1 hunks)

🔇 Additional comments (4)

feature/verify-email/src/main/res/values/strings.xml (1)

21-21: 사용자 피드백 메시지가 개선되었습니다!

이전의 일반적인 메시지 대신 구체적인 오류 원인을 설명하는 메시지로 변경되어 사용자 경험이 향상되었습니다. 메시지가 명확하고 다른 문자열들과 일관된 톤을 유지하고 있습니다.

feature/verify-email/src/main/java/team/retum/jobis/verify/email/viewmodel/VerifyEmailViewModel.kt (2)

96-101: ConflictException 처리 로직이 개선되었습니다.

이메일 설명 타입을 Error로 명시적으로 설정하여 사용자에게 더 명확한 피드백을 제공하도록 개선되었습니다. 이는 이메일 인증 과정에서 발생하는 예외 상황을 더 정확하게 표현할 수 있게 해줍니다.

---

96-101: 이메일 인증 버그 수정 확인 필요

구현된 변경사항이 PR의 목적인 이메일 인증 버그를 해결하는 것으로 보입니다. 다음 시나리오에 대한 테스트를 진행해주시기 바랍니다:

1. 존재하지 않는 이메일 입력 시 처리
2. 이미 등록된 이메일 입력 시 처리
3. 인증 코드 만료 시나리오

✅ Verification successful

이메일 인증 예외 처리가 적절히 구현되어 있음을 확인했습니다

VerifyEmailViewModel의 구현을 검토한 결과, PR에서 언급된 이메일 인증 버그에 대한 수정이 다음과 같이 적절하게 구현되어 있습니다:

• 존재하지 않는 이메일: NotFoundException 처리를 통해 NotFoundStudent 사이드 이펙트 발생
• 이미 등록된 이메일: ConflictException 처리를 통해 에러 상태 표시
• 인증 코드 만료: NotFoundException 처리를 통해 AuthenticationCodeExpiration 사이드 이펙트 발생

각 예외 상황에 대한 적절한 UI 피드백이 구현되어 있어 사용자에게 명확한 안내가 가능합니다.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 관련 테스트 코드 확인
rg -t kotlin "VerifyEmailViewModel.*Test" 

Length of output: 43

---

Script:

#!/bin/bash
# 이메일 검증 관련 코드 확인
rg -t kotlin "email.*verification|verify.*email" -B 2 -A 2

# 이메일 검증 관련 예외 처리 코드 확인
ast-grep --pattern 'catch ($error) {
  $$$
}'

# 이메일 관련 상태 변경 코드 확인
rg -t kotlin "emailDescriptionType.*Error" -B 3 -A 3

Length of output: 8256

---

Script:

#!/bin/bash
# ConflictException 처리 확인
rg -t kotlin "ConflictException" -B 5 -A 5

# 이메일 검증 관련 예외 처리 코드 자세히 확인
rg -t kotlin "catch.*Exception.*email" -B 5 -A 10

# VerifyEmailViewModel의 전체 구현 확인
fd -e kt "VerifyEmailViewModel" --exec cat {}

Length of output: 24457

feature/verify-email/src/main/java/team/retum/jobis/verify/email/ui/VerifyEmailScreen.kt (1)

71-73: 이메일 미등록 사용자에 대한 오류 메시지가 적절하게 수정되었습니다.

사용자에게 더 명확한 피드백을 제공하도록 메시지가 개선되었습니다.

리소스 문자열이 올바르게 정의되어 있는지 확인하겠습니다:

✅ Verification successful

이메일 미등록 오류 메시지 리소스가 정상적으로 확인되었습니다.

strings.xml에 toast_not_found_email 문자열 리소스가 올바르게 정의되어 있어 사용자에게 적절한 피드백이 제공될 것입니다.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the string resource exists
rg "toast_not_found_email" -g "*.xml"

Length of output: 154