Files
clean-architecture-frontend…/docs/manual/reference/patterns.md
T
DongHyeonka 2ec9d56008 feat(scaffold): create:feature --with-create가 짝 백엔드 생성기와 같은 slice를 만든다
문제
- 프론트 create:feature는 GET /api/<base>-items 목록 하나를 만든다. 짝 백엔드
  new-feature.sh는 POST /<plural>(201, NOT_IDEMPOTENT)과 GET /<plural>/{id}를
  만든다. 경로 규칙도, operation 쌍도 맞지 않는다(03-07).
- 짝 백엔드 모양(Envelope)의 상세 GET·작성 POST·폼·결과 불명 화면 예제는
  참조 기능뿐이고, 참조 기능은 problem details 모양이라 옮기면 짝 백엔드에서
  쓰이지 않는 분기와 값(400·422 분류, retryBudget 0, Envelope 줄 없음)을
  함께 옮긴다(09-06, 16 5.3절).
- 생성된 목록의 "총 N개"는 배열 길이다. 백엔드 meta.page.total을 쓰지
  않는다(03-02 수정이 남긴 일).

고른 방법
- 경로: 백엔드 new-feature.sh와 같은 복수형 규칙(backendPathSegment)으로
  API_PATH 상수 하나를 둔다. 백엔드 api-base-path는 API_BASE_URL에 붙인다.
- 목록: mapper가 { items, total }을 내고 total은 page?.total ?? 길이다. 빈
  목록은 EmptySurface로 같은 빈 상태를 그린다.
- --with-create: 상세 GET, 작성 POST, 상세·작성 라우트와 페이지, 폼 스키마
  (이름 100자 = 백엔드 NAME_MAX_LENGTH), 뮤테이션 정책(commandMutationIdentity),
  작성 폼 테스트를 만든다. 작성은 백엔드 기본에 맞춰 NEVER(retryBudget 0, 키
  없음)다. --keyed는 백엔드 create를 IdempotencyExecutor 뒤에 둔 경우의
  KEYED 값(IDEMPOTENCY_REPLAY, retryBudget 1)을 쓴다.
- 작성 descriptor: acceptedStatuses [201], refusedBeforeWrite
  ["<BASE>_INVALID"], classifyStatus는 401·403·429를 NOT_APPLIED(백엔드
  보안 필터·@RequiresPermission 프록시·rate-limit interceptor가 use case 전에
  거절한다). mapProblem이 <BASE>_INVALID를 이름 칸 오류로 바꾼다.
- 생성 테스트: gateway 테스트가 세 operation의 백엔드 본문(201 Envelope,
  404 <BASE>_NOT_FOUND, 400 <BASE>_INVALID → NOT_APPLIED, 응답 유실 →
  MAYBE_APPLIED, NEVER는 키 없음·KEYED는 503 IDEMPOTENCY_UNAVAILABLE 뒤 같은 키
  1회 재전송)을 손으로 적는다. 하네스 재시도 상한은 앱 기본값 2다(16-07 (3)).
  작성 폼 테스트는 라우터를 거쳐 201 저장 뒤 상세 열기, 400 거절을 이름 칸에
  보이고 저장 버튼이 켜진 채 다시 저장, 응답 유실 뒤 결과 불명(NEVER는 다시
  보내기 없음, KEYED는 같은 Idempotency-Key로 다시 보내기)을 본다.
- 페이지 테스트의 앱 조립은 <base>-test-app.tsx 하나로 모은다.
- slice 템플릿은 scripts/create-feature-write-slice.ts에 둔다. 리뷰 5.3절
  재검토 조건(템플릿 2,000줄)을 넘지 않게 하고, create-feature.ts의 수정을
  필요한 자리로 좁힌다.
- X1: 생성한 context 선언을 임시 폴더에 써서 생성기 선언 읽기로 읽고, 그
  모듈을 import해 앱 모듈 조립(라우트 루트 검사)이 기능 라우트를 받는지 보는
  단위 테스트를 더한다.

버린 대안
- 작성을 기본 KEYED로: 백엔드 생성 create는 키를 읽지 않아, 같은 키 재전송이
  새 항목을 만든다. 안전해 보이는 거짓 보장이다.
- 참조 기능을 Envelope로 옮기기(09-06 (2)): 참조 테스트와 MSW fixture를 다수
  바꾸고 problem details 예제가 사라진다.
- 목록 값을 배열로 두고 total을 배열 속성으로 싣기: TanStack 구조 공유가 배열
  속성을 버린다.

위험·한계
- 백엔드 생성기는 목록 엔드포인트를 만들지 않는다. 백엔드에 GET 페이지 목록을
  더하기 전에는 생성 목록이 405를 받는다. descriptor 주석과 매뉴얼에 적었다.
- 생성 기능의 초기 JS: 기본 +647 B, --with-create +964 B(이 브랜치 기준선
  203,702 B에서 잰 값, 기능당 1 KiB 안). 기준선의 남은 여유는 1,098 B라
  --with-create 기능 하나를 넣으면 134 B가 남는다.
- 두 생성기를 실제로 띄워 붙여 보지는 않았다. 백엔드 템플릿의 응답 본문과
  경로를 읽어 생성 테스트에 옮겼다.

