Merge pull request #109 from ASAP-Lettering/ASAP-325

tlarbals824 · web-flow · commit 3b6c60b3fbb0 · 2025-01-04T21:03:36.000+09:00
ASAP-325 feat: 편지 공유 상태 확인할 수 있는 api 추가
diff --git a/Application-Module/src/main/kotlin/com/asap/application/letter/port/in/LetterLogUsecase.kt b/Application-Module/src/main/kotlin/com/asap/application/letter/port/in/LetterLogUsecase.kt
@@ -6,9 +6,17 @@ interface LetterLogUsecase {
 
     fun log(request: LogRequest)
 
+    fun finLatestLogByLetterCode(letterCode: String): LogResponse?
+
     data class LogRequest(
         val letterCode: String,
         val logType: LetterLogType,
         val logContent: String,
     )
+
+    data class LogResponse(
+        val letterId: String,
+        val logType: LetterLogType,
+        val logContent: String,
+    )
 }
diff --git a/Application-Module/src/main/kotlin/com/asap/application/letter/port/out/LetterLogManagementPort.kt b/Application-Module/src/main/kotlin/com/asap/application/letter/port/out/LetterLogManagementPort.kt
@@ -1,9 +1,12 @@
 package com.asap.application.letter.port.out
 
+import com.asap.domain.common.DomainId
 import com.asap.domain.letter.entity.LetterLog
 
 interface LetterLogManagementPort {
     fun save(log: LetterLog): LetterLog
 
     fun findAll(): List<LetterLog>
+
+    fun findLatestByLetterId(letterId: DomainId): LetterLog?
 }
diff --git a/Application-Module/src/main/kotlin/com/asap/application/letter/service/LetterLogService.kt b/Application-Module/src/main/kotlin/com/asap/application/letter/service/LetterLogService.kt
@@ -25,4 +25,17 @@ class LetterLogService(
             letterLogManagementPort.save(this)
         }
     }
+
+    override fun finLatestLogByLetterCode(letterCode: String): LetterLogUsecase.LogResponse? {
+        val letter = sendLetterManagementPort.getLetterByCodeNotNull(letterCode)
+        val latestLog = letterLogManagementPort.findLatestByLetterId(letter.id)
+
+        return latestLog?.let {
+            LetterLogUsecase.LogResponse(
+                letterId = it.targetLetterId.value,
+                logType = it.logType,
+                logContent = it.content
+            )
+        }
+    }
 }
