Merge pull request #12 from Nexters/feat/TASK-159-notifications

[TASK-159] 문제 생성 완료 알림 발송

Author: JunRain2

build.gradle.kts

@@ -45,6 +45,9 @@ dependencies {
     // JWT
     implementation("com.nimbusds:nimbus-jose-jwt:${properties["nimbusVersion"]}")
 
+    // Push
+    implementation("com.google.firebase:firebase-admin:${properties["firebaseAdminVersion"]}")
+
     // Test
     testImplementation("org.springframework.boot:spring-boot-starter-webmvc-test")
     testImplementation("org.springframework.boot:spring-boot-starter-data-mongodb-test")
@@ -108,4 +111,10 @@ tasks.register<Test>("networkTest") {
         includeTags("network")
     }
     outputs.upToDateWhen { false }
+
+    // 실패 원인이 외부에 있어 스택 트레이스만으로는 모자란다. 어댑터가 삼킨 실패도 로그로는 남으므로 그대로 흘려보낸다.
+    testLogging {
+        showStandardStreams = true
+        exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
+    }
 }

gradle.properties

@@ -2,6 +2,7 @@ kotlinLoggingVersion=8.0.4
 springdocVersion=3.0.3
 ktlintVersion=1.8.0
 nimbusVersion=10.9.1
+firebaseAdminVersion=9.9.0
 kotestVersion=6.2.3
 mockitoKotlinVersion=5.4.0
 springAiVersion=2.0.0

src/main/kotlin/com/nexters/gitit/application/NotifyQuizResult.kt

@@ -0,0 +1,53 @@
+package com.nexters.gitit.application
+
+import com.nexters.gitit.domain.member.MemberRepository
+import com.nexters.gitit.domain.notification.NotificationSender
+import com.nexters.gitit.domain.notification.QuizResultNotification
+import com.nexters.gitit.domain.project.ProjectRepository
+import com.nexters.gitit.domain.quizrepo.QuizRepoRepository
+import org.springframework.stereotype.Service
+
+/**
+ * 문제 생성이 끝났음을 그 저장소를 학습 중인 회원들에게 알립니다.
+ *
+ * 저장소에서 회원으로 가는 길은 `Project`뿐입니다 — `QuizRepo`는 누가 자기를 학습하는지 모릅니다.
+ * 그래서 저장소 하나에 회원이 여럿이고, 알림에 실을 프로젝트 id는 회원마다 다릅니다.
+ */
+@Service
+class NotifyQuizResult(
+    private val quizRepoRepository: QuizRepoRepository,
+    private val projectRepository: ProjectRepository,
+    private val memberRepository: MemberRepository,
+    private val notificationSender: NotificationSender,
+) {
+    /**
+     * 푸시 콜이 프로젝트 수만큼 나갑니다. [NotificationSender.send]는 토큰 여러 개에 메시지 하나라,
+     * `projectId`가 회원마다 다른 이상 한 번으로 묶을 수 없습니다. 한 저장소의 학습자가 수백 명이 되면
+     * 그때 포트에 "토큰별 data"를 넣습니다 — 지금은 루프가 더 쌉니다.
+     */
+    operator fun invoke(command: Command) {
+        // 생성이 끝난 뒤 삭제된 저장소라면 알릴 것이 없다.
+        val quizRepo = quizRepoRepository.findById(command.quizRepoId) ?: return
+        val projects = projectRepository.findAllByQuizRepoId(quizRepo.id)
+        if (projects.isEmpty()) return
+
+        val notification = QuizResultNotification.from(quizRepo.status)
+        val tokens =
+            memberRepository
+                .findAllByIds(projects.map { it.memberId })
+                .mapNotNull { member -> member.deviceInfo?.deviceToken?.let { member.id to it } }
+                .toMap()
+
+        projects.forEach { project ->
+            // 푸시 권한을 거부한 회원은 토큰이 없다. 알림이 유일한 결과 통지가 아니라(화면에서 상태를 읽는다) 그냥 건너뛴다.
+            val token = tokens[project.memberId] ?: return@forEach
+
+            notificationSender.send(listOf(token), notification.message(project.id))
+        }
+    }
+
+    /** 저장소 상태와 알릴 대상은 전부 도큐먼트에서 다시 읽으므로 id 하나만 받습니다. */
+    data class Command(
+        val quizRepoId: String,
+    )
+}

src/main/kotlin/com/nexters/gitit/domain/member/MemberRepository.kt

