Files
clean-architecture-backend-…/src/composition/idempotency/README.md
T
DongHyeonka ab5982e955 refactor(repo)!: 샘플 모듈과 그 참조를 지운다
문제: src/sample-portfolio(311파일)와 src/Dockerfile.sample이 빌드 8곳,
registry, PR job, spotbugs 제외, 매뉴얼·leaf 문서 수십 곳에 얽혀 있다.
매뉴얼과 생성 명령이 예시를 맡게 된 뒤로 샘플은 유지 비용만 남았고,
문서 일부는 이미 없는 태스크(sampleOffTest)와 ArchUnit 규칙을 가리킨다.

고른 방법: 소유자 결정(2026-11-07)대로 샘플을 폴더째 지우고 역할은
옮기지 않는다. 샘플을 가리키던 것도 같은 변경에서 지운다.
- 빌드: registry 행, 루트 build.gradle의 샘플 태스크·의존·단계
  (sampleWebContractCheck, :sample-portfolio:*, strict lane 단계),
  app-bootstrap architectureTestRuntimeOnly, spotbugs 제외 3곳
- CI: ci-quality-gates.yml의 sample-portfolio job과 release-gate 칸
- 테스트: SampleRuntimeDefaultsContractTest, Dockerfile.sample 비교 테스트,
  ArchUnit 규칙의 죽은 sample 패키지 제외. build-logic 테스트와
  application-core 테스트의 가짜 이름은 example-app으로 바꾼다
- 문서: 매뉴얼 예시를 실제 코드(durable operation, identifier,
  ErrorCodeRegistryMappingTest)로 바꾸고, 템플릿에 예가 없는 기법
  (유일 제약 → 같은 409)은 규칙과 확인 방법만 적는다. 결정 색인의
  샘플 전용 행은 "샘플과 함께 사라짐"으로 표시한다
버린 대안: 설계서 권장안(OpenAPI 스냅숏·웹 계약을 옮긴 뒤 삭제)은
소유자가 고르지 않았다.

위험·한계:
- 샘플 안에만 있던 검사(OpenAPI 스냅숏, Date 헤더, 가상 스레드 MDC
  전파, 요청당 SQL 수 단언)가 함께 사라진다. 소유자가 남기라 하면
  총괄이 따로 맡긴다.
- APP_CACHE_REDIS_ENABLED는 샘플이 읽지 않는 키라(설계서 가정과 다름)
  지우지 않고 src/README.md 문장만 고쳤다. 제거 기한 2026-11-30은 그대로.
- docs/capability-status.md 「제거된 코드」 표와 docs/work/evidence.md의
  샘플 경로는 이력이라 두었다.

검증(desktop, 트리 0525e14e, ~/t1-layout-logs/):
- ./gradlew :ci --warning-mode=fail rc=0 (502 executed, 83 from cache)
- :verifyStrictLaneStages --dry-run rc=0
- :app-bootstrap:documentContractTest rc=0
- -p build-logic check rc=0
- :verifyDependencyLocks rc=0
- python3 scripts/check-work-docs.py, 상대 링크 검사 rc=0

Refs: design-docs repo-structure/README.md 3.1, repo-structure/01-backend-layout.md 6.2
BREAKING CHANGE: src/sample-portfolio, src/Dockerfile.sample, 샘플 태스크와 job이 없어진다. 샘플을 고쳐 쓰던 파생 서비스는 병합 때 수정 대 삭제 충돌이 난다. docs/upgrade/2026-11-maturity-review.md B-49.
2026-11-07 12:21:03 +09:00

7.4 KiB
Raw Blame History

composition:idempotency — 요청 멱등성 executor 조립

  • Module ID: composition-idempotency
  • Gradle path: :composition:idempotency
  • Package: dev.caskeleton.composition.idempotency
  • 테스트: ./gradlew :composition:idempotency:test --console=plain

제공하는 것

선택한 provider의 저장소 위에 IdempotencyExecutor를 하나 만든다. KEYED use case는 application-core의 IdempotencyExecutor만 받는다.

