Files
clean-architecture-frontend…/docs/manual
DongHyeonka f800549315 feat(http): 짝 백엔드 Fileserver의 multipart 한 번 업로드 client를 더한다
문제: 두 템플릿을 짝으로 쓰면 파일 업로드 경로가 없다. 프론트 업로드
레시피는 PRESIGNED_MULTIPART_V1 서버를 가정하는데 짝 백엔드는 그 코드를
지웠고, 짝 백엔드 Fileserver(POST /v1/files)를 부를 프론트 client는 없다.
src 전체에 multipart 요청을 만드는 코드가 없다.

고친 방법(리뷰 D1 (나-1)): src/adapters/http/fileserver-upload.ts에
createFileserverUploadClient를 둔다. 백엔드 bbe944bd 계약 그대로다.
- 입력은 FileContentPort.openSource가 주는 FileByteSource다. 바이트를 한
  번 읽어 multipart 본문(파트 이름 file, RFC 7578, 파일 이름은 HTML 폼
  인코더처럼 escape)을 직접 만든다. File·Blob은 이 adapter에 들어오지
  않는다(eslint browser-data 경계). 선언 크기가 maxFileBytes보다 크면 읽기
  전에 거절하고, 읽는 중에 넘어도 멈춘다. 선언 크기가 있으면 본문 버퍼
  하나에 바로 쓴다.
- 전송 규칙은 레시피와 V3 실행기와 같다. credentials는 인증 프로필이
  정하고, 자격 증명 헤더는 admitCredentialHeaders로 프로필에 맞춰 받는다.
  redirect "error", no-referrer, no-store, 응답 본문 상한, 바이트에 비례한
  deadline 하나, 호출자 abort(커널 createAbortableOperation).
- 성공: 201 READY / 202 그 밖의 state를 Envelope에서 읽는다. 201과 202의
  state가 맞지 않거나 size가 보낸 바이트와 다르면 SCHEMA_MISMATCH,
  APPLIED_CONFIRMED.
- 실패: backend-envelope.ts의 readFailureEnvelope와 envelopeFailureReading을
  그대로 쓴다. 효과 판정은 Fileserver 계약을 따른다. details.ambiguous,
  AMBIGUOUS_COMPLETION, IDEMPOTENT_IN_FLIGHT, IDEMPOTENCY_COMPLETION_UNKNOWN은
  MAYBE_APPLIED. 그 밖의 4xx는 NOT_APPLIED(백엔드 UploadFile use case가
  모호하지 않은 실패에서 업로드를 취소한다). 5xx는 이름 붙인 Fileserver
  code만 NOT_APPLIED이고 나머지는 MAYBE_APPLIED. 보낸 뒤 네트워크 실패·
  시간 초과·abort도 MAYBE_APPLIED. Envelope의 retryable:false와 상한(기본
  30초)을 넘는 Retry-After는 retryable을 false로 만든다(01-02와 같은 규칙).
- Idempotency-Key 헤더를 보낸다. client는 스스로 다시 보내지 않는다.

위치를 http adapter로 고른 이유: Envelope 해석(backend-envelope.ts), 자격
증명 admission(http-contract-bridge.ts), bounded reader를 adapter 안
import로 다시 쓴다. 새 adapter 사이 import 예외가 필요 없다. 바꾼 http
파일은 index.ts의 export 한 묶음뿐이다.
버린 대안:
- backend-envelope.ts를 커널(src/adapters/platform/)로 옮기고 client를
  browser-transfer에 둔다. 다른 작업이 지금 고치는 파일을 옮겨야 하고,
  커널은 제품 중립 primitive 자리인데 백엔드 짝 정책이 들어간다.
  file-transfer 레시피 예산 여유도 1.7KB뿐이고, 이 client는 presigned
  레시피와 무관한데 그 제거 드릴에 함께 지워진다.
- browser-transfer에 Envelope 파서를 하나 더 둔다. 갈라진 사본이다.
- V3 실행기에 multipart 본문을 더한다. 1,900줄짜리 실행기를 다른 작업과
  동시에 크게 고쳐야 한다.
- FormData와 Blob을 쓴다. http adapter는 File·Blob을 쓸 수 없고(eslint),
  기능은 Blob을 갖지 않는다.

조립: 제품이 product-composition.ts에서 client 재료
(FileserverUploadClientDependencies)를 capability로 넘기고, 기능 adapter가
createFileserverUploadClient를 부른다. 그래서 템플릿 boot 번들에는 들지
않는다. 매뉴얼 02 결정표 7절, patterns.md, 두 architecture 문서, 레시피
fallback이 이 경로를 가리킨다. adapter INVENTORY와 상세 리뷰 표에 행을
더했다(번호는 끝에 141로 붙였다).

