docs(contracts): 짝 백엔드 계약 기준점을 45d2a478로 올린다

문제
check:backend-contract-drift가 백엔드 HEAD 45d2a478에서 http-contract.md §2
두 행의 설명 변경을 알린다. IDEMPOTENT_IN_FLIGHT(PostgreSQL 저장소는 409
대신 첫 요청이 끝날 때까지 기다림)와 IDEMPOTENCY_UNAVAILABLE(processing
lease가 시작 전에 끝나 저장소가 시작을 거절함)이다. 같은 커밋이 6.1절이
인용하는 GlobalExceptionHandler와 IdempotencyExecutor도 고쳤다.

고른 방법
- 두 행의 code·status·retryable·재전송 규칙은 같다. 프론트 판정(처리 중
  MAYBE_APPLIED·같은 키, UNAVAILABLE 실행 안 됨·같은 키 자동 재전송)은
  바꾸지 않는다.
- 6.1절이 인용하는 블록 13개를 두 판에서 대조했다. 내용은 모두 같고
  GlobalExceptionHandler 4개, IdempotencyExecutor 1개의 줄 번호만 옮겼다.
  인용한 다른 백엔드 파일 15개는 바뀌지 않았다.
- pin, 답 표 JSON, 계약 문서 4.1·6·6.1절, CHANGELOG의 pin 행과 알려진
  제한을 같이 고친다.

위험·한계
- PostgreSQL 저장소의 기다림이 프론트 totalDeadline보다 길면 응답 없는
  끝(결과 불명, 키 유지)이 된다. 판정은 안전 쪽이다.
- Fileserver 계약(docs/fileserver/http-contract.md)은 bbe944bd 이후 바뀌지
  않았다.

검증
- check:backend-contract-drift --backend <백엔드 checkout>: pinned
  45d2a478.
- backend-contract-pin·changelog-review-ids 테스트 11건,
  verify:documentation PASS_SCOPED.

