Files
clean-architecture-backend-…/docs/fileserver/upgrade-guide.md
T
DongHyeonka 7b5b4c6983 fix(http)!: fileserver·notification HTTP와 bulk envelope를 공용 계약대로 답한다
문제: fileserver·notification의 HTTP 표면이 공용 계약(web AGENTS B8,
http-contract §1, manual 11)과 달랐다.
- fileserver batch는 part가 실패해도 success:true였고 결과를 data.results에
  넣었다. fullySucceeded()를 아무도 부르지 않았다. 계약끼리도 달랐다(web B8의
  BATCH_PARTIAL_FAILURE vs fileserver 계약의 200 + results[].error).
- BulkEnvelope.partial의 error.message가 영어 고정 문구였고, BulkItemResult는
  호출자 문구를 그대로 실었으며 null 키를 남겼다(mix-in 없음).
- Content-Range가 CORS 노출 목록에 없어 브라우저가 다운로드를 이어 받지 못했다.
- 알림 제출·template 게시의 모르는 channel·slot·locale이 details 없는
  BAD_PARAMETER였고(주석은 validation error), template 경로가 lowerCamel이 아닌
  /notification-templates였다.
- 전송 넷(raw·multipart·draft-12·tus)이 이름 없는 업로드에 "upload.bin"을
  지어 넣었다. 앱 정책 OriginalFilenamePolicy의 기본값은 "file"이라 업무 규칙이
  두 곳에 있었다(HARD-STOP 4).
- EnvelopeWireShapeTest는 http-contract §1의 증거로 쓰이는데 data null 키 생략,
  String → Envelope, unsorted page의 sort:null, 부분 실패 문구를 보지 않았다.

고른 방법:
- 리뷰 README 6절 ①대로 fileserver batch도 공용 bulk envelope다. 모두 성공 →
  success:true + results, 하나라도 실패 → success:false + BATCH_PARTIAL_FAILURE +
  part별 details(index, status, id, code, message). 성공한 part는 되돌리지 않는다.
  BatchUploadResponse는 쓰는 곳이 없어져 지웠다.
- BulkEnvelope.partial과 BulkItemResult.error(index, ApiErrorCode)는 category
  고정 문구를 쓴다. BulkItemResult에 null 생략 mix-in을 더했다.
- 알림 controller는 NotificationFieldRejection(VALIDATION_FAILED carrier, 필드를
  짚는 details 하나, 거절한 값은 싣지 않음)을 던진다. template 경로는
  /notificationTemplates다. 읽는 endpoint가 없어 201에 Location을 싣지 않고,
  manual 11 규칙에 그 경우를 적었다.
- 전송은 이름이 없으면 빈 이름을 넘기고 OriginalFilenamePolicy가 정한다.
- EnvelopeWireShapeTest에 빠진 넷을 더했다. EnvelopeTest의 when 둘인 시험을
  둘로 나눴다.
버린 대안: /notification-templates를 별칭으로 남기기 — 같은 자원의 경로가 둘이
되고 인가·공개 경로 스냅숏이 둘을 따로 봐야 한다.

위험·한계: batch를 읽는 client, 알림 template 경로를 쓰는 client와 배포
스크립트, BulkItemResult.error(index, code, message)를 부르던 코드가 바뀐다
(upgrade 안내 6·7·10·11·12, 14).

BREAKING CHANGE: fileserver batch 응답이 공용 bulk envelope가 됐다. 알림
template 경로가 /notificationTemplates다. 알림의 모르는 vocabulary 값은
VALIDATION_FAILED다. BulkItemResult.error는 ApiErrorCode를 받는다. 이름 없는
업로드의 표시 이름이 "file"이다. 할 일은 docs/upgrade/2026-11-round9-contracts.md.

Refs: RR9-03-01, RR9-03-02, RR9-03-09, RR9-03-13, RR9-03-21, RR9-05-09
2026-11-13 04:46:39 +09:00

