[IDLE-461] 유저가 다중 디바이스에서 알림을 받을 수 있도록 개선한다.

[wonjunYou]

1. 📄 Summary

• 한 유저가 다중 디바이스에서 알림을 받을 수 있도록 알림 발송 로직을 개선했습니다.

Summary by CodeRabbit

• 새로운 기능

  • 여러 기기 토큰에 대한 알림 전송 기능이 추가되어, 센터 관리자에게 더 많은 알림을 보낼 수 있게 되었습니다.

• 버그 수정

  • 단일 기기 토큰 검색에서 다수 기기 토큰 검색으로 변경되어, 사용자 ID에 따라 여러 기기 토큰을 효과적으로 처리할 수 있습니다.

[coderabbitai]

Walkthrough

CarerApplyFacadeService.kt, DeviceTokenService.kt, 및 DeviceTokenJpaRepository.kt 파일에서 여러 변경 사항이 있었습니다. 주요 변경 사항은 CarerApplyFacadeService의 createApply 메서드에서 centerManagers를 반복하는 방식이 map에서 forEach로 변경된 것입니다. 이로 인해 각 센터 매니저와 연결된 모든 디바이스 토큰을 가져오고, 이를 통해 여러 알림을 전송할 수 있게 되었습니다. DeviceTokenService는 단일 디바이스 토큰을 가져오는 메서드를 제거하고, 사용자 ID에 따라 여러 디바이스 토큰을 가져오는 메서드를 추가했습니다. DeviceTokenJpaRepository에도 해당 메서드가 추가되었습니다.

Changes

파일 경로	변경 요약
idle-application/src/main/kotlin/com/swm/idle/application/applys/facade/CarerApplyFacadeService.kt	createApply 메서드에서 map 대신 forEach 사용, 모든 디바이스 토큰을 가져오는 로직으로 변경.
idle-application/src/main/kotlin/com/swm/idle/application/notification/domain/DeviceTokenService.kt	findByUserId 메서드 제거, findAllByUserId 메서드 추가 (여러 디바이스 토큰을 반환).
idle-domain/src/main/kotlin/com/swm/idle/domain/notification/repository/jpa/DeviceTokenJpaRepository.kt	findAllByUserId 메서드 추가 (특정 사용자 ID에 대한 여러 디바이스 토큰을 반환).

Possibly related PRs

• [IDLE-399] FCM 디바이스 토큰 관리 API 및 알림 도메인 설계 #179: DeviceTokenService.kt의 findAllByUserId 메서드 변경 사항이 CarerApplyFacadeService.kt의 수정 사항과 직접적으로 관련되어 있습니다.
• [IDLE-000] 배포 전 최종 수정사항 반영 #205: 주로 SMS 서비스 업데이트에 중점을 두고 있지만, 사용자에게 알림을 전송하는 방식과 관련하여 간접적으로 연관됩니다.

Suggested labels

✨기능, 🎯리팩토링

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)

idle-domain/src/main/kotlin/com/swm/idle/domain/notification/repository/jpa/DeviceTokenJpaRepository.kt (1)

17-18: 다중 디바이스 지원을 위한 메서드가 잘 추가되었습니다.

다만 몇 가지 개선사항을 제안드립니다:

1. findByUserId 메서드와 findAllByUserId 메서드가 공존하면 혼란을 야기할 수 있습니다. 단일 디바이스 토큰 조회는 더 이상 사용되지 않으므로 findByUserId 메서드를 @Deprecated 처리하는 것이 좋겠습니다.

2. 현재 반환 타입이 List<DeviceToken>?로 nullable입니다. 디바이스 토큰이 없는 경우 null 대신 빈 리스트를 반환하는 것이 Kotlin의 null safety 원칙에 더 부합합니다.

다음과 같이 수정을 제안드립니다:

-    fun findAllByUserId(userId: UUID): List<DeviceToken>?
+    fun findAllByUserId(userId: UUID): List<DeviceToken>

+    @Deprecated("다중 디바이스 지원으로 인해 더 이상 사용되지 않습니다. findAllByUserId를 사용해주세요.")
     fun findByUserId(userId: UUID): DeviceToken?

idle-application/src/main/kotlin/com/swm/idle/application/applys/facade/CarerApplyFacadeService.kt (2)

Line range hint 65-87: 알림 처리 로직의 구조 개선이 필요합니다

중첩된 루프 구조와 복잡한 알림 생성 로직으로 인해 코드의 가독성과 유지보수성이 저하될 수 있습니다. 또한 디바이스 토큰이 많은 경우 성능 문제가 발생할 수 있습니다.

다음과 같은 개선사항을 제안드립니다:

1. 알림 생성 로직을 별도의 private 메소드로 추출:

private fun createAndSendNotification(
    deviceToken: String,
    centerManager: CenterManager,
    carer: Carer,
    jobPosting: JobPosting,
    jobPostingId: UUID
) {
    val notificationInfo = CarerApplyNotificationInfo(
        title = "${carer.name} 님이 공고에 지원하였습니다.",
        body = createBodyMessage(jobPosting),
        receiverId = centerManager.id,
        notificationType = NotificationType.APPLICANT,
        imageUrl = carer.profileImageUrl,
        notificationDetails = mapOf(
            "jobPostingId" to jobPostingId,
        )
    )

    val notification = notificationService.create(notificationInfo)

    ApplyEvent.createApplyEvent(
        deviceToken = deviceToken,
        notificationId = notification.id,
        notificationInfo = notificationInfo
    ).also {
        carerApplyEventPublisher.publish(it)
    }
}

2. 비동기 처리 도입 검토:

centerManagers?.forEach { centerManager ->
    deviceTokenService.findAllByUserId(centerManager.id)
        .orEmpty()
        .asFlow()
        .onEach { deviceToken ->
            createAndSendNotification(deviceToken, centerManager, carer, jobPosting, jobPostingId)
        }
        .launchIn(coroutineScope)
}

---

테스트 코드 작성이 필요합니다

검색 결과를 분석한 결과, CarerApplyFacadeService에 대한 테스트 파일이 존재하지 않는 것으로 확인되었습니다. 다중 디바이스 알림 전송 기능의 안정성을 보장하기 위해 다음과 같은 테스트 케이스 작성이 필수적입니다:

• idle-application/src/test/kotlin/com/swm/idle/application/applys/facade/CarerApplyFacadeServiceTest.kt 파일 생성이 필요하며 다음 시나리오를 포함해야 합니다:
  • 여러 디바이스 토큰이 등록된 센터 매니저에게 알림이 정상적으로 전송되는지 검증
  • 디바이스 토큰이 없는 센터 매니저의 경우 예외 없이 처리되는지 검증
  • 알림 생성 및 이벤트 발행이 정상적으로 수행되는지 검증

🔗 Analysis chain

Line range hint 62-88: 테스트 케이스 보강이 필요합니다

다중 디바이스 알림 전송 기능이 추가됨에 따라 다음과 같은 테스트 시나리오가 필요합니다:

• 여러 디바이스 토큰이 있는 경우의 알림 전송
• 디바이스 토큰이 없는 경우의 처리
• 일부 알림 전송이 실패하는 경우의 처리

테스트 파일 존재 여부를 확인하기 위해 다음 스크립트를 실행합니다:

---

Let me try a different search strategy to verify the test coverage.

---

Let me try one final search strategy to find test files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: 관련 테스트 파일 검색

echo "테스트 파일 검색 중..."
fd -e kt "CarerApplyFacadeServiceTest"

echo "알림 관련 테스트 코드 검색 중..."
rg -l "createApply.*notification" -g "*Test.kt"

Length of output: 327

---

Script:

#!/bin/bash
# Search for test files related to CarerApply
echo "케어기버 지원 관련 테스트 파일 검색..."
fd "Test.*\.kt$" | grep -i "apply"

# Search for notification related test code
echo "\n알림 관련 테스트 코드 검색..."
rg "notification.*test" -t kt -i

# Search specifically in test directories
echo "\n테스트 디렉토리 내 파일 검색..."
fd -t f . -p "**/test/**/*.kt"

Length of output: 393

---

Script:

#!/bin/bash
# 모든 Kotlin 파일 검색
echo "테스트 파일 검색 중..."
find . -type f -name "*Test.kt"

# 알림 관련 코드 검색
echo "\n알림 관련 코드 검색..."
rg -l "notification" --type-add 'kotlin:*.kt' -t kotlin

# CarerApply 관련 코드 검색
echo "\n케어기버 지원 관련 코드 검색..."
rg -l "CarerApply" --type-add 'kotlin:*.kt' -t kotlin

Length of output: 4203

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4f4a807 and 25fbc2c.

📒 Files selected for processing (3)

