docs: leaf 안내와 web 한도 표의 틀린 위치·주체를 코드에 맞춘다
문제(새 눈 리뷰):
- web-notification 안내가 callback 서명 검증을 유스케이스가 한다고 적었다.
실제로는 composition의 ProviderCallbackIngressBridge가 outbound provider
adapter(SES는 SnsSignatureVerifier)로 검증하고 검증된 event만 넘긴다.
- application-notification 안내가 없는 패키지 platform.port.out을 나가는 포트
위치로 적었고, testFixtures를 「포트마다 fake 하나」라고 실제보다 크게 적었다.
- web-fileserver 책임 목록에 lifecycle(삭제·복사·이동)과 http(Range·조건부
다운로드 계획) 패키지가 없었다.
- redis-runtime README가 app.redis.* 기본값 위치를 잘못 적었다. objectstorage
README가 포트 개수를 복사했다.
- web 한도 표가 multipart 한도를 「전역 한도 없음」이라 했고, 아무도 막지 않는
칸을 「늘 애플리케이션」이라 했다.
- TESTING_STRATEGY가 묶음 태스크를 셋이라 세며 performanceCheck를 빠뜨렸다.
- roadmap messaging-r2 이력 블록의 날짜·이유가 틀렸다(6d27356e, 2026-09-25).
- 지운 ComposeMergeCharacterizationTest 행의 커밋이 지운 쪽 기준이 아니었다.
고친 것: 위 문장을 지금 코드대로 고쳤다. 공개 경로 스냅숏 문장과 fileserver
「오류 코드」 절 안내는 공개 표면 PR·계약 PR이 만드는 것이라 병합 순서로 맞춘다.
검증: check-docs.py·check-work-docs.py rc=0.
Refs: RR9-04-09, RR9-04-21, RR9-04-35, RR9-04-42, RR9-03-30
This commit is contained in:
@@ -11,7 +11,8 @@
|
||||
|
||||
## 책임
|
||||
|
||||
- 업로드(`controller`, tus `tus`, IETF draft-12 `draft12`)·다운로드·관리(`admin`) HTTP endpoint와 그 요청 해석(`mapper`).
|
||||
- 업로드(`controller`, tus `tus`, IETF draft-12 `draft12`)·다운로드·파일 삭제와 복사·이동(`lifecycle`)·관리(`admin`) HTTP endpoint와 그 요청 해석(`mapper`).
|
||||
- 다운로드의 Range·조건부 요청 해석과 응답 계획(`http`의 `HttpDownloadPlanner`, `HttpRangeResolver`).
|
||||
- 실패를 Envelope로 바꾸는 `problem`(`FileserverExceptionHandler`, `FileserverProblemHeaders`), 전송 worker pool(`config.BlockingTransferExecutor`), nginx `X-Accel-Redirect`(`nginx`).
|
||||
- CORS 노출 헤더 기여(`config.FileserverHttpSurfaceConfiguration`).
|
||||
|
||||
|
||||
@@ -4,7 +4,8 @@
|
||||
|
||||
## 책임과 소유하지 않는 것
|
||||
|
||||
- 업로드(`controller`, tus `tus`, IETF draft-12 `draft12`)·다운로드·관리(`admin`) HTTP endpoint와 그 요청 해석(`mapper`).
|
||||
- 업로드(`controller`, tus `tus`, IETF draft-12 `draft12`)·다운로드·파일 삭제와 복사·이동(`lifecycle`)·관리(`admin`) HTTP endpoint와 그 요청 해석(`mapper`).
|
||||
- 다운로드의 Range·조건부 요청 해석과 응답 계획(`http`의 `HttpDownloadPlanner`, `HttpRangeResolver`).
|
||||
- 실패를 Envelope로 바꾸는 `problem`(`FileserverExceptionHandler`, `FileserverProblemHeaders`), 전송 worker pool(`config.BlockingTransferExecutor`), nginx `X-Accel-Redirect`(`nginx`).
|
||||
- CORS 노출 헤더 기여(`config.FileserverHttpSurfaceConfiguration`).
|
||||
- 소유하지 않는 것: 할당량·표시 이름 같은 정책(`application-fileserver`), 바이트 저장(`adapter:outbound:fileserver`), 공용 Envelope 처리(`adapter:inbound:web`).
|
||||
|
||||
@@ -19,7 +19,8 @@
|
||||
|
||||
- controller는 변환만 한다. 모르는 channel·slot·locale은 그 필드를 짚는 `400 VALIDATION_FAILED`로 거절하고, 발송 판정은 유스케이스에 넘긴다.
|
||||
- callback 경로는 presentation prefix를 받지 않는 절대 경로다. provider에 한 번 등록한 URL이 prefix 변경으로 움직이면 안 된다(`NotificationRoutePrefixTest`).
|
||||
- callback chain은 인증 없이 열고 서명 검증을 유스케이스가 한다. 그 `permitAll`은 공개 경로 스냅숏에 들어 있다(`docs/security/public-paths-snapshot.txt`).
|
||||
- callback chain은 인증 없이 연다. 서명 검증은 이 leaf의 `ProviderCallbackIngress`에 맡긴다. 구현은 `composition:notification-platform`의 `ProviderCallbackIngressBridge`이고, `adapter:outbound:notification`의 provider adapter(`ProviderCallbackAdapterRegistry`, SES는 `SnsSignatureVerifier`)로 검증한 뒤 검증된 event만 유스케이스에 넘긴다. 유스케이스는 서명을 보지 않는다.
|
||||
- 그 `permitAll`은 공개 경로 스냅숏(`docs/security/public-paths-snapshot.txt`)에 들어 있다. callback 경로를 바꾸면 스냅숏도 바뀐다.
|
||||
- `adapter:inbound:web`의 inbound 규칙이 그대로 적용된다: repository 접근 없음, DTO를 application으로 넘기지 않음.
|
||||
|
||||
## 테스트
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
- 알림 제출(`NotificationSubmissionController`)과 template 게시(`NotificationTemplateController`) HTTP endpoint.
|
||||
- provider callback 수신(`NotificationCallbackMvcController`)과 그 경로만 덮는 보안 chain(`CallbackMvcSecurityConfiguration`).
|
||||
- 요청 DTO를 `application-notification`의 command로 바꾼다. 업무 판정은 하지 않는다.
|
||||
- 소유하지 않는 것: 발송 판정·서명 검증(`application-notification`), provider 호출(`adapter:outbound:notification`), 공용 오류 처리(`adapter:inbound:web`).
|
||||
- 소유하지 않는 것: 발송 판정(`application-notification`), callback 서명 검증과 provider 호출(`adapter:outbound:notification`, `composition:notification-platform`이 `ProviderCallbackIngress`로 이어 준다), 공용 오류 처리(`adapter:inbound:web`).
|
||||
|
||||
## 공개 표면
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ Redis 연결과 명령 실행의 공용 runtime을 담는 leaf다. 업무 포트
|
||||
|
||||
## 공개 표면
|
||||
|
||||
`connection.RedisRuntimeClient`, `command.SemanticRedisCommands`, key 타입, 설정 `app.redis.*`(env `APP_REDIS_*`, `docs/registries/env-keys.yaml`, 기본값 `config/module-defaults/redis-runtime.yml`).
|
||||
`connection.RedisRuntimeClient`, `command.SemanticRedisCommands`, key 타입, 설정 `app.redis.*`(env `APP_REDIS_*`, `docs/registries/env-keys.yaml`). 기본값은 `RedisRuntimeSettings`의 Java 기본값이고, `app.redis.enabled`만 cache-redis의 `config/module-defaults/cache-redis.yml`이 정한다. 이 leaf의 `config/module-defaults/redis-runtime.yml`은 health 상태 순서만 싣는다.
|
||||
|
||||
## 조립
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@
|
||||
## 책임
|
||||
|
||||
- 알림 플랫폼의 업무 흐름: 제출·예약·취소·조회, template 게시, provider callback 수집, 발송 판정과 재시도 정책.
|
||||
- 들어오는 포트(`platform.port.in`의 `*UseCase`·`*Command`·`*Query`)와 나가는 포트(`platform.port.out`), 오류 어휘(`platform.api.error`).
|
||||
- testFixtures: 포트마다 fake 하나와 공유 계약. adapter의 시험이 같은 계약을 상속한다.
|
||||
- 들어오는 포트(`platform.port.in`의 `*UseCase`·`*Command`·`*Query`), 나가는 포트(`*Port`, 쓰는 흐름의 패키지에 있다: `platform.dispatch`·`platform.callback`·`platform.policy`·`platform.observation`·`platform.admin`·`platform.inbox`·`platform.template`), 오류 어휘(`platform.api.error`). `port.out` 패키지는 따로 없다.
|
||||
- testFixtures: 흐름 패키지마다 `testkit`에 저장 포트의 in-memory fake와 공유 계약(`*Contract`), provider adapter 계약(`ProviderAdapterContract`). adapter의 시험이 같은 계약을 상속한다.
|
||||
|
||||
## 규칙
|
||||
|
||||
|
||||
@@ -5,13 +5,13 @@
|
||||
## 책임과 소유하지 않는 것
|
||||
|
||||
- 알림 플랫폼의 업무 흐름: 제출·예약·취소·조회, template 게시, provider callback 수집, 발송 판정과 재시도 정책.
|
||||
- 들어오는 포트(`platform.port.in`의 `*UseCase`·`*Command`·`*Query`)와 나가는 포트(`platform.port.out`), 오류 어휘(`platform.api.error`).
|
||||
- testFixtures: 포트마다 fake 하나와 공유 계약. adapter의 시험이 같은 계약을 상속한다.
|
||||
- 들어오는 포트(`platform.port.in`의 `*UseCase`·`*Command`·`*Query`), 나가는 포트(`*Port`, 쓰는 흐름의 패키지에 있다: `platform.dispatch`·`platform.callback`·`platform.policy`·`platform.observation`·`platform.admin`·`platform.inbox`·`platform.template`), 오류 어휘(`platform.api.error`). `port.out` 패키지는 따로 없다.
|
||||
- testFixtures: 흐름 패키지마다 `testkit`에 저장 포트의 in-memory fake와 공유 계약(`*Contract`), provider adapter 계약(`ProviderAdapterContract`). adapter의 시험이 같은 계약을 상속한다.
|
||||
- 소유하지 않는 것: HTTP 모양(`adapter:inbound:web-notification`), provider 호출·설정(`adapter:outbound:notification`), 저장(`adapter:outbound:persistence-notification`), 조립(`composition:notification-platform`).
|
||||
|
||||
## 공개 표면
|
||||
|
||||
들어오는 포트 `platform.port.in`(예: `SubmitNotificationUseCase`, `PublishNotificationTemplateUseCase`, `IngestProviderCallbackUseCase`), 나가는 포트 `platform.port.out`, 오류 `platform.api.error`. 설정 prefix는 없다(설정은 `adapter:outbound:notification`의 `app.notification.platform.*`).
|
||||
들어오는 포트 `platform.port.in`(예: `SubmitNotificationUseCase`, `PublishNotificationTemplateUseCase`, `IngestProviderCallbackUseCase`), 흐름 패키지의 나가는 포트(`*Port`), 오류 `platform.api.error`. 설정 prefix는 없다(설정은 `adapter:outbound:notification`의 `app.notification.platform.*`).
|
||||
|
||||
## 조립
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
## 공개 표면
|
||||
|
||||
`port`의 여덟 포트(`ObjectTransferPort`, `ObjectInspectionPort`, `StagedObjectPublicationPort`, `ManagedObjectPublicationPort`, `ObjectRetirementPort` 등)와 값 타입. 설정 prefix는 없다(`app.object-storage.*`는 adapter의 것).
|
||||
`port`의 포트(`ObjectTransferPort`, `ObjectInspectionPort`, `StagedObjectPublicationPort`, `ManagedObjectPublicationPort`, `ObjectRetirementPort` 등)와 값 타입. 설정 prefix는 없다(`app.object-storage.*`는 adapter의 것).
|
||||
|
||||
## 조립
|
||||
|
||||
|
||||
Reference in New Issue
Block a user