Merge remote-tracking branch 'origin/feature/34-circuit-breaker-for-gRPC' into feature/34-circuit-breaker-for-gRPC

Author: qkrwndnjs1075

buildSrc/src/main/kotlin/Dependencies.kt

@@ -105,5 +105,6 @@ object Dependencies {
     const val RESILIENCE4J_SPRING_BOOT = "io.github.resilience4j:resilience4j-spring-boot3:${DependencyVersions.RESILIENCE4J}"
     const val RESILIENCE4J_KOTLIN = "io.github.resilience4j:resilience4j-kotlin:${DependencyVersions.RESILIENCE4J}"
 
-
+    // Netty
+    const val NETTY = "io.netty:netty-resolver-dns-native-macos:${DependencyVersions.NETTY}"
 }

buildSrc/src/main/kotlin/DependencyVersions.kt

@@ -45,6 +45,9 @@ object DependencyVersions {
     // Caffeine
     const val CAFFEINE = "3.1.8"
 
-    //Resilience4j
+    // Resilience4j
     const val RESILIENCE4J = "2.0.2"
+
+    // Netty
+    const val NETTY = "4.1.111.Final"
 }

casper-application-infrastructure/build.gradle.kts

@@ -110,6 +110,12 @@ dependencies {
     implementation(Dependencies.RESILIENCE4J_RETRY)
     implementation(Dependencies.RESILIENCE4J_SPRING_BOOT)
     implementation(Dependencies.RESILIENCE4J_KOTLIN)
+
+    runtimeOnly(Dependencies.NETTY) {
+        artifact {
+            classifier = osdetector.classifier
+        }
+    }
 }
 
 sourceSets {

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/domain/examcode/usecase/GrantExamCodesUseCase.kt

@@ -15,13 +15,22 @@ import hs.kr.entrydsm.application.domain.examcode.util.DistanceUtil
 import kotlinx.coroutines.async
 import kotlinx.coroutines.coroutineScope
 
+/**
+ * 1차 전형에 합격한 학생들에게 수험번호를 부여하는 유스케이스입니다.
+ *
+ * @property applicationContract ApplicationAggregate를 가져옵니다.
+ * @property statusContract StatusAggregate를 업데이트합니다.
+ * @property kakaoGeocodeContract 카카오 맵 API와 상호작용합니다.
+ * @property distanceUtil 두 지점 사이의 거리를 구합니다.
+ * @property baseLocationContract 기준이 되는 장소의 위경도를 가져옵니다.
+ */
 @UseCase
 class GrantExamCodesUseCase(
     private val applicationContract: ApplicationContract,
-    private val statusContract: StatusContract,
     private val kakaoGeocodeContract: KakaoGeocodeContract,
-    private val distanceUtil: DistanceUtil,
     private val baseLocationContract: BaseLocationContract,
+    private val statusContract: StatusContract,
+    private val distanceUtil: DistanceUtil,
 ) : GrantExamCodesContract {
 
     companion object {
@@ -31,6 +40,10 @@ class GrantExamCodesUseCase(
         private const val SPECIAL_EXAM_CODE_PREFIX = "02"
     }
 
+    /**
+     * 1차 전형에 합격한 학생들의 주소와 학교까지의 거리를 계산하고,
+     * 전형별로 그룹화하여 수험번호를 부여합니다.
+     */
     override suspend fun execute() {
         val allFirstRoundPassedApplication = applicationContract.queryAllFirstRoundPassedApplication()
         val examCodeInfos = collectDistanceInfo(allFirstRoundPassedApplication)
@@ -46,16 +59,26 @@ class GrantExamCodesUseCase(
         saveExamCodes(examCodeInfos)
     }
 
+    /**
+     * 학생들의 주소를 위경도로 변환하고, 학교와의 거리를 계산합니다.
+     *
+     * @param applications 1차 전형에 합격한 학생 리스트
+     * @return 학생들의 접수 코드, 전형 유형, 학교까지의 거리를 담은 리스트
+     * @throws ExamCodeException.failedGeocodeConversion 주소 변환에 실패했을 경우
+     */
     private suspend fun collectDistanceInfo(applications: List<Application>): List<ExamCodeInfo> = coroutineScope {
         applications.map { application ->
             async {
                 val address = application.streetAddress as String
                 val coordinate = kakaoGeocodeContract.geocode(address)
                     ?: throw ExamCodeException.failedGeocodeConversion(address)
+
                 val baseLat = baseLocationContract.baseLat
                 val baseLon = baseLocationContract.baseLon
+
                 val userLat = coordinate.first
                 val userLon = coordinate.second
+
                 val distance = distanceUtil.haversine(baseLat, baseLon, userLat, userLon)
                 ExamCodeInfo(
                     receiptCode = application.receiptCode,
@@ -66,6 +89,12 @@ class GrantExamCodesUseCase(
         }.map { it.await() }
     }
 
+    /**
+     * 학생들을 학교까지의 거리를 기준으로 그룹화하고, 그룹 내에서 수험번호를 부여합니다.
+     *
+     * @param examCodeInfos 학생들의 정보 리스트
+     * @param applicationType 전형 유형 (일반, 특별)
+     */
     private fun assignExamCodes(examCodeInfos: List<ExamCodeInfo>, applicationType: String) {
         val sortedByDistance = examCodeInfos.sortedByDescending { it.distance }
 
@@ -76,6 +105,13 @@ class GrantExamCodesUseCase(
         }
     }
 
+    /**
+     * 학생들을 학교까지의 거리가 같은 그룹으로 묶습니다.
+     *
+     * @param sortedInfos 거리를 기준으로 내림차순 정렬된 학생 정보 리스트
+     * @param applicationType 전형 유형
+     * @return 거리가 같은 학생들끼리 묶인 그룹 리스트
+     */
     private fun createDistanceGroups(sortedInfos: List<ExamCodeInfo>, applicationType: String): List<DistanceGroup> {
         val groups = mutableListOf<DistanceGroup>()
         val uniqueDistances = sortedInfos.map { it.distance }.distinct()
@@ -88,6 +124,11 @@ class GrantExamCodesUseCase(
     }
 
 
+    /**
+     * 같은 거리 그룹 내의 학생들에게 수험번호를 부여합니다.
+     *
+     * @param distanceGroup 거리가 같은 학생 그룹
+     */
     private fun assignNumbersInGroup(distanceGroup: DistanceGroup) {
         distanceGroup.examCodeInfoList.forEach { examCodeInfo ->
             val receiptCode = String.format("%03d", examCodeInfo.receiptCode)
@@ -96,7 +137,11 @@ class GrantExamCodesUseCase(
         }
     }
 
-
+    /**
+     * 부여된 수험번호를 저장합니다.
+     *
+     * @param examCodeInfos 수험번호가 부여된 학생 정보 리스트
+     */
     private suspend fun saveExamCodes(examCodeInfos: List<ExamCodeInfo>) {
         examCodeInfos.forEach { info ->
             info.examCode?.let { examCode ->

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/config/ResilienceConfig.kt

@@ -23,6 +23,11 @@ class ResilienceConfig(
         return circuitBreakerRegistry.circuitBreaker("status-grpc")
     }
 
+    @Bean
+    fun scheduleGrpcCircuitBreaker(): CircuitBreaker {
+        return circuitBreakerRegistry.circuitBreaker("schedule-grpc")
+    }
+
     @Bean
     fun userGrpcRetry(): Retry {
         return retryRegistry.retry("user-grpc")
@@ -32,4 +37,9 @@ class ResilienceConfig(
     fun statusGrpcRetry(): Retry {
         return retryRegistry.retry("status-grpc")
     }
+
+    @Bean
+    fun scheduleGrpcRetry(): Retry {
+        return retryRegistry.retry("schedule-grpc")
+    }
 }

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/grpc/client/schedule/ScheduleGrpcClient.kt

@@ -1,13 +1,17 @@
 package hs.kr.entrydsm.application.global.grpc.client.schedule
 
+import hs.kr.entrydsm.application.global.extension.executeGrpcCallWithResilience
 import hs.kr.entrydsm.application.global.grpc.dto.schedule.InternalScheduleResponse
 import hs.kr.entrydsm.application.global.grpc.dto.schedule.ScheduleType
 import hs.kr.entrydsm.casper.schedule.proto.ScheduleServiceGrpc
 import hs.kr.entrydsm.casper.schedule.proto.ScheduleServiceProto
+import io.github.resilience4j.circuitbreaker.CircuitBreaker
+import io.github.resilience4j.retry.Retry
 import io.grpc.Channel
 import io.grpc.stub.StreamObserver
 import kotlinx.coroutines.suspendCancellableCoroutine
 import net.devh.boot.grpc.client.inject.GrpcClient
+import org.springframework.beans.factory.annotation.Qualifier
 import org.springframework.stereotype.Component
 import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
@@ -18,7 +22,10 @@ import kotlin.coroutines.resumeWithException
  * Schedule Service와 gRPC 통신을 하는 클라이언트입니다.
  */
 @Component
-class ScheduleGrpcClient {
+class ScheduleGrpcClient(
+    @Qualifier("scheduleGrpcRetry") private val retry: Retry,
+    @Qualifier("scheduleGrpcCircuitBreaker") private val circuitBreaker: CircuitBreaker
+) {
     @GrpcClient("schedule-service")
     lateinit var channel: Channel
 
@@ -28,37 +35,48 @@ class ScheduleGrpcClient {
      * @return 일정 정보
      */
     suspend fun getScheduleByType(type: String): InternalScheduleResponse {
-        val scheduleStub = ScheduleServiceGrpc.newStub(channel)
+        return executeGrpcCallWithResilience(
+            retry = retry,
+            circuitBreaker = circuitBreaker,
+            fallback = {
+                InternalScheduleResponse(
+                    type = toInternal(ScheduleServiceProto.Type.valueOf(type.uppercase())),
+                    date = LocalDateTime.now()
+                )
+            }
+        ) {
+            val scheduleStub = ScheduleServiceGrpc.newStub(channel)
 
-        val request =
-            ScheduleServiceProto.TypeRequest.newBuilder()
-                .setType(ScheduleServiceProto.Type.valueOf(type.uppercase()))
-                .build()
+            val request =
+                ScheduleServiceProto.TypeRequest.newBuilder()
+                    .setType(ScheduleServiceProto.Type.valueOf(type.uppercase()))
+                    .build()
 
-        val response =
-            suspendCancellableCoroutine { continuation ->
-                scheduleStub.getScheduleByType(
-                    request,
-                    object : StreamObserver<ScheduleServiceProto.GetScheduleResponse> {
-                        override fun onNext(value: ScheduleServiceProto.GetScheduleResponse) {
-                            continuation.resume(value)
-                        }
+            val response =
+                suspendCancellableCoroutine { continuation ->
+                    scheduleStub.getScheduleByType(
+                        request,
+                        object : StreamObserver<ScheduleServiceProto.GetScheduleResponse> {
+                            override fun onNext(value: ScheduleServiceProto.GetScheduleResponse) {
+                                continuation.resume(value)
+                            }
 
-                        override fun onError(t: Throwable) {
-                            continuation.resumeWithException(t)
-                        }
+                            override fun onError(t: Throwable) {
+                                continuation.resumeWithException(t)
+                            }
 
-                        override fun onCompleted() {}
-                    },
-                )
-            }
+                            override fun onCompleted() {}
+                        },
+                    )
+                }
 
-        val formatter = DateTimeFormatter.ISO_LOCAL_DATE_TIME
+            val formatter = DateTimeFormatter.ISO_LOCAL_DATE_TIME
 
-        val scheduleType = toInternal(response.type)
-        val date = LocalDateTime.parse(response.date, formatter)
+            val scheduleType = toInternal(response.type)
+            val date = LocalDateTime.parse(response.date, formatter)
 
-        return InternalScheduleResponse(scheduleType, date)
+            InternalScheduleResponse(scheduleType, date)
+        }
     }
 
     /**