Files
clean-architecture-frontend…/docs/manual/03-outside-feature-folder.md
T
DongHyeonka 615da352b9 docs(realtime): 짝 백엔드 실시간 출구와 프론트 transport 대응표를 적는다
문제
짝 백엔드의 실시간 출구는 STOMP-over-SockJS 채널(/ws, /topic 구독 1개,
Map<String,String> 투영, 재전송 없음)과 raw WebSocket 라이브러리 API,
NDJSON·JSON text sequence writer다. 프론트 SSE 어댑터는
text/event-stream과 REALTIME_EVENT_V1 envelope을, WebSocket 어댑터는
subprotocol "realtime.v1"을 요구한다. 어느 repo에도 이 불일치와 지금
되는 경로가 적혀 있지 않아, 채택자가 두 repo를 다 읽어야 안다.

고른 방법
- 리뷰의 최소 방향을 프론트 repo 안에서 따른다. 설계 문서에 0.1절을
  두고 transport별 대응표(지금 연결되나·이유), push가 필요할 때의 세
  길, 재검토 조건을 적는다. 레시피 Realtime 절과 매뉴얼 03 C절에서 한
  줄로 링크한다.
- 다시 확인한 백엔드 사실(읽기만): 아키텍처 테스트가 MVC SseEmitter를
  금지한다(ForbiddenApiArchitectureTest NO_SSE_EMITTER, 결정 D3).
  StreamMediaType.SSE는 OpenAPI 생성기만 쓴다. subprotocol 협상 코드는
  없다. 그래서 첫째 길을 SSE가 아니라 realtime.v1 WebSocket handler로
  적었다.
- 지금 되는 경로(bounded polling)는 사실로 적고, push 경로는 고르지
  않았다. 제품 결정이다.
- 버린 대안: desktop-server-git/design-docs/에 쓰기. 이 브랜치 밖이라
  함께 합쳐지지 않는다. 필요하면 그쪽에서 이 절을 링크한다.

위험·한계
- 백엔드 사실은 지금 백엔드 HEAD(70fb80bf)를 읽은 것이다. 백엔드가
  바뀌면 표가 낡는다. 재검토 조건에 적었다.
- 실제 연결은 실행하지 않았다(리뷰와 같음).

검증
- verify:documentation PASS_SCOPED. documentation-readiness·
  changelog-review-ids 테스트 15건 통과.

Refs: docs/reviews/2026-11-03-maturity-review/04-adapters-realtime.md 04-02
2026-11-04 20:29:32 +09:00

9.7 KiB

03. 기능 폴더 밖 파일

핵심: 기능 하나에 필요한 파일은 거의 모두 src/features/<id>/와 tests/features/<id>/ 안에 있다. 폴더 밖 파일은 네 묶음으로 나뉜다.

기능 폴더 밖 파일
  ├─ A. 생성 명령이 만든다          → 사람은 확인만
  ├─ B. 사람이 꼭 해야 한다         → a11y 서명, 자리표시자 교체
  ├─ C. 조건이 맞을 때만 사람이 고친다 → 레이아웃, 새 capability, 제품 인증 프로필 등
  └─ D. 고치지 않는다               → 중앙 카탈로그, governance, 공유 mock 등

정본 표: 파일마다 "언제 고치나"와 "안 고치면 무엇이 실패하나"는 docs/architecture/starter-experience.md의 "Adding a feature" 절 표(File | When | What fails without it)가 정본이다. 이 문서는 그 표를 복사하지 않는다. 그 표에 없는 것만 더한다. 누가 하는지, 왜 폴더 밖인지, 사람이 하는 절차.

링크: starter-experience.md "Adding a feature"


A. 생성 명령이 만든다

corepack pnpm create:feature가 쓰는 폴더 밖 파일은 둘이다. 있는 파일은 덮어쓰지 않는다.

  • src/contexts/<context>/context-module.ts
    • 새 context일 때만 만든다. --context를 주면 만들지 않는다.
    • 왜 밖인가: context는 여러 기능이 함께 쓰는 소속 선언이다. 기능 하나가 갖지 않는다.
  • artifacts/tests/a11y-manual/<ROUTE_ID>.md
    • 라우트마다 하나. Status: pending-manual-review로 만든다.
    • 왜 밖인가: 수동 접근성 검토 기록은 라우트 단위로 한 폴더에 모은다. 릴리스 검토자가 한 곳에서 서명한다.
    • pending 기록은 merge 게이트를 통과하고 릴리스 게이트를 넘지 못한다(원칙 7).

