Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feature: 프로필 수정 API 구현 #131

Merged
merged 7 commits into from
May 19, 2024
Merged

feature: 프로필 수정 API 구현 #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
29206d9
feat: 회원 프로필 수정 컨트롤러 구현
hgo641 May 9, 2024
f685b9f
feat: 회원 프로필 수정 서비스 구현
hgo641 May 9, 2024
44adc8b
test: 회원 프로필 수정 컨트롤러 테스트 작성
hgo641 May 9, 2024
92e555a
test: 회원 프로필 수정 서비스 테스트 작성
hgo641 May 9, 2024
9cd87be
feat: 닉네임 변경시 중복을 검증하는 로직 변경
hgo641 May 16, 2024
70c3577
refactor: command가 Nickname객체를 가지게 변경
hgo641 May 16, 2024
5ded692
chore: 프로필 추가 API 주석 처리
hgo641 May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/main/kotlin/com/petqua/application/member/MemberService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package com.petqua.application.member

import com.petqua.application.member.dto.MemberAddProfileCommand
import com.petqua.application.member.dto.MemberSignUpCommand
import com.petqua.application.member.dto.UpdateProfileCommand
import com.petqua.application.token.AuthTokenInfo
import com.petqua.application.token.TokenService
import com.petqua.common.domain.findActiveByIdOrThrow
Expand All @@ -19,6 +20,7 @@ import com.petqua.domain.member.nickname.NicknameWordRepository
import com.petqua.domain.policy.bannedword.BannedWordRepository
import com.petqua.domain.policy.bannedword.BannedWords
import com.petqua.exception.member.MemberException
import com.petqua.exception.member.MemberExceptionType.ALREADY_EXIST_NICKNAME
import com.petqua.exception.member.MemberExceptionType.FAILED_NICKNAME_GENERATION
import com.petqua.exception.member.MemberExceptionType.HAS_SIGNED_UP_MEMBER
import com.petqua.exception.member.MemberExceptionType.NOT_FOUND_MEMBER
Expand Down Expand Up @@ -88,4 +90,23 @@ class MemberService(
val bannedWords = BannedWords(bannedWordRepository.findAll())
bannedWords.validateContainingBannedWord(name)
}

fun updateProfile(command: UpdateProfileCommand) {
validateNickname(command.nickname, command.memberId)
val member = memberRepository.findActiveByIdOrThrow(command.memberId) {
MemberException(NOT_FOUND_MEMBER)
}
Comment on lines +96 to +98
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

회원 존재 여부 검증은 토큰에서 memberId를 추출할 때 이미 진행하고 있어요. 굳이 또 검증할 필요는 없다고 생각하는데 어떠신가요?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Combi153 @TaeyeonRoyce
맞습니다! 그런데 코드를 구현할 때는 토큰에서 member검증하는 코드는 이 서비스 로직의 트랜잭션에 포함되지 않는 코드이기 때문에 확실히 검증하려면 트랜잭션내에서 한번 더 확인해도 좋겠다고 생각했었어요! 혹시 잘못 생각하고 있는 부분이 있다면 알려주세요!😀

음 그런데 확실히 그 잠깐 사이에 멤버가 삭제되어버리는 일도 없을 것 같고... 실제로 중간에서 멤버가 삭제된다고 해도 문제가 생길 것 같지도 않고... 너무 과한 검증같긴하네여 역시 뺄까요?!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

불필요할 것 같아요.
말씀하신대로 해당 상황도 발생할 경우가 매우 적고, 트랜잭션에 포함되어 있다 하더라도 동시에 다른 요청에서 삭제하는 경우 보장이되나요?

저는 빼는게 좋을 것 같습니다!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

동시에 다른 요청에서 삭제하는 경우 보장이되나요?
아 그렇네요 ?! 빼고 오겠습니다

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

빼려고 갔다왔는데... 어차피 해당 코드에서 member를 조회해와야하잖아요??...
그럼 두 분은 그냥 memberRepository.findById(command.memberId).get()... 이렇게 가져오는 걸 원하시는 건가요?
검증 코드... 그냥 둬도 좋을지도?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

아니면 body로 변경된 정보들은 변경된 상태로 넘어오고, 변경되지 않은 정보는 원본 상태로 함께 넘어오는 상태로 생각하고
memberRepository에서 바로 update쿼리 날리는 걸 말하셨던 건가요?.?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

아뇨아뇨 현재 방안으로 유지해도 좋을 것 같아요!

#131 (comment) 해당 코멘트에 대한 답변이었어요.

말씀대로 어차피 Member를 사용해야한다면 위 방식대로 써도 괜찮을 것 같습니다!

member.updateNickname(command.nickname)
}

