Be/feature/#460 ai 통신 socket 통신 서버 측 리팩토링 and 테스트 코드 작성

[HeoJiye]

reslove #460

변경 사항

• AI 파트 Nest 서버 측 리팩토링
• AI 파트 Nest 서버 측 testcode 작성
  • chatbot 쪽 (생성형 ai, stream 조작 등 로직)
  • socket 쪽 (server와 client 간의 socket 통신 로직)

고민과 해결 과정

1️⃣ AI 파트 Nest 서버 측 리팩토링

기존 구조

• AI api, Stream, Socket 통신 관련 로직들이 event 폴더에 모두 모여있음

src/events
- clova-studio.ts
- create-dto-helper.ts
- events.gateway.ts
- event.module.ts
- stream.ts
- types.ts
- ws-exception.filter.ts

수정한 구조

• AI api 관련 로직과 socket 통신 관련 로직을 분리 (src/chatbot, src/socket)
• 추후 Clova에서 ChatGPT로 변경이 용이하게 공통 interface를 만들어놓고 바꿔끼면 되도록 작성
• socket쪽은 SocketService와 SocketGateway를 분리해서 비즈니스 로직과 이벤트 게이트웨이 로직을 분리함

src/chatbot
- clova-studio
   - clova-studio.service.ts
   - ...
- chatbot.interface.ts

src/socket
- socket.service.ts
- socket.gateway.ts

🎯 리팩토링 목표

• 작은 기능 단위로 단위 테스트를 작성할 수 있도록
• 추후에 ChatGPT등 다른 API로 옮겨가기 쉽도록
• socket 관련 로직과 ai api 관련 로직이 잘 분리되어 있도록

2️⃣ AI 파트 Nest 서버 측 테스트 코드 작성

• chatbot 쪽은 작은 로직을 가지고 있는 함수들 단위로 테스트 코드를 작성함.

- src/chatbot/clova-studio/clova-studio.servie.spec.ts
- src/chatbot/clova-studio/message/message.spec.ts
- src/chatbot/clova-studio/stream/stream.spec.ts

단순히 input, output을 비교하는 수준의 단위 테스트

• socket 쪽은 server와 client 간의 통신 로직을 검사하는 테스트 코드를 작성함.

- src/socket/socket.service.spec.ts

client가 메세지를 보내면, 일어나야 하는 일들 등의 상호작용 과정에서 일어나야 하는 일들을 테스트
⚠ 완전 e2e 수준의 test를 src/socket/socket.gateway.spec.ts에 추후에 작성할 예정

(선택) 테스트 결과

[HeoJiye]

@kimyu0218
⚠리팩토링 과정에서 src/chat/dto/create-chatting-message.dto.ts에 함수 하나를 수정했는데, 그래서 chat.service.spec.ts에서 지금 오류가 나!
유정이가 다른 PR에 댓글로 테스트 코드 수정한다 그래서 일단 안 건드렸는데, 이거 수정 필요할 것 같아!

[HeoJiye]

🗨

• 테스트 문구, input output이 어때야하는지 분명하게 수정해보기
• mocks 파일 구조 유정이랑 통일하기

[kimyu0218]

👍 👍

[Doosies]

👍 👍 👍 확실히 한곳에 모여 있을 때보다 나눠두니까 이 함수들이 어떤 역할을 하는지 보기 쉬워졌어