Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test/chat stomp : 채팅 STOMP 테스트 코드 작성 #249

Open
wants to merge 9 commits into
base: dev
Choose a base branch
from

Conversation

KooSuYeon
Copy link
Contributor

@KooSuYeon KooSuYeon commented Sep 24, 2024

개요

  • 채팅 테스트 코드 setting PR입니다!
  • 채팅까지 구현한 사항 리뷰 부탁드립니다 :)
  • port를 랜덤하게 테스트하는 springTest입니다.
  • WebSocketClient, WebSocketStompClient, StompSessionHandlerAdapter 클래스를 이용해 가상의 StompClient 생성 후 웹소켓 연결/구독/채팅을 구현했습니다.
  • Hibernate의 sql 로그는 채팅 테스트 로그를 확인하는데 불편함이 있어 꺼두었습니다.

로그 설명

  1. 웹소켓 연결 성공 과정
Connecting to ws://localhost:51170/ws 
// 클라이언트가 지정된 URL로 웹소켓에 연결 요청을 보냄

New StandardWebSocketSession 
// 새로운 웹소켓 세션이 생성됨

Connection established in session id=cd0af1f3-8a2d-40fd-9c23-98b2cf621c9d 
// 연결이 성공적으로 이루어지고, 세션 ID가 생성됨

Sending CONNECT {heart-beat=[0,0], accept-version=[1.1,1.2]} 
// STOMP 프로토콜을 통해 연결 요청이 전송됨

Received CONNECTED {version=[1.2], heart-beat=[0,0]} 
// 서버가 연결을 수립했음을 나타내는 응답을 반환

구현 계획

  • STOMP Session Connect 테스트
  • 싱글 채팅방 채팅 테스트

  • 채팅 전송 헤더에 JWT 토큰 넣기 구현
  • 헤더에 JWT 토큰 넣기 테스트 코드 작성

  • 싱글 채팅방 익셉션 테스트
  • 싱글 채팅방 퇴장 테스트

@KooSuYeon KooSuYeon force-pushed the test/chat-stomp branch 2 times, most recently from 17d0d00 to 79ab7db Compare September 26, 2024 03:41
@KooSuYeon
Copy link
Contributor Author

로그 설명

  1. STOMP 구독 성공 과정
Sending SUBSCRIBE {destination=[/sub/chatroom/1], id=[0]} session=65f406ac-c690-63bc-1bd4-0aef297b8438
From client: SUBSCRIBE /sub/chatroom/1 id=0 session=ccdae57f-0634-ac7d-99dc-0dd60e7be463
// 구독 요청을 클라이언트 단에서 보냄

Processing SUBSCRIBE /sub/chatroom/1 id=0 session=ccdae57f-0634-ac7d-99dc-0dd60e7be463
// 구독 요청이 가는 것을 획인할 수 있음

@KooSuYeon
Copy link
Contributor Author

로그 설명

  1. ChatSerivce의 sendMessage() 메서드, ChatroomService의 getChats() 메서드 테스트
  • Broadcast chat 전송 테스트 및 저장된 채팅 불러오기 를 확인하기 위한 테스트입니다
  • 한 채팅방에서만 채팅 100개 보내봅니다
  • member1이 전송한 채팅을 같은 채팅방에 있는 member2가 열람한다는 시나리오입니다
Broadcasting to 4 sessions.
// 연결된 세션 표시 -> 앞선 세션들 종료되지 않아 4개인가..? 확인중인 사항