위험·한계:
- 재개가 없다. 파일 전체를 메모리에 한 번 읽는다(maxFileBytes까지). tus
  client는 없다.
- 짝 백엔드 bbe944bd의 POST /v1/files는 멱등 키를 읽지 않는다
  (NOT_IDEMPOTENT). MAYBE_APPLIED 뒤 같은 키로 다시 보내도 파일이 두 개
  생길 수 있다. 매뉴얼에 적었다.
- 효과 판정 표(NOT_APPLIED_5XX_CODES, MAYBE_APPLIED_CODES)는 백엔드
  bbe944bd 기준이다. 어긋남을 알리는 검사는 없다(12-06과 같은 종류).
- 실제 짝 백엔드를 띄운 업로드는 하지 않았다. 테스트는 계약대로 답하는
  MSW다. 실제 브라우저(Playwright)에서도 돌리지 않았다.
- 템플릿 기본 product-composition.ts가 자격 증명 owner를 노출하지 않으므로,
  템플릿 세션(EXTERNAL_BEARER)으로 올리려면 제품이 자기 credential
  provider를 써야 한다.

검증:
- tests/integration/fileserver-upload.test.ts 48건 통과(201/202 본문,
  Envelope 실패 16종, 409 IDEMPOTENT_IN_FLIGHT + Retry-After 2, 상한 밖
  Retry-After, 보낸 뒤 네트워크 실패 뒤 같은 키 재전송, 시간 초과, abort,
  자격 증명 거절, 크기·입력 거절). multipart 본문은 undici FormData
  파서로 다시 읽어 확인했다.
- 변이 7건(4xx 판정, ambiguous 무시, 상한 무시, credentials 고정, 키 누락,
  201/202 state 검사 제거, Envelope retryable 무시) 모두 실패를 만들었다.
- check:types, lint(바꾼 파일), check:architecture, check:adapter-inventory,
  verify:documentation, check:registries, check:ci 통과
- check:bundle PASS: initial JS 201,921 / 204,800 gzip bytes. 빌드 산출물
  어디에도 client 코드가 없다(dist grep). check:optional-recipes:source PASS
  (file-transfer 56,082 / 57,800)

Refs: docs/reviews/2026-11-03-maturity-review/01-adapters-browser-transfer.md 01-01
2026-11-04 21:05:23 +09:00
..

개발 매뉴얼

이 폴더는 이 템플릿으로 만든 프로젝트에 새 기능 하나를 추가하는 절차를 적는다. 기능 하나는 화면(라우트와 페이지)과 그 화면이 쓰는 API 호출을 함께 뜻한다.

시작은 corepack pnpm create:feature <id>다. 이 명령이 모든 merge 게이트를 통과하는 가장 작은 기능을 만든다. 그 뒤 이 매뉴얼의 단계대로 뼈대를 실제 기능으로 바꾼다.

누가 읽는가

  • 이 템플릿을 복사한 제품 팀의 프론트엔드 개발자.
  • 기능을 만드는 AI 에이전트. 단계마다 "쓸 스킬"을 적었다.
    • 스킬: Claude Code가 부르는 작업 지침의 이름이다. 사람이 읽을 때는 건너뛰어도 된다.

전제: 루트 README.md의 "Start locally"대로 로컬에서 앱이 뜬다.

읽는 순서

README (이 문서)
  → 01 작업 순서 (처음부터 끝까지 한 번)
  → 02 결정표 (단계 중 "무엇을 고를지" 막힐 때)
  → 03 기능 폴더 밖 파일 (폴더 밖을 고쳐야 할 때)
  → reference/ (명령 인자, 전역 ID, 패턴, 오류 메시지를 찾아볼 때)
문서 내용
01-add-a-feature.md 0~11단계. 단계마다 정할 것, 판단 기준, 잡는 검사와 못 잡는 것, 쓸 스킬
02-decision-tables.md context 경계, 계약 출처, 재시도 의미, 결과 불명, 인증, 페이지 템플릿, 파일 업로드
03-outside-feature-folder.md 기능 폴더 밖 파일. 생성 명령이 하는 것과 사람이 하는 것
reference/create-feature.md create:feature의 인자, 만드는 파일, 거부 조건, 출력
reference/global-ids.md 전역 ID 종류, 생성 명령이 만드는 값, 유일성 검사
reference/patterns.md 기능 개발 패턴과 예제 위치. 예제가 없는 패턴은 "없음"
reference/errors.md 생성·조립·레지스트리 검사의 실패 메시지와 고칠 파일