@@ -5,5 +5,8 @@ interface MemberRepository {
 
     fun findById(id: String): Member?
 
+    /** 없는 id는 결과에서 빠집니다. 개수가 맞는지 확인하려면 부르는 쪽이 셉니다. */
+    fun findAllByIds(ids: List<String>): List<Member>
+
     fun findBySocialIdentity(socialIdentity: SocialIdentity): Member?
 }

src/main/kotlin/com/nexters/gitit/domain/notification/NotificationMessage.kt

@@ -0,0 +1,12 @@
+package com.nexters.gitit.domain.notification
+
+/**
+ * 알림 한 건의 내용. 도메인이 FCM 타입을 모르게 하려고 우리 타입을 둡니다.
+ *
+ * [data]는 화면에 안 보이고 앱이 읽는 값(눌렀을 때 갈 곳 등)입니다. 전송 규격상 숫자도 문자열로 넣어야 합니다.
+ */
+data class NotificationMessage(
+    val title: String,
+    val body: String,
+    val data: Map<String, String> = emptyMap(),
+)

src/main/kotlin/com/nexters/gitit/domain/notification/NotificationSender.kt

@@ -0,0 +1,14 @@
+package com.nexters.gitit.domain.notification
+
+/**
+ * 여러 기기에 같은 푸시 알림을 보냅니다.
+ *
+ * 전송 실패를 예외로 올리지 않는 것이 이 포트의 계약입니다 — 알림을 못 보냈다고 부르는 쪽 작업까지
+ * 되돌릴 이유가 없습니다.
+ */
+interface NotificationSender {
+    fun send(
+        deviceTokens: List<String>,
+        message: NotificationMessage,
+    )
+}

src/main/kotlin/com/nexters/gitit/domain/notification/QuizResultNotification.kt

@@ -0,0 +1,45 @@
+package com.nexters.gitit.domain.notification
+
+import com.nexters.gitit.domain.quizrepo.QuizRepoStatus
+
+/**
+ * 문제 생성 결과를 알리는 문구 한 벌.
+ *
+ * 셋으로 가르는 기준은 **받은 사람이 할 수 있는 일**입니다. [REJECTED]는 이 저장소로는 문제를 못 만든다는
+ * 판정이라 다시 돌려도 결과가 같아 재시도를 권하면 안 되고, [FAILED]는 사고라 다시 하면 성공할 수 있습니다.
+ *
+ * 거절 사유(`QuizRepo.rejectedReason`)는 싣지 않습니다 — 내부 에러 코드이고, 화면에서 다시 읽습니다.
+ */
+enum class QuizResultNotification(
+    private val type: String,
+    private val title: String,
+    private val body: String,
+) {
+    READY("QUIZ_READY", "프로젝트 준비 완료", "새 문제가 도착했어요"),
+    REJECTED("QUIZ_REJECTED", "문제를 만들 수 없는 저장소예요", "다른 저장소로 등록해 주세요"),
+    FAILED("QUIZ_FAILED", "문제를 만들지 못했어요", "잠시 후 다시 시도해 주세요"),
+    ;
+
+    /**
+     * [type]을 enum 이름에서 뽑지 않는 이유는 그 문자열이 앱과의 약속이어서입니다 — 여기서 이름을 바꾸면
+     * 클라이언트가 조용히 못 알아듣습니다.
+     *
+     * 문구는 모두에게 같지만 [projectId]는 회원마다 다릅니다. 눌렀을 때 열 화면이 회원별 프로젝트입니다.
+     */
+    fun message(projectId: String): NotificationMessage =
+        NotificationMessage(
+            title = title,
+            body = body,
+            data = mapOf("type" to type, "projectId" to projectId),
+        )
+
+    companion object {
+        /** 끝났다는 이벤트를 받고도 상태가 완료·거절이 아니면 사고로 끝난 것입니다. */
+        fun from(status: QuizRepoStatus): QuizResultNotification =
+            when (status) {
+                QuizRepoStatus.COMPLETED -> READY
+                QuizRepoStatus.REJECTED -> REJECTED
+                else -> FAILED
+            }
+    }
+}

src/main/kotlin/com/nexters/gitit/domain/project/ProjectRepository.kt

@@ -7,4 +7,7 @@ interface ProjectRepository {
      * 이미 있을 때 난이도를 덮어쓰지 않는 것이 이 메서드의 계약입니다. 난이도 변경은 등록과 구분되는 별도 행위입니다.
      */
     fun saveIfAbsent(project: Project): Project
+
+    /** 저장소 하나를 학습 중인 프로젝트 전부. 문제 생성이 끝났을 때 알릴 대상을 찾는 방향입니다. */
+    fun findAllByQuizRepoId(quizRepoId: String): List<Project>
 }

src/main/kotlin/com/nexters/gitit/event/QuizEventHandler.kt