• idle-application/src/main/kotlin/com/swm/idle/application/applys/facade/CarerApplyFacadeService.kt (3 hunks)
• idle-application/src/main/kotlin/com/swm/idle/application/notification/domain/DeviceTokenService.kt (1 hunks)
• idle-domain/src/main/kotlin/com/swm/idle/domain/notification/repository/jpa/DeviceTokenJpaRepository.kt (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

idle-application/src/main/kotlin/com/swm/idle/application/notification/domain/DeviceTokenService.kt (1)

20-21: 코드 개선 제안: 문서화 및 Null 처리 개선이 필요합니다.

다음 사항들을 고려해 주시기 바랍니다:

1. 메서드의 목적과 동작을 설명하는 KDoc 문서를 추가하면 좋을 것 같습니다.
2. null 대신 빈 리스트를 반환하는 것이 Kotlin의 관례에 더 부합할 것 같습니다.

다음과 같이 수정하는 것을 제안드립니다:

+    /**
+     * 사용자 ID에 연결된 모든 디바이스 토큰을 조회합니다.
+     *
+     * @param userId 조회할 사용자의 UUID
+     * @return 디바이스 토큰 목록 (없는 경우 빈 리스트 반환)
+     */
     fun findAllByUserId(userId: UUID): List<DeviceToken>? {
-        return deviceTokenJpaRepository.findAllByUserId(userId)
+        return deviceTokenJpaRepository.findAllByUserId(userId) ?: emptyList()
     }

레포지토리 구현을 확인해 주세요.

DeviceTokenJpaRepository의 findAllByUserId 구현이 올바르게 되어있는지 확인이 필요합니다.

✅ Verification successful

Let me gather more information about the repository implementation.

---

Let me check if this is a Spring Data JPA repository interface.

---

리뷰 의견을 수정합니다: Spring Data JPA의 명명 규칙에 따른 적절한 구현입니다.

DeviceTokenJpaRepository가 Spring Data JPA 인터페이스로 구현되어 있어, findAllByUserId 메서드는 Spring Data JPA의 명명 규칙에 따라 자동으로 올바르게 구현됩니다. 다만, 서비스 계층에서의 개선 제안은 여전히 유효합니다:

• KDoc 문서화 추가
• null 대신 빈 리스트 반환 처리

수정 제안:

/**
 * 사용자 ID에 연결된 모든 디바이스 토큰을 조회합니다.
 *
 * @param userId 조회할 사용자의 UUID
 * @return 디바이스 토큰 목록 (없는 경우 빈 리스트 반환)
 */
fun findAllByUserId(userId: UUID): List<DeviceToken> {
    return deviceTokenJpaRepository.findAllByUserId(userId) ?: emptyList()
}

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: DeviceTokenJpaRepository의 findAllByUserId 메서드 구현 확인

# Test: Repository 클래스에서 findAllByUserId 메서드 검색
rg -t kotlin "findAllByUserId.*UUID.*List<DeviceToken>" 

Length of output: 379

---

Script:

#!/bin/bash
# Check the implementation details of DeviceTokenJpaRepository
rg -A 5 -B 5 "findAllByUserId" idle-domain/src/main/kotlin/com/swm/idle/domain/notification/repository/jpa/DeviceTokenJpaRepository.kt

Length of output: 296

---

Script:

#!/bin/bash
# Check if DeviceTokenJpaRepository is a Spring Data JPA interface
rg -A 2 -B 2 "interface DeviceTokenJpaRepository" idle-domain/src/main/kotlin/com/swm/idle/domain/notification/repository/jpa/DeviceTokenJpaRepository.kt

Length of output: 302

[coderabbitai]

⚠️ Potential issue

널 안전성 개선이 필요합니다

deviceTokenService.findAllByUserId가 null을 반환할 수 있는 상황에 대해 더 명시적인 처리가 필요합니다. 빈 리스트를 반환하는 것이 더 안전한 방식일 수 있습니다.

다음과 같이 수정하는 것을 제안드립니다:

-        centerManagers?.forEach { centerManager ->
-            val deviceTokens = deviceTokenService.findAllByUserId(centerManager.id)
+        centerManagers?.forEach { centerManager ->
+            val deviceTokens = deviceTokenService.findAllByUserId(centerManager.id).orEmpty()

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	centerManagers?.forEach { centerManager ->
	val deviceTokens = deviceTokenService.findAllByUserId(centerManager.id)
	centerManagers?.forEach { centerManager ->
	val deviceTokens = deviceTokenService.findAllByUserId(centerManager.id).orEmpty()