Repository navigation
Feat: 스펙 diff 에 STOMP 계약 비교 추가 - #48
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
💡 PR 작업 내용
📋 세부 작업 내용
1.
x-websocket비교로 STOMP 계약을 diff 에 포함[기존]
STOMP 는 OpenAPI paths 에 없어서, 계약이 바뀌어도 스펙 변경 알림에 한 줄도 안 나갔습니다.
STORIX-BE-2.0#284 에서 구독에 인가 검증을 넣고 에러 전달 통로를 정리했는데, 알림에는 상태코드가 바뀐 REST 4개만 나갑니다. 구독 인가가 생긴 것도, 사유를 받으려면
/user/queue/errors를 먼저 구독해야 한다는 것도 전달되지 않습니다.[변경 후]
BE 가 OpenAPI 루트에
x-websocket을 싣기 시작했으므로 그걸 비교해 STOMP 계약 변경을 diff 에 포함합니다.2. STOMP 계약 변경 분류
[기존]
STOMP 계약 변경은 diff 에 잡히지 않아 분류 기준도 없었습니다.
[변경 후]
목적지 제거·권한 변경·에러 목적지 변경은 깨지는 변경으로 분류합니다.
ACTIONABLE에도 넣어 슬랙 본문에서 접히지 않게 했습니다3. 웹소켓 태그로 따로 노출
[기존]
알림에 웹소켓 변경이 드러나는 자리가 없었습니다.
[변경 후]
웹소켓 태그로 따로 묶어 노출합니다. 슬랙에는 이렇게 나갑니다.
확인한 것들:
/v3/api-docs를 그대로 받아 돌렸습니다. 계약이 없던 스펙과 비교하면 목적지 4개, 사유 4종, 에러코드 10개가 잡힙니다.before가 없어 터지던 것을 고쳤습니다. 실제 스펙으로 돌리다 발견했습니다.changed에 항목 하나를 더하는 방식이라 슬랙·체인지로그·상세 리포트가 모두 그대로 받습니다.📸 작업 화면 (스크린샷)
💬 리뷰 요구사항(선택)
x-websocket의destinations는 BE 쪽에 상수로 적혀 있습니다. 코드에서 자동으로 뽑는 게 아니라 실제 destination 과 어긋날 수 있는데, 지금은 4개뿐이고 바뀔 일이 드물어 그대로 두었습니다.⭐ 관련 이슈 번호
🖇️ 기타
BE 쪽
x-websocket은 Team-STORIX/STORIX-BE-2.0#284 에 들어 있습니다. 그쪽이 먼저 배포돼야 이 비교가 의미를 갖습니다.