private fun validateNickname(nickname: Nickname, memberId: Long) {
validateContainingBannedWord(nickname.value)
validateDuplicatedNickname(nickname, memberId)
}

private fun validateDuplicatedNickname(nickname: Nickname, memberId: Long) {
throwExceptionWhen(memberRepository.existsMemberByNicknameAndIdNot(nickname, memberId)) {
MemberException(ALREADY_EXIST_NICKNAME)
}
}
}
9 changes: 9 additions & 0 deletions src/main/kotlin/com/petqua/application/member/dto/MemberDtos.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import com.petqua.domain.member.PetFish
import com.petqua.domain.member.PetFishCount
import com.petqua.domain.member.PetFishSex
import com.petqua.domain.member.PetFishes
import com.petqua.domain.member.nickname.Nickname
import java.time.YearMonth

data class MemberSignUpCommand(
Expand Down Expand Up @@ -51,3 +52,11 @@ data class PetFishAddCommand(
)
}
}

data class UpdateProfileCommand(
val memberId: Long,
val nickname: Nickname,
) {

constructor(memberId: Long, nickname: String) : this(memberId, Nickname.from(nickname))
}
2 changes: 2 additions & 0 deletions src/main/kotlin/com/petqua/domain/member/MemberRepository.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,7 @@ interface MemberRepository : JpaRepository<Member, Long> {

fun existsMemberByNickname(nickname: Nickname): Boolean

fun existsMemberByNicknameAndIdNot(nickname: Nickname, id: Long): Boolean

fun existsMemberByAuthCredentialsId(authCredentialsId: Long): Boolean
}
1 change: 1 addition & 0 deletions src/main/kotlin/com/petqua/exception/member/MemberExceptionType.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ enum class MemberExceptionType(
INVALID_MEMBER_NICKNAME(BAD_REQUEST, "M16", "유효하지 않은 회원 닉네임입니다."),

CONTAINING_BANNED_WORD_NAME(BAD_REQUEST, "M20", "이름에 금지 단어를 포함할 수 없습니다."),
ALREADY_EXIST_NICKNAME(BAD_REQUEST, "M21", "이미 사용 중인 닉네임입니다."),

INVALID_MEMBER_STATE(INTERNAL_SERVER_ERROR, "M90", "유효하지 않은 회원 상태입니다."),
FAILED_NICKNAME_GENERATION(LOOP_DETECTED, "M91", "서버에서 회원 닉네임을 생성하지 못했습니다.")
Expand Down
28 changes: 21 additions & 7 deletions src/main/kotlin/com/petqua/presentation/member/MemberController.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import com.petqua.common.config.SIGN_UP_TOKEN_SECURITY_SCHEME_KEY
import com.petqua.domain.auth.Auth
import com.petqua.domain.auth.LoginMember
import com.petqua.domain.auth.SignUpGuest
import com.petqua.presentation.member.dto.MemberAddProfileRequest
import com.petqua.presentation.member.dto.MemberSignUpRequest
import com.petqua.presentation.member.dto.UpdateProfileRequest
import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.security.SecurityRequirement
Expand All @@ -19,6 +19,7 @@ import org.springframework.http.HttpStatus.CREATED
import org.springframework.http.ResponseCookie
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PatchMapping
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.RequestMapping
Expand Down Expand Up @@ -69,16 +70,29 @@ class MemberController(
return ResponseEntity.noContent().build()
}

@Operation(summary = "회원 물생활 프로필 입력 API", description = "회원의 추가적인 물생활 정보를 입력합니다")
@ApiResponse(responseCode = "204", description = "회원 물생활 프로필 입력 성공")
// @Operation(summary = "회원 물생활 프로필 입력 API", description = "회원의 추가적인 물생활 정보를 입력합니다")
// @ApiResponse(responseCode = "204", description = "회원 물생활 프로필 입력 성공")
// @SecurityRequirement(name = ACCESS_TOKEN_SECURITY_SCHEME_KEY)
// @PostMapping("/profiles")
// fun addProfile(
// @Auth loginMember: LoginMember,
// @RequestBody request: MemberAddProfileRequest,
// ): ResponseEntity<Unit> {
// val command = request.toCommand(loginMember.memberId)
// memberService.addProfile(command)
// return ResponseEntity.noContent().build()
// }

@Operation(summary = "회원 프로필 수정 API", description = "회원의 프로필 정보를 수정합니다")
@ApiResponse(responseCode = "204", description = "회원 프로필 수정 성공")
@SecurityRequirement(name = ACCESS_TOKEN_SECURITY_SCHEME_KEY)
@PostMapping("/profiles")
fun addProfile(
@PatchMapping("/profiles")
fun updateProfile(
@Auth loginMember: LoginMember,
@RequestBody request: MemberAddProfileRequest,
@RequestBody request: UpdateProfileRequest,
): ResponseEntity<Unit> {
val command = request.toCommand(loginMember.memberId)
memberService.addProfile(command)
memberService.updateProfile(command)
return ResponseEntity.noContent().build()
}
}
17 changes: 17 additions & 0 deletions src/main/kotlin/com/petqua/presentation/member/dto/MemberDtos.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package com.petqua.presentation.member.dto
import com.petqua.application.member.dto.MemberAddProfileCommand
import com.petqua.application.member.dto.MemberSignUpCommand
import com.petqua.application.member.dto.PetFishAddCommand
import com.petqua.application.member.dto.UpdateProfileCommand
import io.swagger.v3.oas.annotations.media.Schema
import java.time.YearMonth

Expand Down Expand Up @@ -89,3 +90,19 @@ data class PetFishAddRequest(
)
val count: Int,
)