diff --git a/Bootstrap-Module/src/main/kotlin/com/asap/bootstrap/web/letter/api/LetterLogApi.kt b/Bootstrap-Module/src/main/kotlin/com/asap/bootstrap/web/letter/api/LetterLogApi.kt
@@ -0,0 +1,54 @@
+package com.asap.bootstrap.web.letter.api
+
+import com.asap.bootstrap.common.security.annotation.AccessUser
+import com.asap.bootstrap.web.letter.dto.LetterShareStatusResponse
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.media.Content
+import io.swagger.v3.oas.annotations.media.Schema
+import io.swagger.v3.oas.annotations.responses.ApiResponse
+import io.swagger.v3.oas.annotations.responses.ApiResponses
+import io.swagger.v3.oas.annotations.tags.Tag
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RequestParam
+
+@Tag(name = "Letter", description = "Letter API")
+@RequestMapping("/api/v1/letters/logs")
+interface LetterLogApi {
+
+    @Operation(summary = "편지 공유 상태 조회")
+    @GetMapping("/share/status")
+    @ApiResponses(
+        value = [
+            ApiResponse(
+                responseCode = "200",
+                description = """
+                    편지 공유 상태 조회 성공
+                    - isShared: 공유 여부
+                    - letterId: 편지 ID
+                    - shareTarget: 공유 대상
+                    
+                    isShared가 true인 경우, letterId와 shareTarget은 null이 아님 즉 공유 성공
+                    isShared가 false인 경우, letterId와 shareTarget은 null임 즉 공유 실패
+                    
+                    shareTarget은 카카오 챗 타입
+                    * MEMO_CHAT: 개인 채팅
+                    * DIRECT_CHAT: 1:1 채팅
+                    * MULTI_CHAT: 그룹 채팅
+                    * OPEN_DIRECT_CHAT: 오픈 채팅
+                    * OPEN_MULTI_CHAT: 오픈 그룹 채팅
+                """,
+                content = [
+                    Content(
+                        mediaType = "application/json",
+                        schema = Schema(implementation = LetterShareStatusResponse::class)
+                    )
+                ]
+            )
+        ]
+    )
+    fun getLetterShareStatus(
+        @RequestParam("letterCode") letterCode: String,
+        @AccessUser userId: String
+    ): LetterShareStatusResponse
+}
diff --git a/Bootstrap-Module/src/main/kotlin/com/asap/bootstrap/web/letter/controller/LetterLogController.kt b/Bootstrap-Module/src/main/kotlin/com/asap/bootstrap/web/letter/controller/LetterLogController.kt
@@ -0,0 +1,27 @@
+package com.asap.bootstrap.web.letter.controller
+
+import com.asap.application.letter.port.`in`.LetterLogUsecase
+import com.asap.bootstrap.web.letter.api.LetterLogApi
+import com.asap.bootstrap.web.letter.dto.LetterShareStatusResponse
+import com.asap.bootstrap.webhook.dto.KakaoWebHookRequest
+import com.fasterxml.jackson.databind.ObjectMapper
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class LetterLogController(
+    private val letterLogUsecase: LetterLogUsecase,
+    private val objectMapper: ObjectMapper
+) : LetterLogApi {
+    override fun getLetterShareStatus(letterCode: String, userId: String): LetterShareStatusResponse {
+        return letterLogUsecase.finLatestLogByLetterCode(letterCode)?.let {
+            val kakaoWebHookRequest =
+                objectMapper.readValue(it.logContent, KakaoWebHookRequest::class.java)
+            LetterShareStatusResponse.success(
+                letterId = it.letterId,
+                shareTarget = kakaoWebHookRequest.chatType
+            )
+        } ?: run {
+            LetterShareStatusResponse.fail()
+        }
+    }
+}
diff --git a/Bootstrap-Module/src/main/kotlin/com/asap/bootstrap/web/letter/dto/LetterShareStatusResponse.kt b/Bootstrap-Module/src/main/kotlin/com/asap/bootstrap/web/letter/dto/LetterShareStatusResponse.kt
@@ -0,0 +1,30 @@
+package com.asap.bootstrap.web.letter.dto
+
+import com.asap.bootstrap.webhook.dto.KakaoChatType
+
+data class LetterShareStatusResponse(
+    val isShared: Boolean,
+    val letterId: String?,
+    val shareTarget: KakaoChatType?,
+) {
+    companion object{
+        fun success(
+            letterId: String,
+            shareTarget: KakaoChatType
+        ): LetterShareStatusResponse {
+            return LetterShareStatusResponse(
+                isShared = true,
+                letterId = letterId,
+                shareTarget = shareTarget
+            )
+        }
+
+        fun fail(): LetterShareStatusResponse {
+            return LetterShareStatusResponse(
+                isShared = false,
+                letterId = null,
+                shareTarget = null
+            )
+        }
+    }
+}
diff --git a/Bootstrap-Module/src/test/kotlin/com/asap/bootstrap/acceptance/letter/controller/LetterLogControllerTest.kt b/Bootstrap-Module/src/test/kotlin/com/asap/bootstrap/acceptance/letter/controller/LetterLogControllerTest.kt
@@ -0,0 +1,51 @@
+package com.asap.bootstrap.acceptance.letter.controller
+
+import com.asap.application.letter.port.`in`.LetterLogUsecase
+import com.asap.bootstrap.acceptance.letter.LetterAcceptanceSupporter
+import com.asap.bootstrap.webhook.dto.KakaoChatType
+import com.asap.bootstrap.webhook.dto.KakaoWebHookRequest
+import com.asap.domain.letter.entity.LetterLogType
+import org.junit.jupiter.api.Test
+import org.mockito.BDDMockito
+import org.springframework.boot.test.mock.mockito.MockBean
+import org.springframework.test.web.servlet.get
+
+class LetterLogControllerTest: LetterAcceptanceSupporter() {
+
+    @MockBean
+    private lateinit var letterLogUsecase: LetterLogUsecase
+
+    @Test
+    fun getLetterShareStatus(){
+        // given
+        val letterCode = "letterCode"
+        val accessToken = jwtMockManager.generateAccessToken("userId")
+
+        BDDMockito.given(letterLogUsecase.finLatestLogByLetterCode(letterCode)).willReturn(
+            LetterLogUsecase.LogResponse(
+                letterId = "letterId",
+                logType = LetterLogType.SHARE,
+                logContent = KakaoWebHookRequest(
+                    chatType = KakaoChatType.MEMO_CHAT,
+                    hashChatId = "hashChatId",
+                    templateId = "templateId",
+                    requestType = LetterLogType.SHARE,
+                    requestId = "requestId",
+                ).let{
+                    objectMapper.writeValueAsString(it)
+                }
+            )
+        )
+
+        // when then
+        mockMvc.get("/api/v1/letters/logs/share/status?letterCode=$letterCode"){
+            header("Authorization", "Bearer $accessToken")
+        }
+            .andExpect {
+                status { isOk() }
+                jsonPath("$.isShared") { isBoolean() }
+                jsonPath("$.letterId") { isString() }
+                jsonPath("$.shareTarget") { isString() }
+            }
+    }
+}
diff --git a/Bootstrap-Module/src/test/kotlin/com/asap/bootstrap/integration/letter/LetterLogApiIntegrationTest.kt b/Bootstrap-Module/src/test/kotlin/com/asap/bootstrap/integration/letter/LetterLogApiIntegrationTest.kt
@@ -0,0 +1,78 @@
+package com.asap.bootstrap.integration.letter
+
+import com.asap.application.letter.LetterMockManager
+import com.asap.bootstrap.IntegrationSupporter
+import com.asap.bootstrap.webhook.dto.KakaoChatType
+import com.asap.bootstrap.webhook.dto.KakaoWebHookRequest
+import com.asap.domain.letter.entity.LetterLogType
+import org.junit.jupiter.api.Test
+import org.springframework.http.MediaType
+import org.springframework.test.web.servlet.get
+import org.springframework.test.web.servlet.post
+
+class LetterLogApiIntegrationTest(
+    private val letterMockManager: LetterMockManager
+) : IntegrationSupporter() {
+
+    @Test
+    fun getLetterShareStatus_success() {
+        //given
+        val senderId = userMockManager.settingUser(username = "senderUsername")
+        val userId = userMockManager.settingUser(username = "username")
+        val accessToken = jwtMockManager.generateAccessToken(userId)
+        val letter =
+            letterMockManager.generateMockSendLetter("username", senderId = senderId)
+        val letterCode = letter.letterCode!!
+
+
+        val request = KakaoWebHookRequest(
+            requestId = letterCode,
+            requestType = LetterLogType.SHARE,
+            chatType = KakaoChatType.MEMO_CHAT,
+            hashChatId = "1234567890",
+            templateId = "1234567890"
+        )
+
+        mockMvc.post("/webhook/kakao") {
+            headers {
+                set("Authorization", "KakaoAP 1234567890")
+                set("X-Kakao-Resource-ID", "1234567890")
+                set("User-Agent", "KakaoAgent")
+            }
+            contentType = MediaType.APPLICATION_JSON
+            content = objectMapper.writeValueAsString(request)
+        }
+        //when then
+        mockMvc.get("/api/v1/letters/logs/share/status?letterCode=$letterCode") {
+            header("Authorization", "Bearer $accessToken")
+        }
+            .andExpect {
+                status { isOk() }
+                jsonPath("$.isShared") { value(true) }
+                jsonPath("$.letterId") { value(letter.id.value) }
+                jsonPath("$.shareTarget") { value(request.chatType.name) }
+            }
+    }
+
+    @Test
+    fun getLetterShareStatus_fail() {
+        //given
+        val senderId = userMockManager.settingUser(username = "senderUsername")
+        val userId = userMockManager.settingUser(username = "username")
+        val accessToken = jwtMockManager.generateAccessToken(userId)
+        val letter =
+            letterMockManager.generateMockSendLetter("username", senderId = senderId)
+        val letterCode = letter.letterCode!!
+
+        //when then
+        mockMvc.get("/api/v1/letters/logs/share/status?letterCode=$letterCode") {
+            header("Authorization", "Bearer $accessToken")
+        }
+            .andExpect {
+                status { isOk() }
+                jsonPath("$.isShared") { value(false) }
+                jsonPath("$.letterId") { value(null) }
+                jsonPath("$.shareTarget") { value(null) }
+            }
+    }
+}
diff --git a/Bootstrap-Module/src/test/kotlin/com/asap/bootstrap/integration/webhook/WebHookApiIntegrationTest.kt b/Bootstrap-Module/src/test/kotlin/com/asap/bootstrap/integration/webhook/WebHookApiIntegrationTest.kt
@@ -7,6 +7,7 @@ import com.asap.bootstrap.webhook.dto.KakaoChatType
 import com.asap.bootstrap.webhook.dto.KakaoWebHookRequest
 import com.asap.domain.letter.entity.LetterLogType
 import com.fasterxml.jackson.module.kotlin.readValue
