Files
clean-architecture-frontend…/docs/manual/reference/patterns.md
T
DongHyeonka 5c2f8b875c docs(manual): 매뉴얼만으로 기능을 추가한 실험의 막힘 5건을 메운다 (1101/16-01)
문제: docs/manual(7c7ef32)만 보고 notice-feature(목록·상세·작성, GET 2 +
KEYED POST 1)를 만든 실험(b58d131, 합치지 않음)에서 매뉴얼이 답하지 않아
코드를 읽어야 했던 곳이 나왔다.

| 막힘 | 절 | 매뉴얼에 없던 것 |
|---|---|---|
| 1 | 01-3단계 | 백엔드 Envelope와 뼈대 problem details 중 무엇을 따르나 |
| 2 | 01-3단계 | V2 입력 칸(requestSource, pathSchema, pathParameterNames, maxEncodedSearchBytes, boundary) |
| 3 | 01-5단계 | routeId가 무엇에 쓰이고 쓰기에는 어느 route를 적나 |
| 4 | 01-6단계 | 상세 경로를 items/ 아래 두는 이유, a11y spec 치환 고치는 법 |
| 5 | 01-10단계 | 같은 멱등 키 재전송과 요청 본문을 테스트에서 보는 법 |
| 덧 | 02-4절, 01-2단계, patterns | 503 IDEMPOTENCY_UNAVAILABLE 판정, 길이 제한 위치, 검색 폼 예 |

고친 절과 근거(코드 위치):
- 01-3단계 "응답 모양": 뼈대·MSW·V3 실행기는 DTO와 problem details를 쓴다.
  V3는 본문을 벗기지 않고 검증한다(src/adapters/http/http-execution-v3.ts:1410,
  1633-1647; src/adapters/http/index.ts:41-48; backend-api-and-server-state-
  contract.md:161-173). MSW는 {data} 감싼 응답을 실패 시나리오로 둔다
  (tests/mocks/handlers/http-scenarios.ts:80-81, 143-150). 뼈대 problem 스키마는
  최상위 code다(scripts/create-feature.ts:542-550). 짝 백엔드는 모든 JSON을
  Envelope로 보낸다(backend docs/web/http-contract.md:16-33).
- 01-3단계 "V2 행의 입력 칸": 칸 표와 공지 예 두 행. 근거
  src/contracts/api-operations.ts:9,25-27,112-125,142-190,
  src/contracts/schema-registry.ts:6-11, config/contracts/registry-governance.json:220
  (boundary는 허용값만 검사), tests/unit/http-operation-v2-v3-parity.test.ts:39-49,91,
  src/adapters/http/request-builder.ts:129-135(V2만 읽음),
  src/contracts/external-contract-runtime.ts:33,
  src/adapters/http/http-contract-bridge.ts:225-231(V3 고정 상한 8,192).
- 01-5단계 routeId: 실행기에 넘겨 관측 기록의 route_id로만 쓴다
  (src/adapters/http/feature-http-binding.ts:272-273,
  src/adapters/http/http-execution-v3.ts:248-254,653-655,
  src/bootstrap/runtime-adapters.ts:249-293). 기준은 "요청을 보내는 화면".
  참조 기능 생성은 LIST를 적었다(reference-http-gateway.ts:32-34).
- 01-6단계: items/ 이유(reference-feature-contract.ts:36-37, React Router
  정적 우선), a11y spec 치환 줄(tests/e2e/accessibility.spec.ts:26-29,36-43),
  파라미터 해석 실패 시 잘못된 경로 화면(src/presentation/routes/app-router.tsx:371).
  드릴 잔여물 검사는 기능 ID·폴더 이름만 찾는다(scripts/test-sample-removal.ts:
  114-117,383-392). URL 함수가 codec을 넘겨야 한다는 줄도 더했다
  (src/presentation/routes/route-codecs.ts:36,69-87; 생성 판
  scripts/create-feature.ts:934-938은 넘기지 않음).
- 03 "기능을 지울 때"·C절, 01-11단계: a11y spec 치환 줄을 손으로 지운다.
- 01-10단계, patterns "테스트": msw request:start로 요청을 모으는 예
  (실험 tests/features/notice-feature/notice-pages.test.tsx, msw 2.15
  node_modules/msw/lib/core/experimental/frames/http-frame.d.ts:58,
  생성 판 setupServer scripts/create-feature.ts:1147-1149).
