feat: DeadLetter 발생시 슬랙으로 알럿이 가게하고, 재수행 할 수 있도록 수정한다

Author: devxb

.github/workflows/deploy.yml

@@ -85,6 +85,7 @@ jobs:
             "ELASTIC_SEARCH_USER_NAME=${{ secrets.ELASTIC_SEARCH_USER_NAME }}"
             "ELASTIC_SEARCH_PASSWORD=${{ secrets.ELASTIC_SEARCH_PASSWORD }}"
             "QUIZ_APPROVE_TOKEN=${{ secrets.QUIZ_APPROVE_TOKEN }}"
+            "RELAY_APPROVE_TOKEN=${{ secrets.RELAY_APPROVE_TOKEN }}"
 
       - name: build and push filebeat
         uses: docker/build-push-action@v4

deploy/api/Dockerfile

@@ -20,6 +20,7 @@ ARG ELASTIC_SEARCH_URIS
 ARG ELASTIC_SEARCH_USER_NAME
 ARG ELASTIC_SEARCH_PASSWORD
 ARG QUIZ_APPROVE_TOKEN
+ARG RELAY_APPROVE_TOKEN
 
 ARG JAR_FILE=./*.jar
 COPY ${JAR_FILE} gitanimals-api.jar
@@ -43,7 +44,8 @@ ENV db_url=${DB_URL} \
   elastic_search_uris=${ELASTIC_SEARCH_URIS} \
   elastic_search_user_name=${ELASTIC_SEARCH_USER_NAME} \
   elastic_search_password=${ELASTIC_SEARCH_PASSWORD} \
-  quiz_approve_token=${QUIZ_APPROVE_TOKEN}
+  quiz_approve_token=${QUIZ_APPROVE_TOKEN} \
+  relay_approve_token=${RELAY_APPROVE_TOKEN}
 
 ENTRYPOINT java -Djava.net.preferIPv4Stack=true -jar gitanimals-api.jar \
   --spring.datasource.url=${db_url} \
@@ -65,4 +67,5 @@ ENTRYPOINT java -Djava.net.preferIPv4Stack=true -jar gitanimals-api.jar \
   --spring.elasticsearch.uris=${elastic_search_uris} \
   --spring.elasticsearch.username=${elastic_search_user_name} \
   --spring.elasticsearch.password=${elastic_search_password} \
-  --quiz.approve.token=${quiz_approve_token}
+  --quiz.approve.token=${quiz_approve_token} \
+  --relay.approve.token=${relay_approve_token}

gradle.properties

@@ -24,7 +24,7 @@ kotestExtensionSpringVersion=1.1.3
 testContainerVersion=1.20.6
 
 ### Netx ###
-netxVersion=0.4.7
+netxVersion=0.4.9
 
 ### Snowflake ###
 snowflakeVersion=5.2.5

src/main/kotlin/org/gitanimals/core/redis/RedisPubSubChannel.kt

@@ -7,4 +7,6 @@ object RedisPubSubChannel {
 
     const val SLACK_INTERACTED = "SLACK_INTERACTED"
     const val SLACK_REPLIED = "SLACK_REPLIED"
+
+    const val DEAD_LETTER_OCCURRED = "DEAD_LETTER_OCCURRED"
 }

src/main/kotlin/org/gitanimals/notification/app/SlackDeadLetterMessageListener.kt

@@ -0,0 +1,56 @@
+package org.gitanimals.notification.app
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import org.gitanimals.core.redis.TraceableMessageListener
+import org.gitanimals.notification.app.event.DeadLetterEvent
+import org.gitanimals.notification.domain.Notification
+import org.gitanimals.notification.domain.Notification.ActionRequest
+import org.gitanimals.notification.domain.Notification.ActionRequest.Style.PRIMARY
+import org.springframework.beans.factory.annotation.Qualifier
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.data.redis.connection.Message
+import org.springframework.data.redis.core.StringRedisTemplate
+import org.springframework.stereotype.Component
+
+@Component
+class SlackDeadLetterMessageListener(
+    private val redisTemplate: StringRedisTemplate,
+    private val objectMapper: ObjectMapper,
+    @Qualifier("gitAnimalsDeadLetterSlackNotification") private val notification: Notification,
+    @Value("\${relay.approve.token}") private val approveToken: String,
+): TraceableMessageListener(redisTemplate, objectMapper) {
+
+    override fun onMessage(message: Message) {
+        runCatching {
+            val deadLetterEvent = objectMapper.readValue(
+                redisTemplate.stringSerializer.deserialize(message.body),
+                DeadLetterEvent::class.java,
+            )
+
+            val payloadWhenRelayButtonClicked = mapOf(
+                "clicked" to "RELAY",
+                "sourceKey" to "RELAY_DEAD_LETTER",
+                "approveToken" to approveToken,
+                "deadLetterId" to deadLetterEvent.deadLetterId
+            )
+
+            notification.notifyWithActions(
+                message = """
+                    :this_is_fine::this_is_fine::this_is_fine::this_is_fine::this_is_fine:
+                    DeadLetter
+                    ---
+                    $deadLetterEvent
+                    ---
+                """.trimIndent(),
+                actions = listOf(
+                    ActionRequest(
+                        id = "relay_action",
+                        name = "Relay",
+                        style = PRIMARY,
+                        interaction = payloadWhenRelayButtonClicked,
+                    )
+                ),
+            )
+        }
+    }
+}

src/main/kotlin/org/gitanimals/notification/app/event/DeadLetterEvent.kt

@@ -0,0 +1,9 @@
+package org.gitanimals.notification.app.event
+
+import org.rooftop.netx.api.SagaEvent
+
+data class DeadLetterEvent(
+    val traceId: String,
+    val deadLetterId: String,
+    val sagaEvent: SagaEvent,
+)

src/main/kotlin/org/gitanimals/notification/infra/SlackNotifiactions.kt

@@ -91,3 +91,9 @@ class GitAnimalsNewQuizCreatedSlackNotification(
     objectMapper: ObjectMapper,
     @Value(value = "\${slack.token}") token: String,
 ) : SlackNotification(token, "C08GU67NV6W", objectMapper)
+
+@Component
+class GitAnimalsDeadLetterSlackNotification(
+    objectMapper: ObjectMapper,
+    @Value(value = "\${slack.token}") token: String,
+) : SlackNotification(token, "C08M0R0GEKV", objectMapper)

src/main/kotlin/org/gitanimals/supports/deadletter/DeadLetterEvent.kt

@@ -0,0 +1,17 @@
+package org.gitanimals.supports.deadletter
+
+import org.gitanimals.core.IdGenerator
+import org.gitanimals.core.filter.MDCFilter
+import org.gitanimals.core.redis.AsyncRedisPubSubEvent
+import org.gitanimals.core.redis.RedisPubSubChannel.DEAD_LETTER_OCCURRED
+import org.rooftop.netx.api.SagaEvent
+import org.slf4j.MDC
+
+data class DeadLetterEvent(
+    private val deadLetterId: String,
+    private val sagaEvent: SagaEvent
+): AsyncRedisPubSubEvent(
+    traceId = runCatching { MDC.get(MDCFilter.TRACE_ID) }
+        .getOrElse { IdGenerator.generate().toString() },
+    channel = DEAD_LETTER_OCCURRED,
+)

src/main/kotlin/org/gitanimals/supports/deadletter/DeadLetterEventPublisher.kt

@@ -0,0 +1,20 @@
+package org.gitanimals.supports.deadletter
+
+import org.rooftop.netx.api.SagaEvent
+import org.rooftop.netx.spi.DeadLetterListener
+import org.springframework.context.ApplicationEventPublisher
+
+class DeadLetterEventPublisher(
+    private val applicationEventPublisher: ApplicationEventPublisher,
+) : DeadLetterListener {
+
+    override fun listen(deadLetterId: String, sagaEvent: SagaEvent) {
+        applicationEventPublisher.publishEvent(
+            DeadLetterEvent(
+                deadLetterId = deadLetterId,
+                sagaEvent = sagaEvent,
+            )
+        )
+    }
+}
+

src/main/kotlin/org/gitanimals/supports/deadletter/DeadLetterListenConfigurer.kt

@@ -0,0 +1,20 @@
+package org.gitanimals.supports.deadletter
+
+import org.rooftop.netx.spi.DeadLetterRegistry
+import org.springframework.context.ApplicationEventPublisher
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+@Configuration
+class DeadLetterListenConfigurer(
+    private val deadLetterRegistry: DeadLetterRegistry,
+    private val applicationEventPublisher: ApplicationEventPublisher,
+) {
+
+    @Bean
+    fun deadLetterEventPublisher(): DeadLetterEventPublisher {
+        return DeadLetterEventPublisher(applicationEventPublisher).apply {
+            deadLetterRegistry.addListener(this)
+        }
+    }
+}