src/.generated/도 기능 폴더 밖이다. 생성기가 매번 다시 만든다. 손으로 고치지 않는다.


B. 사람이 꼭 해야 한다

수동 접근성 검토 서명

create:feature가 pending 기록을 만든다
  → merge: 형식만 본다 (review:a11y-manual -- --format-only, FE-GATE-009)
  → 릴리스 후보가 나온다
  → 사람이 그 후보로 라우트를 검토하고 기록에 서명한다
  → release: 서명을 본다 (review:a11y-manual, FE-GATE-028)

할 일:

  1. 릴리스 후보 하나를 띄운다.
  2. docs/accessibility/manual-checklist.md의 M1~M7과 스크린 리더 항목을 그 라우트에서 확인한다.
  3. artifacts/tests/a11y-manual/<ROUTE_ID>.md를 채운다.
    • Status: reviewed, Release ID, Reviewer, Reviewed at, Signature, Attestation: accepted
    • 항목마다 pass 또는 not-applicable (<구체적 이유>)
  4. 모든 라우트 기록의 Release ID가 같아야 한다.

안 하면: FE-GATE-028이 Manual accessibility evidence is incomplete:로 릴리스를 막는다.

생성 명령이 서명까지 하지 않는 이유: 자동으로 "검토함"을 쓰면 서명이 아무 뜻이 없어진다(원칙 7).

자리표시자 계약 신원 교체

패키지 인자 없이 만든 기능은 자리표시자 신원을 쓴다. staging·production에 내보내기 전에 바꾼다.

백엔드가 @org-contracts/<service> 패키지를 배포한다
  → 패키지를 제품 의존성으로 더한다
  → 의존성 변경 증거를 적는다
  → 기능 계약의 신원 네 필드를 바꾼다
  → 계약 기여가 패키지의 descriptor를 쓰게 바꾼다
  → 승인 검사로 확인한다

