Merge pull request #84 from NMNB-Team/v1/feat/#83-withdrawal-of-membership

Author: 88dldl

nmnb-application/src/main/kotlin/nmnb/application/global/auth/controller/AuthController.kt

@@ -18,6 +18,7 @@ import nmnb.common.response.status.SuccessStatus
 import nmnb.domain.auth.SocialType
 import nmnb.domain.user.User
 import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PatchMapping
 import org.springframework.web.bind.annotation.PathVariable
 import org.springframework.web.bind.annotation.PostMapping
 import org.springframework.web.bind.annotation.RequestMapping
@@ -76,4 +77,16 @@ class AuthController(
     ): BaseResponse<Any> {
         return BaseResponse.onSuccess(SuccessStatus.OK, authService.logout(user, deviceId, accessToken, refreshToken))
     }
+
+    @Operation(summary = "회원탈퇴 API", description = "soft delete를 수행합니다. 데이터는 남아있으나, 조회에서 제외됩니다._숙희")
+    @ApiResponses(
+        ApiResponse(responseCode = "COMMON200", description = "성공입니다."),
+    )
+    @TokenApiResponse
+    @PatchMapping("/withdraw")
+    fun withdraw(
+        @Parameter(name = "user", hidden = true) @AuthUser user: User,
+    ): BaseResponse<Any> {
+        return BaseResponse.onSuccess(SuccessStatus.OK, authService.withdraw(user))
+    }
 }

nmnb-application/src/main/kotlin/nmnb/application/global/auth/service/AuthService.kt

@@ -9,4 +9,5 @@ interface AuthService {
     fun signInWithSocial(accessCode: String, type: SocialType, deviceId: String): AuthUserResponse
     fun refreshToken(refreshToken: String, deviceId: String): AuthTokenResponse
     fun logout(user: User, deviceId: String, accessToken: String, refreshToken: String)
+    fun withdraw(user: User)
 }

nmnb-application/src/main/kotlin/nmnb/application/global/auth/service/AuthServiceImpl.kt

@@ -78,4 +78,9 @@ class AuthServiceImpl(
 
         blacklistService.register(accessToken)
     }
+
+    @Transactional
+    override fun withdraw(user: User) {
+        userRepository.delete(user)
+    }
 }

nmnb-application/src/main/kotlin/nmnb/application/global/config/SecurityConfig.kt

@@ -30,6 +30,7 @@ class SecurityConfig(
         "/v1/api/users/profile",
         "/v1/api/auth/refresh",
         "/v1/api/auth/logout",
+        "/v1/api/auth/withdraw",
     )
 
     @Bean

nmnb-application/src/test/kotlin/nmnb/application/ControllerTestSupport.kt

@@ -13,6 +13,7 @@ import nmnb.application.global.auth.generator.ExtractAccessTokenArgumentResolver
 import nmnb.application.global.auth.generator.ExtractDeviceIdArgumentResolver
 import nmnb.application.global.auth.generator.ExtractRefreshTokenArgumentResolver
 import nmnb.application.global.auth.service.AuthService
+import nmnb.application.global.common.utils.ResponseUtils
 import nmnb.application.global.config.SecurityConfig
 import nmnb.application.global.infrastructure.security.BlacklistService
 import nmnb.application.global.infrastructure.security.JwtProvider
@@ -67,4 +68,7 @@ abstract class ControllerTestSupport {
 
     @MockBean
     protected lateinit var blacklistService: BlacklistService
+
+    @MockBean
+    protected lateinit var responseUtils: ResponseUtils
 }

nmnb-application/src/test/kotlin/nmnb/application/global/auth/controller/AuthControllerTest.kt

@@ -12,6 +12,7 @@ import org.mockito.kotlin.whenever
 import org.springframework.security.test.context.support.WithMockUser
 import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.csrf
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.patch
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
@@ -70,6 +71,28 @@ class AuthControllerTest() : ControllerTestSupport() {
             .andExpect(jsonPath("$.code").value(SuccessStatus.OK.code))
     }
 
+    @DisplayName("회원탈퇴에 성공한다.")
+    @WithMockUser
+    @Test
+    fun withdraw() {
+        // given
+        val deviceId = "deviceId"
+        val accessToken = "access.token"
+        val user = User.fixture()
+
+        mockUserAuthentication(user, accessToken, deviceId)
+
+        // when & then
+        mockMvc.perform(
+            patch("/v1/api/auth/withdraw")
+                .header("X-Access-Token", accessToken)
+                .header("Device-Id", deviceId)
+                .with(csrf()),
+        )
+            .andExpect(status().isOk)
+            .andExpect(jsonPath("$.code").value(SuccessStatus.OK.code))
+    }
+
     private fun mockUserAuthentication(user: User, accessToken: String, deviceId: String) {
         whenever(jwtProvider.getEmailWithValidation(accessToken)).thenReturn(user.email)
         whenever(userRepository.findByEmail(user.email)).thenReturn(user)

nmnb-application/src/test/kotlin/nmnb/application/global/auth/service/AuthServiceImplTest.kt

@@ -1,5 +1,7 @@
 package nmnb.application.global.auth.service
 
+import jakarta.persistence.EntityManager
+import jakarta.persistence.PersistenceContext
 import nmnb.application.IntegrationTestSupport
 import nmnb.application.global.auth.service.dto.KakaoAccount
 import nmnb.application.global.auth.service.dto.KakaoProfile
@@ -46,6 +48,9 @@ class AuthServiceImplTest : IntegrationTestSupport() {
     @MockBean
     private lateinit var jwtProvider: JwtProvider
 
+    @PersistenceContext
+    private lateinit var em: EntityManager
+
     @AfterEach
     fun tearDown() {
         userRepository.deleteAllInBatch()
@@ -152,4 +157,23 @@ class AuthServiceImplTest : IntegrationTestSupport() {
         verify(refreshTokenService).deleteRefreshToken(id, refreshToken)
         verify(blacklistService).register(accessToken)
     }
+
+    @Test
+    @DisplayName("회원탈퇴에 성공한다. soft delete 되어 데이터는 남아있지만, 조회에서는 제외된다. ")
+    fun withdraw() {
+        // given
+        val user = User.fixture()
+        userRepository.save(user)
+
+        // when
+        authService.withdraw(user)
+
+        // then
+        val deleteValue = em.createNativeQuery("SELECT deleted FROM users u WHERE u.user_id = ?")
+            .setParameter(1, user.id)
+            .singleResult
+        assertThat(deleteValue).isEqualTo(true)
+
+        assertThat(userRepository.findByEmail(user.email)).isNull()
+    }
 }

nmnb-domain/src/main/kotlin/nmnb/domain/user/User.kt

@@ -14,9 +14,13 @@ import nmnb.common.domain.SignUpStatus
 import nmnb.domain.JpaBaseEntity
 import nmnb.domain.post.Post
 import nmnb.domain.user.generator.annotation.UserId
+import org.hibernate.annotations.SQLDelete
+import org.hibernate.annotations.SQLRestriction
 import java.util.UUID
 
 @Entity
+@SQLDelete(sql = "UPDATE users SET deleted = true WHERE user_id = ?")
+@SQLRestriction("deleted = false")
 @Table(name = "users")
 class User(
     @Column(nullable = false, unique = true)
@@ -32,6 +36,8 @@ class User(
     @Column(name = "user_id")
     val id: String? = null
 
+    var deleted: Boolean = false
+
     @Enumerated(EnumType.STRING)
     var petOwnershipStatus: PetOwnershipStatus = PetOwnershipStatus.UNKNOWN