[Chat] 채팅방에 초대할 때 사용할 코드 생성 API 구현

chat/build.gradle.kts

@@ -41,6 +41,9 @@ dependencies {
   implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
   implementation("org.jetbrains.kotlin:kotlin-reflect")
 
+  // non-blocking redis
+  implementation("org.springframework.boot:spring-boot-starter-data-redis")
+
   // test
   testImplementation(project(":test"))
   testImplementation("org.springframework.boot:spring-boot-starter-test")

chat/compose.yml

@@ -3,8 +3,17 @@ services:
     image: mongo:latest
     container_name: mongo
     ports:
-      - "27017:27017"
+      - "27018:27017"
     environment:
-        MONGO_INITDB_ROOT_USERNAME: root
-        MONGO_INITDB_ROOT_PASSWORD: 58155815
-        MONGO_INITDB_DATABASE: mongodb
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: testpassword1234
+      MONGO_INITDB_DATABASE: mongodb
+
+  redis:
+    image: redis:alpine
+    container_name: redis_link
+    ports:
+      - "6379:6379"
+    environment:
+      - REDIS_PASSWORD = "testpassword1234"
+    command: [ "redis-server","--requirepass","${REDIS_PASSWORD}" ]

chat/src/main/kotlin/kpring/chat/chatroom/api/v1/ChatRoomController.kt

@@ -3,6 +3,7 @@ package kpring.chat.chatroom.api.v1
 import kpring.chat.chatroom.service.ChatRoomService
 import kpring.core.auth.client.AuthClient
 import kpring.core.chat.chatroom.dto.request.CreateChatRoomRequest
+import kpring.core.global.dto.response.ApiResponse
 import org.springframework.http.ResponseEntity
 import org.springframework.validation.annotation.Validated
 import org.springframework.web.bind.annotation.*
@@ -34,4 +35,14 @@ class ChatRoomController(
     val result = chatRoomService.exitChatRoom(chatRoomId, userId)
     return ResponseEntity.ok().body(result)
   }
+
+  @GetMapping("/chatroom/{chatRoomId}/invite")
+  fun getChatRoomInvitation(
+    @PathVariable("chatRoomId") chatRoomId: String,
+    @RequestHeader("Authorization") token: String,
+  ): ResponseEntity<*> {
+    val userId = authClient.getTokenInfo(token).data!!.userId
+    val result = chatRoomService.getChatRoomInvitation(chatRoomId, userId)
+    return ResponseEntity.ok().body(ApiResponse(data = result))
+  }
 }

chat/src/main/kotlin/kpring/chat/chatroom/repository/InvitationRepository.kt

@@ -0,0 +1,67 @@
+package kpring.chat.chatroom.repository
+
+import kpring.chat.global.config.ChatRoomProperty
+import org.springframework.data.redis.core.RedisTemplate
+import org.springframework.data.redis.core.ValueOperations
+import org.springframework.stereotype.Component
+import java.nio.charset.StandardCharsets
+import java.security.MessageDigest
+import java.util.*
+
+@Component
+class InvitationRepository(
+  private val redisTemplate: RedisTemplate<String, String>,
+  private val chatRoomProperty: ChatRoomProperty,
+) {
+  fun getInvitationCode(
+    userId: String,
+    chatRoomId: String,
+  ): String {
+    val key = generateKey(userId, chatRoomId)
+    var value = redisTemplate.opsForValue().get(key)
+    if (value == null) {
+      value = setInvitation(key, chatRoomId)
+    }
+    return generateCode(key, value)
+  }
+
+  fun setInvitation(
+    key: String,
+    chatRoomId: String,
+  ): String {
+    val value = generateValue()
+    val ops: ValueOperations<String, String> = redisTemplate.opsForValue()
+    ops.set(key, value, chatRoomProperty.getExpiration())
+    return value
+  }
+
+  fun getExpiration(
+    userId: String,
+    chatRoomId: String,
+  ): Long {
+    val key = generateKey(userId, chatRoomId)
+    val expiration = redisTemplate.getExpire(key)
+    return expiration
+  }
+
+  fun generateCode(
+    key: String,
+    value: String,
+  ): String {
+    val combine = "$key,$value"
+    val digest = MessageDigest.getInstance("SHA-256")
+    val hash = digest.digest(combine.toByteArray(StandardCharsets.UTF_8))
+    return Base64.getEncoder().encodeToString(hash)
+  }
+
+  private fun generateKey(
+    userId: String,
+    chatRoomId: String,
+  ): String {
+    return "$userId:$chatRoomId"
+  }
+
+  private fun generateValue(): String {
+    return UUID.randomUUID().toString()
+  }
+}

chat/src/main/kotlin/kpring/chat/chatroom/service/ChatRoomService.kt