- 02-4절 503: V3는 problem 스키마 실패면 쓰기를 MAYBE_APPLIED로 두고
  (http-execution-v3.ts:1633-1647), 통과하면 기능 classifyProblem이 정한다
  (src/adapters/http/http-effect-certainty.ts:99-131; 참조 기능
  reference-feature-contract-contribution.ts:49-70은 503을 MAYBE_APPLIED).
  V2 IDEMPOTENCY_REFUSALS에 503이 없어 effect가 비고
  (src/adapters/http/client.ts:1035-1038,1109-1135) 조정자가 MAYBE_APPLIED로
  본다(src/presentation/adapters/query/application-query.ts:824-834). 재전송은
  같은 키, 새 저장은 새 키(같은 파일 583-589, 636-669). 판정: 백엔드 행동
  (http-contract.md:94 "같은 키로 나중에 다시")과 맞는다. 화면 문구만 다르다.
- 01-2단계: 길이 제한은 경계 검증. 참조 기능도 스키마·폼에만 둔다
  (reference-schemas.ts:66, reference-resource-form.ts:9).
- patterns "URL 검색값을 바꾸는 폼": 짧은 예(SearchField, CollectionPage
  toolbar, buildRouteUrl search).
- errors.md: V2 입력 칸 실패 메시지 3개와 Unregistered route codec.

남긴 것:
- 응답 모양 제한: 지금 생성한 기능은 짝 백엔드의 Envelope 응답을 읽지
  못한다. 매뉴얼에는 제한과 선택지 둘(백엔드가 DTO를 보냄 / 프론트 V3가
  Envelope를 벗김)만 적었다. 결정은 없다. CHANGELOG·리뷰 기록은 이 커밋
  범위 밖이다.
- 경로 파라미터와 본문을 함께 받는 operation(PUT 등)의 V2/V3 일치 규칙이
  없다는 사실만 적었다.
- 예시 코드는 실험 브랜치의 notice 기능에서 옮겼다. 이 저장소에서 다시
  돌려 보지 않았다(실험 커밋 기록상 기능 테스트 21개 통과).

검증:
- node scripts/generate-product-feature-index.ts &&
  node scripts/verify-documentation-readiness.ts: PASS_SCOPED,
  documentReferences의 docs/manual 8개 파일 missing 0
- node scripts/run-vitest.ts run tests/unit/deletable-history-documents.test.ts
  tests/unit/documentation-readiness.test.ts: 2 파일 16개 통과
- 새로 적은 실패 메시지·식별자: src·scripts·tests에서 모두 찾음.
  request:start는 msw 타입에서 확인
2026-11-03 08:01:49 +09:00

11 KiB

기능 개발 패턴

기능을 만들 때 쓰는 패턴과, 그 패턴의 정의와 예제가 어디 있는지 적는다.

  • 정의: 플랫폼(기능 밖)에서 패턴을 제공하는 파일.
  • 예제: 복사해 볼 수 있는 기능 코드. 생성 뼈대는 create:feature가 만드는 코드다. 참조 기능은 src/features/reference-feature/다.
  • 예제가 없는 패턴은 없음이라고 적었다. 그 패턴은 정의를 읽고 직접 쓴다.

참조 기능은 예제일 뿐이다. 복사해 이름을 바꾸지 않는다. 모양을 보고 생성 뼈대에 옮긴다.

기능 조립

패턴 정의 예제 검사
기능 모듈 등록 src/features/feature-module.ts (defineFeatureModule, defineFeatureRuntime), 생성기 생성 뼈대 feature-module.ts, feature-runtime.ts 생성기, 기능 ID와 계약 featureId 일치
context 소속 선언 src/contexts/bounded-context-module.ts src/contexts/reference-context/context-module.ts 생성기(없는 context, 예산), 앱 모듈(루트 밖 라우트)
context 전용 레이아웃 docs/architecture/starter-experience.md "Product home and layouts" tests/helpers/fixture-layout-product.tsx (테스트 fixture) tests/component/context-layouts.test.tsx
앱 홈 대신하기 src/contracts/routes.ts의 FEATURE_REPLACEABLE_PLATFORM_ROUTE_IDS 없음 (기능 예제) 조립 (두 기능이 APP_HOME을 선언하면 실패)
조립 기여(needs) src/features/feature-adapter-contribution.ts 생성 뼈대 adapters/create-<base>-feature-input.ts 조립 (없는 capability, 다른 기능의 input)
제품 capability src/bootstrap/product-composition.ts, src/bootstrap/product-composition-contract.ts recipes/frontend-capabilities/indexeddb-feature-capability.ts check:types
기능 끄기 config/runtime/<profile>.json의 FEATURE_OVERRIDES config/runtime/local.json tests/component/product-feature-switch.test.tsx

