문제: 설계서·계획서·납품 패키지·증거·학습 문서와 ADR이 기록이라는 표시 없이 지금 문서처럼 읽힌다. 상태 칸이 설계서 72개 중 40개, 계획서는 거의 없고, 있어도 Approved·확정·Accepted.처럼 값이 제각각이며 영어다. 고른 방법: docs/design, docs/history, docs/adr, docs/notification/adr의 .md 246개 맨 위에 같은 모양의 머리 블록을 단다. 칸은 상태·작성일· 요약(한국어 한 문장)·현재 정본, 대체됐으면 대체됨이다. 블록은 표시 줄 두 개로 감싸서 빼면 원문 바이트가 그대로 돌아온다(246개 모두 대조함). - 종류는 폴더가 정하고 둘째 줄에 적는다(plans/evidence는 증거). - 상태는 원래 상태 줄을 고정 어휘로 바꾼 값이다. 상태 줄이 없는 설계서와 체크 상자가 다 표시되지 않은 계획서는 「확인 안 함」. capability-status.md 제거 표로 지운 것이 확인된 설계서 다섯은 「폐기」, 2026-07-20 하네스 설계·계획과 production capability platform 설계는 「대체됨」이다. - 현재 정본은 구조 정리로 옮겨질 수 있는 src/messaging·src/grpc 대신 docs/ 쪽 문서나 옮기지 않는 leaf README를 가리킨다. docs/README.md에 「문서 수명과 언어」「기록 문서의 머리 블록」「문서와 코드를 같은 변경에서 고친다」를 더하고, 파생 서비스 안내에 머리 블록 충돌 가능성을 적었다. 버린 대안: H1 제목 아래에 블록을 두는 안은 보기에는 낫지만 빼는 규칙이 파일마다 달라져 원문 복원이 기계적이지 않다. 「종류」 칸을 따로 두는 안은 폴더와 같은 정보를 두 번 쓰게 한다. 위험·한계: 「확인 안 함」 설계서 38개, 계획서 51개는 지금 유효한지 아무도 판정하지 않았다. 요약은 제목·목표 줄을 보고 쓴 것이라 본문을 끝까지 읽지 않았다. 납품 패키지 셋의 MANIFEST.sha256는 이제 맞지 않는다 (납품 당시 바이트의 해시이고, 블록을 빼면 다시 맞는다). 리뷰 폴더에는 아직 머리 블록을 달지 않았다. 검증: 머리 블록을 뺀 내용과 HEAD 원본 246개 일치, check-work-docs.py rc=0, --links docs·README.md·CLAUDE.md·AGENTS.md 깨진 링크 0.
3.8 KiB
결정 기록 본문은 결정한 때의 원문이다. 지금도 유효한지는 「상태」를, 지금 동작은 「현재 정본」을 읽는다.
- 상태: 채택
- 작성일: 2026-08-13
- 요약: BSON 표현을 고정한 목록으로 관리한다는 결정이다.
- 현재 정본:
docs/mongodb/bson-mapping-guide.md
ADR-MONGO-002 — BSON representation is a pinned manifest
- Status: Accepted
- Date: 2026-08-13
- Design source: design §10, decision D-06
Context
How a Java value is represented in BSON is a data contract, but nothing in the default toolchain
treats it as one. Spring Data and the MongoDB driver both have defaults, and those defaults have
changed across versions. A BigDecimal can land as a Double, a String or a Decimal128; a UUID
can land as Binary subtype 3 or subtype 4; an Instant can land as a Date or a String.
The consequences are asymmetric. A representation change is invisible in a value-equality test —
12.30 looks like 12.30 whether it is a double or a Decimal128 — but once a collection holds
production data, changing it is a full migration. And the UUID case is worse than a migration: legacy
Java representation byte-swaps two halves of the UUID, so a document written under one representation
and read under the other yields a different, valid-looking UUID. Nothing errors. You get the wrong
record.
Decision
MongoTypeRepresentationManifest pins the representation for every type the platform maps, and
MongoMappingConfiguration builds the Spring Data converters from it. Nothing relies on a library
default.
| Java | BSON | Rationale |
|---|---|---|
UUID |
Binary subtype 4 (STANDARD) |
Subtype 3 byte-swaps; cross-representation reads are silently wrong. |
BigDecimal |
Decimal128 |
A double cannot represent 12.30; money compared as a double is eventually wrong by a cent. |
BigInteger |
Decimal128, or declared String when out of range |
34 significant digits; out of range fails on write instead of rounding. |
Instant / OffsetDateTime / ZonedDateTime |
UTC Date |
One instant, one representation. |
LocalDate |
declared per field | A calendar day is not an instant. |
LocalDateTime |
refused | No offset: the stored value depends on the writing JVM's default zone. |
enum |
String name |
Ordinals renumber when someone inserts a constant. |
Type metadata follows MongoTypeMetadataPolicy — NONE, ALIAS or CLASS_NAME. A
@LongLivedMongoDocument type may not use CLASS_NAME: writing a FQCN into a million documents makes
a package rename a data migration.
The manifest is enforced by a golden gate. MongoBsonSnapshot canonicalises a stored document,
preserving BSON types and keeping missing distinct from null, and
MongoBsonSnapshotAssert.hasTypeSignature(...) fails on any representation change. The registry
pins UuidCodec(STANDARD) explicitly rather than inheriting a default, since inheriting the default
is the exact drift the gate exists to catch.
Consequences
Positive. A library upgrade cannot move a representation without failing a test. Money is exact. UUIDs read back as themselves. Class moves stay refactors.
Negative. Every representation-affecting change requires updating a snapshot and writing a migration. A new mapped type needs a manifest entry before it can be used. This is the intended friction: the alternative is discovering the change in production.
Rejected alternative — "snapshot the JSON." JSON destroys exactly the distinctions the gate
protects: Decimal128 and String both render as text, Binary UUID and ObjectId both render as
hex, and missing and null both disappear.