data class UpdateProfileRequest(
@Schema(
description = "닉네임",
example = "펫쿠아"
)
val nickname: String,
) {

fun toCommand(memberId: Long): UpdateProfileCommand {
return UpdateProfileCommand(
memberId = memberId,
nickname = nickname,
)
}
}
69 changes: 69 additions & 0 deletions src/test/kotlin/com/petqua/application/member/MemberServiceTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import com.ninjasquad.springmockk.SpykBean
import com.petqua.application.member.dto.MemberAddProfileCommand
import com.petqua.application.member.dto.MemberSignUpCommand
import com.petqua.application.member.dto.PetFishAddCommand
import com.petqua.application.member.dto.UpdateProfileCommand
import com.petqua.domain.auth.AuthCredentialsRepository
import com.petqua.domain.fish.FishRepository
import com.petqua.domain.member.FishTankRepository
Expand All @@ -20,6 +21,7 @@ import com.petqua.domain.member.nickname.NicknameWordRepository
import com.petqua.domain.policy.bannedword.BannedWord
import com.petqua.domain.policy.bannedword.BannedWordRepository
import com.petqua.exception.member.MemberException
import com.petqua.exception.member.MemberExceptionType.ALREADY_EXIST_NICKNAME
import com.petqua.exception.member.MemberExceptionType.CONTAINING_BANNED_WORD_NAME
import com.petqua.exception.member.MemberExceptionType.FAILED_NICKNAME_GENERATION
import com.petqua.exception.member.MemberExceptionType.HAS_SIGNED_UP_MEMBER
Expand All @@ -30,6 +32,7 @@ import com.petqua.exception.member.MemberExceptionType.INVALID_MEMBER_FISH_TANK_
import com.petqua.exception.member.MemberExceptionType.INVALID_MEMBER_PET_FISH
import com.petqua.exception.member.MemberExceptionType.INVALID_MEMBER_PET_FISH_COUNT
import com.petqua.exception.member.MemberExceptionType.NOT_FOUND_MEMBER
import com.petqua.test.DataCleaner
import com.petqua.test.fixture.authCredentials
import com.petqua.test.fixture.fish
import com.petqua.test.fixture.member
Expand Down Expand Up @@ -57,6 +60,7 @@ class MemberServiceTest(
private val fishRepository: FishRepository,
private val petFishRepository: PetFishRepository,
private val fishTankRepository: FishTankRepository,
private val dataCleaner: DataCleaner,

@SpykBean private val nicknameGenerator: NicknameGenerator,
) : BehaviorSpec({
Expand Down Expand Up @@ -444,4 +448,69 @@ class MemberServiceTest(
}
}
}