자주 나오는 말

  • 기능(feature): src/features/<id>/ 폴더 하나. 그 기능의 테스트는 tests/features/<id>/에 둔다.
  • context: 같은 URL 앞부분 아래에 있는 기능 묶음이다. 선언은 src/contexts/<context>/context-module.ts다.
  • 라우트 루트: context가 가진 URL 앞부분이다. 선언 파일의 CONTEXT_ROUTE_PATH가 그 값이다.
  • 생성기: scripts/generate-product-feature-index.ts. 기능·context 선언을 읽어 src/.generated/를 만든다. 모든 빌드·검사 명령이 먼저 돌린다.
  • 조립: 부팅이나 테스트 시작 때 설치된 기능의 계약·라우트·문구를 하나로 합치는 일. 중복이 있으면 여기서 실패한다.
  • 게이트: CI가 돌리는 검사 묶음이다. ID는 FE-GATE-0NN 꼴이고 정의는 config/ci/gates.json에 있다.
  • 계약 패키지: 백엔드 API의 모양과 신원(버전·digest·소스 리비전)을 담은 @org-contracts/* 패키지.
  • digest: 패키지 내용의 해시다. 같은 버전 번호로 내용이 바뀌는 것을 막는다.

공통 원칙

판단 원칙은 design-docs repo의 conventions/feature-design-principles.md(기능 설계 공통 원칙)에 있다. 프론트·백엔드 템플릿이 함께 쓰는 원칙이다. 이 매뉴얼은 원칙을 복사하지 않고 "(원칙 5)"처럼 번호로 가리킨다.

이 폴더에 두는 것

  • 이 템플릿의 파일 이름, 명령, 게이트 ID로 쓴 절차와 판단 기준.
  • 실패 메시지와 고칠 파일. 메시지는 코드의 문자열을 그대로 옮긴다.

이 폴더에 두지 않는 것

  • 두 템플릿 공통 원칙. design-docs의 원칙 문서에 둔다.
  • 목록. route ID, 오류 code, 게이트 목록을 여기에 적지 않는다. 정본 위치만 적는다(원칙 8).
    • route ID: src/features/installed-feature-contracts.ts의 ROUTE_REGISTRY
    • 게이트: config/ci/gates.json
    • 백엔드 오류 code와 멱등성 응답: 백엔드 템플릿의 clean-architecture-backend-template/docs/web/http-contract.md
  • 다른 repo의 계약 표. 백엔드 멱등성 응답 표는 위 파일 §2가 정본이다. 위치만 적는다.
  • 작업 이력. docs/reviews/와 docs/superpowers/는 복사한 프로젝트가 지울 수 있다. 이 매뉴얼은 그 문서에 기대지 않는다.

지금 구조가 아닌 설명은 링크하지 않는다.

  • docs/architecture/frontend-ports-adapters-and-boundaries.md의 "7. 권장 목표 디렉터리 구조".
    • 목표안이다. 지금 기능 폴더 구조와 다르다.
    • 지금 구조는 docs/architecture/layers.md가 정본이다.
  • docs/architecture/starter-experience.md의 예전 "폴더 밖 수정" 4행 표와 "governance는 바뀌지 않는다" 문장(2026-11-01 리뷰 시점 판).
    • 그 판은 실제로 고쳐야 하는 파일을 다 적지 않았다.
    • 지금 판의 "Adding a feature" 절 표가 정본이다. 03 문서가 이 표를 링크한다.
  • 참조 기능 페이지의 경로 문자열과 route 입력 cast.
    • 지금은 고쳐졌다. 그래도 이 매뉴얼의 예시는 route ID와 buildRouteUrl로만 쓴다.

문서와 코드가 다를 때

코드가 맞다. 이 매뉴얼은 주장이고, 근거는 코드·설정·실행 결과다.

docs/README.md §1에서 이 폴더를 링크하면 verify:documentation(FE-GATE-017)이 이 폴더 문서에 적힌 경로·명령·게이트 ID가 있는지 검사한다. 폴더 링크는 그 폴더 바로 아래 .md만 검사한다. reference/도 검사하려면 따로 링크한다. 설명이 코드와 맞는지는 검사하지 않는다.

플랫폼 규칙(예산·실행·검증·텔레메트리)의 근거는 docs/architecture/의 scale-architecture.md에 있다. 이 매뉴얼은 scale-architecture.md §24처럼 절 번호로 가리킨다.