Encoding STOMP MESSAGE, headers={destination=[/sub/chatroom/1], content-type=[application/json], subscription=[0], message-id=[8106601f-db2f-efaa-85d9-f442bda1abd8-1]}
Sending TextMessage payload=[MESSAGE
de..], byteCount=527, last=true], StandardWebSocketSession[id=8106601f-db2f-efaa-85d9-f442bda1abd8, uri=ws://localhost:51170/ws]
// 채팅 전송

Received MESSAGE {destination=[/sub/chatroom/1], content-type=[application/json], subscription=[0], message-id=[cf851300-1ae9-6e38-5fbd-57700a6184e7-3], content-length=[375]} session=61677fd2-5df1-2666-0234-42509dd432d7 application/json payload={"id":1,"message":"채팅 테스트를 해볼게","imgCode":null,"member":{"id":...(truncated)
// RedisPublisher가 전송된 채팅 받음 -> 채팅방을 구독한 Session에게로 해당 채팅 전송


===================
SAVED CHAT: {"id":86,"message":"채팅 테스트를 해볼게","member":{"id":2,"username":"211_0","profileImg":null},"groupChatroom":null,"singleChatroom":{"id":1,"created":{"nano":338547000,"year":2024,"monthValue":9,"dayOfMonth":26,"hour":15,"minute":20,"second":42,"month":"SEPTEMBER","dayOfWeek":"THURSDAY","dayOfYear":270,"chronology":{"id":"ISO","calendarType":"iso8601"}},"members":[{"id":1,"username":"poream","profileImg":null},{"id":2,"username":"211_0","profileImg":null}],"chatroom_type":"SINGLE"},"imgCode":[],"created":{"nano":983219000,"year":2024,"monthValue":9,"dayOfMonth":26,"hour":15,"minute":21,"second":20,"month":"SEPTEMBER","dayOfWeek":"THURSDAY","dayOfYear":270,"chronology":{"id":"ISO","calendarType":"iso8601"}}}

// DB에 저장된 채팅 확인

- SecurityWebSockConfig:
- SecurityConfig로 보호되지 않았던 /pub, /sub 보안 잠그기
- WebSockConfig:
- 채팅 발행하기에 앞서 Client에서 보내준 Authorization 값 STOMP Session에 포함시키기 위한 Interceptor 주입
- WebSocketInterceptor:
- CONNCECT -> SEND 모두 authorization을 받아 JWTFilter의 doFilterChain 메서드가 하는 일을 수행함
- 자격증명이 마친다면 StompHeaderAccessor로 회원 이메일을 전달함
- Member Profile Img 코드 정리
- StompHandlerAdapter 클래스의 메서드 이용해
연결 정보 표시

- Connect 구현 -> 예시 : Connected: {version=[1.2], heart-beat=[0,0]}
- Timeout은 60Sec
- session의 Connect 성공 후에는 disconnect

- build.gradle 에서는 JVM 메모리 부족 이슈로 MemberControllerTest와 동일하게 제외
- 채팅 테스트를 하기 위해서는 채팅방, 멤버의 데이터가 사전에 있어야 함 -> @WithMockUser 같은 어노테이션을 이용하려 했으나 실패
- 어차피 사전 데이터란 앞서 생성해놓은 더미데이터인 import.sql과 같은 쓰임새를 가질 것이라 판단해 test 디렉토리 하위에도 import.sql을 가져와 데이터 초기화를 진행하기로 결정함

- import.sql에 schema 코드도 존재하였는데 이는 DDL (Liquibase)로 초기화하고 테스트 profile에서는 H2에서 DDL을 자동으로 만들어주도록 되어 있기 때문에 schema 코드는 삭제해줌
- 확장적으로 웹소켓 채팅 테스트 코드를 작성했음

- 앞선 ~2 커핏까지 중복된 부분 (모듈화) :
- 1. 가상의 WebStompClient를 만드는 코드인 getStompClient 메서드로 모듈화

- 2. testConnectWebSocket() :
- WebSocket에 세션이 2초 안에 CONNECT되는지 확인 된 후 연결된 SESSION의 ID를 확인할 수 있음

- 3. testSubscribeWebSocket():
- WebSocket이 연결된 후 채팅을 받기 위해 채팅방 구독을 진행하는 메서드임
- 싱글 채팅방으로 생성된 유저 두 명이 각자의 세션으로 웹소켓 구독을 진행하기까지의 시나리오임
- 가장 먼저 STOMP CONNECT를 진행하는데 ChatService의 sendMessage에서는 sessionAccessor과 옳지 않은 접근의 경우 Session 연결을 끊어버려야 하기 때문에 StompHeaders를 StompSession을 생성할 때 연결해 기억해둠
- 그 후 채팅을 받기 위한 채팅방 구독을 진행함
- * STOMP session 연결 Timelimit은 60s
- * 채팅방 헤더 정보를 갖고 올 때의 Timelimit 은 10s

- 4. testChatWebSocketAndGetChatroomChats() :
 - 구독을 진행한 채팅방으로 ChatService의 sendMessage() 메서드를 테스트
 - 해당 메서드를 실행한 후 저장되는 chats들을 ChatroomService의 getChats() 메서드로 테스트
  해보는 메서드임
 - 채팅을 보내기 위한 header 사전 설정 :
 - 1. 연결된 StompSession을 id 연결해줌
 - 2. Destination 설정
- 사전 작업 (SetUp) / 공통 사항 :
- JWT 생성 후 StompHeader에 넣기
- Client 측에 해당 Session에 Header 적용해 수정

- 웹소켓 연결 / 구독 / 채팅 전송 Authorization / 채팅 전송 테스트 통과
- 채팅 전송 Authorization 테스트 :
- CONNECT된 Authorization이 SEND까지 연결되는지 확인하기 위한 목적
- 연결되지 않는다면 Exception을 일으켜야 함 -> 일으키지 않음 확인

- 채팅 전송 테스트 :
- 실제 코드에서는 Session이 유지되기 때문에 이미 Authorization이 검증된 유저를 SimpMessageHeaderAccessor에 주입해 ChatService의 sendMessage를 테스트함
@KooSuYeon KooSuYeon changed the base branch from dev to feat/chat-authorization September 27, 2024 12:47
Base automatically changed from feat/chat-authorization to dev October 2, 2024 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant