Files
portfolio-hub/docs/batches/bat-016_20260605_ledger-accounting-consolidation/design.md
T
genichinandClaude Opus 4.8 2a19b7f058 fix: ledger write idempotency for TimescaleDB hypertable (BAT-016 rework)
BAT-016's initial implementation passed only against mocked repositories and
broke on a real database. Two defects fixed:

1. insert_ledger_trade used `ON CONFLICT (portfolio_id, order_id, execution_id)
   WHERE order_id IS NOT NULL` but portfolio_ledger is a TimescaleDB hypertable,
   which cannot have that partial unique index (must include the partitioning
   column recorded_at). The statement errored against Postgres. Replaced with
   application-level idempotency: SELECT-before-insert inside the existing
   `SELECT ... FOR UPDATE` portfolio row lock, which serializes concurrent
   same-portfolio writes (race-safe). Duplicate returns current authoritative
   portfolio state (dcy-006 OQ-4 b).

2. `with self._connect() as conn:` closes the shared psycopg3 connection on exit,
   leaving the reused repository connection unusable. Switched to
   `with conn.transaction():` (commits without closing).

Added tests/test_ledger_consolidation_integration.py — real-Postgres integration
tests (new / duplicate / negative-balance) that close the mock-only verification
gap. Full suite: 376 passed.

SDLC: REQ-036/037 CHG-20260605-03 reconcile OQ-7 (ii) (DB partial unique →
application-level idempotency) since the hypertable makes the DB constraint
infeasible. REQ-036/037/038 → Implemented; BAT-016 → release-candidate.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-05 22:11:17 +09:00

5.3 KiB

BAT-016 Design

  • Status: confirmed
  • Batch: BAT-016

Architecture Summary

  • 신 path(POST /v1/portfolios/{id}/ledger/trades)를 portfolio 회계의 단일 권위 endpoint로 재정의하고, 두 ledger 테이블을 portfolio_ledger 단일 회계 원장으로 통합한다. ledger write가 portfolio 잔고를 단일 트랜잭션으로 갱신하고 응답에 거래 후 권위 상태를 포함한다. 마이그레이션(DB) + 도메인/repository 통합(app) + endpoint 동작 변경 + 레거시 deprecated 표기의 3 REQ 묶음.

Changed Areas

  • Docs: docs/data-model.md(portfolio_ledger 통합 스키마, ledger_trades entity 제거), docs/interface-contract.md(신 path 회계 동작+응답, 레거시 deprecated), docs/runtime-flows.md(ledger write flow 회계 단계)
  • Modules: migrations/versions/(신규 revision), app/repositories/postgres.py(ensure_schema + insert 통합 + FOR UPDATE + ON CONFLICT partial), app/repositories/portfolio_repository.py, app/domain/models.py(LedgerEntry 통합), app/domain/services.py(음수 허용 회계 헬퍼), app/api/v1_portfolios.py(handler), app/schemas/v1.py(응답), app/api/portfolios.py(레거시 deprecated)
  • Interfaces: POST /v1/portfolios/{id}/ledger/trades(응답 확장 + 회계), POST /portfolios/{id}/buy·/sell(deprecated 표기)

Key Decisions

갱신 (2026-06-05, verify 후 재구현): portfolio_ledger가 TimescaleDB hypertable임이 확인되어 partial UNIQUE index/PK 기반 idempotency가 불가능 → application-level idempotency로 재정의. 아래 결정 1/2/5 + Edge Cases가 이를 반영하도록 수정됨.

  1. 마이그레이션 전략 (REQ-036): 단일 alembic revision(down_revision=20260601_0024)에서 컬럼 추가 → backfill(action→side, recorded_at→executed_at) → 타입 변경(Float→NUMERIC(20,8)) → action 컬럼 제거 → 보조 인덱스 신설 → ledger_trades DROP 순. partial UNIQUE index는 생성하지 않는다(hypertable 제약). ledger_entry_id는 Identity 컬럼(비-PK).
  2. order_id/execution_id NULL 허용 + application-level idempotency (OQ-7 (ii) 재정의): portfolio_ledger는 TimescaleDB hypertable(파티션 컬럼 recorded_at)이라 (portfolio_id, order_id, execution_id) partial unique index/PK를 만들 수 없다(cannot create a unique index without the column recorded_at). 따라서 OQ-7 (ii)의 "DB partial UNIQUE + ON CONFLICT"는 불가 → SELECT ... FOR UPDATE(portfolios row 락) 안에서 SELECT-before-insert로 idempotency 구현. broker write(order_id 존재)만 기존 row 조회 후 dedup, 레거시/수동 write(order_id NULL)는 append-only. portfolios row lock이 동시 write를 직렬화하여 race-safe. REQ-036/037 CHG-20260605-03 정합.
  3. 도메인 모델 통합 (REQ-037 FR-13): LedgerEntry를 단일 모델로 유지하고 broker 필드(ledger_entry_id, order_id, execution_id, side, executed_at)를 흡수. LedgerTrade dataclass 삭제. 기존 LedgerEntry(잔고 snapshot 필드)와 LedgerTrade(broker 필드)의 합집합.
  4. 회계 헬퍼 분리 (REQ-037 FR-6, R-8): 음수 검증을 제거한 ledger 전용 회계 함수를 추출. 기존 apply_buy/apply_sell(음수 거부)은 레거시 buy/sell 전용으로 보존. 공통 회계 공식(부호/fee/tax)은 가능한 한 공유 함수로 추출해 divergence 방지.
  5. 단일 트랜잭션 + row lock (REQ-037 FR-6/FR-7): SELECT ... FOR UPDATE로 portfolios row 잠금 → (broker write면) 기존 ledger row SELECT-before-insert → 없으면 회계 계산 + portfolio_ledger INSERT + portfolios UPDATE → COMMIT. 트랜잭션은 conn.transaction() 사용(psycopg3 with conn:는 connection을 close하므로 공유 connection 유지를 위해 transaction 블록 사용). duplicate(기존 row 존재)면 INSERT/UPDATE 없이 portfolios 현재 권위 상태로 응답(OQ-4 (b)).
  6. 레거시 deprecated (REQ-038): FastAPI route deprecated=True + 응답 헤더 Deprecation: true. 동작 무변경. 레거시 write는 portfolio_ledger에 order_id/execution_id NULL append.

Edge Cases

  • duplicate 호출(SELECT-before-insert로 기존 row 발견): INSERT/UPDATE 없음 → status="duplicate" + portfolios 현재 권위 상태 응답. portfolio_ledger row 재생성 없음.
  • 음수 잔고: buy로 cash 음수 또는 sell로 quantity 음수 → 거부하지 않고 그대로 기록/응답(OQ-3).
  • 레거시 write의 NULL order_id: idempotency 조회 대상 외 → append-only(같은 buy 두 번 = row 2건).
  • action 자유형식 값(예: 'manual'): 마이그레이션 backfill 시 side 매핑 규칙 외 → 개발 워크스페이스 분포 단순(확인 후 처리). prod는 release 이연.
  • 도메인 모델 통합 시 광범위 참조(R-1): test_v1_portfolios_ledger / test_v1 / test_daemon_assignment 등 LedgerTrade/LedgerEntry 참조 전수 갱신.

Architecture Impact

  • both (data-model + runtime-flows)

Reference Doc Update Plan

  • project-structure.md: none (신규 모듈/디렉토리 없음, 기존 모듈 변경에 한정)
  • runtime-flows.md: ledger write flow 섹션에 회계 적용(단일 트랜잭션 + FOR UPDATE + portfolio_ledger insert + portfolios UPDATE) + portfolio_ledger 단일 원장 + 레거시 deprecated 명문화
  • data-model.md: portfolio_ledger entity에 신규 컬럼/제약/타입 추가 + ledger_trades entity 섹션 제거 (REQ-036 Impacted Area)