Skip to content

[Feature] 공통 채팅 REST API 및 WebSocket 이벤트 추가 - #1766

Merged
kongwoojin merged 3 commits into
developfrom
feature/1750-common-chat-api
Nov 17, 2026
Merged

kongwoojin merged 3 commits into
developfrom
feature/1750-common-chat-api

Conversation

@kongwoojin

@kongwoojin kongwoojin commented Nov 14, 2026 •

Copy link
Copy Markdown
Member

PR 개요

이슈 번호: #1750

공통 채팅 REST API와 WebSocket 이벤트 구독을 추가합니다. 기존 채팅 화면과 레거시 함수는 유지합니다.

PR 체크리스트

  • Code convention을 잘 지켰나요?
  • Lint check를 수행하였나요?
  • Assignees를 추가했나요?

작업사항

  • 버그 수정
  • 신규 기능
  • 코드 스타일 수정 (포맷팅 등)
  • 리팩토링 (기능 수정 X, API 수정 X)
  • 기타

작업사항의 상세한 설명

기존 구조의 제약

  • 채팅 API와 구독 경로가 분실물의 articleId, chatRoomId에 종속되어 있습니다.
  • 공통 API에서 사용하는 문자열 roomId, messageId와 이벤트 구분을 기존 모델로 표현할 수 없습니다.

변경 내용

  • /chatrooms 기반 목록·상세·메시지 조회, 메시지 전송, 읽음 처리 API를 추가했습니다.
  • 메시지 조회에 after_message_id, before_message_id, limit을 지원합니다.
  • /topic/chatrooms/{roomId}에서 MESSAGE_CREATED, ROOM_CHANGED 이벤트를 수신하고 도메인 모델로 변환합니다.
  • 문자열 ID와 nullable 발신자 정보를 별도 모델로 표현합니다.
  • 기존 ChatRepository, ChatRemoteDataSource에 구현하고, 레거시 함수에는 @Deprecated("")를 추가했습니다.
  • 분실물 채팅방 생성은 기존 API를 사용한 뒤, 공통 목록에서 서버가 반환한 roomId를 조회합니다.

변경 전후 구조

flowchart TB
    subgraph Before["변경 전"]
        direction LR
        F1["feature/chat"] --> U1["기존 UseCase"]
        U1 --> R1["ChatRepository"]
        R1 --> D1["ChatRemoteDataSource"]
        D1 --> A1["ChatAuthApi<br/>분실물 REST API"]
        D1 --> S1["KoinStomp<br/>분실물 토픽"]
    end

    subgraph After["변경 후"]
        direction LR
        F2["feature/chat"] --> U2["기존 UseCase<br/>레거시 함수 Deprecated"]
        U2 --> R2["ChatRepository"]
        U3["추가 채팅 UseCase"] --> R2
        R2 --> D2["ChatRemoteDataSource"]
        D2 --> A2["ChatAuthApi<br/>기존 API + /chatrooms"]
        D2 --> S2["KoinStomp<br/>기존 토픽 + /topic/chatrooms/{roomId}"]
    end
Loading

논의 사항

없음

스크린샷

해당 없음

추가내용

  • Base: refactor/1750-stomp-websocket
  • API 명세
  • develop, sprint 브랜치를 향하고 있습니다
  • production 브랜치를 향하고 있습니다

Summary by CodeRabbit

  • 새 기능
    • 새 채팅 기능을 통해 채팅방 목록과 상세 정보, 메시지를 조회할 수 있습니다.
    • 채팅 메시지 전송, 새 메시지 및 채팅방 변경 이벤트 수신, 읽음 처리를 지원합니다.
    • 분실물 게시글에서 관련 채팅방을 만들 수 있습니다.

@kongwoojin
kongwoojin requested a review from a team as a code owner November 14, 2026 17:38
@kongwoojin kongwoojin self-assigned this Nov 14, 2026
@coderabbitai

coderabbitai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

채팅방 목록·상세·메시지 조회, 이벤트 구독, 메시지 전송과 읽음 처리를 위한 새 API와 도메인 모델을 추가했습니다. 새 기능을 저장소와 유스케이스에 연결하고, 기존 채팅 메서드에는 deprecated 표시를 적용했습니다.

Changes

채팅 API 통합