@@ -2,14 +2,17 @@ package kpring.chat.chatroom.service
 
 import kpring.chat.chatroom.model.ChatRoom
 import kpring.chat.chatroom.repository.ChatRoomRepository
+import kpring.chat.chatroom.repository.InvitationRepository
 import kpring.chat.global.exception.ErrorCode
 import kpring.chat.global.exception.GlobalException
+import kpring.core.chat.chat.dto.response.InvitationResponse
 import kpring.core.chat.chatroom.dto.request.CreateChatRoomRequest
 import org.springframework.stereotype.Service
 
 @Service
 class ChatRoomService(
   private val chatRoomRepository: ChatRoomRepository,
+  private val invitationRepository: InvitationRepository,
 ) {
   fun createChatRoom(
     request: CreateChatRoomRequest,
@@ -30,6 +33,15 @@ class ChatRoomService(
     chatRoomRepository.save(chatRoom)
   }
 
+  fun getChatRoomInvitation(
+    chatRoomId: String,
+    userId: String,
+  ): InvitationResponse {
+    verifyChatRoomAccess(chatRoomId, userId)
+    val code = invitationRepository.getInvitationCode(userId, chatRoomId)
+    return InvitationResponse(code)
+  }
+
   fun verifyChatRoomAccess(
     chatRoomId: String,
     userId: String,

chat/src/main/kotlin/kpring/chat/global/config/ChatRoomProperty.kt

@@ -0,0 +1,19 @@
+package kpring.chat.global.config
+
+import org.springframework.boot.context.properties.ConfigurationProperties
+import org.springframework.context.annotation.Configuration
+import java.time.Duration
+
+@Configuration
+@ConfigurationProperties(prefix = "chatroom")
+class ChatRoomProperty {
+  private lateinit var expiration: Duration
+
+  fun getExpiration(): Duration {
+    return expiration
+  }
+
+  fun setExpiration(expiration: Duration) {
+    this.expiration = expiration
+  }
+}

chat/src/main/kotlin/kpring/chat/global/config/RedisConfig.kt

@@ -0,0 +1,16 @@
+package kpring.chat.global.config
+
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.data.redis.connection.RedisConnectionFactory
+import org.springframework.data.redis.core.RedisTemplate
+
+@Configuration
+class RedisConfig {
+  @Bean
+  fun redisTemplate(connectionFactory: RedisConnectionFactory): RedisTemplate<*, *> {
+    val template = RedisTemplate<ByteArray, ByteArray>()
+    template.connectionFactory = connectionFactory
+    return template
+  }
+}

chat/src/main/kotlin/kpring/chat/global/exception/ErrorCode.kt

@@ -12,4 +12,7 @@ enum class ErrorCode(val httpStatus: Int, val message: String) {
 
   // 404
   CHATROOM_NOT_FOUND(HttpStatus.NOT_FOUND.value(), "해당 id로 chatroom을 찾을 수 없습니다"),
+
+  // 500
+  INVITATION_LINK_SAVE_FAILURE(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Invitation Code가 저장되지 않았습니다"),
 }

chat/src/main/resources/application.yml

@@ -11,12 +11,21 @@ spring:
       authentication-database: admin
       authSource: admin
 
+    redis:
+      host: localhost
+      port: 6379
+      password: testpassword1234
+
 server:
   port: 8081
 
 auth:
-  url: "http://localhost:30000/"
+  url: "http://localhost:30001/"
 url:
-    server: "http://localhost:8080/"
+  server: "http://localhost:8080/"
+
 page:
   size: 100
+chatroom:
+  expiration: 1d
+  baseurl: "http://localhost:8081/"

chat/src/test/kotlin/kpring/chat/chatroom/ChatRoomServiceTest.kt

@@ -7,6 +7,7 @@ import io.mockk.mockk
 import io.mockk.verify
 import kpring.chat.chatroom.model.ChatRoom
 import kpring.chat.chatroom.repository.ChatRoomRepository
+import kpring.chat.chatroom.repository.InvitationRepository
 import kpring.chat.chatroom.service.ChatRoomService
 import kpring.chat.global.ChatRoomTest
 import kpring.chat.global.CommonTest
@@ -16,7 +17,8 @@ import java.util.*
 class ChatRoomServiceTest : FunSpec({
 
   val chatRoomRepository = mockk<ChatRoomRepository>()
-  val chatRoomService = ChatRoomService(chatRoomRepository)
+  val invitationRepository = mockk<InvitationRepository>()
+  val chatRoomService = ChatRoomService(chatRoomRepository, invitationRepository)
 
   test("createChatRoom 는 새 ChatRoom을 저장해야 한다") {
     // Given

chat/src/test/kotlin/kpring/chat/chatroom/api/v1/ChatRoomControllerTest.kt

@@ -0,0 +1,102 @@
+package kpring.chat.chat.api.v1
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.ninjasquad.springmockk.MockkBean
+import io.kotest.core.spec.style.DescribeSpec
+import io.mockk.every
+import io.mockk.junit5.MockKExtension
+import kpring.chat.chatroom.api.v1.ChatRoomController
+import kpring.chat.chatroom.service.ChatRoomService
+import kpring.chat.global.ChatRoomTest
+import kpring.chat.global.CommonTest
+import kpring.core.auth.client.AuthClient
+import kpring.core.auth.dto.response.TokenInfo
+import kpring.core.auth.enums.TokenType
+import kpring.core.chat.chat.dto.response.InvitationResponse
+import kpring.core.global.dto.response.ApiResponse
+import kpring.test.restdoc.dsl.restDoc
+import kpring.test.restdoc.json.JsonDataType
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
+import org.springframework.restdocs.ManualRestDocumentation
+import org.springframework.restdocs.RestDocumentationExtension
+import org.springframework.restdocs.operation.preprocess.Preprocessors
+import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import org.springframework.test.web.reactive.server.WebTestClient
+import org.springframework.test.web.servlet.client.MockMvcWebTestClient
+import org.springframework.web.context.WebApplicationContext
+
+@WebMvcTest(controllers = [ChatRoomController::class])
+@ExtendWith(RestDocumentationExtension::class)
+@ExtendWith(SpringExtension::class)
+@ExtendWith(MockKExtension::class)
+class ChatRoomControllerTest(
+  private val om: ObjectMapper,
+  webContext: WebApplicationContext,
+  @MockkBean val chatRoomService: ChatRoomService,
+  @MockkBean val authClient: AuthClient,
+) : DescribeSpec({
+
+    val restDocument = ManualRestDocumentation()
+    val webTestClient: WebTestClient =
+      MockMvcWebTestClient.bindToApplicationContext(webContext).configureClient().baseUrl("http://localhost:8081").filter(
+        WebTestClientRestDocumentation.documentationConfiguration(restDocument).operationPreprocessors()
+          .withRequestDefaults(Preprocessors.prettyPrint()).withResponseDefaults(Preprocessors.prettyPrint()),
+      ).build()
+
+    beforeSpec { restDocument.beforeTest(this.javaClass, "chat controller") }
+
+    afterSpec { restDocument.afterTest() }
+
+    describe("GET /api/v1/chatroom/{chatRoomId}/invite : getChatRoomInvitation api test") {
+
+      val url = "/api/v1/chatroom/{chatRoomId}/invite"
+      it("getChatRoomInvitation api test") {
+
+        // Given
+        val chatRoomId = ChatRoomTest.TEST_ROOM_ID
+        val userId = CommonTest.TEST_USER_ID
+        val key = "62e9df6b-13cb-4673-a6fe-8566451b7f15"
+        val data = InvitationResponse(key)
+
+        every { authClient.getTokenInfo(any()) } returns
+          ApiResponse(
+            data =
+              TokenInfo(
+                type = TokenType.ACCESS, userId = CommonTest.TEST_USER_ID,
+              ),
+          )
+
+        every {
+          chatRoomService.getChatRoomInvitation(
+            chatRoomId,
+            userId,
+          )
+        } returns data
+
+        // When
+        val result = webTestClient.get().uri(url, chatRoomId).header("Authorization", "Bearer mock_token").exchange()
+
+        val docs = result.expectStatus().isOk.expectBody().json(om.writeValueAsString(ApiResponse(data = data)))
+
+        // Then
+        docs.restDoc(
+          identifier = "getChatRoomInvitation_200",
+          description = "채팅방 참여코드를 위한 key값을 반환하는 api",
+        ) {
+          request {
+            path {
+              "chatRoomId" mean "채팅방 참여코드를 발급할 채팅방 Id"
+            }
+          }
+
+          response {
+            body {
+              "data.code" type JsonDataType.Strings mean "참여 코드"
+            }
+          }
+        }
+      }
+    }
+  })

core/src/main/kotlin/kpring/core/chat/chat/dto/request/ChatType.kt

@@ -2,9 +2,10 @@ package kpring.core.chat.chat.dto.request
 
 enum class ChatType(val type: String) {
   Room("Room"),
-  Server("Server");
+  Server("Server"),
+  ;
 
-  override fun toString(): String{
-    return type;
+  override fun toString(): String {
+    return type
   }
 }

core/src/main/kotlin/kpring/core/chat/chat/dto/response/InvitationResponse.kt

@@ -0,0 +1,5 @@
+package kpring.core.chat.chat.dto.response
+
+data class InvitationResponse(
+  val code: String,
+)