+import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.shouldBe
 import org.junit.jupiter.api.Test
 import org.springframework.http.MediaType
@@ -51,9 +52,10 @@ class WebHookApiIntegrationTest(
         response.andExpect {
             status { isOk() }
         }
-        with(letterLogManagementPort.findAll().first()) {
-            this.targetLetterId shouldBe letter.id
-            this.logType shouldBe LetterLogType.SHARE
+        with(letterLogManagementPort.findLatestByLetterId(letter.id)) {
+            this.shouldNotBeNull()
+            this!!.targetLetterId shouldBe letter.id
+            this!!.logType shouldBe LetterLogType.SHARE
             objectMapper.readValue<KakaoWebHookRequest>(this.content) shouldBe request
         }
     }
diff --git a/Infrastructure-Module/Persistence/src/main/kotlin/com/asap/persistence/jpa/letter/adapter/LetterLogManagementJpaAdapter.kt b/Infrastructure-Module/Persistence/src/main/kotlin/com/asap/persistence/jpa/letter/adapter/LetterLogManagementJpaAdapter.kt
@@ -1,6 +1,7 @@
 package com.asap.persistence.jpa.letter.adapter
 
 import com.asap.application.letter.port.out.LetterLogManagementPort
+import com.asap.domain.common.DomainId
 import com.asap.domain.letter.entity.LetterLog
 import com.asap.persistence.jpa.letter.LetterLogMapper
 import com.asap.persistence.jpa.letter.repository.LetterLogJpaRepository
@@ -17,4 +18,8 @@ class LetterLogManagementJpaAdapter(
     override fun findAll(): List<LetterLog> {
         return letterLogJpaRepository.findAll().map { LetterLogMapper.toDomain(it) }
     }
+
+    override fun findLatestByLetterId(letterId: DomainId): LetterLog? {
+        return letterLogJpaRepository.findLatestBy(letterId.value)?.let { LetterLogMapper.toDomain(it) }
+    }
 }
diff --git a/Infrastructure-Module/Persistence/src/main/kotlin/com/asap/persistence/jpa/letter/repository/LetterLogJpaRepository.kt b/Infrastructure-Module/Persistence/src/main/kotlin/com/asap/persistence/jpa/letter/repository/LetterLogJpaRepository.kt
@@ -2,6 +2,14 @@ package com.asap.persistence.jpa.letter.repository
 
 import com.asap.persistence.jpa.letter.entity.LetterLogEntity
 import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.data.jpa.repository.Query
 
 interface LetterLogJpaRepository: JpaRepository<LetterLogEntity, String> {
+    @Query("""
+        select l from LetterLogEntity l
+        where l.targetLetterId = :letterId
+        order by l.createdAt desc
+        limit 1
+    """)
+    fun findLatestBy(letterId: String): LetterLogEntity?
 }

Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,17 @@ class LetterLogService(`
`25`	`25`	`letterLogManagementPort.save(this)`
`26`	`26`	`}`
`27`	`27`	`}`
	`28`	`+`
	`29`	`+ override fun finLatestLogByLetterCode(letterCode: String): LetterLogUsecase.LogResponse? {`
	`30`	`+ val letter = sendLetterManagementPort.getLetterByCodeNotNull(letterCode)`
	`31`	`+ val latestLog = letterLogManagementPort.findLatestByLetterId(letter.id)`
	`32`	`+`
	`33`	`+ return latestLog?.let {`
	`34`	`+ LetterLogUsecase.LogResponse(`
	`35`	`+ letterId = it.targetLetterId.value,`
	`36`	`+ logType = it.logType,`
	`37`	`+ logContent = it.content`
	`38`	`+ )`
	`39`	`+ }`
	`40`	`+ }`
`28`	`41`	`}`