검증
- RED: tests/unit/create-feature.test.ts 새 17건 실패 → GREEN 43건 통과.
- 기본·--with-create·--with-create --keyed·--context reference-context
  --with-create 네 기능을 만든 상태에서: check:types(app·test·node), lint,
  check:registries(additive), check:i18n, check:architecture,
  check:design-system, check:diagnostics, verify:documentation 통과. 생성 기능
  테스트 77건 통과. 빠른 계층 313파일 3,818건 중 참조 라우팅 테스트 1건만
  실패(X1, 다음 커밋).
- 변이: refusedBeforeWrite 삭제 → gateway·폼 테스트 2건 실패. 상세 GET의
  responseEnvelope 삭제 → 조립 거절로 테스트와 check:registries 실패. KEYED
  retryBudget 0 → 503 재전송 테스트 실패. 정책의 descriptor 상수 오타 → tsc 실패.
- flock 아래 build, check:bundle: 기준 203,702, 기본 기능 204,349, --with-create
  기능 204,666 / 204,800 B PASS.

Refs: docs/reviews/2026-11-03-maturity-review/09-app-core.md 09-06
Refs: docs/reviews/2026-11-03-maturity-review/03-adapters-http-state.md 03-07
Refs: docs/reviews/2026-11-03-maturity-review/16-structure-patterns.md 16-01
2026-11-04 23:42:00 +09:00

12 KiB

기능 개발 패턴

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

  • 정의: 플랫폼(기능 밖)에서 패턴을 제공하는 파일.
  • 예제: 복사해 볼 수 있는 기능 코드. 생성 뼈대는 create:feature가 만드는 코드다. 쓰기 slice는 create:feature <id> --with-create가 더 만드는 코드다(짝 백엔드 Envelope 모양). 참조 기능은 src/features/reference-feature/다(Envelope가 아닌 problem details 모양).
  • 예제가 없는 패턴은 없음이라고 적었다. 그 패턴은 정의를 읽고 직접 쓴다.

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

기능 조립

패턴 정의 예제 검사
기능 모듈 등록 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/features/product-capabilities.ts(타입), 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 쓰기 slice presentation/<base>-route-codecs.ts(상세 params), 참조 기능 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와 검증

패턴 정의 예제 검사
HTTP 계약 src/contracts/external-contract-runtime.ts 생성 뼈대 contracts/<base>-contract-contribution.ts 계약 조립, check:registries (FE-REG-API 행은 src/contracts/api-operations.ts의 projectApiOperationRows가 뽑는다)
스키마 메타데이터 src/contracts/schema-registry.ts의 SchemaDefinition 생성 뼈대 contracts/<base>-schema-metadata.ts check:registries (FE-REG-SCHEMA)
배포된 계약 패키지 출처 같은 파일의 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의 BoundaryMappingResult 생성 뼈대 contracts/<base>-mapper.ts 타입 검사
gateway port + HTTP 어댑터 src/adapters/http/index.ts의 createFeatureHttpBinding, defineFeatureHttpOperationForRoutes 생성 뼈대 adapters/<base>-http-gateway.ts 음성 타입 fixture (operation ID, route ID, 입력)
문제 응답 → 업무 실패 mapProblem (HTTP 바인딩) 쓰기 slice adapters/<base>-http-gateway.ts(400 <BASE>_INVALID → 이름 칸), 참조 기능 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 페이지 테스트
파일 업로드 (짝 백엔드 Fileserver) src/adapters/http/index.ts의 createFileserverUploadClient (POST /v1/files) 없음 (기능 예제). 조립은 02 결정표 7절 tests/integration/fileserver-upload.test.ts

서버 상태

패턴 정의 예제 검사
쿼리 바인딩 src/contracts/server-state.ts의 bindQuery, src/presentation/adapters/query/application-query.ts 생성 뼈대 presentation/use-<base>-items.ts profile ID (실행 때). owner·operationId는 읽는 곳이 없는 @deprecated 칸이라 적지 않는다
무효화 topic src/contracts/query-invalidation.ts 생성 뼈대 계약 invalidation 조립(중복, 고아 topic)
멱등 키 쓰기 V3 retrySemantics: "KEYED", commandRecovery, 뮤테이션 정책(src/contracts/server-state.ts의 commandMutationIdentity로 operation ID와 키 여부를 descriptor에서 받는다) 쓰기 slice --keyed(contracts/<base>-contract-contribution.ts, presentation/use-<base>-create.ts), 참조 기능 생성 명령(use-reference-feature.ts, reference-feature-contract-contribution.ts) 계약 조립(복구 descriptor 필수), 타입(descriptor 상수 이름), 기능 테스트
결과 불명 화면 src/presentation/components/async-surface.tsx의 onReconcileUnknownEffect, onResendUnknownEffect 쓰기 slice presentation/<base>-create-page.tsx, 참조 기능 presentation/reference-resource-form-page.tsx 기능 테스트만(쓰기 slice는 <base>-create-page.test.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_A_FEATURE, 기능이 아닌 샘플) 계약 테스트

화면

패턴 정의 예제 검사
페이지 템플릿 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 쓰기 slice presentation/<base>-form.ts와 <base>-create-page.tsx, 참조 기능 presentation/reference-resource-form.ts와 폼 페이지 페이지 테스트(서버 필드 오류, 이탈 확인)
화면 문구 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처럼 기능 밖 공유 폴더에 둘 수 있는지 먼저 본다. 공유 경로를 안내하는 예제는 없다.