할 일:

  1. 패키지를 production 의존성으로 더한다. package.json과 lockfile이 바뀐다.
  2. config/security/dependency-change-evidence.json에 add:<name>@<version> 항목을 더한다(owner, reviewer, reason, rollback).
    • 안 하면: generate:supply-chain(check:bundle, FE-GATE-012 안에서 돈다)이 high-risk dependency missing review: add:<name>@<version>로 실패한다.
  3. src/features/<id>/contracts/<base>-feature-contract.ts의 <BASE>_CONTRACT_PACKAGE에서 네 필드를 함께 바꾼다.
    • packageId, version(정확한 SemVer), digest(sha256: + 소문자 hex 64자리), sourceRevision(hex 7~64자리)
    • 자리표시자 상수 import를 지운다.
  4. src/features/<id>/contracts/<base>-contract-contribution.ts가 로컬 descriptor 대신 패키지의 descriptor를 쓰게 바꾼다.
    • @org-contracts/* import는 이 파일에서만 된다(external-contract-package-single-import-path).
  5. 공개 대상으로 승인 검사를 돌린다.
    • APP_PROFILE=staging으로 빌드한 뒤 APP_PROFILE=staging RELEASE_TARGET=staging corepack pnpm check:release-admission(FE-GATE-027)을 돌린다.
    • 검사는 빌드 결과 dist/config.json을 읽는다. 빌드 변수는 루트 README.md의 "Runtime configuration" 절에 있다.

안 하면: FE-GATE-027이 거절한다.

release admission refused for staging:
  contractPackages.@org-contracts/<service>: pins the placeholder identity create:feature writes; pin the published package's version, digest and revision

생성 명령이 실제 신원을 만들지 않는 이유: 어느 백엔드 버전과 맞춰 빌드했는지는 사람이 정해야 한다(원칙 2).


C. 조건이 맞을 때만 사람이 고친다

언제와 실패 메시지는 정본 표에 있다. 여기에는 무엇을 위해 고치는지만 적는다.

  • src/contexts/<context>/context-layout.tsx: context가 AppShell 대신 자기 틀을 쓸 때. 예제: tests/helpers/fixture-layout-product.tsx.
  • tests/e2e/accessibility.spec.ts: 경로 파라미터가 :resourceId가 아닐 때, 또는 모든 API가 []를 답하면 그려지지 않는 보호 페이지일 때. 치환 줄 고치는 법은 01 문서 6단계.
  • src/bootstrap/product-composition.ts: needs에 템플릿이 만들지 않는 capability를 적었을 때. 제품 인증 프로필의 자격 증명도 여기서 준다.
    • 템플릿 파일 src/bootstrap/runtime-adapters.ts는 고치지 않는다.
    • 실시간 갱신: 짝 백엔드의 실시간 출구(STOMP·NDJSON)와 프론트 realtime 어댑터(SSE·realtime.v1 WebSocket)는 그대로 연결되지 않는다. 지금 되는 경로는 bounded polling이다. 대응표: realtime 설계 0.1절.
  • src/contracts/product-contracts.ts: 제품 인증 프로필이나 제품 런타임 설정 키가 필요할 때.
    • 템플릿 파일 src/contracts/rest-profiles.ts는 고치지 않는다.
  • config/runtime/<profile>.json: 환경별로 기능을 끄고 싶을 때(FEATURE_OVERRIDES).
  • package.json, lockfile, config/security/dependency-change-evidence.json: 계약 패키지를 더할 때(B절).

정본 표에 없는 것:

  • config/contracts/registry-baseline.json과 승인 파일: 레지스트리 행을 빼거나 바꿀 때만. 더하기만 하면 고치지 않는다. 절차는 01 문서 9단계.
  • config/testing/risk-coverage.json의 criticalModules: 기능 파일에 따로 커버리지 하한을 걸고 싶을 때(선택). 제거 드릴이 기능 폴더를 가리키는 행을 지운다.
  • tests/e2e/<spec>.spec.ts: 기능 전용 브라우저 테스트가 필요할 때. Playwright는 tests/e2e만 읽어서 기능 폴더 안에 둘 수 없다.

왜 이것들이 기능 폴더 밖인가: 제품 전체가 하나만 갖는 파일이다. 템플릿은 이 자리를 제품 소유로 비워 두었다. 템플릿을 동기화해도 제품의 내용과 충돌하지 않는다.


D. 고치지 않는다

기능을 더할 때 아래는 고치지 않는다. 고쳐야 할 것 같으면 무언가 잘못 고른 것이다.

  • src/features/installed-*.ts (중앙 카탈로그): 기능 폴더를 glob으로 읽는다.
  • config/contracts/registry-governance.json: 라우트의 스키마·로딩 화면 값을 허용 목록으로 갖지 않는다.
  • config/contracts/registry-baseline.json: 더하기만 하는 변경은 additive다.
  • README.md, docs/accessibility/manual-checklist.md: route ID 목록을 갖지 않는다. 라우트별 기록 파일이 검사 대상이다.
  • tests/mocks/ 아래 공유 파일: 기능 테스트는 createHttpScenarioHandler에 기능 계약을 넘긴다. 공유 시나리오 카탈로그는 바뀌지 않는다.
  • src/bootstrap/runtime-adapters.ts, src/contracts/rest-profiles.ts: 템플릿 소유. 제품은 C절의 제품 소유 파일을 쓴다.

기능을 지울 때

corepack pnpm test:sample-removal -- --feature=<id>는 복사본에서 지워 보고 게이트를 돈다. 실제 저장소에서 지울 때는 아래를 함께 지운다.

  • src/features/<id>/, tests/features/<id>/
  • 그 context의 마지막 기능이면 src/contexts/<context>/
  • artifacts/tests/a11y-manual/<ROUTE_ID>.md (라우트마다)
    • 남아도 검사는 실패하지 않는다. 검사는 등록된 라우트의 기록만 읽는다. 그래서 잊기 쉽다.
  • 기능 전용 tests/e2e/ spec
  • tests/e2e/accessibility.spec.ts에 더한 .replace(":<파라미터>", "<값>")
    • 기능 ID를 담지 않아 제거 드릴이 잡지 못한다. 남아도 어떤 검사도 실패하지 않는다.
  • config/runtime/<profile>.json의 FEATURE_OVERRIDES 키
  • config/testing/risk-coverage.json에서 그 기능을 가리키는 행
  • 그 기능만 쓰던 제품 capability, 제품 인증 프로필, 계약 패키지 의존성

그다음 레지스트리 기준선을 다시 찍는다. 행을 빼는 것은 breaking 변경이다.

REGISTRY_BASELINE_OWNER=<담당> REGISTRY_BASELINE_REASON="<id> removed" corepack pnpm update:registry-baseline