라우트

패턴 정의 예제 검사
라우트 선언 src/contracts/routes.ts, src/contracts/route-runtime-contract.ts 생성 뼈대 계약 routes, routeRuntimeContracts 조립(중복 route ID), check:registries(경로·chunk 중복)
context 라우트 적재 src/platform/routing/context-route-module.ts 생성 뼈대 context-routes.ts context 적재(계약에 없는 handle)
route ID로 URL 만들기 src/presentation/routes/route-codecs.ts의 buildRouteUrl 생성 뼈대 presentation/<base>-routes.ts, 참조 기능 presentation/reference-routes.ts 타입(기능의 route ID만 받음)
파라미터·검색값 codec src/presentation/routes/route-codecs.ts 참조 기능 presentation/reference-route-codecs.ts 해석 실패 시 잘못된 경로 화면
URL 검색값 읽기 src/presentation/routes/route-input.tsx의 useRouteInput + 검색값 codec 참조 기능 presentation/reference-routes.ts 해석 실패 시 잘못된 경로 화면
URL 검색값을 바꾸는 폼 buildRouteUrl의 search, 디자인 시스템 SearchField, CollectionPage의 toolbar 기능 예제 없음. 아래 짧은 예 라우터를 거치는 페이지 테스트

URL 검색값을 바꾸는 폼 (짧은 예)

검색값의 정본은 URL이다. 입력 중인 글자만 state에 둔다.

사용자가 검색어를 입력한다 (state의 draft만 바뀐다)
  → 제출하면 navigate(목록 URL + ?q=...)
  → 라우터가 검색값 codec으로 q를 읽는다
  → 목록 쿼리 입력이 바뀌어 GET을 다시 보낸다

준비:

  • 목록 라우트의 searchSchema와 routeRuntimeContracts의 searchCodec.
  • 그 codec을 context-routes.ts handle의 codecs와 URL 함수(buildRouteUrl의 세 번째 인자)에 함께 넘긴다.
  • 검색값을 읽는 hook. 참조 기능 reference-routes.ts의 useReferenceListFilters가 예제다.
// 공지 기능의 목록 페이지. noticeRouteUrl은 생성된 <base>-routes.ts의 URL 함수다.
const navigate = useNavigate();
const listQuery = useNoticeListQuery(); // URL 검색값 읽기
const [draft, setDraft] = useState(listQuery.q ?? "");
const search = (q: string) =>
  void navigate(noticeRouteUrl("NOTICE_LIST", q.trim() ? { search: { q: q.trim() } } : {}));

<CollectionPage
  toolbar={
    <form role="search" onSubmit={(event) => { event.preventDefault(); search(draft); }}>
      <SearchField
        label={message("notice.list.search")}
        clearLabel={message("notice.list.searchClear")}
        value={draft}
        onChange={(event) => setDraft(event.currentTarget.value)}
        onClear={() => { setDraft(""); search(""); }}
      />
      <Button type="submit">{message("notice.list.searchSubmit")}</Button>
    </form>
  }
  /* heading, resultCount, children은 생성된 목록 페이지와 같다 */
/>

API와 검증

