Skip to content

feat: add KOTH challenge leaderboard API - #55

Merged
jiwonnii merged 4 commits into
mainfrom
feat/koth-leaderboard
Sep 6, 2026
Merged

jiwonnii merged 4 commits into
mainfrom
feat/koth-leaderboard

Conversation

@jiwonnii

@jiwonnii jiwonnii commented Sep 3, 2026 •

Copy link
Copy Markdown
Collaborator

인증된 사용자가 특정 KOTH 문제의 양수 득점 팀과 순위를 조회할 수 있도록 GET /api/v1/koth/leaderboard?koth_challenge_id={uuid}를 추가합니다.

동작

  • 필수 koth_challenge_id와 UUID 형식을 검증합니다.
  • 문제 ID·제목·상태, leaderboard, total_count, updated_at을 응답합니다. 순위 항목에는 rank, team_id, team_name, earned_score, solved_at이 포함됩니다.
  • 양수 점수 팀만 포함하고 밴된 팀은 제외합니다. 높은 점수 우선, 동점 순위는 1, 1, 3이며 같은 순위는 득점 시각·팀 이름·팀 ID 순으로 표시합니다.
  • /koth/me와 /koth/clubs의 순위·현재 점유자에서도 밴된 팀을 제외합니다.

모델과 마이그레이션

  • KothSolve에 양수 득점 시 solved_at을 요구하는 ck_koth_positive_score_has_solved_at 제약을 추가합니다.
  • koth.0004_positive_score_requires_solved_at이 기존 양수 득점 행의 누락 시각을 보완한 뒤 제약을 적용합니다. 배포 시 마이그레이션 적용이 필요합니다.
  • 마이그레이션 테스트는 DB를 내리기 전에 최신 마이그레이션 목록과 복원 cleanup을 등록해 정상·실패 종료 모두 최신 스키마로 복구합니다.

검증과 후속 반영

KOTH leaderboard API 명세

@jongcoding

Copy link
Copy Markdown
Contributor

전체적인 API 구현은 노션 명세와 거의 일치합니다

  • 인증 처리
  • koth_challenge_id 필수 및 UUID 검증
  • 양수 점수 팀만 포함
  • 밴된 팀 제외
  • 동점 순위 1, 1, 3
  • 동점일 때 solved_at, 팀 이름, 팀 ID 순 정렬

이 부분들은 정상적으로 반영되어 있습니다

다만 모델상 earned_score > 0인데 solved_at이 NULL인 상태가 아직 가능합니다
정상 polling 경로에서는 양수 점수가 되는 순간 solved_at을 넣고 있지만, DB 자체에서는 이 상태를 막고 있지 않아서 잘못된 데이터가 들어오면 API 응답에 solved_at: null이 내려갈 수 있습니다
이 경우 동점 정렬 기준도 명세대로 동작한다고 보기 어렵습니다

기존 데이터에 양수 점수인데 solved_at이 비어 있는 행이 있는지 확인해서 backfill하고, 아래와 같은 DB constraint를 추가하는 게 좋을 것 같습니다

CheckConstraint(
    condition=Q(earned_score__lte=0) | Q(solved_at__isnull=False),
    name="ck_koth_positive_score_has_solved_at",
)

해당 케이스에 대한 migration 테스트와 API 회귀 테스트까지 추가되면 승인해도 될 것 같습니다

추가로 /koth/me, /koth/clubs 쪽은 밴된 팀을 순위나 현재 점유자 계산에서 제외하지 않는 것으로 보여서, 이번 PR과 별도 이슈로라도 ranking 기준을 통일해두는 게 좋을 것 같습니다

@jongcoding

Copy link
Copy Markdown
Contributor

이전에 말씀드린 득점 시각 누락과 차단 팀 제외는 수정된 것 확인했습니다
별도 PostgreSQL에서 기존 앱 테스트 252개도 모두 통과했고, 누적 점수 정렬과 동점 순위도 명세대로 나옵니다
다만 마이그레이션 테스트의 종료 처리만 보완 부탁드립니다
#57에는 0005까지 있는데, 이 테스트는 DB를 0003으로 내렸다가 0004까지만 올리고 끝납니다
추가로 확인해보니 테스트 자체는 통과해도 종료 후에는 0005가 미적용 상태로 남았습니다
같은 DB를 이어 쓰는 다음 테스트가 최신 코드와 다른 테이블 구조를 받게 됩니다
테스트 시작 전에 최신 마이그레이션 목록을 저장하고, 종료할 때 해당 상태로 복원해주세요
DB를 내리기 전에 addCleanup에 복원 처리를 등록해두면 중간에 테스트가 실패해도 정리할 수 있습니다
현재 API 기능이 깨지는 문제는 아니고 테스트끼리 영향을 주지 않도록 하는 보완 요청입니다

@jongcoding

Copy link
Copy Markdown
Contributor

기존에 말씀드린 migration 테스트 복구 누락은 수정 확인했습니다

#55 단독 관련 테스트 21개, 최신 main에 #55와 #57을 합친 관련 테스트 35개 모두 통과했습니다
정상 종료뿐 아니라 setUp 중 예외와 테스트 본문 실패가 발생해도 최신 migration으로 복구되는 것까지 확인했습니다

기능 쪽 추가 수정 요청은 없습니다
#55 먼저 머지하고 #57은 base를 main으로 변경한 뒤 CI 한 번 더 확인해주세요

문서 두 군데만 정리 부탁드립니다
PR 본문의 모델·migration 변경 없음 문구는 현재 변경 내용에 맞춰 수정해주세요
공통 계약에도 이번 리더보드 오류코드 3개를 등록해주세요
지금 API나 CI가 깨지는 부분은 아니지만 목록에 없는 코드는 HTTP 상태 대조 검사에서 빠지고 있습니다

@jiwonnii
jiwonnii merged commit 665467b into main Sep 6, 2026
6 checks passed
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.

2 participants