3.7 KiB

Fileserver 업그레이드 안내

Capability 켜기

Fileserver는 꺼진 채로 나온다. 명시적으로 켜기 전에는 아무것도 등록하지 않는다. endpoint도, 스레드 pool도, metric도 없다.

app:
  fileserver-platform:
    enabled: true
    instance-id: ${HOSTNAME}
    default-namespace: default
    observability:
      fingerprint-key: ${FILESERVER_FINGERPRINT_KEY}

instance-id는 인스턴스마다 달라야 한다. writer lease의 소유자이기 때문이다. 두 노드가 같은 값을 쓰면 둘 다 같은 lease를 가졌다고 믿는다.

fingerprint-key는 필수이고 기본값이 없다. 없으면 key 없는 digest로 물러서지 않고 시작이 실패한다. 셀 수 있는 식별자 공간에서 key 없는 digest는 되돌릴 수 있다.

선택 면

각각 따로 된 스위치이고, 모두 기본으로 꺼져 있다.

app:
  fileserver-platform:
    admin:
      enabled: false        # management plane. 관리 port에 둔다
    tus:
      enabled: false        # tus 1.0, Stable
    httpbis-draft12:
      enabled: false        # Experimental. 표준 미확정, 예고 없이 바뀔 수 있다
    nginx:
      enabled: false        # 프런트 프록시 위임. 검증한 internal location이 필요하다

DB schema

metadata schema는 capability 마이그레이션으로 설치되고 비활성 상태로 시작한다.

V1__create_fileserver_metadata.sql  →  capability_schema_registry: jpa-fileserver-metadata-v1

의도해서 활성화한다. 활성화한 schema 없이 capability를 켜면 첫 업로드가 아니라 시작 때 실패한다.

게시 방식 고르기

방식 언제
atomic-move-preferred 기본값. probe가 증명하면 원자적 rename을, 아니면 metadata pointer를 쓴다.
atomic-move-required 닫힌 쪽으로 실패한다. 원자적 move를 증명하지 못하는 저장소에서는 시작을 거부한다.
metadata-pointer 원자적 rename이 없는 저장소용. 게시가 곧 metadata 확정이다.

저장소를 인증했고 잘못된 설정이 게시 때가 아니라 부팅 때 드러나기를 원하면 atomic-move-required를 고른다.

놀랄 만한 동작

  • content가 아직 있으면 삭제는 204가 아니라 202로 답한다. 파일은 이미 읽을 수 없고, 물리 회수는 미뤘다. 202를 실패로 다루면 쓸데없이 재시도한다.
  • batch 업로드는 part가 실패해도 200으로 답한다. batch는 명시적으로 원자적이지 않고, 상태 코드 하나로는 부분 결과를 정직하게 알릴 수 없다. 판별은 success다. 모두 성공하면 success: true와 results[], 하나라도 실패하면 success: false, error.code = BATCH_PARTIAL_FAILURE와 part별 error.details[](index, status, 성공한 part의 id, 실패한 part의 code·message)다. 2026-11-12 전에는 실패가 있어도 success: true였다 (docs/upgrade/2026-11-round9-contracts.md).
  • 결과를 모르는 실패는 재시도하면 안 된다. 실패 Envelope의 error.details에서 "ambiguous": true를 본다.
  • If-Match는 version 숫자가 아니라 strong ETag를 받는다. client는 실제로 받은 표현에 대해서만 주장할 수 있다.
  • 스크립트가 될 수 있는 형식은 호출자가 요청해도 inline으로 그리지 않는다.

업그레이드 확인

./gradlew verifyCleanArchitectureDependencies --console=plain
./gradlew :application-fileserver:check :adapter:inbound:web-fileserver:check \
          :adapter:outbound:fileserver:check :adapter:outbound:persistence-fileserver:check \
          :composition:fileserver-platform:check --console=plain
./gradlew :app-bootstrap:architectureTest --console=plain