composition:idempotency
  ├─ IdempotencyAutoConfiguration   provider != disabled 일 때만: 설정 바인딩 + executor 하나
  ├─ IdempotencySettings            수명 정책(lease·replay TTL·retention·codec·revision), strict 바인딩
  └─ config/module-defaults/idempotency.yml (설정 기본값, support 로더가 읽음)
  • 저장소는 포트(IdempotencyStorePort)다. Redis는 adapter:outbound:cache-redis, PostgreSQL은 adapter:outbound:persistence-jpa가 app.capabilities.idempotency.provider에 따라 하나를 기여한다. 선택한 provider의 저장소가 정확히 하나가 아니면(0개: 모듈이 없거나 꺼짐, 2개: 다른 곳이 하나 더 등록) 기동이 개수와 함께 실패한다.
  • 켜기와 끄기: 모듈이 있어도 provider=disabled(기본)면 아무것도 바인딩하거나 만들지 않는다.
  • 설정 바인딩은 StrictSettingsBinder다. 같은 prefix 아래 Redis 저장소가 자기 키(key-version, command-timeout)를 두므로 그 두 키만 빼고 엄격하게 본다. 수명 정책 키를 잘못 쓰면 기본값이 조용히 쓰이는 대신 기동이 실패한다.
  • app-bootstrap이 이 한 줄을 쓴다. 예전의 샘플 모듈 복사본 (SampleIdempotencyConfig, 상한 검증 없이 Binder로 읽고 저장소를 하나로 가정)은 삭제했다.

추가할 한 줄

// app-bootstrap/build.gradle
runtimeOnly project(':composition:idempotency')   // 요청 멱등성 executor

기본 조립에 있다. provider가 disabled면 꺼져 있으므로 저장소 모듈 없이도 안전하다. 이 줄을 지우면 executor, 설정 기본값이 함께 빠진다(그때 KEYED use case는 executor를 받지 못해 기동이 실패한다).

필요한 env 키

전체 목록과 타입은 docs/registries/env-keys.yaml의 APP_IDEMPOTENCY_* 행이 SSOT다.

언제 키
켤 때 APP_IDEMPOTENCY_PROVIDER (redis 또는 postgresql), 그리고 그 provider 모듈의 줄과 env
조정할 때 APP_IDEMPOTENCY_PROCESSING_LEASE(≤1h), APP_IDEMPOTENCY_TTL(≤72h, processing lease 이상, APP_IDEMPOTENCY_FAILURE_RETENTION 이하 — 24h보다 올리면 failure retention도 함께 올린다), APP_IDEMPOTENCY_FAILURE_RETENTION(≤30d, APP_IDEMPOTENCY_TTL 이상)

설계 결정 참조 (app-bootstrap에서 옮김)

이 모듈의 코드는 2026-09-28에 app-bootstrap autoconfigure/idempotency에서 옮겨 왔다(소유자 결정 3). 아래 근거는 그때의 기록이다.

IdempotencyAutoConfiguration

  • IdempotencyExecutor를 여기서 한 번만 만든다. provider 모듈은 IdempotencyStorePort만 내놓는다 — redis는 cache-redis의 RedisIdempotencyConfig, postgresql은 persistence-jpa의 PostgreSqlIdempotencyStoreConfig. lease·replay TTL·retention·codec id·policy revision 은 어느 store 든 같은 정책이라 IdempotencySettings 하나에서 읽는다. executor 를 application-core 밖에서 만드는 이유는 이 설정을 application-core가 직접 읽으면 안 되기 때문이다.
  • store 가 정확히 하나가 아니면 기동을 거부한다. 0개는 provider 모듈이 runtime classpath 에 없거나 스위치가 꺼진 경우, 2개는 다른 무언가가 store 를 등록한 경우다. 둘 다 빈 누락 오류나 엉뚱한 store 로 요청을 처리하는 대신 개수를 담은 startup 실패로 드러난다.
  • provider=disabled(기본)면 executor 빈 자체가 없다. jdbc 값과 V1 조립(IdempotencyConfig, config/idempotency.yml)은 삭제됐다.
  • postgresql provider 는 PostgreSQL data source 가 아니면 기동을 거부한다. bootRunH2 에서는 disabled 나 redis 를 쓴다.

