문제 기능 하나가 같은 HTTP API를 두 번 적는다. *-api-contract.ts의 V2 행 (defineRestOperation)은 check:registries(FE-REG-API)가 검사하는 선언이고, contract contribution의 V3 descriptor가 실제로 실행된다. 둘이 어긋나지 않게 http-operation-v2-v3-parity 테스트를 따로 둔다. 048f490으로 V2 클라이언트가 없어져 V2 행을 읽는 실행 코드는 없고, 검사만 남은 두 번째 사본이다. V2 행을 위한 기능별 runtimeSchemas·mappers 레지스트리와 V2 보안 프로필 해석 (resolveRestSecurityProfiles)도 같이 남아 있다. 사용자 지시: 최신 경로 하나만 남기고, 레지스트리 기준선 재승인을 승인했다. 고른 방법 - src/contracts/api-operations.ts를 projectApiOperationRows 하나로 바꿨다. 조립된 contribution의 descriptor마다 operationId, featureId, method, path, authProfileId, retrySemantics, requestBody, responseBody, responseEnvelope, request/response/problemSchema(검증기 schemaId) 행을 만든다. FE-REG-API는 같은 export(API_OPERATIONS)를 읽고, governance 정의를 이 필드로 바꿨다. requestSchema·responseSchema는 그대로 FE-REG-SCHEMA를 참조한다. - FeatureRuntime은 apiContract 대신 schemas(FE-REG-SCHEMA 행)만 받는다. installed-feature-runtime-registries는 schemas로 스키마 레지스트리를 만들고 FE-REG-API 행을 descriptor에서 뽑는다. RUNTIME_SCHEMA_CODECS, MAPPER_REGISTRY, REST_PROFILE_BINDINGS_VALID, API_RUNTIME_BINDINGS_VALID를 지웠다. - realtime snapshot 바인딩은 ApiOperationRow를 받고 method GET과 retrySemantics SAFE·IDEMPOTENT를 본다(V2의 contractVersion·semantics· replayPolicy 대신). - rest-profiles.ts에서 V2 행용 provider·CSRF 프로필 해석을 지웠다. V3는 조립 때 auth profile을 검사하고 자격증명 헤더를 프로필로 거른다. - 참조 기능: reference-api-contract.ts를 reference-schema-metadata.ts로 바꾸고(스키마 행만), V2 runtime codec·operation mapper·레지스트리 mapper를 지웠다. V3 descriptor가 쓰지 않는 NoRequest 스키마 행도 지웠다. - create:feature: <base>-api-contract.ts 대신 <base>-schema-metadata.ts를 만든다. codec·mapper 레지스트리 행과 그 테스트를 만들지 않는다. - 레지스트리 기준선을 update:registry-baseline으로 다시 만들고 승인했다 (digest 16f72742…, 승인자 DongHyeonka, 이유에 사용자 승인을 적음). - 매뉴얼 01·02·reference, starter-experience, 계약 문서의 V2 설명을 지웠다. 버린 대안 - V2 행을 남기고 V3에서 생성하기: 생성 단계와 생성물이 하나 더 생긴다. 행은 실행되지 않으므로 메모리에서 뽑아 검사하면 충분하다. - 스키마 메타데이터(FE-REG-SCHEMA 행)도 검증기에서 뽑기: boundary· unknownFieldPolicy·owner는 검증기에 없고, 라우트 스키마도 같은 레지스트리를 쓴다. 이 행은 V2가 아니라 스키마 레지스트리라 남겼다. 위험·한계 - BREAKING: FeatureRuntime 모양, contracts·rest-profiles·loaded-feature-runtimes 의 이름이 바뀌거나 없어졌다. memento-frontend의 memento-web이 V2 행을 쓴다. 옮기는 법은 CHANGELOG에 적는다. - V2 보안 프로필 일관성 검사(auth "none"과 ANONYMOUS, 쿠키 프로필의 CSRF 모드)가 사라졌다. V3 descriptor에는 그 칸이 없다. - BoundedPollOperationContract(realtime polling recipe)는 contractVersion: 2 필드를 갖지만 자체 계약이라 바꾸지 않았다. 검증 - check:types, lint, check:architecture, check:registries(11 registries PASS, compatibility=none), check:ci, check:diagnostics, check:adapter-inventory, verify:documentation 통과. - test:unit 2,566(새 tests/unit/api-operation-rows.test.ts 3건 포함), test:integration 114, test:component 245, test:contract 23, test:runtime-schema 56, tests/features 99 통과. - tests/unit/second-api-feature-registries.test.ts: V3 descriptor만 가진 두 번째 기능을 복사본에 넣으면 기준선을 고치지 않고 check:registries가 통과한다. - check:bundle 통과. 초기 JS 201,598 → 200,911 B. - test:feature-scaffold 16개, test:sample-removal 23개 검사 통과. BREAKING CHANGE: FeatureRuntime이 apiContract 대신 schemas를 받는다. defineRestOperation, ApiOperation, RestOperationV2, composeApiOperations, validateApiRuntimeBindings, getApiOperation, contracts의 API_OPERATIONS, createRestProviderProfile, RestProviderProfile, resolveRestSecurityProfiles, validateRestProfileBindings, REST_CSRF_PROFILES, RestCsrfProfile, loaded-feature-runtimes의 RUNTIME_SCHEMA_CODECS, MAPPER_REGISTRY, REST_PROFILE_BINDINGS_VALID, API_RUNTIME_BINDINGS_VALID가 없어졌다. 기능은 operation을 contract contribution에만 적고, schemas 행을 feature-runtime에 넘긴다.
11 KiB
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.tshandle의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 바인딩) |
참조 기능 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처럼 기능 밖 공유 폴더에 둘 수 있는지 먼저 본다. 공유 경로를 안내하는 예제는 없다.