Files
clean-architecture-frontend…/docs/manual/reference/patterns.md
T
DongHyeonka 48c1ab7ab6 fix(server-state)!: 손으로 적은 뮤테이션 operation ID를 타입 검사에서 막는다
문제: 1103/16-05 수정으로 commandMutationIdentity가 생겼지만
BoundMutation.operationId는 여전히 string이다. 정책에 operation ID를
문자열로 직접 적으면 오타가 check:types와 check:registries를 통과하고,
저장할 때마다 실행기가 보내기 전에 MISSING_IDEMPOTENCY_KEY 위반으로
거부한다. 매뉴얼 01은 이것을 "못 잡음"으로 적고 있었다.

고른 방법: BoundMutation.operationId를 brand 타입 MutationOperationId로
바꾼다. 이 값을 돌려주는 것은 commandMutationIdentity뿐이라, 문자열을
직접 적으면 check:types가 실패한다. 런타임 값은 descriptor의 문자열
그대로이고 실행기·intent factory는 바뀌지 않는다. 참조 기능과 쓰기 slice
생성기는 이미 commandMutationIdentity를 spread하므로 고칠 것이 없다.
템플릿 테스트의 손글씨 ID 20곳은 tests/helpers/mutation-operation-id.ts
(commandMutationIdentity를 거치는 test helper)나 그 파일의 descriptor로
바꿨다. 매뉴얼 01·patterns 표·state 설계 예시를 맞췄다.
버린 대안: (1) 위반 이름을 INTENT_OPERATION_MISMATCH로 나누는 것. 실행
때만 드러나는 것은 같고, 공개 위반 어휘에 값이 하나 늘어 다운스트림
분기가 바뀐다. (2) 설치된 operation ID의 union 타입. 기능마다 늦게
적재되는 계약 전체를 타입으로 모을 곳이 없다.

위험·한계: 공개 타입(src/contracts/server-state.ts)이 좁아진다. 정책에
operation ID를 문자열로 적은 다운스트림 코드는 동기화 뒤 check:types가
실패한다. commandMutationIdentity에 descriptor 상수 대신 손으로 만든
객체를 넘기면 여전히 오타가 통과한다(매뉴얼 "못 잡음"). HTTP가 아닌
뮤테이션은 descriptor 모양 객체를 넘겨야 한다. 이 repo에는 그런 소비자가
없다.

검증: desktop batch에서 확인.
corepack pnpm check:types:test
tests/unit/command-mutation-identity.test.ts의 @ts-expect-error가 부모
커밋에서는 쓰이지 않아(TS2578) 실패하고 이 커밋에서 통과한다.
node scripts/run-vitest.ts run tests/unit/command-mutation-identity.test.ts tests/component/application-mutation-admission.test.tsx tests/component/application-mutation-scope-fence.test.tsx tests/component/application-query.test.tsx tests/component/form-foundation.test.tsx

BREAKING CHANGE: BoundMutation.operationId는 string이 아니라
MutationOperationId다. 뮤테이션 정책의 `operationId: "<ID>"`와
`requiresIdempotencyKey`를 `...commandMutationIdentity(<OPERATION>_CONTRACT)`
로 바꾼다(src/contracts/server-state.ts). commandMutationIdentity의 반환
타입도 operationId가 MutationOperationId다.

Refs: 1103/16-05
2026-11-05 22:26:27 +09:00

12 KiB

기능 개발 패턴

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

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

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

기능 조립

패턴 정의 예제 검사
기능 모듈 등록 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 상수 이름, 손으로 적은 operation ID는 MutationOperationId가 아니다), 기능 테스트
결과 불명 화면 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처럼 기능 밖 공유 폴더에 둘 수 있는지 먼저 본다. 공유 경로를 안내하는 예제는 없다.