IdempotencySettings

  • app.capabilities.idempotency 에 바인딩되는 유일한 설정 record 다(값은 config/module-defaults/idempotency.yml).

    키 env 기본값 상한
    provider APP_IDEMPOTENCY_PROVIDER disabled disabled | redis | postgresql
    processing-lease APP_IDEMPOTENCY_PROCESSING_LEASE 30s 1h
    replay-ttl APP_IDEMPOTENCY_TTL 24h 72h, 그리고 processing-lease 이상·failure-retention 이하
    failure-retention APP_IDEMPOTENCY_FAILURE_RETENTION 24h 30d, 그리고 replay-ttl 이상
    response-codec-id — json-v2 1–64자
    policy-revision — 2 양수
    reaper-interval — 10m 양수

    Redis store 튜닝값 key-version, command-timeout(APP_IDEMPOTENCY_REDIS_COMMAND_TIMEOUT)도 같은 prefix 아래 있지만 lifecycle 정책이 아니라서 이 record 에 두지 않고 cache-redis가 읽는다.

  • replay-ttl 이 processing-lease 보다 짧으면 기동을 거부한다. 같은 키로 다시 보내라는 답을 받은 클라이언트는 lease 안 어느 때든 돌아올 수 있다. 재생 창이 그보다 먼저 닫히면 그 재전송은 작업을 한 번 더 돌린다(재리뷰 2026-11-04 RR-03-11). 두 store 는 이 관계와 상관없이 기록을 lease + replay TTL 동안 둔다 — 이 검사는 store 를 지키는 것이 아니라 재생을 무력하게 만드는 정책을 막는다. IdempotencyClaimRequest 에는 두지 않았다: 포트는 어떤 값 쌍으로도 쓸 수 있고, store 가 모든 쌍에서 안전한지는 공유 계약이 본다.

  • failure-retention 이 replay-ttl 보다 짧으면 기동을 거부한다. 실패로 표시된 기록(포기·재시도 가능)은 표시부터 이 기간만 남는다. replay-ttl 보다 짧으면 효과 불명으로 포기한 기록이 먼저 사라져 같은 키 재전송이 작업을 다시 돌린다. 메시지는 두 키와 값을 함께 보여 준다. 기본값(둘 다 24h)은 그대로 뜬다. 재리뷰 RR3-03-02 때는 지금 기동하는 설정을 깨지 않으려고 문서로만 두었고, 2026-11-04 소유자 결정으로 검사를 넣었다.

  • 상한 검사는 컴팩트 생성자에서 fail-fast 로 던진다. Duration의 상한은 JSR-303(@Valid) 애너테이션으로 표현할 수 없어 생성자에서 직접 검증한다. 검증을 느슨하게 두면 과도하게 긴 TTL 이 저장소를 조용히 부풀리고 멱등성 키 추측 공격의 유효 시간 창을 넓히기 때문에, 부팅 시점에 즉시 실패시키는 쪽을 택했다.

  • replay TTL 상한(72h) / 기본값(24h)을 바꿀 때는 보안 베이스라인의 JWT 키 회전 겹침(overlap) 윈도와 반드시 함께 검토해야 한다. 멱등성 레코드의 수명이 키 회전 겹침 윈도(현재 24h)보다 길면, 가명화(pseudonym) 기준이 회전된 principal 에 대해 레코드가 재생(replay)될 수 있다. 이 불변식을 강제하는 CI 게이트는 security-operational-baseline 쪽에 위임돼 있다.

  • reaper-interval은 전용 환경변수가 없다. reaper 실행 주기는 비밀이나 배포별 값이 아니라 순수 운영 튜닝 값이다. reaper 는 provider 가 postgresql 일 때만 돈다.