Given("프로필 수정을 할 때") {
val member = memberRepository.save(member(nickname = "닉네임"))
bannedWordRepository.save(BannedWord(word = "금지 단어"))

When("닉네임을 입력하면") {
Comment on lines +452 to +456
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

테스트 좋아요 👍

val command = UpdateProfileCommand(
memberId = member.id,
nickname = "변경된 닉네임",
)
memberService.updateProfile(command)

Then("닉네임을 수정한다") {
val updatedMember = memberRepository.findById(member.id).get()

assertSoftly {
updatedMember.nickname.value shouldBe "변경된 닉네임"
}
}
}

When("닉네임에 부적절한 단어가 들어가면") {
val command = UpdateProfileCommand(
memberId = member.id,
nickname = "금지 단어",
)

Then("예외를 던진다") {
shouldThrow<MemberException> {
memberService.updateProfile(command)
}.exceptionType() shouldBe CONTAINING_BANNED_WORD_NAME
}
}

When("이미 다른 회원이 사용중인 닉네임이라면") {
memberRepository.save(member(nickname = "변경된 닉네임"))
val command = UpdateProfileCommand(
memberId = member.id,
nickname = "변경된 닉네임",
)

Then("예외를 던진다") {
shouldThrow<MemberException> {
memberService.updateProfile(command)
}.exceptionType() shouldBe ALREADY_EXIST_NICKNAME
}
}

When("회원이 존재하지 않으면") {
val command = UpdateProfileCommand(
memberId = Long.MAX_VALUE,
nickname = "변경된 닉네임",
)

Then("예외를 던진다") {
shouldThrow<MemberException> {
memberService.updateProfile(command)
}.exceptionType() shouldBe NOT_FOUND_MEMBER
}
}
}

afterContainer {
dataCleaner.clean()
}
})
19 changes: 19 additions & 0 deletions src/test/kotlin/com/petqua/presentation/member/MemberControllerSteps.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package com.petqua.presentation.member

import com.petqua.presentation.member.dto.MemberAddProfileRequest
import com.petqua.presentation.member.dto.MemberSignUpRequest
import com.petqua.presentation.member.dto.UpdateProfileRequest
import io.restassured.module.kotlin.extensions.Extract
import io.restassured.module.kotlin.extensions.Given
import io.restassured.module.kotlin.extensions.Then
Expand Down Expand Up @@ -59,3 +60,21 @@ fun requestAddProfile(
response()
}
}

fun requestUpdateProfile(
request: UpdateProfileRequest,
accessToken: String,
): Response {
return Given {
log().all()
contentType(APPLICATION_JSON_VALUE)
body(request)
auth().preemptive().oauth2(accessToken)
} When {
patch("/members/profiles")
} Then {
log().all()
} Extract {
response()
}
}
Loading
Loading