패턴 정의 예제 검사
V2 operation 행 src/contracts/api-operations.ts의 defineRestOperation 생성 뼈대 contracts/<base>-api-contract.ts check:registries (FE-REG-API)
V3 HTTP 계약(실행) src/contracts/external-contract-runtime.ts 생성 뼈대 contracts/<base>-contract-contribution.ts 계약 조립, V2/V3 일치 테스트
배포된 계약 패키지 출처 같은 파일의 EXTERNAL_PACKAGE 생성 뼈대(자리표시자 또는 --package 신원). 실제 @org-contracts/* 패키지를 import하는 예제는 없음 계약 조립(신원 형식), 릴리스 승인(자리표시자)
런타임 검증기 src/contracts/zod-validator.ts의 zodValidator 생성 뼈대 contracts/<base>-schemas.ts 스키마 ID 중복
검증 생략 src/contracts/unvalidated-payload.ts의 unvalidatedPayload 없음 (기능 예제) 이유가 비면 throw, listUnvalidatedPayloads가 목록을 보임
DTO → 화면 값 mapper src/contracts/boundary-mapper.ts 생성 뼈대 contracts/<base>-mapper.ts mapper ID 중복
gateway port + HTTP 어댑터 src/adapters/http/index.ts의 createFeatureHttpBinding, defineFeatureHttpOperationForRoutes 생성 뼈대 adapters/<base>-http-gateway.ts 음성 타입 fixture (operation ID, route ID, 입력)
문제 응답 → 업무 실패 mapProblem (HTTP 바인딩) 참조 기능 adapters/reference-http-gateway.ts (409, 422) 기능 테스트
결과와 실패 src/contracts/result.ts, src/contracts/errors.ts 생성 뼈대 application/<base>-feature-api.ts FailureKind 닫힌 어휘(타입)
실패 → 화면 행동 src/contracts/errors.ts의 action 참조 기능 presentation/use-reference-failure-action.ts 페이지 테스트

서버 상태

패턴 정의 예제 검사
쿼리 바인딩 src/contracts/server-state.ts의 bindQuery, src/presentation/adapters/query/application-query.ts 생성 뼈대 presentation/use-<base>-items.ts profile ID (실행 때). operationId는 string이라 묶이지 않음
무효화 topic src/contracts/query-invalidation.ts 생성 뼈대 계약 invalidation 조립(중복, 고아 topic)
멱등 키 쓰기 V3 retrySemantics: "KEYED", commandRecovery, 뮤테이션 정책 참조 기능 생성 명령(use-reference-feature.ts, reference-feature-contract-contribution.ts) 계약 조립(복구 descriptor 필수), 기능 테스트
결과 불명 화면 src/presentation/components/async-surface.tsx의 onReconcileUnknownEffect, onResendUnknownEffect 참조 기능 presentation/reference-resource-form-page.tsx 기능 테스트만
수정·삭제 명령 같은 V3 계약 (PUT, PATCH, DELETE) 없음 (참조 기능은 생성 명령만 있다) —
낙관적 갱신 useApplicationMutation의 optimistic 옵션 (application-query.ts) 없음 런타임 테스트만
페이지 넘김 src/adapters/query-cache/index.ts의 createCursorPaginationRuntime 없음 (참조 기능은 커서 필터만, 다음 커서 없음) 런타임 테스트만
로컬 저장(IndexedDB) recipes/frontend-capabilities/indexeddb-feature-capability.ts + product-composition.ts src/features/local-draft-feature/ (NOT_INSTALLED, 설치되지 않음) 계약 테스트

화면

패턴 정의 예제 검사
페이지 템플릿 src/presentation/templates/page-templates.tsx 생성 뼈대 CollectionPage, 참조 기능 페이지 4개 page-templates-own-layout-only
비동기 상태 화면 src/presentation/components/async-surface.tsx의 AsyncSurface 생성 뼈대 목록 페이지 페이지 테스트
폼 src/presentation/forms/use-app-form.ts의 useAppForm 참조 기능 presentation/reference-resource-form.ts와 폼 페이지 페이지 테스트(422 허용 필드, 이탈 확인)
화면 문구 src/presentation/i18n/index.ts, 기능 문구 catalog 생성 뼈대 contracts/<base>-message-catalog.ts lint(문구 literal), check:i18n(ko-KR·en-US 키)
권한 분기 라우트 access, 서버 403 → 실패 참조 기능 403 화면 테스트 가드 테스트. 역할·권한 힌트 예제는 없음

테스트

패턴 정의 예제 검사
응답 시나리오 tests/mocks/handlers/http-scenarios.ts의 createHttpScenarioHandler 생성 뼈대 페이지 테스트 test:coverage
보낸 요청(헤더·본문) 확인 MSW setupServer().events.on("request:start") 01 문서 10단계의 짧은 예. 핸들러에서 모으는 방법은 참조 기능 reference-production-vertical.test.tsx의 504 재전송 테스트 test:coverage
같은 멱등 키 재전송 시나리오 in-flight-409 + 위 요청 모으기 01 문서 10단계 test:coverage

관측

패턴 정의 예제 검사
기능 telemetry src/platform/telemetry/telemetry-port.ts의 TelemetryPort, failOpenTelemetryPort 생성 뼈대 application/<base>-feature-api.ts 기능 테스트

같은 이름의 다른 타입 src/application/ports/telemetry-port.ts의 TelemetryPort는 기능에서 쓰지 않는다.

기능 사이

패턴 정의 예제 검사
기능 간 협력 금지 규칙만 있다 없음 check:architecture (features-do-not-import-other-features)

두 기능이 같은 것을 써야 하면 기능끼리 import하지 않는다. 공유할 것은 src/contracts나 src/application처럼 기능 밖 공유 폴더에 둘 수 있는지 먼저 본다. 공유 경로를 안내하는 예제는 없다.