@@ -1,6 +1,8 @@
 package com.nexters.gitit.event
 
 import com.nexters.gitit.application.GenerateQuiz
+import com.nexters.gitit.application.NotifyQuizResult
+import com.nexters.gitit.domain.quizrepo.QuizGenerationFinished
 import com.nexters.gitit.domain.quizrepo.QuizGenerationRequested
 import org.springframework.context.event.EventListener
 import org.springframework.scheduling.annotation.Async
@@ -15,6 +17,7 @@ import org.springframework.stereotype.Component
 @Component
 class QuizEventHandler(
     private val generateQuiz: GenerateQuiz,
+    private val notifyQuizResult: NotifyQuizResult,
 ) {
     /**
      * 발행자를 붙잡아 두지 않으려고 비동기입니다 — 문제 생성은 한 번에 몇 분이 걸립니다.
@@ -27,4 +30,14 @@ class QuizEventHandler(
     fun handle(event: QuizGenerationRequested) {
         generateQuiz(GenerateQuiz.Command(event.quizRepoId))
     }
+
+    /**
+     * 이 이벤트는 [GenerateQuiz]의 finally에서, 예외를 다시 던지는 경로에서도 나옵니다.
+     * 동기로 받으면 알림 발송이 그 스택 위에서 돌아 문제 생성 스레드를 더 붙잡습니다.
+     */
+    @Async
+    @EventListener
+    fun handle(event: QuizGenerationFinished) {
+        notifyQuizResult(NotifyQuizResult.Command(event.quizRepoId))
+    }
 }

src/main/kotlin/com/nexters/gitit/infrastructure/firebase/FcmNotificationSender.kt

@@ -0,0 +1,68 @@
+package com.nexters.gitit.infrastructure.firebase
+
+import com.google.firebase.messaging.FirebaseMessaging
+import com.google.firebase.messaging.FirebaseMessagingException
+import com.google.firebase.messaging.MulticastMessage
+import com.google.firebase.messaging.Notification
+import com.nexters.gitit.domain.notification.NotificationMessage
+import com.nexters.gitit.domain.notification.NotificationSender
+import com.nexters.gitit.infrastructure.firebase.FcmNotificationSender.Companion.MULTICAST_TOKEN_LIMIT
+import io.github.oshai.kotlinlogging.KotlinLogging
+
+private val logger = KotlinLogging.logger {}
+
+/**
+ * iOS도 FCM이 APNs로 중계해 기기 종류로 갈라지지 않습니다.
+ *
+ * 실패는 로그로만 남깁니다 — 지운 앱의 토큰이 조용히 죽어 있어 실패가 정상 범위입니다.
+ */
+class FcmNotificationSender(
+    private val firebaseMessaging: FirebaseMessaging,
+) : NotificationSender {
+    /** 상한을 넘겨 보내면 그 묶음이 통째로 거절되므로 [MULTICAST_TOKEN_LIMIT]개씩 나눠 보냅니다. */
+    override fun send(
+        deviceTokens: List<String>,
+        message: NotificationMessage,
+    ) {
+        val notification =
+            Notification
+                .builder()
+                .setTitle(message.title)
+                .setBody(message.body)
+                .build()
+
+        // 빈 목록이면 반복이 안 돌아 따로 거르지 않는다.
+        deviceTokens.chunked(MULTICAST_TOKEN_LIMIT).forEach { tokens ->
+            sendChunk(
+                MulticastMessage
+                    .builder()
+                    .setNotification(notification)
+                    .putAllData(message.data)
+                    .addAllTokens(tokens)
+                    .build(),
+            )
+        }
+    }
+
+    private fun sendChunk(message: MulticastMessage) {
+        try {
+            val response = firebaseMessaging.sendEachForMulticast(message)
+            if (response.failureCount > 0) {
+                // 실패 건수만 남기면 토큰이 죽은 건지 설정이 틀린 건지 구분이 안 돼, 사유 코드를 종류별로 센다.
+                val reasons =
+                    response.responses
+                        .mapNotNull { it.exception?.messagingErrorCode }
+                        .groupingBy { it }
+                        .eachCount()
+                logger.warn { "Push delivery failed for ${response.failureCount}/${response.responses.size} devices: $reasons" }
+            }
+        } catch (e: FirebaseMessagingException) {
+            logger.warn(e) { "Push send call failed: ${e.messagingErrorCode}" }
+        }
+    }
+
+    companion object {
+        // FCM이 정한 상한. 줄이는 건 되지만 늘리면 거절된다.
+        private const val MULTICAST_TOKEN_LIMIT = 500
+    }
+}