Files
clean-architecture-backend-…/docs/manual/11-checklist.md
T
DongHyeonka 7b5b4c6983 fix(http)!: fileserver·notification HTTP와 bulk envelope를 공용 계약대로 답한다
문제: fileserver·notification의 HTTP 표면이 공용 계약(web AGENTS B8,
http-contract §1, manual 11)과 달랐다.
- fileserver batch는 part가 실패해도 success:true였고 결과를 data.results에
  넣었다. fullySucceeded()를 아무도 부르지 않았다. 계약끼리도 달랐다(web B8의
  BATCH_PARTIAL_FAILURE vs fileserver 계약의 200 + results[].error).
- BulkEnvelope.partial의 error.message가 영어 고정 문구였고, BulkItemResult는
  호출자 문구를 그대로 실었으며 null 키를 남겼다(mix-in 없음).
- Content-Range가 CORS 노출 목록에 없어 브라우저가 다운로드를 이어 받지 못했다.
- 알림 제출·template 게시의 모르는 channel·slot·locale이 details 없는
  BAD_PARAMETER였고(주석은 validation error), template 경로가 lowerCamel이 아닌
  /notification-templates였다.
- 전송 넷(raw·multipart·draft-12·tus)이 이름 없는 업로드에 "upload.bin"을
  지어 넣었다. 앱 정책 OriginalFilenamePolicy의 기본값은 "file"이라 업무 규칙이
  두 곳에 있었다(HARD-STOP 4).
- EnvelopeWireShapeTest는 http-contract §1의 증거로 쓰이는데 data null 키 생략,
  String → Envelope, unsorted page의 sort:null, 부분 실패 문구를 보지 않았다.

고른 방법:
- 리뷰 README 6절 ①대로 fileserver batch도 공용 bulk envelope다. 모두 성공 →
  success:true + results, 하나라도 실패 → success:false + BATCH_PARTIAL_FAILURE +
  part별 details(index, status, id, code, message). 성공한 part는 되돌리지 않는다.
  BatchUploadResponse는 쓰는 곳이 없어져 지웠다.
- BulkEnvelope.partial과 BulkItemResult.error(index, ApiErrorCode)는 category
  고정 문구를 쓴다. BulkItemResult에 null 생략 mix-in을 더했다.
- 알림 controller는 NotificationFieldRejection(VALIDATION_FAILED carrier, 필드를
  짚는 details 하나, 거절한 값은 싣지 않음)을 던진다. template 경로는
  /notificationTemplates다. 읽는 endpoint가 없어 201에 Location을 싣지 않고,
  manual 11 규칙에 그 경우를 적었다.
- 전송은 이름이 없으면 빈 이름을 넘기고 OriginalFilenamePolicy가 정한다.
- EnvelopeWireShapeTest에 빠진 넷을 더했다. EnvelopeTest의 when 둘인 시험을
  둘로 나눴다.
버린 대안: /notification-templates를 별칭으로 남기기 — 같은 자원의 경로가 둘이
되고 인가·공개 경로 스냅숏이 둘을 따로 봐야 한다.

위험·한계: batch를 읽는 client, 알림 template 경로를 쓰는 client와 배포
스크립트, BulkItemResult.error(index, code, message)를 부르던 코드가 바뀐다
(upgrade 안내 6·7·10·11·12, 14).

BREAKING CHANGE: fileserver batch 응답이 공용 bulk envelope가 됐다. 알림
template 경로가 /notificationTemplates다. 알림의 모르는 vocabulary 값은
VALIDATION_FAILED다. BulkItemResult.error는 ApiErrorCode를 받는다. 이름 없는
업로드의 표시 이름이 "file"이다. 할 일은 docs/upgrade/2026-11-round9-contracts.md.

Refs: RR9-03-01, RR9-03-02, RR9-03-09, RR9-03-13, RR9-03-21, RR9-05-09
2026-11-13 04:46:39 +09:00

3.6 KiB