Refs: docs/reviews/2026-11-03-maturity-review/12-guardrails-ci.md 12-06
This commit is contained in:
DongHyeonka
2026-11-05 00:24:59 +09:00
parent 01b9def556
commit 580be5839d
4 changed files with 14 additions and 11 deletions
+2 -2
View File
@@ -148,7 +148,7 @@
| [계약] | V3 descriptor의 선택 칸 `responseEnvelope: "ENVELOPE_V1"`이면 실행기가 짝 백엔드 Envelope(`{success, data\|error, meta}`)를 읽는다. `outputValidator`는 `data`(키가 없으면 `null`), `problemValidator`는 `error`를 받는다. `meta.requestId`·`traceId`는 선택이다. 성공 status의 Envelope 아닌 본문은 새 위반 `ENVELOPE_MISMATCH`다(`HttpContractViolationKind`에 추가). `create:feature`가 만든 기능은 이 값을 선언한다. 참조 기능과 값이 없는 descriptor는 DTO와 problem details를 읽는다 (1101 README 14.3) | `src/contracts/external-contract-runtime.ts`, `src/adapters/http/`, `scripts/create-feature.ts`, `tests/mocks/handlers/http-scenarios.ts` | `7db32e1`, `bd83b49` |
| [계약] | Envelope operation의 400·409·422와 백엔드가 정한 5xx 넷은 `classifyProblem` 대신 백엔드 기준 표(`backend-envelope.ts`, 근거는 계약 문서 6.1절)가 정한다. 적용 안 됨(`NOT_APPLIED`)은 400 `VALIDATION_FAILED`(details 모양과 상관없음), 400 `IDEMPOTENCY_KEY_INVALID`, 422 `IDEMPOTENT_REQUEST_MISMATCH`와 그 operation의 `refusedBeforeWrite` code다. 그 밖의 400·409·422는 결과 불명이다. 503 `IDEMPOTENCY_UNAVAILABLE`, 503 `IDEMPOTENCY_COMPLETION_UNKNOWN`, 500 `IDEMPOTENCY_RECOVERY_REQUIRED`, 503 `REQUEST_TIMEOUT`은 분류기와 상관없이 결과 불명이고 키를 지킨다. KEYED operation은 503 `IDEMPOTENCY_UNAVAILABLE`을 `retryBudget` 안에서 같은 키로 다시 보낸다. 필드 목록이 있는 거절은 `VALIDATION_REJECTED`와 필드 오류, 필드 목록 없는 422는 `UNKNOWN_CLIENT_FAILURE`다. 진단은 두 멱등성 거절에 `reason`을 싣는다 (1101 README 14.4, 1103/03-04, 1103/08-05) | `src/adapters/http/backend-envelope.ts`, `src/adapters/http/http-execution-v3.ts`, `docs/architecture/backend-api-and-server-state-contract.md` | `3261208`, `c05f41a`, `3761507`, `613c1cf` |
| [계약] | `CommandEffectDescriptor.refusedBeforeWrite`(선택, Envelope operation 전용): 그 엔드포인트가 쓰기 전에만 내는 업무 거절 code. 적은 code의 400·409·422는 `NOT_APPLIED`라 폼에서 값을 고쳐 다시 저장할 수 있다. 멱등성 code를 적거나 Envelope가 아닌 operation에 적으면 조립이 거절한다 (1103/03-01) | `src/contracts/external-contract-runtime.ts`, `src/adapters/http/backend-envelope.ts`, `src/contracts/api-operations.ts` | `1e8b3d0`, `3fba68b` |
| [계약] | 짝 백엔드 계약 기준점을 기계가 읽는다. `config/contracts/backend-contract-pin.json`(백엔드 `c508b1ba`)과 백엔드 `docs/web/http-contract.md` §2 답 표(`config/contracts/backend-idempotency-answers.json`)를 `tests/unit/backend-contract-pin.test.ts`가 프론트 판정 표와 대조한다. `check:backend-contract-drift --backend <백엔드 checkout>`(로컬, 게이트 밖)이 pin 뒤의 백엔드 변경을 알린다 (1103/12-06) | `config/contracts/`, `scripts/check-backend-contract-drift.ts`, `src/adapters/http/backend-envelope.ts` | `ba2b4f4`, `5379c80` |
| [계약] | 짝 백엔드 계약 기준점을 기계가 읽는다. `config/contracts/backend-contract-pin.json`(백엔드 `45d2a478`)과 백엔드 `docs/web/http-contract.md` §2 답 표(`config/contracts/backend-idempotency-answers.json`)를 `tests/unit/backend-contract-pin.test.ts`가 프론트 판정 표와 대조한다. `check:backend-contract-drift --backend <백엔드 checkout>`(로컬, 게이트 밖)이 pin 뒤의 백엔드 변경을 알린다 (1103/12-06) | `config/contracts/`, `scripts/check-backend-contract-drift.ts`, `src/adapters/http/backend-envelope.ts` | `ba2b4f4`, `5379c80` |
| [계약] | 성공 결과에 Envelope `meta.page`가 `page`로 실리고, `mapSuccess` 두 번째 인자 `FeatureHttpSuccessContext { page }`로 받는다(배럴 `EnvelopePage`). bulk `results`는 지원하지 않는다. 실패 Envelope의 `meta.traceId`는 `AppFailure.traceId`가 된다. 실행 결과의 선택 칸 `sentRequestId`: 서버가 `x-correlation-id`를 돌려주지 않으면 `AppFailure.requestId`는 보낸 값이고, 결과 불명·조회 실패 화면에 "지원 참조" 줄이 보인다 (1103/03-02, 1103/03-06, 0929/03-04) | `src/adapters/http/` | `49a0986`, `631ce33`, `849d000` |
| [계약] | 결과 불명 쓰기의 진단·텔레메트리에 `effect_certainty`가, 진단 `reason`에 `UnknownEffectReason`이 실린다 (1103/03-05) | `src/adapters/http/`, `config/contracts/` | `39c1de2` |
| [계약] | 키 없는(`NEVER`) 결과 불명 요청에는 "같은 요청으로 다시 보내기"가 없다. mutation 컨트롤러 `canResendUnknownEffect`, `AsyncState.unknownEffectResendable`. 처리 중 409의 `Retry-After`는 `retryAfterMs`로 실리고, 결과 불명 요청을 같은 키로 다시 보낼 때 그 시각까지(최대 5초) 기다린다 (0929/03-03, 백엔드 리뷰 1101/02-01) | `src/presentation/adapters/query/application-query.ts`, `src/presentation/components/async-surface.tsx` | `2017ef7`, `47fec5c` |
@@ -261,7 +261,7 @@
- 제품 안에 적은 계약(memento `PRODUCT_LOCAL_CONTRACT`)에 줄 출처 종류가 없다. `EXTERNAL_PACKAGE` 신원을 어떻게 정할지(패키지 없이 digest를 붙이는 법)는 템플릿이 정하지 않았다.
- 참조 기능은 `responseEnvelope`를 선언하지 않아 DTO와 problem details만 읽는다. 짝 백엔드에 붙는 완성 예시는 `create:feature --with-create`가 만드는 기능이다.
- 짝 백엔드 생성기(`new-feature.sh`)에 목록 GET이 없다. `create:feature` 목록 화면은 백엔드가 `GET /<plural>`을 더한 뒤에야 닿는다 (1103/03-07).
- 짝 백엔드 계약 pin(`c508b1ba`) 뒤로 백엔드가 바뀌었다. 2026-11-05에 `check:backend-contract-drift`가 HEAD `45d2a478`에서 `docs/web/http-contract.md` §2 두 행(`IDEMPOTENT_IN_FLIGHT`, `IDEMPOTENCY_UNAVAILABLE`)의 설명 변경을 알렸다. status·code·재시도 칸은 같다. pin은 아직 올리지 않았다.
- 짝 백엔드 계약 pin은 `45d2a478`(2026-11-05)이다. 그 뒤 백엔드가 바뀌면 `check:backend-contract-drift --backend <백엔드 checkout>`가 알린다. 이 검사는 게이트 밖이라 CI는 알리지 않는다.
- 업로드: 백엔드 `POST /v1/files`는 `Idempotency-Key`를 읽지 않는다. 결과 불명 뒤 같은 키로 다시 보내도 파일이 둘 생길 수 있다. client의 code 목록은 백엔드 기준점에 묶여 있다. `EXTERNAL_BEARER`로 올리려면 제품 provider가 필요하다. 실제 백엔드 업로드와 firefox·webkit은 돌리지 않았다.
- 세션 owner recipe는 실제 Keycloak·Redis와 붙여 보지 않았다. jwt 모드: 백엔드 realm에 브라우저용 public client가 없어 제품이 더한다(매뉴얼 04에 JSON). redis-session 모드: 백엔드 운영 코드에 로그인·로그아웃·세션 조회·CSRF 발급 엔드포인트가 없어 owner가 URL을 기본값 없이 받는다. OIDC owner는 토큰을 메모리에 두어 새로고침하면 로그아웃되고, ID token 서명을 검사하지 않는다.
- 플랫폼 구성 화면(`EXAMPLES_PLATFORM`, `/examples/platform`)은 플랫폼 라우트라 끌 수 없고 FE-GATE-028 서명 대상이다. 예제 기능을 뺀 제품에서 예제 화면을 여는 e2e·visual spec은 실패한다 (1103/09-04).
+1 -1
View File
@@ -2,7 +2,7 @@
"schemaVersion": 1,
"backend": {
"repository": "clean-architecture-backend-template",
"commit": "c508b1ba4ba358cec1f18aa3ca19a02d9224d74b",
"commit": "45d2a478b800586f1d84151723629a560265d58e",
"document": "docs/web/http-contract.md",
"sectionsCompared": ["1", "2", "4"]
},
@@ -2,7 +2,7 @@
"schemaVersion": 1,
"source": {
"repository": "clean-architecture-backend-template",
"commit": "c508b1ba4ba358cec1f18aa3ca19a02d9224d74b",
"commit": "45d2a478b800586f1d84151723629a560265d58e",
"document": "docs/web/http-contract.md"
},
"answers": [
@@ -165,7 +165,7 @@ Envelope의 모양과 키 존재 규칙은 짝 백엔드 템플릿 문서가 정
- 정본: [`clean-architecture-backend-template/docs/web/http-contract.md`](../../../clean-architecture-backend-template/docs/web/http-contract.md)
1절 "Envelope 키 존재 규칙"
- 기준 커밋: 백엔드 `c508b1ba`. 기계가 읽는 정본은
- 기준 커밋: 백엔드 `45d2a478`. 기계가 읽는 정본은
`config/contracts/backend-contract-pin.json`(repo, 전체 SHA, 대조한 절 §1·§2·§4,
담당)이다. 백엔드 §2 표와 §4 `REQUEST_TIMEOUT`은
`config/contracts/backend-idempotency-answers.json`에 code·status·쓰기 전 거절·같은 키
@@ -259,7 +259,7 @@ backend idempotency를 대체하지 않는다.
- 정본: [`clean-architecture-backend-template/docs/web/http-contract.md`](../../../clean-architecture-backend-template/docs/web/http-contract.md)
2절 "멱등성 응답", 4절 "web 전용 오류 코드"
- 기준 커밋: 4.1절과 같다(백엔드 `c508b1ba`, `config/contracts/backend-contract-pin.json`).
- 기준 커밋: 4.1절과 같다(백엔드 `45d2a478`, `config/contracts/backend-contract-pin.json`).
- 프론트가 그 응답을 읽는 곳:
- 키 생성·검사: `src/contracts/mutation-intent.ts` `isValidIdempotencyKey`
- 결과 불명 재전송이 같은 키를 쓰고 `Retry-After`까지 기다리는 곳:
@@ -283,21 +283,24 @@ mutation이 400·409·422로 실패하면 프론트는 그 요청이 적용됐
바뀐 파일(`GlobalExceptionHandler`, `IdempotencyExecutor`, `PersistenceExceptionTranslator`,
`FailureCategory`, `DomainExceptionHandler`)을 다시 읽었다. 판정은 바뀌지 않았고 줄
번호만 옮겼다. `c508b1ba`에서는 바뀐 `IdempotencyExecutor`(늦게 끝난 실행 기록)를 다시
읽었다. 처리 중·불일치 판정은 그대로 action 전이고 줄 번호만 옮겼다. 같은 code가 쓰기 전과
읽었다. 처리 중·불일치 판정은 그대로 action 전이고 줄 번호만 옮겼다. `45d2a478`에서는
바뀐 `GlobalExceptionHandler`(로그 줄 정리)와 `IdempotencyExecutor`를 다시 읽었다. 인용한
블록의 내용은 그대로이고 줄 번호만 옮겼다. §2는 처리 중(PostgreSQL 저장소는 409 대신
기다림)과 `IDEMPOTENCY_UNAVAILABLE`(lease 만료로 시작 거절) 설명만 늘었고 code·status·재시도는 같다. 같은 code가 쓰기 전과
뒤에서 모두 나오면 "쓰기 뒤 가능"으로 둔다. 프론트는 code만 보고 둘을 가를 수
없다.
| code (status) | 나오는 곳 | 단계 | 프론트 결과 | 백엔드 파일:줄 |
| --- | --- | --- | --- | --- |
| `VALIDATION_FAILED` (400), details = 필드 목록 | 요청 본문 `@Valid` 실패, 컨트롤러 파라미터 제약 실패. 컨트롤러 메서드가 불리기 전 | 쓰기 전 | `NOT_APPLIED` | `GlobalExceptionHandler.java:218-231`, `:346-368` |
| `VALIDATION_FAILED` (400), details = 필드 목록 | 요청 본문 `@Valid` 실패, 컨트롤러 파라미터 제약 실패. 컨트롤러 메서드가 불리기 전 | 쓰기 전 | `NOT_APPLIED` | `GlobalExceptionHandler.java:205-218`, `:333-355` |
| `VALIDATION_FAILED` (400), details = 필드 목록 | `ConstraintViolationException`. 어느 층에서 던져도 이 handler가 받는다. 요청 경로에서 던지는 코드는 없다(application bean에 `@Validated` 없음, JPA entity에 Bean Validation 제약 없음, 직접 throw 없음) | 쓰기 전(현재 출처 없음) | `NOT_APPLIED` | `GlobalExceptionHandler.java:101-106` |
| `VALIDATION_FAILED` (400), details = `{cause}` 또는 없음 | 본문을 읽지 못함(`HttpMessageNotReadableException`) | 쓰기 전 | `NOT_APPLIED` | `GlobalExceptionHandler.java:233-251` |
| `VALIDATION_FAILED` (400), details = `{cause}` 또는 없음 | 본문을 읽지 못함(`HttpMessageNotReadableException`) | 쓰기 전 | `NOT_APPLIED` | `GlobalExceptionHandler.java:220-238` |
| `VALIDATION_FAILED` (400), details = `{field, code}` | 페이지·정렬 파라미터. 목록 GET 컨트롤러가 use case 전에 검사한다 | 쓰기 전 | `NOT_APPLIED` | `GlobalExceptionHandler.java:149-153`, `PageParams.java:27-33`, `SortParam.java:16-43` |
| `IDEMPOTENCY_KEY_INVALID` (400) | KEYED 컨트롤러 첫 줄의 키 파싱 | 쓰기 전 | `NOT_APPLIED` | `IdempotencyKeyHeader.java:32-38`, `PosterImagePublicationController.java:64` |
| `IDEMPOTENT_REQUEST_MISMATCH` (422) | 멱등성 executor가 action 전에 판정 | 쓰기 전 | `NOT_APPLIED` | `IdempotencyExecutor.java:127-128`, `:166-167` |
| `IDEMPOTENT_IN_FLIGHT` (409) | 멱등성 executor가 action 전에 판정. 같은 키의 앞선 요청이 실행 중이다 | 이번 요청은 쓰기 전. 앞선 요청은 적용될 수 있다 | `MAYBE_APPLIED` | `IdempotencyExecutor.java:129-130`, `:168-169` |
| `BAD_PARAMETER` (400) | 타입 변환 실패, 필수 파라미터·헤더 없음(쓰기 전). **어느 층이든 `IllegalArgumentException`**(use case·domain 포함) | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `GlobalExceptionHandler.java:92-99`, `:108-116`, `:397-417`, `HttpStatusErrorCodes.java:33-34` |
| `MAPPING_FAILED` (400) | web 매퍼(쓰기 전), outbound ACL 매퍼(use case 안), 멱등성 응답 직렬화(action이 끝난 뒤) | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `WorkLogWebMapper.java:36`, `RepoStatsAclMapper.java:14`, `JsonIdempotentResponseCodec.java:32`, `IdempotencyExecutor.java:267` |
| `BAD_PARAMETER` (400) | 타입 변환 실패, 필수 파라미터·헤더 없음(쓰기 전). **어느 층이든 `IllegalArgumentException`**(use case·domain 포함) | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `GlobalExceptionHandler.java:92-99`, `:108-116`, `:384-404`, `HttpStatusErrorCodes.java:33-34` |
| `MAPPING_FAILED` (400) | web 매퍼(쓰기 전), outbound ACL 매퍼(use case 안), 멱등성 응답 직렬화(action이 끝난 뒤) | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `WorkLogWebMapper.java:36`, `RepoStatsAclMapper.java:14`, `JsonIdempotentResponseCodec.java:32`, `IdempotencyExecutor.java:276` |
| `DB_SERIALIZATION_FAILURE`, `DB_DEADLOCK`, `DB_LOCK_TIMEOUT`, `DB_NULL_VIOLATION`, `DB_FK_VIOLATION`, `DB_UNIQUE_VIOLATION`, `DB_CHECK_VIOLATION`, `DB_OPTIMISTIC_CONFLICT` (409) | persistence 어댑터가 SQL·JPA 실패를 바꾼 것. 트랜잭션 안이나 commit에서 | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `FailureCategory.java:86-102`, `StandardSqlStateErrorMapping.java:46-52`, `PersistenceExceptionTranslator.java:133` |
| `LOCK_ACQUISITION_TIMEOUT` (409) | 분산 락 대기 초과. use case 안 | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `LockRegistryDistributedLock.java:50`, `:53` |
| 참조 도메인 `WORKLOG_INVALID`, `POSTER_INVALID_STATE`, `POSTER_IMAGE_REQUIRED` (400), `WORKLOG_CONFLICT`, `POSTER_ALREADY_EXISTS`, `POSTER_IMAGE_ALREADY_PUBLISHED` (409) | application·domain 예외 | 쓰기 뒤 가능 | `MAYBE_APPLIED` | `DomainExceptionHandler.java:52-90` |