refactor: oAuth에 연동된 유저이름이 변경되었을때 identity user 이름도 싱크한다 (#175)

Author: devxb

src/main/kotlin/org/gitanimals/identity/app/AppleLoginFacade.kt

@@ -27,6 +27,7 @@ class AppleLoginFacade(
                     entryPoint = EntryPoint.APPLE,
                     profileImage = profileImage,
                     contributionPerYears = mapOf(),
+                    authenticationId = username,
                 )
             }
         }

src/main/kotlin/org/gitanimals/identity/app/GithubLoginFacade.kt

@@ -15,27 +15,65 @@ class GithubLoginFacade(
     fun login(code: String): String {
         val oauthUserResponse = oauth2Api.getOauthUsername(oauth2Api.getToken(code))
 
-        val user = when (userService.existsUser(oauthUserResponse.username, EntryPoint.GITHUB)) {
-            true -> userService.getUserByNameAndEntryPoint(
-                oauthUserResponse.username,
-                EntryPoint.GITHUB,
-            )
-
-            else -> {
-                val contributedYears =
-                    contributionApi.getAllContributionYearsWithToken(oauthUserResponse.username)
-                val contributionCountPerYears =
-                    contributionApi.getContributionCountWithToken(
+        val user = when (userService.existsByEntryPointAndAuthenticationId(
+            entryPoint = EntryPoint.GITHUB,
+            authenticationId = oauthUserResponse.id,
+        )) {
+            true -> {
+                runCatching {
+                    userService.getUserByNameAndEntryPoint(
                         oauthUserResponse.username,
-                        contributedYears
+                        EntryPoint.GITHUB,
+                    )
+                }.getOrElse {
+                    if (it is IllegalArgumentException) {
+                        userService.updateUsernameByEntryPointAndAuthenticationId(
+                            username = oauthUserResponse.username,
+                            entryPoint = EntryPoint.GITHUB,
+                            authenticationId = oauthUserResponse.id,
+                        )
+                        return@getOrElse userService.getUserByNameAndEntryPoint(
+                            oauthUserResponse.username,
+                            EntryPoint.GITHUB,
+                        )
+                    }
+                    throw it
+                }
+            }
+
+            false -> {
+                if (userService.existsUser(
+                        username = oauthUserResponse.username,
+                        entryPoint = EntryPoint.GITHUB,
+                    )
+                ) {
+                    userService.updateUserAuthInfoByUsername(
+                        username = oauthUserResponse.username,
+                        entryPoint = EntryPoint.GITHUB,
+                        authenticationId = oauthUserResponse.id,
                     )
 
-                userService.newUser(
-                    username = oauthUserResponse.username,
-                    entryPoint = EntryPoint.GITHUB,
-                    profileImage = oauthUserResponse.profileImage,
-                    contributionPerYears = contributionCountPerYears,
-                )
+                    userService.getUserByNameAndEntryPoint(
+                        username = oauthUserResponse.username,
+                        entryPoint = EntryPoint.GITHUB,
+                    )
+                } else {
+                    val contributedYears =
+                        contributionApi.getAllContributionYearsWithToken(oauthUserResponse.username)
+                    val contributionCountPerYears =
+                        contributionApi.getContributionCountWithToken(
+                            oauthUserResponse.username,
+                            contributedYears,
+                        )
+
+                    userService.newUser(
+                        username = oauthUserResponse.username,
+                        entryPoint = EntryPoint.GITHUB,
+                        authenticationId = oauthUserResponse.id,
+                        profileImage = oauthUserResponse.profileImage,
+                        contributionPerYears = contributionCountPerYears,
+                    )
+                }
             }
         }
 

src/main/kotlin/org/gitanimals/identity/app/Oauth2Api.kt

@@ -8,6 +8,7 @@ interface Oauth2Api {
 
     class OAuthUserResponse(
         val username: String,
+        val id: String,
         val profileImage: String,
     )
 }

src/main/kotlin/org/gitanimals/identity/controller/UserController.kt

@@ -2,6 +2,7 @@ package org.gitanimals.identity.controller
 
 import org.gitanimals.identity.app.Token
 import org.gitanimals.identity.app.UserFacade
+import org.gitanimals.identity.controller.request.UsernameUpdateRequest
 import org.gitanimals.identity.controller.response.UserResponse
 import org.gitanimals.identity.domain.EntryPoint
 import org.gitanimals.identity.domain.UserService
@@ -101,4 +102,18 @@ class UserController(
     ) {
         userService.increasePointByUsername(username, entryPoint, idempotencyKey, point)
     }
+
+    @ResponseStatus(HttpStatus.OK)
+    @PatchMapping("/internals/users")
+    fun updateUserByAuthInfo(
+        @RequestParam("entry-point") entryPoint: EntryPoint,
+        @RequestParam("authentication-id") authenticationId: String,
+        @RequestBody request: UsernameUpdateRequest,
+    ) {
+        userService.updateUsernameByEntryPointAndAuthenticationId(
+            username = request.changedName,
+            entryPoint = entryPoint,
+            authenticationId = authenticationId,
+        )
+    }
 }

src/main/kotlin/org/gitanimals/identity/controller/request/UsernameUpdateRequest.kt

@@ -0,0 +1,5 @@
+package org.gitanimals.identity.controller.request
+
+data class UsernameUpdateRequest(
+    val changedName: String,
+)

src/main/kotlin/org/gitanimals/identity/controller/response/UserResponse.kt

@@ -16,10 +16,10 @@ data class UserResponse(
         fun from(user: User): UserResponse {
             return UserResponse(
                 id = user.id.toString(),
-                username = user.name,
+                username = user.getName(),
                 points = user.getPoints().toString(),
                 profileImage = user.profileImage,
-                entryPoint = user.entryPoint,
+                entryPoint = user.getEntryPoint(),
             )
         }
     }

src/main/kotlin/org/gitanimals/identity/domain/User.kt

@@ -5,13 +5,15 @@ import org.gitanimals.identity.core.AggregateRoot
 import org.gitanimals.identity.core.IdGenerator
 import org.gitanimals.identity.core.instant
 import org.gitanimals.identity.core.toZonedDateTime
+import org.slf4j.LoggerFactory
 import kotlin.math.max
 import kotlin.math.min
 
 @AggregateRoot
 @Table(
     name = "users", indexes = [
-        Index(columnList = "username", unique = true)
+        Index(columnList = "username", unique = true),
+        Index(columnList = "entry_point, authentication_id", unique = true),
     ]
 )
 @Entity(name = "users")
@@ -21,7 +23,7 @@ class User(
     val id: Long,
 
     @Column(name = "username", nullable = false)
-    val name: String,
+    private var name: String,
 
     @Column(name = "points", nullable = false)
     private var points: Long,
@@ -36,17 +38,34 @@ class User(
 
     @Column(name = "profile_image", nullable = false)
     val profileImage: String,
-    
-    @Enumerated(EnumType.STRING)
-    @Column(name = "entry_point", columnDefinition = "VARCHAR(50) DEFAULT 'GITHUB'")
-    val entryPoint: EntryPoint,
+
+    @Embedded
+    private val authInfo: UserAuthInfo,
 
     @Version
     private val version: Long? = null,
 ) : AbstractTime() {
 
+    fun getName(): String = name
+
     fun getPoints(): Long = points
 
+    fun getEntryPoint(): EntryPoint = authInfo.entryPoint
+
+    fun findAuthenticationId(): String? = authInfo.authenticationId
+
+    fun setAuthenticationId(authenticationId: String) {
+        if (authInfo.authenticationId != null) {
+            check(authInfo.authenticationId == authenticationId) {
+                val message =
+                    "Different authenticationId input. saved authenticationId: \"${authInfo.authenticationId}\", input authenticationId: \"$authenticationId\""
+                logger.error(message)
+                message
+            }
+        }
+        authInfo.authenticationId = authenticationId
+    }
+
     fun givePoint(point: Long, reason: String) {
         val current = instant().toZonedDateTime()
         pointHistories.removeAll { it.createdAt.toZonedDateTime().isBefore(current) }
@@ -74,23 +93,30 @@ class User(
         this.points += point
     }
 
+    fun updateUsername(username: String) {
+        this.name = username
+    }
+
     companion object {
-        private val JOIN_POINT_THRESHOLD = 100_000L
-        private val PER_DAY_GIVE_POINT_THRESHOLD = 20000L
+        private val logger = LoggerFactory.getLogger(User::class.simpleName)
+
+        private const val JOIN_POINT_THRESHOLD = 100_000L
+        private const val PER_DAY_GIVE_POINT_THRESHOLD = 20000L
 
         fun newUser(
             name: String,
             points: Long,
             profileImage: String,
             entryPoint: EntryPoint,
+            authenticationId: String,
         ): User {
             return User(
                 id = IdGenerator.generate(),
                 name = name,
                 points = min(points, JOIN_POINT_THRESHOLD),
                 pointHistories = mutableListOf(),
                 profileImage = profileImage,
-                entryPoint = entryPoint,
+                authInfo = UserAuthInfo(entryPoint, authenticationId),
             )
         }
     }

src/main/kotlin/org/gitanimals/identity/domain/UserAuthInfo.kt

@@ -0,0 +1,16 @@
+package org.gitanimals.identity.domain
+
+import jakarta.persistence.Column
+import jakarta.persistence.Embeddable
+import jakarta.persistence.EnumType
+import jakarta.persistence.Enumerated
+
+@Embeddable
+class UserAuthInfo(
+    @Enumerated(EnumType.STRING)
+    @Column(name = "entry_point", columnDefinition = "VARCHAR(50) DEFAULT 'GITHUB'")
+    val entryPoint: EntryPoint,
+
+    @Column(name = "authentication_id", nullable = true)
+    var authenticationId: String?,
+)

src/main/kotlin/org/gitanimals/identity/domain/UserRepository.kt

@@ -1,10 +1,35 @@
 package org.gitanimals.identity.domain
 
 import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.data.jpa.repository.Query
+import org.springframework.data.repository.query.Param
 
 interface UserRepository : JpaRepository<User, Long> {
 
-    fun findByNameAndEntryPoint(name: String, entryPoint: EntryPoint): User?
+    @Query(
+        """
+            select u from users as u 
+            where u.name = :name
+            and u.authInfo.entryPoint = :entryPoint
+        """
+    )
+    fun findByNameAndEntryPoint(
+        @Param("name") name: String,
+        @Param("entryPoint") entryPoint: EntryPoint,
+    ): User?
+
+    @Query(
+        """
+            select u from users as u
+            where u.authInfo.entryPoint = :entryPoint
+            and u.authInfo.authenticationId = :authenticationId
+        """
+    )
+    fun findByEntryPointAndAuthenticationId(
+        @Param("entryPoint") entryPoint: EntryPoint,
+        @Param("authenticationId") authenticationId: String,
+    ): User?
+
+    fun existsByNameAndAuthInfoEntryPoint(name: String, entryPoint: EntryPoint): Boolean
 
-    fun existsByNameAndEntryPoint(name: String, entryPoint: EntryPoint): Boolean
 }

src/main/kotlin/org/gitanimals/identity/domain/UserService.kt

@@ -14,7 +14,34 @@ class UserService(
 ) {
 
     fun existsUser(username: String, entryPoint: EntryPoint): Boolean =
-        userRepository.existsByNameAndEntryPoint(username, entryPoint)
+        userRepository.existsByNameAndAuthInfoEntryPoint(username, entryPoint)
+
+    fun existsByEntryPointAndAuthenticationId(entryPoint: EntryPoint, authenticationId: String) =
+        findByEntryPointAndAuthenticationId(entryPoint, authenticationId) != null
+
+    fun findByEntryPointAndAuthenticationId(
+        entryPoint: EntryPoint,
+        authenticationId: String
+    ): User? {
+        return userRepository.findByEntryPointAndAuthenticationId(
+            entryPoint = entryPoint,
+            authenticationId = authenticationId,
+        )
+    }
+
+    @Retryable(retryFor = [ObjectOptimisticLockingFailureException::class])
+    @Transactional
+    fun updateUsernameByEntryPointAndAuthenticationId(
+        username: String,
+        entryPoint: EntryPoint,
+        authenticationId: String,
+    ) {
+        userRepository.findByEntryPointAndAuthenticationId(entryPoint, authenticationId)
+            ?.updateUsername(username)
+            ?: throw IllegalArgumentException(
+                "Cannot find user by entryPoint(\"$entryPoint\") and authenticationId(\"$authenticationId\")"
+            )
+    }
 
     @Retryable(retryFor = [ObjectOptimisticLockingFailureException::class])
     @Transactional
@@ -26,17 +53,29 @@ class UserService(
     fun newUser(
         username: String,
         entryPoint: EntryPoint,
+        authenticationId: String,
         profileImage: String,
         contributionPerYears: Map<Int, Int>
     ): User {
         if (existsUser(username, entryPoint)) {
             return getUserByNameAndEntryPoint(username, entryPoint)
         }
+
+        if (existsByEntryPointAndAuthenticationId(entryPoint, authenticationId)) {
+            updateUsernameByEntryPointAndAuthenticationId(
+                username = username,
+                entryPoint = entryPoint,
+                authenticationId = authenticationId,
+            )
+            return getUserByNameAndEntryPoint(username, entryPoint)
+        }
+
         val user = User.newUser(
             name = username,
             points = contributionPerYears.toPoint(),
             profileImage = profileImage,
             entryPoint = entryPoint,
+            authenticationId = authenticationId,
         )
         return userRepository.save(user)
     }
@@ -76,6 +115,18 @@ class UserService(
         return user
     }
 
+    @Transactional
+    @Retryable(ObjectOptimisticLockingFailureException::class)
+    fun updateUserAuthInfoByUsername(
+        username: String,
+        entryPoint: EntryPoint,
+        authenticationId: String,
+    ) {
+        val user = getUserByNameAndEntryPoint(username, entryPoint)
+
+        user.setAuthenticationId(authenticationId)
+    }
+
     private fun requireIdempotency(idempotencyKey: String) {
         val userIdempotency =
             userIdempotencyRepository.findByIdOrNull(idempotencyKey)