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

minisundev · 2024-06-03T17:33:33Z

#️⃣연관된 이슈

📝작업 내용

채팅방에 초대할 때 사용할 코드 생성

💬리뷰 요구사항

채팅방 참가자가 채팅방에 초대하기 위해서 참여코드를 발급받을때에 쓰는
key: 채팅방id,유저id
value: 참여 코드
인 UserChatRoomInvitationRepository를 하나 만들고

채팅방 비참여자가 채팅방에 참여할때 쓸 (아직 api 구현이 안 되어서 사용하지는 않고 있습니다)
key: 참여 코드
value: 채팅방id 인 InvitationChatRoomRepository를 하나 만들었습니다

그런데 UserChatRoomInvitationRepository에서 참여 코드를 새로 생성할때
참여코드 -> 채팅방 id도 InvitationChatRoomRepository에 저장해야해서
UserChatRoomInvitationRepository에서 InvitationChatRoomRepository를 주입받아

fun setInvitation(
    key: String,
    chatRoomId: String,
  ): String {
    val invitationCode = generateCode()
    val ops: ValueOperations<String, String> = redisTemplate.opsForValue()
    ops.set(key, invitationCode, propertyConfig.getExpiration())
    invitationChatRoomRepository.setInvitationCode(invitationCode, chatRoomId)//-> 이 부분
    return invitationCode
  }

이런식으로 사용하게 했는데 Repository끼리 저런식으로 결합되는게 좋은지 의문입니다
Service단에서 처리하려면 Return되는 DTO에 필드 하나를 추가해야할 것 같아서 저렇게 했는데
필드를 하나 추가하고 결합도를 낮추는게 더 나을까요?

…메서드 구현

yudonggeun · 2024-06-04T02:08:17Z

UserChatRoomInvitationRepository, InvitationChatRoomRepository 하나만 있어도 기능 구현이 가능하지 않을까요?

minisundev · 2024-06-04T02:14:37Z

UserChatRoomInvitationRepository, InvitationChatRoomRepository 하나만 있어도 기능 구현이 가능하지 않을까요?

그렇긴 한데 채팅방에 링크로 참여하는 경우에는 참여코드 -> 채팅방 id 이렇게 읽어야 하잖아요

찾아보니까 Redis는 Value로 검색하는 경우에 시간복잡도가 굉장히 증가한다고 하더라고요 인덱스 설정을 잘 하면 된다고 하긴 하던데 인덱스 설정하는것보다 그냥 key랑 value를 반대로 해서 저장하면 성능이 좋다고 생각했어요

어차피 key랑 value를 반대로 해서 두번 저장할거면 다른 레파지토리에 저장하는게 나아보여서 분리했어요 (같은 레파지토리에다 저장하면 채팅방id:유저id로 참여코드 찾을때는 참여코드->채팅방id는 볼 필요도 없는데 같이 보여서 성능이 안 좋아질 거 같아서요)

yudonggeun · 2024-06-04T02:09:27Z

chat/compose.yml

+      - "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}" ]


저번에 한번 본 코드처럼 보이는데요? 중복된 코드가 많으면 코드 리뷰가 힘들어요.

저번 pr에 올렸는데 closed되어서 다시 올렸어요

yudonggeun · 2024-06-04T02:13:33Z

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