11. 체크리스트 — PR 올리기 전

빠진 것이 있으면 해당 장으로 돌아간다. 검사 명령은 저장소 루트에서 실행한다.

배치·이름

  • 배치를 03장 기준표로 정했다(기본: 계층 leaf 안 <feature> 패키지).
  • 패키지 이름이 템플릿 패키지(src/application/core/README.md 「패키지 소유 (Package ownership)」)와 겹치지 않고, 업무 코드를 템플릿 패키지에 넣지 않았다.
  • 이름이 src/application/core/AGENTS.md 「Naming convention」을 따른다.

domain

  • 불변식은 aggregate 안에 있고, 위반은 XInvariantException(Reason)이다.
  • id 문법은 id 값 객체 생성자가 검사한다.
  • Spring·JPA·전송 타입을 import하지 않는다.

application

  • 모든 유스케이스에 @UseCaseCapability, 선언과 TransactionPort 호출이 맞다.
  • 쓰기 유스케이스: @RequiresPermission, non-final, bean으로 조립.
  • 외부 호출은 트랜잭션 밖이다.
  • 멱등성 선언을 05장 기준으로 골랐다(재전송될 쓰기는 KEYED).
  • 클라이언트 탓 실패는 carrier 예외 + 기능 코드, 서버 탓은 IllegalStateException.

persistence

  • 저장 adapter가 서비스 전용 persistence leaf에 있다(persistence-jpa 아님).
  • 연관관계는 한쪽만(mappedBy 없음).
  • 중복 규칙은 DB 유일성 제약이 막고, adapter가 그 제약 위반만 기능 예외로 바꾼다.
  • 여러 인스턴스가 집는 작업은 트랜잭션 안 claim + lease.
  • 마이그레이션은 자기 스트림(자기 history table)에 있고, 적용된 파일을 고치지 않았다.
  • adapter가 XRepositoryContract를 실 DB lane에서 상속한다.

inbound

  • 컨트롤러는 변환만 한다. repository·엔티티를 모른다.
  • 경로는 lowerCamel 복수형(AIP-122). 생성은 201 + Location. 만든 것을 읽는 endpoint가 없으면 Location을 싣지 않고 controller 주석에 그 이유를 적는다.
  • 도메인 규칙을 DTO bean validation에 다시 쓰지 않았다.
  • 엔드포인트를 더했으면 요청률 제한을 어디서 거는지(ingress/app) 배포 설계에 있다. 앱 기본 off·켜는 법은 docs/security/rate-limiting.md.

조립·권한

  • XConfig가 @ConditionalOnBean(포트)이고 imports에 한 줄 있다. 포트가 다른 자동 설정에서 오면 afterName.
  • 역할 → 권한 매핑을 app.authz.role-permissions에 더했다.
  • 객체 단위 판정이 필요하면 유스케이스 안에서 하고, 남의 것은 404.

이벤트

  • 저장과 outbox append가 같은 tx.inWrite 안이다.
  • 계약 id·버전·schema·해시를 정했고 계약 bean을 등록했다.

테스트

  • 포트마다 fake 하나와 공유 계약이 포트 소유 leaf testFixtures에 있다.
  • 이름은 행동 문장, @DisplayName은 필요할 때만 한국어, GWT 주석, // when 하나.
  • Docker가 필요한 테스트는 strict lane이고 단계가 있다.

검사

./gradlew <owner-leaf>:check --console=plain        # 건드린 leaf마다
./gradlew architectureCheck --console=plain          # leaf 경계를 넘었으면
./gradlew verifyPublicPathSnapshot                   # 공개 경로가 바뀌었으면
./gradlew :app-bootstrap:verifyEnvKeys               # env 키가 바뀌었으면
./gradlew verifyDependencyLocks                      # 의존성이 바뀌었으면
  • 실행한 명령과 결과를 PR 본문 「검증」에 적었다. 못 돌린 것은 이유와 함께 적었다.