Skip to content

✨[FEAT] UT 시드에 정산 리포트 연결 및 리셋 플래그 추가 (#41) - #42

Open
chjpooh2002 wants to merge 3 commits into
devfrom
feat/41-seed-report-reset
Open

chjpooh2002 wants to merge 3 commits into
devfrom
feat/41-seed-report-reset

Conversation

@chjpooh2002

Copy link
Copy Markdown
Contributor

📌 제목 형식

1. 📖 개요

  • UT(T-13 리포트 목록 → T-14 정산 리포트 · 교육비 수정 → T-15 수입 · 입금 현황)를 시드 데이터로 재현하도록, 수입 카드 과외 4개에 사이클 1 정산 리포트를 만들어 청구와 연결합니다.
  • 리허설로 바뀐 데이터를 되돌릴 수 있게 SUDAM_SEED_RESET=true로 재기동하면 시드 선생님의 과외를 지우고 처음 상태로 다시 만드는 리셋 플래그를 추가합니다.

2. ✅ 변경 사항

  • 시드 리포트 (B1)
    • 박지후 · 윤서아 · 이도윤 · 김하린의 사이클 1에 정산 회차만큼 회차 · 기록 · 진도를 깔고, 실제 정산과 같은 순서(사이클 1 정산 → 사이클 2 열기 → 리포트 생성 → 청구 발행)로 SettlementReportCreator를 불러 리포트를 만듭니다. 리포트를 직접 만들지 않아 통계 · 진도 표가 실제 정산과 같은 계산으로 나옵니다.
    • 사이클 2 선불 청구의 reportId에 사이클 1 리포트 ID를 연결합니다. 실제 정산은 사이클을 닫을 때 항상 리포트를 만들므로 4명 모두 리포트를 둡니다.
    • 학생마다 이해도 분포가 다른 기록 노트를 추가했습니다 (상/중/하: 박지후 6/2/0, 윤서아 2/5/1, 이도윤 0/1/3, 김하린 5/3/0).
    • DemoIncomeCard는 기록 수가 정산 회차와 다르면 만들어지지 않습니다 (스냅샷의 "인정 회차 = 정산 회차" 전제 보호).
    • 김서아의 회차 · 기록 생성 반복문을 createRecordedSessions로 빼서 함께 씁니다 (김서아 동작은 그대로).
  • 리셋 플래그 (B2)
    • sudam.seed.reset(SUDAM_SEED_RESET, 기본 false) 추가. sudam.seed.enabled도 true일 때만 동작합니다.
    • DemoSeedResetter가 시드 선생님의 과외 ID를 조회한 뒤, JPQL 일괄 삭제를 FK 역순으로 실행합니다. 참여자의 같은 테이블 참조(guardian_consent_by)는 지우기 전에 비웁니다.
    • 삭제는 seed() 트랜잭션에 MANDATORY로 참여합니다. 다시 만들다 실패하면 삭제도 롤백되어 원래 데이터가 남습니다.
    • User · TeacherProfile · 약관 동의는 남겨 카카오 로그인 상태를 유지합니다.
    • 리셋 모드로 부팅하면 "리셋 후 끄세요" 경고를 로그로 크게 남깁니다.
  • 문서: docs/architecture.md 시연용 가상 데이터 절에 리셋 사용법, 학생별 리포트 표, 배포 주의를 추가했습니다.

3. 🧪 테스트

  • 로컬에서 애플리케이션 실행 및 기본 플로우 확인
  • 단위 테스트 실행 (./gradlew test)
  • 추가로 수행한 테스트가 있다면 아래에 작성

추가 테스트 내역:

  • .\gradlew.bat build 통과 (테스트 228개, 실패 0).
  • 단위 테스트 (시드 패키지 38개): 생성기 호출 대상 · 순서(사이클 1 SETTLED 뒤 호출), 청구 reportId 연결, 사이클 1 회차 수 · 날짜 범위, 리셋이 과외 존재 확인보다 먼저 실행됨, 삭제 순서, 실행기의 reset 전달, 시드가 꺼져 있으면 리셋기 빈 없음, 기록 수 불변식.
  • 로컬 실기동 (MySQL + Redis):
    1. create + 시드: 리포트 생성 · 청구 연결을 DB로 확인, 박지후 · 윤서아 · 이도윤 GET /reports/{id} · GET /reports/{id}/invoice 200.
    2. 박지후 교육비를 400,000으로 수정 → update + 리셋으로 재기동: 360,000 · 조정 내역 0건으로 복구, 선생님 User ID · 약관 동의 유지, 옛 과외 ID의 행 남지 않음.
    3. update, 리셋 끔: "이미 있어 건너뜀", 데이터 변화 없음.
    4. 김하린 리포트 추가 뒤 다시 부팅해 리포트 4건 · 청구 연결 4건 확인.
  • GET /reports/deliveries는 아직 없는 API라 목록은 확인하지 못했습니다.

4. 🔗 관련 이슈

5. 📂 변경 파일/영향 범위

  • 영향 도메인(예: 회원, 인증, 주문 등): 시연용 가상 데이터(global/seed). 도메인 코드는 바꾸지 않았고 리포트 생성 포트를 호출만 합니다.
  • 주요 변경 파일:
    • com.sudam.global.seed.DemoSeedService — 리포트 생성 · 청구 연결, 리셋 호출
    • com.sudam.global.seed.DemoSeedResetter (신규) — FK 역순 일괄 삭제
    • com.sudam.global.seed.DemoIncomeCard — 학생별 기록 노트, 기록 수 검사
    • com.sudam.global.seed.DemoLessonPlan — 시작일부터 수업일 고르기
    • com.sudam.global.seed.DemoSeedRunner — reset 설정 전달, 경고 로그
    • src/main/resources/application.yaml, .env.example, docs/architecture.md

6. 🙋 리뷰 요청

  • DemoSeedResetter.STATEMENTS의 삭제 순서가 FK 구조와 맞는지 봐 주세요. 리포트 열람 테이블(settlement_report_views)이 머지되면 SettlementReport 삭제 앞에 한 줄 추가하겠습니다.
  • 리셋이 seed() 트랜잭션 안에서 도는 구조(실행기에서 따로 부르지 않음)가 괜찮은지 봐 주세요. 따로 부르면 트랜잭션이 둘로 나뉘어, 시드가 실패할 때 지워진 채 남습니다.
  • 이제 리포트 목록(T-13)에 4건이 나옵니다. 4건 모두 GENERATED로 시작하고, "보냄" 상태는 UT에서 실제 보내기로 확인하는 것을 전제로 했습니다.

7. ⚠️ 주의 사항 / 기타

  • .env.example에 SUDAM_SEED_RESET 키를 추가했습니다. 기본값이 false라 비워 둬도 로컬 실행은 그대로입니다.
  • 개발 서버(ddl-auto: update)에 옛 시드(리포트 없음)가 있으면, 이 PR 배포 후 한 번 SUDAM_SEED_RESET=true로 재기동해야 리포트가 생깁니다. 리셋이 끝나면 꼭 다시 끄세요 (켜 두면 재기동마다 지워짐).
  • SUDAM_SEED_TEACHER_KAKAO_ID에 실제 계정을 넣고 리셋하면, 그 계정에서 손으로 만든 과외도 함께 지워집니다.
  • 스키마 변경 없음.

- 수입 카드 과외 4개의 사이클 1에 회차 · 기록 · 진도를 깔고, 실제 정산 순서(정산 → 다음 사이클 → 리포트 → 청구)로 SettlementReportCreator를 불러 리포트를 만든다.
- 사이클 2 선불 청구의 reportId에 사이클 1 리포트 ID를 연결한다.
- 학생마다 이해도 분포를 다르게 둔 기록 노트를 추가하고, 기록 수가 정산 회차와 다르면 카드를 만들 수 없게 했다.
- sudam.seed.reset(SUDAM_SEED_RESET)과 sudam.seed.enabled가 모두 true면 재기동 때 시드 선생님의 과외와 그 아래 데이터를 지우고 다시 만든다.
- DemoSeedResetter가 JPQL 일괄 삭제를 FK 역순으로 실행한다. 참여자의 같은 테이블 참조(guardian_consent_by)는 지우기 전에 비운다.
- 삭제는 seed() 트랜잭션에 MANDATORY로 참여해, 다시 만들다 실패하면 삭제도 롤백된다. User · TeacherProfile · 약관 동의는 남긴다.
- 리셋 모드로 부팅하면 끄라는 경고를 로그로 크게 남긴다.
@chjpooh2002 chjpooh2002 added the feat 새로운 기능 개발 label Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feat 새로운 기능 개발

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨[FEAT] UT 시드에 정산 리포트 연결 및 리셋 플래그 추가

1 participant