+  fun getInvitation(
+    userId: String,
+    chatRoomId: String,
+  ): InvitationResponse {


repository에서 InvitationResponse를 반환하는 로직은 어울리지 않은 것 같아요. response는 http 와 관련된 용어라서 오해의 소지가 있어보이는데요? InvitationResponse의 다른 이름은 없을까요?

좋은 지적이네요 더 고민해볼게요ㅕ!

yudonggeun · 2024-06-04T02:22:28Z

chat/src/main/resources/application.yml

 page:
  size: 100
+chatroom:
+  expiration: 1d
+  baseurl: "http://localhost:8081/"


baseurl을 사용한 곳이 있나요?

지금은 사용하지 않고 있어요 빼겠습니다!

yudonggeun · 2024-06-04T02:25:45Z

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

+
+@Configuration
+@ConfigurationProperties(prefix = "chatroom")
+class PropertyConfig {


Config 보다는 Property가 더 어울리는 이름인 것 같아요. ChatroomProperty

일단 설정파일이라 그렇게 했는데 의미를 생각하면 그게 나아보이네요~!

yudonggeun · 2024-06-04T02:27:25Z

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

+@Component
+class InvitationChatRoomRepository(
+  private val redisTemplate: RedisTemplate<String, String>,
+  private val propertyConfig: PropertyConfig,


init을 통해서 property의 값으로 미리 초기화 하도록 구성하면 더 좋을 것 같아요.

class InvitationChatRoomRepository( .. ){ val ttl = propertyConfig.getExpiration() }

static이 아니라서 주입받아야 할 것 같고 뭔가 변수가 추가되었을때도 한번만 주입받기 위해서 저렇게 사용했습니다!

yudonggeun · 2024-06-04T02:29:05Z

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가 저장되지 않았습니다"),


client로 노출할 메시지라서 에러 메시지가 너무 상세하지 않은가요?

좋은 지적이네요 다시 생각해볼게요ㅕ

yudonggeun · 2024-06-04T02:31:18Z

그렇긴 한데 채팅방에 링크로 참여하는 경우에는 참여코드 -> 채팅방 id 이렇게 읽어야 하잖아요

찾아보니까 Redis는 Value로 검색하는 경우에 시간복잡도가 굉장히 증가한다고 하더라고요 인덱스 설정을 잘 하면 된다고 하긴 하던데 인덱스 설정하는것보다 그냥 key랑 value를 반대로 해서 저장하면 성능이 좋다고 생각했어요

어차피 key랑 value를 반대로 해서 두번 저장할거면 다른 레파지토리에 저장하는게 나아보여서 분리했어요 (같은 레파지토리에다 저장하면 채팅방id:유저id로 참여코드 찾을때는 참여코드->채팅방id는 볼 필요도 없는데 같이 보여서 성능이 안 좋아질 거 같아서요)

조회할 때, 초대받은 유저가 코드로 검색하지않으면 되지 않을까요?
초대를 받을 때 채팅방id와 (초대받은)유저 id 조합을 그대로 사용하면 가능할 것 같아서요.

minisundev · 2024-06-04T05:18:33Z

그렇긴 한데 채팅방에 링크로 참여하는 경우에는 참여코드 -> 채팅방 id 이렇게 읽어야 하잖아요
찾아보니까 Redis는 Value로 검색하는 경우에 시간복잡도가 굉장히 증가한다고 하더라고요 인덱스 설정을 잘 하면 된다고 하긴 하던데 인덱스 설정하는것보다 그냥 key랑 value를 반대로 해서 저장하면 성능이 좋다고 생각했어요
어차피 key랑 value를 반대로 해서 두번 저장할거면 다른 레파지토리에 저장하는게 나아보여서 분리했어요 (같은 레파지토리에다 저장하면 채팅방id:유저id로 참여코드 찾을때는 참여코드->채팅방id는 볼 필요도 없는데 같이 보여서 성능이 안 좋아질 거 같아서요)

조회할 때, 초대받은 유저가 코드로 검색하지않으면 되지 않을까요? 초대를 받을 때 채팅방id와 (초대받은)유저 id 조합을 그대로 사용하면 가능할 것 같아서요.

이 방향으로 처음에 개발을 시작했었는데
채팅방id,초대자 user id마다 참여코드를 생성하지만
채팅방 참여 코드를 참여자가 발급받으면 1시간 후에 만료되어야 하는 조건이 있어서 그렇게는 조건을 만족시키면서 구현할 수 없어요

만약 채팅방id:유저id의 정보로만 참여하게 되면
지금 활성화된 참여코드(채팅방id:유저id)가 있다면
한 달(무작위한 1시간보다 긴 시간) 전에 발급된 채팅방 id:유저id의 정보가 포함된 참여코드로도 채팅방에 참여하는게 가능해질 것 같아서 저렇게 분리했습니다!

yudonggeun

초대 코드를 생성하고 조회에 문제가 없는지 단위 테스트를 작성하면 더 좋을 것 같아요! 다음에는 테스트를 통해서 어플리케이션을 신뢰적으로 만들어보죠

yudonggeun · 2024-06-06T05:22:52Z

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

+  fun getInvitationCode(
    userId: String,
    chatRoomId: String,
-  ): InvitationResponse {
+  ): String {
    val key = generateKey(userId, chatRoomId)
    var value = redisTemplate.opsForValue().get(key)
    if (value == null) {
      value = setInvitation(key, chatRoomId)
    }
-
-    val expiration = redisTemplate.getExpire(key)
-
-    return InvitationResponse(value, LocalDateTime.now().plusSeconds(expiration).toString())
+    return generateCode(key, value)


getInviationCode이지만 코드를 생성하고 저장하는 역할을 같이 구현되어있는 것 같아요. 겳합도를 낮추는 방향으로 개선하면 좋을 것 같아요.

네 좋습니다

yudonggeun · 2024-06-06T05:27:29Z

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

+    key: String,
+    value: String,
+  ): String {
+    val combine = "$key,$value"


combine 동사이기도 하고 무슨 의미인지 직관적으로 파악이 힘든 것 같아요!, key, value의 의미가 무엇인지 파악이 힘들어서 주석으로 무슨 의미인지를 좀 더 설명을 해주면 좋을 것 같아요

네~! 변수명이 가독성이 떨어지는거 같긴 하네요

yudonggeun · 2024-06-06T05:31:04Z

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

 import java.util.*

 @Component
-class UserChatRoomInvitationRepository(
+class InvitationRepository(


초대 저장소가 하는 역할이 무엇인가요? 서비스 layer에 더 어울리는 역할을 수행하는 것 같은 느낌?

재사용할 수 있는 컴포넌트인가요?

findbyId 나 save등만 있는게 아니라서 재사용이 불가능할 것 같아요
chatService랑은 좀 동떨어진 일을 하는 것 같아서 저 repository로 초대/참여 관련 로직을 분리했었는데 생각해보면 다른 Service로 분리하는게 더 나아보이네요

yudonggeun · 2024-06-07T11:50:51Z

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

+  private val invitationRepository: InvitationRepository,
+  private val chatRoomProperty: ChatRoomProperty,
+) {
+  fun getOrCreateInvitation(


get과 create 두가지 책임을 담당하는 메서드라서 분리하는 것이 좋다고 생각합니다.

minisundev added 18 commits June 4, 2024 02:02

chore: db setting과 properties application.yml에 추가

7d7cc9b

chore: build.gradle에 redis 추가

0f52c3d

feat: getChatRoomInvitation Controller Layer 구현

9a93d03

feat: getChatRoomInvitation Service Layer 구현

edd40ed

feat: ErrorCode 추가

66ffbc6

feat: UserChatRoomInvitationRepository 생성

b0b114c

feat: UserChatRoomInvitationRepository에 setInvitation, getInvitation …

5b70b4b

…메서드 구현

feat: InvitationChatRoomRepository 생성

9826a24

feat: InvitationChatRoomRepository에 setInvitationLink 메서드 구현

0a934ba

feat: InvitationResponse DTO 생성

7dfae34

feat: PropertyConfig 생성

a5a16e1

feat: RedisConfig 생성

d67ff43

chore: Redis docker image 설정

18b7f84

feat: ChatRoomControllerTest에 getChatRoomInvitation api testcode 작성

47038d4

refac: 추가된 repository 테스트코드에 반영

a9c1453

refac: 메서드,필드 이름 link,key 에서 code로 통일

406d11d

refac: 불필요한 메서드 삭제

a797346

refac: 불필요한 ErrorCode 삭제

7ecfec9

minisundev added enhancement 추가 기능 API 상세 api 문서 Chat 채팅 관련 기능 labels Jun 3, 2024

minisundev added this to the MSA 채팅 서비스 개발 milestone Jun 3, 2024

minisundev requested a review from a team June 3, 2024 17:33

minisundev self-assigned this Jun 3, 2024

yudonggeun reviewed Jun 4, 2024

View reviewed changes

refac: 서비스 로직 repository에서 service로 옮기고 return type이 ResponseDTO가 아니게 변경

46e80af

minisundev added 8 commits June 5, 2024 16:27

rename: userChatRoomInvitationRepository를 InvitationRepository로 변경

18b7cb6

remove: InvitationChatRoomRepository 삭제

ac747fb

feat: invitation 정보들을 인코딩해서 코드 생성하는 method 구현

18c44ef

fix: getExpire를 하기 위한 key 수정

1854afd

refac: InvitationResponse에서 expiration 삭제

6020df3

rename: ChatRoomProperty로 이름 변경

2383b40

refac: 테스트코드에 변경사항 반영

be2f961

style: 코드 정렬

640d3ac

yudonggeun approved these changes Jun 6, 2024

View reviewed changes

minisundev added 4 commits June 6, 2024 22:23

feat: InvitationService 생성

7804e42

refac: InvitationRepository의 재사용 불가능한 로직 InvitationService로 분리

0449e6f

refac: InvitationRepository대신 InvitationService 사용

df2ecfd

chore: 변경된 dependency ChatRoomServiceTest에 반영

c583e10

yudonggeun approved these changes Jun 7, 2024

View reviewed changes

refac: getOrCreateInvitation 메서드 삭제하고 getChatRoomInvitation으로 로직 이동

dde725d

minisundev merged commit 712ea7b into kSideProject:dev Jun 10, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

minisundev commented Jun 3, 2024

yudonggeun commented Jun 4, 2024

minisundev commented Jun 4, 2024 •

edited

Loading

yudonggeun Jun 4, 2024

minisundev Jun 4, 2024

yudonggeun Jun 4, 2024

minisundev Jun 4, 2024

yudonggeun Jun 4, 2024

minisundev Jun 4, 2024

yudonggeun Jun 4, 2024

minisundev Jun 4, 2024

yudonggeun Jun 4, 2024

minisundev Jun 4, 2024

yudonggeun Jun 4, 2024

minisundev Jun 4, 2024

yudonggeun commented Jun 4, 2024 •

edited

Loading

minisundev commented Jun 4, 2024

yudonggeun left a comment

yudonggeun Jun 6, 2024

minisundev Jun 6, 2024

yudonggeun Jun 6, 2024

minisundev Jun 6, 2024

yudonggeun Jun 6, 2024

yudonggeun Jun 6, 2024

minisundev Jun 6, 2024

yudonggeun Jun 7, 2024

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

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

Conversation

minisundev commented Jun 3, 2024

#️⃣연관된 이슈

📝작업 내용

💬리뷰 요구사항

yudonggeun commented Jun 4, 2024

minisundev commented Jun 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yudonggeun commented Jun 4, 2024 • edited Loading

minisundev commented Jun 4, 2024

yudonggeun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minisundev commented Jun 4, 2024 •

edited

Loading

yudonggeun commented Jun 4, 2024 •

edited

Loading