Layer / File(s) Summary
도메인 계약과 유스케이스
domain/src/main/java/in/koreatech/koin/domain/model/chat/*, domain/src/main/java/in/koreatech/koin/domain/error/chat/KoinChatException.kt, domain/src/main/java/in/koreatech/koin/domain/repository/ChatRepository.kt, domain/src/main/java/in/koreatech/koin/domain/usecase/chat/*
채팅방·메시지·이벤트 모델과 채팅 도메인 유형, 저장소 메서드, 새 유스케이스를 추가했습니다. 기존 채팅 메서드와 관련 유스케이스에는 deprecated 표시를 적용했습니다.
API 계약과 원격 데이터 소스
data/src/main/java/in/koreatech/koin/data/request/chat/*, data/src/main/java/in/koreatech/koin/data/response/chat/*, data/src/main/java/in/koreatech/koin/data/api/auth/ChatAuthApi.kt, data/src/main/java/in/koreatech/koin/data/source/remote/ChatRemoteDataSource.kt
새 요청·응답 모델과 채팅방 API를 추가했습니다. 원격 데이터 소스는 새 API 호출을 위임하고 /topic/chatrooms/$roomId 이벤트 프레임을 Flow로 변환합니다. 기존 원격 메서드에도 deprecated 표시를 적용했습니다.
저장소 변환과 오류 처리
data/src/main/java/in/koreatech/koin/data/mapper/ChatRoomMapper.kt, data/src/main/java/in/koreatech/koin/data/repository/ChatRepositoryImpl.kt
응답을 도메인 모델로 변환하는 매퍼와 새 저장소 메서드를 추가했습니다. HTTP 401·403·404와 차단 사용자 오류를 채팅 예외로 변환합니다. 분실물 채팅방 생성은 게시글 ID로 방을 찾아 상세 정보를 조회합니다.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant UseCase as SubscribeChatRoomEventsUseCase
  participant Repository as ChatRepositoryImpl
  participant DataSource as ChatRemoteDataSource
  participant Topic as /topic/chatrooms/{roomId}
  UseCase->>Repository: subscribeChatRoomEvents(roomId)
  Repository->>DataSource: subscribeChatRoomEvents(roomId)
  DataSource->>Topic: 채팅방 이벤트 구독
  Topic-->>DataSource: 이벤트 프레임
  DataSource-->>UseCase: 이벤트 응답을 Flow로 전달
Loading

Suggested reviewers: kym-p

Merge Risk: Minimal · up to a16ae

This change adds the common chat REST APIs, WebSocket event subscription and the matching domain models, and marks the legacy chat methods as deprecated. No concrete defect was established in the reviewed code, so there is no known merge-blocking risk. Whoever adds the first caller of the event-subscription use case should create and collect the Flow in the same coroutine.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed PR 제목은 공통 채팅 REST API 추가와 WebSocket 이벤트 추가를 언급합니다. 변경 요약에서 확인되는 ChatAuthApi, ChatRepository, ChatRoomEvent, 새 UseCase 등이 이 내용과 일치합니다. 다만 제목에 채팅방 목록·메시지 전송·읽음 처리 등 세부 범위와 기존 API @Deprecated 처리는 드러나지 않습…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

PR 제목은 공통 채팅 REST API 추가와 WebSocket 이벤트 추가를 언급합니다. 변경 요약에서 확인되는 ChatAuthApi, ChatRepository, ChatRoomEvent, 새 UseCase 등이 이 내용과 일치합니다. 다만 제목에 채팅방 목록·메시지 전송·읽음 처리 등 세부 범위와 기존 API @Deprecated 처리는 드러나지 않습니다. 그래도 제목은 주요 변경을 정확히 설명합니다.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between b84aba8 and a16ae11.

Files selected for processing: 29

  • data/src/main/java/in/koreatech/koin/data/api/auth/ChatAuthApi.kt
  • data/src/main/java/in/koreatech/koin/data/mapper/ChatRoomMapper.kt
  • data/src/main/java/in/koreatech/koin/data/repository/ChatRepositoryImpl.kt
  • data/src/main/java/in/koreatech/koin/data/request/chat/ChatReadRequest.kt
  • data/src/main/java/in/koreatech/koin/data/request/chat/SendChatMessageRequest.kt
  • data/src/main/java/in/koreatech/koin/data/response/chat/ChatRoomEventResponse.kt
  • data/src/main/java/in/koreatech/koin/data/response/chat/ChatRoomInfoResponse.kt
  • data/src/main/java/in/koreatech/koin/data/response/chat/ChatRoomMessageResponse.kt
  • data/src/main/java/in/koreatech/koin/data/source/remote/ChatRemoteDataSource.kt
  • domain/src/main/java/in/koreatech/koin/domain/error/chat/KoinChatException.kt
  • domain/src/main/java/in/koreatech/koin/domain/model/chat/ChatDomainType.kt
  • domain/src/main/java/in/koreatech/koin/domain/model/chat/ChatRoomEvent.kt
  • domain/src/main/java/in/koreatech/koin/domain/model/chat/ChatRoomInfo.kt
  • domain/src/main/java/in/koreatech/koin/domain/model/chat/ChatRoomMessage.kt
  • domain/src/main/java/in/koreatech/koin/domain/repository/ChatRepository.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/ChatBlockUserUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/CreateLostItemChatRoomUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/GetChatListUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/GetChatMessageUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/GetChatRoomInfoUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/GetChatRoomMessagesUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/GetChatRoomUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/GetChatRoomsUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/MarkChatReadUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/SendChatMessageUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/SendMessageUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/SubscribeChatListUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/SubscribeChatRoomEventsUseCase.kt
  • domain/src/main/java/in/koreatech/koin/domain/usecase/chat/SubscribeChatRoomUseCase.kt

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@sonarqubecloud

Copy link
Copy Markdown

@bcsd-b-bot bcsd-b-bot Bot added the ci:passed label Nov 14, 2026
Base automatically changed from refactor/1750-stomp-websocket to develop November 15, 2026 03:19
): List<ChatMessageResponse>

@POST("chatroom/lost-item/{article_id}/{chat_room_id}/block")
@Deprecated("")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lost-item 전용 chat 이라 사라지는게 맞긴 할 거 같은데,
swagger 에는 남아있어서 혹시 싶어서 남깁니다.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

그래서 Deprecated를 박았습니다

@kongwoojin
kongwoojin merged commit 8ba257c into develop Nov 17, 2026
37 checks passed
@kongwoojin
kongwoojin deleted the feature/1750-common-chat-api branch November 17, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants