Files
clean-architecture-backend-…/docs/adr/ADR-JPA-006-canonical-technical-audit.md
T
DongHyeonka 59dff0041c ci(docs): 문서 검사에 문체를 더하고 번역한 결정 기록의 머리 문구를 맞춘다
문체 규칙(「~한다」, 「~합니다」와 섞지 않음)은 docs/README.md에 있지만
지키는 검사가 없어서, 번역 뒤에도 runbook 열 개에 높임 문장이 남았다.
그리고 결정 기록 머리 블록의 둘째 줄은 「본문은 결정한 때의 원문이다」인데,
2026-11-07에 본문을 한국어로 옮긴 ADR에는 맞지 않는다.

- check-docs.py `style`: 살아 있는 문서의 문장 끝이 높임(습니다·합니다·
  입니다·됩니다·십시오·하세요·주세요)이면 실패. 코드 블록, 인라인 코드,
  따옴표·낫표 안 인용, 「이력」 인용 블록은 보지 않는다.
- runbook 열 개의 「이 runbook은 다음 alert에서 발동됩니다.」를 「다음 alert가
  울리면 쓴다.」로 고쳤다. 지금 걸리는 곳은 이것뿐이었다.
- 결정 기록 표시 줄을 「본문은 결정한 때의 내용이다(번역은 뜻을 바꾸지
  않았다)」로 바꿨다: check-docs.py의 DECISION_LABEL, docs/README.md 설명,
  docs/adr의 머리 블록 33개(기록은 머리 블록만 고친다는 규칙 안).
- docs/README.md 「문서 검사」에 앞 커밋이 더한 `link`와 이번 `style`을 적고,
  링크 검사 설명을 바로잡았다. 「모듈 README」 절(design-docs
  docs-system.md 6.2절 다섯 칸)을 더했다.

버린 대안: 문체를 리뷰로만 보기(번역 묶음 네 개를 거쳐도 남았다).

위험: design-docs docs-system.md 4.1절과 프론트의 같은 문구는 이 repo
밖이라 고치지 않았다(총괄에게 알린다).

검증: python3 -m unittest discover -s scripts/tests(문체 시험 5 포함),
check-docs.py, check-work-docs.py 모두 rc=0. 이 커밋의 트리만 얹은 임시
worktree에서 돌렸다. 검사 조건을 끈 사본 둘에서 문체 시험이 각각 2건,
1건 실패했다.
2026-11-07 22:20:18 +09:00

4.2 KiB

결정 기록 본문은 결정한 때의 내용이다(번역은 뜻을 바꾸지 않았다). 지금도 유효한지는 「상태」를, 지금 동작은 「현재 정본」을 읽는다.

  • 상태: 채택
  • 작성일: 2026-08-24
  • 요약: 기술 감사 모델은 audit 하나뿐이라는 결정이다.
  • 현재 정본: docs/jpa/repository-adaptation.md

ADR-JPA-006 — 기술 감사 모델은 audit 하나뿐이다

  • 상태: 채택
  • 날짜: 2026-08-24
  • 리뷰: docs/reviews/2026-08-14-jpa-module-code-review.md JPA-022

배경

이 leaf에 완전한 기술 감사 장치가 둘 있고, 둘은 schema에 대해 의견이 다르다.

audit/AuditableEntity는 길이 256의 actor 열과 함께 created_at/created_by/updated_at/updated_by를 넣고, 명시적인 initializeAudit/applyModification 호출과 AuditContextPort로 값을 잡는다. auditing/AuditMetadata는 길이 64의 actor 열과 함께 created_*/modified_*를 넣는 Spring Data embeddable이고, AuditorAware를 거쳐 @CreatedDate 같은 것으로 값을 잡는다.

실제로 쓰이는 것은 첫째뿐이다: 샘플 엔티티가 상속하는 것이고 migration도 그것을 위해 썼다. JpaAuditingConfiguration은 Spring @Configuration이 아니고, 운영 코드의 어떤 것도 auditing 타입 셋 중 하나를 만들지 않는다.

리뷰는 migration이나 켜기 결정이 붙은 정해진 모델 하나를 요구했다. 막으려던 실패 방식은 구체적이다: 새 엔티티를 쓰는 사람이 먼저 찾은 패키지를 고르고, 그러면 열 이름, actor 길이, 값 잡는 lifecycle이 테이블마다 갈라진다.

결정

audit/AuditableEntity가 정본이고, 쓰지 않는 auditing/* 구현은 지운다.

완전하고 호환되지 않는 구현을 잠든 후보로 두는 것이 바로 리뷰가 경고한 모호함을 만들었다: 새 엔티티가 자동 완성으로 패키지를 고르고 열 이름, actor 한계, 값 잡는 lifecycle을 소리 없이 바꿀 수 있었다. 나중에 Spring Data auditing으로 옮기는 것은 정본 모델의 migration이지, 옆에서 어긋나 온 두 번째 모델을 켜는 것이 아니다.

그 나중의 migration은 created_*/updated_*, 256자 actor 계약, AuditContextPort, 공용 Clock을 지켜야 한다. listener 배선과 엔티티 변환은 한 번에 들어온다.

결과

감사 장치 둘이 한 leaf 안에 읽을 수 있게 남고, 읽는 사람에게 어느 것이 살아 있는지 알려야 한다. 그 비용은 이 문서, 패키지 javadoc, 그리고 이름이 그것을 말하는 시험이 낸다.

단언하지 않으면 소리 없이 남는 실패 방식이 둘 있으므로, 둘 다 단언한다:

  • 후보가 stereotype을 얻어 이 모듈이 classpath에 있는 모든 배포에서 값을 넣기 시작한다. 테이블에 modified_* 열이 없는 배포도 포함된다 — 거기서 결과는 기능이 아니라 기동 실패다.
  • 누가 한쪽 열 이름을 고쳐 둘을 「맞춘다」. 그러면 배포된 테이블이 migration된 schema와 그 엔티티가 기대하는 schema가 둘 사이 migration 없이 갈라진다.

후보를 언젠가 승격하면 한 번에 승격한다: 앞으로 가는 migration, 샘플 변환, AuditContextPort → AuditorAware와 Clock → DateTimeProvider 다리가 함께 들어오고, 이 ADR은 보완이 아니라 대체된다.

bulk·native update는 어느 장치에서든 아무것도 넣지 않는다. 그것은 여기서 고른 것의 성질이 아니라 JPA의 성질이므로, 없다고 치지 않고 따로 강제한다.

강제

JpaAuditMechanismRule.entitiesUseExactlyOneAuditMechanism과 bulkUpdatesOfAuditedEntitiesStampAudit를 조립 루트의 JpaProductionArchitectureTest가 실제 운영 그래프에 대고 돌린다 — fixture가 아니다. 이 규칙 묶음의 앞 버전은 fixture에 대고 돌아서 아무것에도 적용되지 않은 채 통과했다. AuditingCandidateStatusTest가 후보에 조립하는 stereotype이 없고 두 열 집합이 따로 남는다고 단언한다. JpaAuditMechanismRuleTest가 규칙 자신의 부정 경우를 시험한다.